element <server>
Namespace:
Type:
Content:
complex, 3 attributes, 12 elements
Defined:
XML Representation Summary
<server
    bind
 = 
xs:token : "0.0.0.0"
    host
 = 
xs:string
    name
 = 
xs:token
    >
   
Content: 
authentication? × http-authentication? × data? × index? × logs? × data-backup? × statistics? × dso-port? × jmx-port? × l2-group-port? × dso? × security?
</server>
Content model elements (12):
Included in content model of elements (1):
Definition Locations
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" name="server" type="server"/>
Attribute Detail
bind
Type:
Use:
optional
Default:
"0.0.0.0"
Defined:
locally, within server complexType
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)
XML Source (see within schema 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
Type:
Use:
optional
Defined:
locally, within server complexType
The host that the server runs on, expansion parameters may be used in this attribute. Defaults to "%i" (the machine IP address).
XML Source (see within schema 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
Type:
Use:
optional
Defined:
locally, within server complexType
The symbolic name of the server, expansion parameters may be used. Defaults to "host:dso-port".
XML Source (see within schema 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
Type:
authentication, complex content
Defined:
locally, within server complexType
Turn on JMX authentication for the Terracotta Server, Enterprise Edition. An empty tag <authentication/> 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 <user who will execute the tc-server> jmxremote.password
XML Source (see within schema source)
<xs:element minOccurs="0" name="authentication" type="authentication">
<xs:annotation>
<xs:documentation xmlns="http://www.w3.org/1999/xhtml">
Turn on JMX authentication for the Terracotta Server, Enterprise Edition.
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
</xs:documentation>
</xs:annotation>
</xs:element>

data
Type:
path, simple content
Default:
"data"
Defined:
locally, within server complexType
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'.
XML Source (see within schema source)
<xs:element default="data" maxOccurs="1" 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>

data-backup
Type:
path, simple content
Default:
"data-backup"
Defined:
locally, within server complexType
Where the data should be stored in case a backup call is initiated.
XML Source (see within schema source)
<xs:element default="data-backup" maxOccurs="1" minOccurs="0" name="data-backup" type="path">
<xs:annotation>
<xs:documentation>
Where the data should be stored in case a backup call is initiated.
</xs:documentation>
</xs:annotation>
</xs:element>

dso
Type:
dso-server-data, complex content
Defined:
locally, within server complexType
Configuration data for DSO that's specific to the DSO server.
XML Source (see within schema 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
Type:
bind-port, simple content
Default:
"9510"
Defined:
locally, within server complexType
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
XML Source (see within schema source)
<xs:element default="9510" maxOccurs="1" minOccurs="0" name="dso-port" type="bind-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>

http-authentication
Type:
http-authentication, complex content
Defined:
locally, within server complexType
Turn on authentication for the embedded Terracotta HTTP Server. This requires a properties file that contains the users and passwords that have access to the HTTP server. <br/> The format of the properties file is: <p> username: password [,rolename ...]</p> The supported roles and protected sections are: <ul> <li><code>statistics</code> (for the statistics gatherer at <code>/statistics-gatherer</code>)</li> </ul> Passwords may be clear text, obfuscated or checksummed. The class <code>com.mortbay.Util.Password</code> should be used to generate obfuscated passwords or password checksums.
XML Source (see within schema source)
<xs:element minOccurs="0" name="http-authentication" type="http-authentication">
<xs:annotation>
<xs:documentation xmlns="http://www.w3.org/1999/xhtml">
Turn on authentication for the embedded Terracotta HTTP Server. This requires a properties file that contains the users and passwords that have access to the HTTP server.
<br/>
The format of the properties file is:
<p>username: password [,rolename ...]</p>
The supported roles and protected sections are:
<ul>
<li>
<code>statistics</code>
(for the statistics gatherer at
<code>/statistics-gatherer</code>
)
</li>
</ul>
Passwords may be clear text, obfuscated or checksummed. The class
<code>com.mortbay.Util.Password</code>
should be used to generate obfuscated passwords or password checksums.
</xs:documentation>
</xs:annotation>
</xs:element>

index
Type:
path, simple content
Default:
"index"
Defined:
locally, within server complexType
Where should the server store its search index data? 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: "index" relative to the server's data path
XML Source (see within schema source)
<xs:element default="index" maxOccurs="1" minOccurs="0" name="index" type="path">
<xs:annotation>
<xs:documentation>
Where should the server store its search index
data?

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: "index" relative to the server's data path
</xs:documentation>
</xs:annotation>
</xs:element>

jmx-port
Type:
bind-port, simple content
Defined:
locally, within server complexType
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: "dso-port" + 10
XML Source (see within schema source)
<xs:element maxOccurs="1" minOccurs="0" name="jmx-port" type="bind-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: "dso-port" + 10
</xs:documentation>
</xs:annotation>
</xs:element>

l2-group-port
Type:
bind-port, simple content
Defined:
locally, within server complexType
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: "dso-port" + 20
XML Source (see within schema source)
<xs:element maxOccurs="1" minOccurs="0" name="l2-group-port" type="bind-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: "dso-port" + 20
</xs:documentation>
</xs:annotation>
</xs:element>

logs
Type:
path, simple content
Default:
"logs"
Defined:
locally, within server complexType
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'.
XML Source (see within schema 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>

security
Type:
security, complex content
Defined:
locally, within server complexType
Configuration of this server's security, ie: SSL and authentication.
XML Source (see within schema source)
<xs:element minOccurs="0" name="security" type="security">
<xs:annotation>
<xs:documentation>
Configuration of this server's security, ie: SSL and
authentication.
</xs:documentation>
</xs:annotation>
</xs:element>

statistics
Type:
path, simple content
Default:
"statistics"
Defined:
locally, within server complexType
In which directory should the server store statistics data that is being buffered? Again, this value undergoes parameter substitution before being used; thus, a value like 'statistics-data-%h' would expand to 'statistics-data' 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: 'statistics' This places the 'statistics' directory in the directory you were in when you invoked 'start-tc-server'.
XML Source (see within schema source)
<xs:element default="statistics" maxOccurs="1" minOccurs="0" name="statistics" type="path">
<xs:annotation>
<xs:documentation>
In which directory should the server store statistics
data that is being buffered? Again, this value undergoes
parameter substitution before being used; thus, a value
like 'statistics-data-%h' would expand to
'statistics-data' 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: 'statistics'

This places the 'statistics' directory in the
directory you were in when you invoked
'start-tc-server'.
</xs:documentation>
</xs:annotation>
</xs:element>

This XML schema documentation has been generated with DocFlex/XML RE 1.7.2 using DocFlex/XML XSDDoc 2.1.0 template set.
DocFlex/XML RE is a reduced edition of DocFlex/XML, which is a tool for programming and running highly sophisticated documentation and reports generators by the data obtained from any kind of XML files. The actual doc-generators are implemented in the form of special templates that are designed visually using a high quality Template Designer GUI basing on the XML schema (or DTD) files describing the data source XML.
DocFlex/XML XSDDoc is a commercial template application of DocFlex/XML that implements a high-end XML Schema documentation generator with simultaneous support of framed multi-file HTML, single-file HTML and RTF output formats. (More formats are planned in the future).
A commercial license for "DocFlex/XML XSDDoc" will allow you:
  • To configure the generated documentation so much as you want. Thanks to our template technology, it was possible to support more than 300 template parameters (working the same as "options" of an ordinary doc-gen), which will give you an unprecedented control over the generated content!
  • To use certain features disabled in the free mode (such as the full documenting of substitution groups).
  • To enable/disable documenting of the initial, imported, included and redefined XML schemas selectively.
  • To document local element components both globally and locally (similar to attributes).
  • To enable/disable reproducing of namespace prefixes.
  • To format your annotations with XHTML tags and reproduce that formatting both in HTML and RTF output.
  • To insert images in your annotations using XHTML <img> tags (supported both in HTML and RTF output).
  • To use PlainDoc.tpl main template to generate all the XML schema documentation in the form of a single HTML file.
  • To use the same template to generate the incredible quality RTF documentation.
  • To document only selected XML schema components specified by name.
  • To remove this very advertisement text
Once having only such a license, you will be able to run the fully-featured XML schema documentation generator both with DocFlex/XML SDK and with DocFlex/XML RE, which is a reduced free edition containing only the template interpretor / output generator. No other licenses will be required!
But this is not all. In addition to it, a commercial license for DocFlex/XML SDK will allow you to modify the XSDDoc templates themselves as much as you want. You will be able to achieve whatever was impossible to do with the template parameters only. And, of course, you could develop any template applications by your own!
Please note: By purchasing a license for this software, you not only acquire a useful tool, you will also make an important investment in its future development, the result of which you could enjoy later by yourself. Every single your purchase matters and makes a difference for us!
To buy a license, please follow this link: http://www.filigris.com/shop/