*Back to [[Book|Administrator's Configuration File Reference#cfr]] [[Topic|Administrator's Configuration File Reference#chap3]]*
h2. {{server.xml}} elements beginning with C
The following elements are discussed below:
|[#{{cgi}}] |[#{{cluster}}] |[#{{connection-creation-property}}] |
|[#{{connection-lease-property}}] |[#{{convert}}] |[#{{custom-resource}}] |
h3. {{cgi}} {anchor:c1}
The {{cgi}} element configures the CGI execution subsystem. This element may appear zero or one time within the {{server}} element. For more information, see [{{server}}|S#s3].
h4. Subelements
The {{cgi}} element can contain the following subelements:
Table 3-8 List of {{cgi}} Subelements
||Element ||Occurrences ||Description ||
|{{timeout}} |0 or 1 |The timeout (in seconds) after which the server will terminate a CGI program. The value can be from 0.001 to 3600, or -1 for no timeout. |
|{{idle-timeout}} |0 or 1 |The timeout (in seconds) after which the server will terminate a nonresponsive CGI program. The value can be from 0.001 to 3600. |
|{{cgistub-path}} |0 or 1 |The path to the {{Cgistub}} binary. If a relative path is used, it is relative to the server's {{config}} directory. |
|{{cgistub-idle-timeout}} |0 or 1 |The timeout (in seconds) after which an unused {{Cgistub}} process will be terminated. The value can be from 0.001 to 3600. |
|{{min-cgistubs}} |0 or 1 |The minimum number of {{Cgistub}} processes the server keeps on hand, waiting to run the CGI programs. The value can be from 0 to 4096. |
|{{max-cgistubs}} |0 or 1 |The maximum number of {{Cgistub}} processes the server keeps on hand, waiting to run the CGI programs. The value can be from 1 to 4096. |
|{{env-variable}} |0 or more |Configures the CGI program environment variables. For more details, see [{{env-variable}}|E#e1]. |
h3. {{cluster}} {anchor:c2}
The {{cluster}} element defines the cluster to which the server belongs. This element may appear zero or one time within the {{server}} element. For more information, see [{{server}}|S#s3].
h4. Subelements
The {{cluster}} element can contain the following subelements:
Table 3-9 List of {{cluster}} Subelements
||Element ||Occurrences ||Description ||
|{{local-host}} |1 |Defines the network address of an instance. The value is the {{host}} value from an {{instance}} element. For more details, see [{{instance}}|I & J#i3]. |
|{{instance}} |1 or more |Defines a member of the server cluster. For more details, see [{{instance}}|I & J#i3]. |
|{{session-replication}} |0 or 1 |Configures the Servlet session replication for the server cluster. For more details, see [{{session-replication}}|S#s5]. |
h3. {{connection-creation-property}} {anchor:c3}
The {{connection-creation-property}} element configures the properties that are set when a JDBC connection ({{java.sql.Connection}}) is created. This element may appear zero or more times within the {{jdbc-resource}} element. For more information, see [{{jdbc-resource}}|I & J#j1].
h4. Subelements
The {{connection-creation-property}} element can contain the following subelements:
Table 3-10 List of {{connection-creation-property}} Subelements
||Element ||Occurrences ||Description ||
|{{name}} |1 |The name of the property |
|{{value}} |1 |The value of the property |
|{{description}} |0 or 1 |The description of the property |
h4. See Also
* [#{{connection-lease-property}}]
* [{{jdbc-resource}}|I & J#j1]
* [{{property}}|P#p3]
h3. {{connection-lease-property}} {anchor:c4}
The {{connection-lease-property}} element configures the properties that are set each time a JDBC connection ({{java.sql.Connection}}) is leased to an application. This element may appear zero or more times within the {{jdbc-resource}} element. For more information, see [{{jdbc-resource}}|I & J#j1].
h4. Subelements
The {{connection-lease-property}} element can contain the following subelements:
Table 3-11 List of {{connection-lease-property}} Subelements
||Element ||Occurrences ||Description ||
|{{name}} |1 |The name of the property |
|{{value}} |1 |The value of the property |
|{{description}} |0 or 1 |The description of the property |
h4. See Also
* [#{{connection-creation-property}}]
* [{{jdbc-resource}}|I & J#j1]
* [{{property}}|P#p3]
h3. {{convert}} {anchor:c5}
The {{convert}} element determines the type of documents that are converted prior to indexing. This element may appear zero or one time within the {{search-collection}} element. Documents with the {{pdf}} file extension are always converted to HTML prior to indexing. For more information, see [{{search-collection}}|S#s2].
h4. Subelements
The {{convert}} element can contain the following subelements:
Table 3-12 List of {{convert}} Subelements
||Element ||Occurrences ||Description ||
|{{extension}} |0 or more |The file extension of a document type that should be converted to HTML. |
h4. See Also
* [{{include}}|I & J#i1]
* [{{index}}|I & J#i2]
* [{{search-app}}|S#s1]
* [{{search-collection}}|S#s2]
h3. {{custom-resource}} {anchor:c6}
The {{custom-resource}} element configures a resource implemented by a custom Java class. This element may appear zero or more times within the {{server}} element. For more information, see [{{server}}|S#s3].
h4. Subelements
The {{custom-resource}} element can contain the following subelements:
Table 3-13 List of {{custom-resource}} Subelements
||Element ||Occurrences ||Description ||
|{{enabled}} |0 or 1 |Determines whether the custom resource is enabled at runtime. The default value is {{true}}. |
|{{jndi-name}} |1 |The JNDI name of the custom resource. |
|{{res-type}} |1 |The type of custom resource. The value is a class name. |
|{{factory-class}} |1 |The class that instantiates a naming context which is used to look up the external resource. The value is a name of a class that implements {{javax.naming.spi.ObjectFactory}}. |
|{{property}} |0 or more |Configures the optional resource-specific properties. For more details, see [{{property}}|P#p3]. |
|{{description}} |0 or 1 |The description of the custom resource. The value of this element is in text format. |
h2. {{server.xml}} elements beginning with C
The following elements are discussed below:
|[#{{cgi}}] |[#{{cluster}}] |[#{{connection-creation-property}}] |
|[#{{connection-lease-property}}] |[#{{convert}}] |[#{{custom-resource}}] |
h3. {{cgi}} {anchor:c1}
The {{cgi}} element configures the CGI execution subsystem. This element may appear zero or one time within the {{server}} element. For more information, see [{{server}}|S#s3].
h4. Subelements
The {{cgi}} element can contain the following subelements:
Table 3-8 List of {{cgi}} Subelements
||Element ||Occurrences ||Description ||
|{{timeout}} |0 or 1 |The timeout (in seconds) after which the server will terminate a CGI program. The value can be from 0.001 to 3600, or -1 for no timeout. |
|{{idle-timeout}} |0 or 1 |The timeout (in seconds) after which the server will terminate a nonresponsive CGI program. The value can be from 0.001 to 3600. |
|{{cgistub-path}} |0 or 1 |The path to the {{Cgistub}} binary. If a relative path is used, it is relative to the server's {{config}} directory. |
|{{cgistub-idle-timeout}} |0 or 1 |The timeout (in seconds) after which an unused {{Cgistub}} process will be terminated. The value can be from 0.001 to 3600. |
|{{min-cgistubs}} |0 or 1 |The minimum number of {{Cgistub}} processes the server keeps on hand, waiting to run the CGI programs. The value can be from 0 to 4096. |
|{{max-cgistubs}} |0 or 1 |The maximum number of {{Cgistub}} processes the server keeps on hand, waiting to run the CGI programs. The value can be from 1 to 4096. |
|{{env-variable}} |0 or more |Configures the CGI program environment variables. For more details, see [{{env-variable}}|E#e1]. |
h3. {{cluster}} {anchor:c2}
The {{cluster}} element defines the cluster to which the server belongs. This element may appear zero or one time within the {{server}} element. For more information, see [{{server}}|S#s3].
h4. Subelements
The {{cluster}} element can contain the following subelements:
Table 3-9 List of {{cluster}} Subelements
||Element ||Occurrences ||Description ||
|{{local-host}} |1 |Defines the network address of an instance. The value is the {{host}} value from an {{instance}} element. For more details, see [{{instance}}|I & J#i3]. |
|{{instance}} |1 or more |Defines a member of the server cluster. For more details, see [{{instance}}|I & J#i3]. |
|{{session-replication}} |0 or 1 |Configures the Servlet session replication for the server cluster. For more details, see [{{session-replication}}|S#s5]. |
h3. {{connection-creation-property}} {anchor:c3}
The {{connection-creation-property}} element configures the properties that are set when a JDBC connection ({{java.sql.Connection}}) is created. This element may appear zero or more times within the {{jdbc-resource}} element. For more information, see [{{jdbc-resource}}|I & J#j1].
h4. Subelements
The {{connection-creation-property}} element can contain the following subelements:
Table 3-10 List of {{connection-creation-property}} Subelements
||Element ||Occurrences ||Description ||
|{{name}} |1 |The name of the property |
|{{value}} |1 |The value of the property |
|{{description}} |0 or 1 |The description of the property |
h4. See Also
* [#{{connection-lease-property}}]
* [{{jdbc-resource}}|I & J#j1]
* [{{property}}|P#p3]
h3. {{connection-lease-property}} {anchor:c4}
The {{connection-lease-property}} element configures the properties that are set each time a JDBC connection ({{java.sql.Connection}}) is leased to an application. This element may appear zero or more times within the {{jdbc-resource}} element. For more information, see [{{jdbc-resource}}|I & J#j1].
h4. Subelements
The {{connection-lease-property}} element can contain the following subelements:
Table 3-11 List of {{connection-lease-property}} Subelements
||Element ||Occurrences ||Description ||
|{{name}} |1 |The name of the property |
|{{value}} |1 |The value of the property |
|{{description}} |0 or 1 |The description of the property |
h4. See Also
* [#{{connection-creation-property}}]
* [{{jdbc-resource}}|I & J#j1]
* [{{property}}|P#p3]
h3. {{convert}} {anchor:c5}
The {{convert}} element determines the type of documents that are converted prior to indexing. This element may appear zero or one time within the {{search-collection}} element. Documents with the {{pdf}} file extension are always converted to HTML prior to indexing. For more information, see [{{search-collection}}|S#s2].
h4. Subelements
The {{convert}} element can contain the following subelements:
Table 3-12 List of {{convert}} Subelements
||Element ||Occurrences ||Description ||
|{{extension}} |0 or more |The file extension of a document type that should be converted to HTML. |
h4. See Also
* [{{include}}|I & J#i1]
* [{{index}}|I & J#i2]
* [{{search-app}}|S#s1]
* [{{search-collection}}|S#s2]
h3. {{custom-resource}} {anchor:c6}
The {{custom-resource}} element configures a resource implemented by a custom Java class. This element may appear zero or more times within the {{server}} element. For more information, see [{{server}}|S#s3].
h4. Subelements
The {{custom-resource}} element can contain the following subelements:
Table 3-13 List of {{custom-resource}} Subelements
||Element ||Occurrences ||Description ||
|{{enabled}} |0 or 1 |Determines whether the custom resource is enabled at runtime. The default value is {{true}}. |
|{{jndi-name}} |1 |The JNDI name of the custom resource. |
|{{res-type}} |1 |The type of custom resource. The value is a class name. |
|{{factory-class}} |1 |The class that instantiates a naming context which is used to look up the external resource. The value is a name of a class that implements {{javax.naming.spi.ObjectFactory}}. |
|{{property}} |0 or more |Configures the optional resource-specific properties. For more details, see [{{property}}|P#p3]. |
|{{description}} |0 or 1 |The description of the custom resource. The value of this element is in text format. |