Configuration for a Mongo instance.
Name | Type | Default | Description |
---|---|---|---|
id | string | A unique configuration ID. | |
libraryRef | A reference to top level library element (string). | Specifies a library that contains the MongoDB Java Driver. | |
onError |
| WARN | Determines the action to take in response to configuration errors. IGNORE Server will not issue any warning and error messages when it incurs a configuration error. WARN Server will issue warning and error messages when it incurs a configuration error. FAIL Server will issue a warning or error message on the first error occurrence and then stop the server. |
password | Reversably encoded password (string) | Password for database user. | |
user | string | Database user name. | |
useCertificateAuthentication | boolean | Use provided certificate from key store to authenticate user to MongoDB. | |
autoConnectRetry | boolean | Retry connections to a server, for an interval up to the maxAutoConnectRetryTime, if the socket cannot be opened. | |
connectionsPerHost | int Min: 0 | Limits the number of open connections to each host. Connections are pooled when not in use. | |
connectTimeout | A period of time with millisecond precision | Connection timeout for new connections. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds. | |
cursorFinalizerEnabled | boolean | Attempts to clean up DBCursors that are not closed. | |
description | string | Description of a Mongo instance. | |
maxAutoConnectRetryTime | A period of time with millisecond precision | Interval during which to retry attempts to open a connection to a server. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds. | |
maxWaitTime | A period of time with millisecond precision | Maximum amount of time to wait for an available connection. If negative, the connection request never times out. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds. | |
socketKeepAlive | boolean | Configures whether or not to keep sockets alive. | |
socketTimeout | A period of time with millisecond precision | The socket timeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds. | |
sslEnabled | boolean | Configures whether or not to enable SSL. | |
sslRef | A reference to top level ssl element (string). | ID of the SSL configuration to be used to connect to the SSL-enabled server. | |
threadsAllowedToBlockForConnectionMultiplier | int Min: 0 | This value, multiplied by connectionsPerHost, establishes an upper limit on threads that are allowed to wait for an available connection. | |
readPreference |
| Configures the read preference. secondary secondary primaryPreferred primaryPreferred nearest nearest secondaryPreferred secondaryPreferred primary primary | |
writeConcern |
| The reliability of a write operation to the mongo server. ERRORS_IGNORED ERRORS_IGNORED MAJORITY MAJORITY FSYNCED FSYNCED FSYNC_SAFE FSYNC_SAFE ACKNOWLEDGED ACKNOWLEDGED JOURNAL_SAFE JOURNAL_SAFE REPLICA_ACKNOWLEDGED REPLICA_ACKNOWLEDGED SAFE SAFE UNACKNOWLEDGED UNACKNOWLEDGED JOURNALED JOURNALED REPLICAS_SAFE REPLICAS_SAFE NONE NONE NORMAL NORMAL |
List of host names. The ordering of this list must be consistent with the list of ports, such that the first element in the list of host names corresponds to the first element in the list of ports, and so forth.
Specifies a library that contains the MongoDB Java Driver.
Name | Type | Default | Description |
---|---|---|---|
name | string | Name of shared library for administrators | |
description | string | Description of shared library for administrators | |
filesetRef | List of references to top level fileset elements (comma-separated string). | Id of referenced Fileset | |
apiTypeVisibility | string | spec,ibm-api,api,stable | The types of API packages that this class loader supports. This value is a comma-separated list of any combination of the following API packages: spec, ibm-api, api, stable, third-party. |
Id of referenced Fileset
Name | Type | Default | Description |
---|---|---|---|
id | string | A unique configuration ID. | |
dir | Path to a directory | ${server.config.dir} | The base directory to search for files. |
caseSensitive | boolean | true | Boolean to indicate whether or not the search should be case sensitive (default: true). |
includes | string | * | The comma or space separated list of file name patterns to include in the search results (default: *). |
excludes | string | The comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded. | |
scanInterval | A period of time with millisecond precision | 0 | Scanning interval to check the fileset for changes as a long with a time unit suffix h-hour, m-minute, s-second, ms-millisecond (e.g. 2ms or 5s). Disabled (scanInterval=0) by default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds. |
Id of referenced folder
Name | Type | Default | Description |
---|---|---|---|
id | string | A unique configuration ID. | |
dir | Path to a directory | Directory or folder to be included in the library classpath for locating resource files |
Id of referenced File
Name | Type | Default | Description |
---|---|---|---|
id | string | A unique configuration ID. | |
name | Path to a file | Fully qualified filename |
List of port numbers. The ordering of this list must be consistent with the list of host names, such that the first element in the list of host names corresponds to the first element in the list of ports, and so forth.
ID of the SSL configuration to be used to connect to the SSL-enabled server.
Name | Type | Default | Description |
---|---|---|---|
keyStoreRef | A reference to top level keyStore element (string). | A keystore containing key entries for the SSL repertoire. This attribute is required. | |
trustStoreRef | A reference to top level keyStore element (string). | ${keyStoreRef} | A keystore containing trusted certificate entries used by the SSL repertoire for signing verification. This attribute is optional. If unspecified, the same keystore is used for both key and trusted certificate entries. |
sslProtocol | string | The SSL handshake protocol. Protocol values can be found in the documentation for the underlying JRE's Java Secure Socket Extension (JSSE) provider. When using the IBM JRE the default value is SSL_TLS and when using the Oracle JRE the default value is SSL. | |
clientAuthentication | boolean | false | Specifies whether client authentication is enabled. If set to true then client authentication is required and the client must provide a certificate for the server trusts. |
clientAuthenticationSupported | boolean | false | Specifies whether a client authentication is supported. If set to true then the client authentication support means the server will check trust from a client if the client presents a certificate. |
securityLevel |
| HIGH | Specifies the cipher suite group used by the SSL handshake. HIGH are 3DES and 128 bit and higher ciphers, MEDIUM are DES and 40 bit ciphers, LOW are ciphers without encryption. If the enabledCiphers attribute is used the securityLevel list is ignored. HIGH Cipher suites 3DES and 128 bit and higher MEDIUM %repertoire.MEDIUM LOW %repertoire.LOW CUSTOM %repertoire.CUSTOM |
clientKeyAlias | string | Specifies the alias of the certificate in the keystore that is used as the key to send to a server that has client authentication enabled. This attribute is only needed if the keystore has more than one key entry. | |
serverKeyAlias | string | Specifies the alias of the certificate in the keystore used as the server's key. This attribute is only needed if the keystore has more then one key entry. | |
enabledCiphers | string | Specifies a custom list of ciphers. Separate each cipher in the list with a space. The supported cipher will depend on the underlying JRE used. Please check the JRE for valid ciphers. |
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
id | string | A unique configuration ID. | |
host | string | The server uses this SSL configuration when it accesses the specified host name. | |
port | int | The server uses this SSL configuration when it accesses the remote host name at the specified port. | |
clientCertificate | string | The client uses this certificate alias if you make a connection to a server that supports or requires client authentication. |