mailbox.properties file

Individual Mailbox nodes (Sterling B2B Integrator clients and Global Mailbox Admin servers) have a mailbox.properties file on the local file system which defines Global Mailbox properties that apply to that particular node only. The Mailbox configuration properties are the combination of three different property files: the global system properties (global.properties), the local data center properties (datacenter.properties), and the local node properties (mailbox.properties).

Usage

The properties defined in mailbox.properties apply to a specific node. Because individual nodes do not need to access the properties of other nodes in the data center, the mailbox.properties file is not required to be in the shared configuration directory. Properties defined in mailbox.properties override the same properties defined in the datacenter.properties file, as well as in the global.properties file.

Only a single Cassandra cluster and ZooKeeper deployment is valid. All Global Mailbox operations that are performed by a Sterling B2B Integrator instance operate against the same Cassandra and ZooKeeper infrastructure, regardless of the Global Mailbox Client adapter instance.

Each Sterling B2B Integrator instance must be pointed to the same Cassandra cluster and ZooKeeper deployment to share access to mailboxes and messages.

Edit the properties file with a text editor.

File location

install_dir/*/mailbox.properties

Environment

Linux® and Windows

Authorization

Only users with administrative permissions can edit the mailbox.properties file.

Syntax

parmname=value

Option descriptions

com.ibm.mailbox.messaging.application.queues: Application queue names for each data center in the format: "{ "dc1_id" : "queue_for_dc1", "dc2_id" : "queue_for_dc2" }"

com.ibm.mailbox.controlcenter.event.path: Directory where events are persisted until they can be posted to the event repository in the format /example/directory/path.

com.ibm.mailbox.config.root.path: The directory path for the configuration files, global.properties and datacenter.properties. This is set during installation. There is no default value.

com.ibm.mailbox.database.cassandra.host.<n>: The IP address or host name of each additional Cassandra server that is configured in the cluster. Each Cassandra node in the cluster is represented by a unique integer value, <n>, for example, 2. Default is (none).

com.ibm.mailbox.database.cassandra.host.1: The host name or IP address of first Cassandra server. Default value is the localhost.

com.ibm.mailbox.database.cassandra.jmx.port: JMX port number for Cassandra. Default JMX port is 7199.

com.ibm.mailbox.database.cassandra.native.transport.port: Native port number for Cassandra. Default Native port is 9042.

com.ibm.mailbox.database.cassandra.rpc.port: RPC port number for Cassandra. Default RPC port is 9160.

com.ibm.mailbox.database.cassandra.ssl.client.alias: Alias for the SSL client. There is no default value.

com.ibm.mailbox.database.cassandra.ssl.ciphers: The list of cipher suites to use to communicate with servers when SSL is enabled. Default value is TLS_RSA_WITH_AES_128_CBC_SHA.
Restriction: Must be set by running the dbConfigUtility setSSL command.

com.ibm.mailbox.database.cassandra.ssl.enabled: Whether to secure client-to-node communications with SSL. Default value is false.
Restriction: Must be set by running the dbConfigUtility setSSL command.

com.ibm.mailbox.database.cassandra.ssl.keystore.file: The fully-qualified path of the keystore file containing the key-certificate used by the client to communicate with servers when SSL is enabled and client authentication is enabled on the server. Default value is (none).
Restriction: Must be set by running the dbConfigUtility setSSL command.

com.ibm.mailbox.database.cassandra.ssl.keystore.password: The password of the keystore file. Default value is (none).
Restriction: Must be set by running the dbConfigUtility setSSL command.

com.ibm.mailbox.database.cassandra.ssl.keystore.type: The type (for example: PKCS12, JKS) of the keystore file. Default value is (none).
Restriction: Must be set by running the dbConfigUtility setSSL command.

com.ibm.mailbox.database.cassandra.ssl.protocol: The security protocol to use to communicate with servers when SSL is enabled. Default value is TLS.
Restriction: Must be set by running the dbConfigUtility setSSL command.

com.ibm.mailbox.database.cassandra.ssl.trust.any: Whether the client can trust any certificate presented by the server. Default value is true.
Restriction: Must be set by running the dbConfigUtility setSSL command.

com.ibm.mailbox.database.cassandra.ssl.truststore.file: The fully-qualified path of the trust store file containing the list of server certificates that the client will trust when trust any is disabled. Default value is (none).
Restriction: Must be set by running the dbConfigUtility setSSL command.

com.ibm.mailbox.database.cassandra.ssl.truststore.password: The password of the trust store file. Default value is (none).
Restriction: Must be set by running the dbConfigUtility setSSL command.

com.ibm.mailbox.database.cassandra.ssl.truststore.type: The type (for example: PKCS12, JKS) of the trust store file. Default value is (none).
Restriction: Must be set by running the dbConfigUtility setSSL command.

com.ibm.mailbox.database.zookeeper.conn.<n>: More zookeeper contact points. N=2,3,4, an so on. Default value is none.

com.ibm.mailbox.database.zookeeper.conn.1: ZooKeeper contact point consisting of host:port. Default value is (none).
Tip: This is slightly different than the Cassandra property.

com.ibm.mailbox.database.zookeeper.connection.timeout: ZooKeeper connection timeout indicated in seconds. Default value is 15 seconds.

com.ibm.mailbox.database.zookeeper.session.timeout: ZooKeeper session timeout indicated in seconds. Default value is 60 seconds.

com.ibm.mailbox.replication.barrier.maxwaittime: The maximum time in milliseconds to wait for an immediate (synchronous) replication request to complete. Default value is 1800 milliseconds.

com.ibm.mailbox.replication.encrypt: Defines the encryption status for the connection between replication servers. Valid values are true and false. The default value is true.

com.ibm.mailbox.replication.hang.threshold: If a replication request remains in IN_PROGRESS state for the specified time (in seconds), the request is considered hung, and moved to PENDING status. Requests in PENDING status are retried, when the replication polling agent runs again. If a replication request failed because the replication server became non-functional in the middle of a transfer, the incomplete file is overwritten when the next replication request starts. Valid range for hang threshold is 1 - 9999 seconds.

com.ibm.mailbox.replication.impl: Custom exit point implementation for IReplicationConfiguration interface. Default value is null.

com.ibm.mailbox.replication.monitor.interval: Time in seconds that the system checks for hung replication requests. Default value is 60 seconds.

com.ibm.mailbox.replication.polling.interval: Time in seconds that the system checks for pending replication requests. Default value is 1 second.

com.ibm.mailbox.replication.polling.threads: The number of threads that run the replication polling task. Default value is 4 threads.

com.ibm.mailbox.replication.queue.depth: The maximum number of replication requests that can be queued for a single replication server connection. The value of this property multiplied by the value of the com.ibm.mailbox.replication.server.max.sessions property is the number of PENDING replication request records that is read from the database each time the replication polling task is run. Default value is 10 replication requests.

com.ibm.mailbox.replication.segment.size: The minimum MB size limit which is used to segment a payload for faster replication. Default value is 100 MB.

com.ibm.mailbox.replication.server.max.consecutive.failures: The number of times the polling agent tries to reach a replication server. If consecutive attempts to reach the replication server fails, the server is marked offline. Valid range for maximum consecutive failures is 1 - 99999.

com.ibm.mailbox.replication.server.max.sessions: The maximum number of sessions on a replication server. Default value is 10 sessions.

com.ibm.mailbox.replication.server.offline.time: The time (in minutes) for which a replication server is marked offline after consecutive connection failures. Valid range for server offline time is 1 - 99999 minutes.

com.ibm.mailbox.replication.type

The type of replication. Valid values are:

asynchronous - delayed (default)
synchronous - immediate

com.ibm.mailbox.storage.async.thread.max: The maximum number of threads to be used for asynchronous requests in storage. Default value is 10 threads.

com.ibm.mailbox.event.scan.query.buckets: Number of buckets to scan for unprocessed events for resending. Default value is 60 (one hour worth of events, which at a load of 100 events/sec writes 360,000 events in a bucket). Increasing this value might cause time outs or excessive tombstones to accumulate.

Example

The following code is the mailbox.properties file with example values for the properties that are defined only in mailbox.properties.

com.ibm.mailbox.config.root.path=/GMShare/config
com.ibm.mailbox.database.cassandra.ssl.clent.alias=ALIAS
com.ibm.mailbox.database.cassandra.ssl.keystore=keystorename
com.ibm.mailbox.database.cassandra.ssl.keystore.password=password
com.ibm.mailbox.database.cassandra.ssl.keystore.type=jks