Concepts : Deployment : Server : Server Parameters
Server Parameters
Introduction
When a Universal Messaging Realm Server is started, there are a number of parameters used in its initial startup sequence.
If you start the realm server manually, e.g. from a shortcut or from the command line, these parameters are in the form of -D options specified in the nserver.conf configuration file. This file is located in the server/<realm>/bin directory of your installation, where <realm> is the name of the Universal Messaging realm. If you start the realm server as a Windows service or as a UNIX daemon, the parameters are taken from nserverdaemon.conf instead.
The -D options are specified in the configuration file in the following format:
wrapper.java.additional.<n>=-D<parameter>=<value>
where <parameter> is the name of the parameter whose value you wish to set, <value> is the value that you want to assign to the parameter, and <n> is any positive integer. If you have several -D options in the file, ensure that <n> values are unique. If you supply several -D options with the same <n> value, only the last of the specified options with this value of <n> will be effective and the earlier ones with this value of <n> will be ignored.
Example:
wrapper.java.additional.25=-DMaxFileSize=4000000000
wrapper.java.additional.26=-DLOGLEVEL=3
The Universal Messaging client API also supports several parameters that can be specified in the command line of any Universal Messaging Client application.
This section describes the parameters, what they are used for and their typical values.
Name
Required
Default
Description
ADAPTER
N
Specifies an interface to use, for example nsp://0.0.0.0:9000/
ADAPTER_x
N
Specifies an interface to use, for example nsp://0.0.0.0:9000/ where x = 0 -> 9
CAKEYSTORE
N
Shorthand for javax.net.ssl.trustStore
CAKEYSTOREPASSWD
N
Shorthand for javax.net.ssl.trustStorePassword
CHANNELUMASK
N
Specifies the default channel protection mask
CKEYSTORE
N
Shorthand for javax.net.ssl.keyStore
CKEYSTOREPASSWD
N
Shorthand for javax.net.ssl.keyStorePassword
DATADIR
Y
What directory to use to store files within
javax.net.ssl.debug
N
Useful to debug SSL issues, see www.javasoft.com for more information
javax.net.ssl.keyStore
N
Used to set the default KeyStore the server will use. If not supplied the client MUST set one when configuring an SSL interface
javax.net.ssl.keyStorePassword
N
Used to set the default password for the keystore. If not supplied the client must set one when configuring an SSL interface
javax.net.ssl.trustStore
N
Used to set the default trust store the server will use. If not supplied the client MUST set one when configuring an SSL interface
javax.net.ssl.trustStorePassword
N
Used to set the default Truststore password the server will use. If not supplied the client MUST set one when configuring an SSL interface
LOG_FRAMEWORK
N
Specifies a third part logging framework to use. Can be set to "LOGBACK" or "LOG4J2". The default is "fLogger".
LOGLEVEL
N
5
Specifies the current log level to use
LOGFILE
N
System.out
Used to specify a log file to write the log entries to
LOGSIZE
N
100000
Specified in bytes before the log file is rolled
MaintenanceFileSizeThreshold
Specifies the upper size limit of the file (for the store's associated store on disk) at which the store will perform maintenance operations (compaction on disk) to attempt to free up disk space.
MaintenanceMemorythreshold
Specifies the memory limit for a store, after which the store will attempt to free memory by clearing caches and performing any other maintenance operations.
MaxFileSize
N
1000000000 (1GB)
Specifies the maximum size (in bytes) of a channel/queue file on disk, before automatic maintenance is performed to re-order the file to remove purged events. The default is 1GB, although maintenance is usually performed well before this limit is reached.
MaxMemory
N
Uses the -Xms (minimum heap size) value
Specifies a target value for the maximum memory usage. As this value is approached, the realm server will attempt to free caches in order to release memory.
mode
N
If set to IPAQ forces a small memory mode for the server
QueuedSharedDurableFilterBound
Note: This parameter is deprecated and will be removed in a future release.

 
N

 
True
Specifies whether to bind a shared durable to the filter of its latest user. If this is set to true, then once the shared durable is bound to a filter, any subsequent subscriptions that mismatch the filter will replace it and an asynchronous exception will be thrown to existing subscribers.
REALM
Y
Specifies the name of the Realm Server
SECURITYFILE
N
Used to specify the Super Users for this realm. Format is user@host (one per line). Note that this is only a bootstrap method on startup of a realm. If you had previously started the realm before specifying a SECURITYFILE, you will need to remove the files realms.nst and realms.nst _old from the RealmSpecific directory, then restart the realm with the -DSECURITYFILE setting in the nserver.conf or nserverdaemon.conf file for the super user entries in the file to be added to the realm ACL.
Copyright © 2013-2017 Software AG, Darmstadt, Germany. (Innovation Release)
Product LogoContact Support   |   Community   |   Feedback