mongo - Mongo (mongo)

Configuration for a Mongo instance.

NameTypeDefaultDescription
idstringA unique configuration ID.
libraryRefA reference to top level library element (string).Specifies a library that contains the MongoDB Java Driver.
onError
  • IGNORE
  • WARN
  • FAIL
WARNDetermines 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.
passwordReversably encoded password (string)Password for database user.
userstringDatabase user name.
useCertificateAuthenticationbooleanUse provided certificate from key store to authenticate user to MongoDB.
autoConnectRetrybooleanRetry connections to a server, for an interval up to the maxAutoConnectRetryTime, if the socket cannot be opened.
connectionsPerHostint
Min: 0
Limits the number of open connections to each host. Connections are pooled when not in use.
connectTimeoutA period of time with millisecond precisionConnection 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.
cursorFinalizerEnabledbooleanAttempts to clean up DBCursors that are not closed.
descriptionstringDescription of a Mongo instance.
maxAutoConnectRetryTimeA period of time with millisecond precisionInterval 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.
maxWaitTimeA period of time with millisecond precisionMaximum 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.
socketKeepAlivebooleanConfigures whether or not to keep sockets alive.
socketTimeoutA period of time with millisecond precisionThe 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.
sslEnabledbooleanConfigures whether or not to enable SSL.
sslRefA reference to top level ssl element (string).ID of the SSL configuration to be used to connect to the SSL-enabled server.
threadsAllowedToBlockForConnectionMultiplierint
Min: 0
This value, multiplied by connectionsPerHost, establishes an upper limit on threads that are allowed to wait for an available connection.
readPreference
  • secondary
  • primaryPreferred
  • nearest
  • secondaryPreferred
  • primary
Configures the read preference.
secondary
secondary
primaryPreferred
primaryPreferred
nearest
nearest
secondaryPreferred
secondaryPreferred
primary
primary
writeConcern
  • ERRORS_IGNORED
  • MAJORITY
  • FSYNCED
  • FSYNC_SAFE
  • ACKNOWLEDGED
  • JOURNAL_SAFE
  • REPLICA_ACKNOWLEDGED
  • SAFE
  • UNACKNOWLEDGED
  • JOURNALED
  • REPLICAS_SAFE
  • NONE
  • NORMAL
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

hostNames

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.

library

Specifies a library that contains the MongoDB Java Driver.

NameTypeDefaultDescription
namestringName of shared library for administrators
descriptionstringDescription of shared library for administrators
filesetRefList of references to top level fileset elements (comma-separated string).Id of referenced Fileset
apiTypeVisibilitystringspec,ibm-api,api,stableThe 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.

library > fileset

Id of referenced Fileset

NameTypeDefaultDescription
idstringA unique configuration ID.
dirPath to a directory${server.config.dir}The base directory to search for files.
caseSensitivebooleantrueBoolean to indicate whether or not the search should be case sensitive (default: true).
includesstring*The comma or space separated list of file name patterns to include in the search results (default: *).
excludesstringThe comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded.
scanIntervalA period of time with millisecond precision0Scanning 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.

library > folder

Id of referenced folder

NameTypeDefaultDescription
idstringA unique configuration ID.
dirPath to a directoryDirectory or folder to be included in the library classpath for locating resource files

library > file

Id of referenced File

NameTypeDefaultDescription
idstringA unique configuration ID.
namePath to a fileFully qualified filename

ports

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.

ssl

ID of the SSL configuration to be used to connect to the SSL-enabled server.

NameTypeDefaultDescription
keyStoreRefA reference to top level keyStore element (string).A keystore containing key entries for the SSL repertoire. This attribute is required.
trustStoreRefA 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.
sslProtocolstringThe 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.
clientAuthenticationbooleanfalseSpecifies 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.
clientAuthenticationSupportedbooleanfalseSpecifies 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
  • MEDIUM
  • LOW
  • CUSTOM
HIGHSpecifies 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
clientKeyAliasstringSpecifies 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.
serverKeyAliasstringSpecifies 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.
enabledCiphersstringSpecifies 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.

ssl > outboundConnection

A unique configuration ID.

NameTypeDefaultDescription
idstringA unique configuration ID.
hoststringThe server uses this SSL configuration when it accesses the specified host name.
portintThe server uses this SSL configuration when it accesses the remote host name at the specified port.
clientCertificatestringThe client uses this certificate alias if you make a connection to a server that supports or requires client authentication.