complexType "server"

Namespace: | http://www.terracotta.org/config
Content: | complex, 3 attributes, 7 elements
Defined: | globally in terracotta-4.xsd, see XML source
Includes: | definitions of 3 attributes and 7 elements
Used: | at 1 location

XML Representation Summary
<...
| bind | = | xs:token : "0.0.0.0"
| host | = | xs:string
| name | = | xs:token
| >
Content: | authentication? × data? × logs? × dso-port? × jmx-port? × l2-group-port? × dso?
</...>

Content Elements (7):

  authentication (type authentication), data (type path), dso (type dso-server-data), dso-port (type port), | jmx-port (type port), l2-group-port (type port), logs (type path)

All Direct / Indirect Based Elements (1):

  server (type server) |

Known Usage Locations

- As direct type of elements (1):

  server (type server) |

Annotation
Data specific to one of your servers.
XML Source

<xs:complexType name="server"> <xs:annotation> <xs:documentation xmlns="http://www.w3.org/1999/xhtml"> Data specific to one of your servers. </xs:documentation> </xs:annotation> <xs:all> <xs:element minOccurs="0" name="authentication" type="authentication"> <xs:annotation> <xs:documentation xmlns="http://www.w3.org/1999/xhtml"> Turn on authentication for the Terracotta server. An empty tag &lt;authentication/&gt; defaults to the standard Java JMX authentication mechanism referring to password and access files in: $JAVA_HOME/jre/lib/management. <ul> <li>$JAVA_HOME/jre/lib/management/jmxremote.password</li> <li>$JAVA_HOME/jre/lib/management/jmxremote.access</li> </ul> You must modify these files as such (if none exist create them): <p>jmxremote.password</p> add a line to the end of the file declaring your username and password followed by a caridge return: <p>secretusername secretpassword</p> <p>jmxremote.access</p> add the following line (with a caridge return) to the end of your file: <p>secretusername readwrite</p> You must also: <br/> $ chmod 500 jmxremote.password <br/> $ chown &lt;user who will execute the tc-server&gt; jmxremote.password <br/> <br/> NOTE: This will not work unless you're correctly running the Terracotta server with Java version &gt;= 1.5 </xs:documentation> </xs:annotation> </xs:element> <xs:element default="data" minOccurs="0" name="data" type="path"> <xs:annotation> <xs:documentation> Where should the server store its persistent data? (This includes stored object data for DSO.) This value undergoes parameter substitution before being used; this allows you to use placeholders like '%h' (for the hostname) or '%(com.mycompany.propname)' (to substitute in the value of Java system property 'com.mycompany.propname'). Thus, a value of 'server-data-%h' would expand to 'server-data-artichoke' if running on host 'artichoke'. If this is a relative path, then it is interpreted relative to the current working directory of the server (that is, the directory you were in when you started the server). It is thus recommended that you specify an absolute path here. Default: 'data' This places the 'data' directory in the directory you were in when you invoked 'start-tc-server'. </xs:documentation> </xs:annotation> </xs:element> <xs:element default="logs" minOccurs="0" name="logs" type="path"> <xs:annotation> <xs:documentation> In which directory should the server store its log files? Again, this value undergoes parameter substitution before being used; thus, a value like 'server-logs-%h' would expand to 'server-logs-artichoke' if running on host 'artichoke'. If this is a relative path, then it is interpreted relative to the current working directory of the server (that is, the directory you were in when you started server). It is thus recommended that you specify an absolute path here. Default: 'logs' This places the 'logs' directory in the directory you were in when you invoked 'start-tc-server'. </xs:documentation> </xs:annotation> </xs:element> <xs:element default="9510" minOccurs="0" name="dso-port" type="port"> <xs:annotation> <xs:documentation> On what port should the DSO server listen for connections from DSO clients? This can be any port you like, but note that ports below 1024 typically require 'root' privileges to use on Unix-style systems (Linux, Solaris). Default:9510 </xs:documentation> </xs:annotation> </xs:element> <xs:element default="9520" minOccurs="0" name="jmx-port" type="port"> <xs:annotation> <xs:documentation> On what port should the server listen for connections from the Terracotta administration console? This can be any port you like, but note that ports below 1024 typically require 'root' privileges to use on Unix-style systems (Linux, Solaris). Default: 9520 </xs:documentation> </xs:annotation> </xs:element> <xs:element default="9530" minOccurs="0" name="l2-group-port" type="port"> <xs:annotation> <xs:documentation> Port for server to server communication which must be indicated when HA mode is networked-active-passive. This can be any port you like, but note that ports below 1024 typically require 'root' privileges to use on Unix-style systems (Linux, Solaris). Default: 9530 </xs:documentation> </xs:annotation> </xs:element> <xs:element minOccurs="0" name="dso" type="dso-server-data"> <xs:annotation> <xs:documentation> Configuration data for DSO that's specific to the DSO server. </xs:documentation> </xs:annotation> </xs:element> </xs:all> <xs:attribute name="host" type="host" use="optional"> <xs:annotation> <xs:documentation> The host that the server runs on, expansion parameters may be used in this attribute. Defaults to "%i" (the machine IP address). </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="name" type="non-blank-token" use="optional"> <xs:annotation> <xs:documentation> The symbolic name of the server, expansion parameters may be used. Defaults to "host:dso-port". </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute default="0.0.0.0" name="bind" type="non-blank-token" use="optional"> <xs:annotation> <xs:documentation> The address this server should bind its network listeners to. By default network listeners will be available on all local addresses (ie. 0.0.0.0) </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType>

Attribute Detail
bind

  The address this server should bind its network listeners to. By default network listeners will be available on all local addresses (ie. 0.0.0.0)

  Type: | non-blank-token
  Use: | optional
  Default: | "0.0.0.0"
  Defined: | locally, within this complexType

  XML Source

  <xs:attribute default="0.0.0.0" name="bind" type="non-blank-token" use="optional"> <xs:annotation> <xs:documentation> The address this server should bind its network listeners to. By default network listeners will be available on all local addresses (ie. 0.0.0.0) </xs:documentation> </xs:annotation> </xs:attribute>

host

  The host that the server runs on, expansion parameters may be used in this attribute. Defaults to "%i" (the machine IP address).

  Type: | host
  Use: | optional
  Defined: | locally, within this complexType

  XML Source

  <xs:attribute name="host" type="host" use="optional"> <xs:annotation> <xs:documentation> The host that the server runs on, expansion parameters may be used in this attribute. Defaults to "%i" (the machine IP address). </xs:documentation> </xs:annotation> </xs:attribute>

name

  The symbolic name of the server, expansion parameters may be used. Defaults to "host:dso-port".

  Type: | non-blank-token
  Use: | optional
  Defined: | locally, within this complexType

  XML Source

  <xs:attribute name="name" type="non-blank-token" use="optional"> <xs:annotation> <xs:documentation> The symbolic name of the server, expansion parameters may be used. Defaults to "host:dso-port". </xs:documentation> </xs:annotation> </xs:attribute>

Content Element Detail
authentication

  Turn on authentication for the Terracotta server. An empty tag <authentication/> defaults to the standard Java JMX authentication mechanism referring to password and access files in: $JAVA_HOME/jre/lib/management.
  - $JAVA_HOME/jre/lib/management/jmxremote.password
  - $JAVA_HOME/jre/lib/management/jmxremote.access
  You must modify these files as such (if none exist create them):

  jmxremote.password

  add a line to the end of the file declaring your username and password followed by a caridge return:

  secretusername secretpassword

  jmxremote.access

  add the following line (with a caridge return) to the end of your file:

  secretusername readwrite

  You must also:
  $ chmod 500 jmxremote.password
  $ chown <user who will execute the tc-server> jmxremote.password
  NOTE: This will not work unless you're correctly running the Terracotta server with Java version >= 1.5

  Type: | authentication, complex content
  Defined: | locally, within this complexType

  XML Source

  <xs:element minOccurs="0" name="authentication" type="authentication"> <xs:annotation> <xs:documentation xmlns="http://www.w3.org/1999/xhtml"> Turn on authentication for the Terracotta server. An empty tag &lt;authentication/&gt; defaults to the standard Java JMX authentication mechanism referring to password and access files in: $JAVA_HOME/jre/lib/management. <ul> <li>$JAVA_HOME/jre/lib/management/jmxremote.password</li> <li>$JAVA_HOME/jre/lib/management/jmxremote.access</li> </ul> You must modify these files as such (if none exist create them): <p>jmxremote.password</p> add a line to the end of the file declaring your username and password followed by a caridge return: <p>secretusername secretpassword</p> <p>jmxremote.access</p> add the following line (with a caridge return) to the end of your file: <p>secretusername readwrite</p> You must also: <br/> $ chmod 500 jmxremote.password <br/> $ chown &lt;user who will execute the tc-server&gt; jmxremote.password <br/> <br/> NOTE: This will not work unless you're correctly running the Terracotta server with Java version &gt;= 1.5 </xs:documentation> </xs:annotation> </xs:element>

data

  Where should the server store its persistent data? (This includes stored object data for DSO.) This value undergoes parameter substitution before being used; this allows you to use placeholders like '%h' (for the hostname) or '%(com.mycompany.propname)' (to substitute in the value of Java system property 'com.mycompany.propname'). Thus, a value of 'server-data-%h' would expand to 'server-data-artichoke' if running on host 'artichoke'. If this is a relative path, then it is interpreted relative to the current working directory of the server (that is, the directory you were in when you started the server). It is thus recommended that you specify an absolute path here. Default: 'data' This places the 'data' directory in the directory you were in when you invoked 'start-tc-server'.

  Type: | path, simple content
  Default: | "data"
  Defined: | locally, within this complexType

  XML Source

  <xs:element default="data" minOccurs="0" name="data" type="path"> <xs:annotation> <xs:documentation> Where should the server store its persistent data? (This includes stored object data for DSO.) This value undergoes parameter substitution before being used; this allows you to use placeholders like '%h' (for the hostname) or '%(com.mycompany.propname)' (to substitute in the value of Java system property 'com.mycompany.propname'). Thus, a value of 'server-data-%h' would expand to 'server-data-artichoke' if running on host 'artichoke'. If this is a relative path, then it is interpreted relative to the current working directory of the server (that is, the directory you were in when you started the server). It is thus recommended that you specify an absolute path here. Default: 'data' This places the 'data' directory in the directory you were in when you invoked 'start-tc-server'. </xs:documentation> </xs:annotation> </xs:element>

dso

  Configuration data for DSO that's specific to the DSO server.

  Type: | dso-server-data, complex content
  Defined: | locally, within this complexType

  XML Source

  <xs:element minOccurs="0" name="dso" type="dso-server-data"> <xs:annotation> <xs:documentation> Configuration data for DSO that's specific to the DSO server. </xs:documentation> </xs:annotation> </xs:element>

dso-port

  On what port should the DSO server listen for connections from DSO clients? This can be any port you like, but note that ports below 1024 typically require 'root' privileges to use on Unix-style systems (Linux, Solaris). Default:9510

  Type: | port, simple content
  Default: | "9510"
  Defined: | locally, within this complexType

  XML Source

  <xs:element default="9510" minOccurs="0" name="dso-port" type="port"> <xs:annotation> <xs:documentation> On what port should the DSO server listen for connections from DSO clients? This can be any port you like, but note that ports below 1024 typically require 'root' privileges to use on Unix-style systems (Linux, Solaris). Default:9510 </xs:documentation> </xs:annotation> </xs:element>

jmx-port

  On what port should the server listen for connections from the Terracotta administration console? This can be any port you like, but note that ports below 1024 typically require 'root' privileges to use on Unix-style systems (Linux, Solaris). Default: 9520

  Type: | port, simple content
  Default: | "9520"
  Defined: | locally, within this complexType

  XML Source

  <xs:element default="9520" minOccurs="0" name="jmx-port" type="port"> <xs:annotation> <xs:documentation> On what port should the server listen for connections from the Terracotta administration console? This can be any port you like, but note that ports below 1024 typically require 'root' privileges to use on Unix-style systems (Linux, Solaris). Default: 9520 </xs:documentation> </xs:annotation> </xs:element>

l2-group-port

  Port for server to server communication which must be indicated when HA mode is networked-active-passive. This can be any port you like, but note that ports below 1024 typically require 'root' privileges to use on Unix-style systems (Linux, Solaris). Default: 9530

  Type: | port, simple content
  Default: | "9530"
  Defined: | locally, within this complexType

  XML Source

  <xs:element default="9530" minOccurs="0" name="l2-group-port" type="port"> <xs:annotation> <xs:documentation> Port for server to server communication which must be indicated when HA mode is networked-active-passive. This can be any port you like, but note that ports below 1024 typically require 'root' privileges to use on Unix-style systems (Linux, Solaris). Default: 9530 </xs:documentation> </xs:annotation> </xs:element>

logs

  In which directory should the server store its log files? Again, this value undergoes parameter substitution before being used; thus, a value like 'server-logs-%h' would expand to 'server-logs-artichoke' if running on host 'artichoke'. If this is a relative path, then it is interpreted relative to the current working directory of the server (that is, the directory you were in when you started server). It is thus recommended that you specify an absolute path here. Default: 'logs' This places the 'logs' directory in the directory you were in when you invoked 'start-tc-server'.

  Type: | path, simple content
  Default: | "logs"
  Defined: | locally, within this complexType

  XML Source

  <xs:element default="logs" minOccurs="0" name="logs" type="path"> <xs:annotation> <xs:documentation> In which directory should the server store its log files? Again, this value undergoes parameter substitution before being used; thus, a value like 'server-logs-%h' would expand to 'server-logs-artichoke' if running on host 'artichoke'. If this is a relative path, then it is interpreted relative to the current working directory of the server (that is, the directory you were in when you started server). It is thus recommended that you specify an absolute path here. Default: 'logs' This places the 'logs' directory in the directory you were in when you invoked 'start-tc-server'. </xs:documentation> </xs:annotation> </xs:element>

XML Schema documentation generated with DocFlex/XML (Kit) v1.6.2 DocFlex/XML is a powerful template-driven documentation and report generator from any data stored in XML files. Based on an innovative technology developed by FILIGRIS WORKS, this new tool offers virtuoso data querying and formatting capabilities not found in anything else! Need to convert your XML data into a clear nice-looking documentation or reports? Web-ready hypertext HTML or printable MS Word / OpenOffice.org friendly RTF? DocFlex/XML may be a cheap, quick and effective solution exactly for this task! Have questions? Not sure how to use it? Just send us e-mail to contact@filigris.com and we are always happy to help you! See also our services at www.filigris.com