ServerProperties (IBM WebSphere eXtreme Scale API Specification)

Overview

Package

Class

Tree

Serialized

Deprecated

Index

Help

IBM WebSphere^TM eXtreme Scale, Release 8.6
API Specification

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ibm.websphere.objectgrid.server
Interface ServerProperties

public interface ServerProperties

The set of properties used to define the behavior of the ObjectGrid server runtime.

Since:: WAS XD 6.1 FIX3

Field Summary
`static String`	`DEFAULT_ZONE` The name of the zone that all containers that do not specify a zone are in.
`static String`	`PROP_CATALOG_SERVICE_ENDPOINTS` Sets the end points to connect to the catalog service grid.
`static String`	`PROP_DISK_OVERFLOW_CAP_BYTES` Defines maximum number of bytes that can be used by this JVM for overflowing content to disk.
`static String`	`PROP_DISK_OVERFLOW_ENABLED` Defines whether the capability of overflowing data from main-memory to disk is enabled.
`static String`	`PROP_DISK_OVERFLOW_MIN_DISK_SPACE_BYTES` Defines minimum number of bytes that must remain free on disk in the partition named by PROP_DISK_STORAGE_PATH.
`static String`	`PROP_DISK_STORAGE_PATH` Defines the root directory to use when disk overflow is enabled.
`static String`	`PROP_ENABLE_CHANNEL_FRAMEWORK` Sets the TransportMode on the IBM ORB properties to ChannelFramework
`static String`	`PROP_ENABLE_EXTREMEMEMORY` Enables the eXtremeMemory memory storage mode for the server.
`static String`	`PROP_ENABLE_MBEANS` Determines whether or not the ObjectGrid will register MBeans in this process.
`static String`	`PROP_HAMANAGERPORT` Defines the port number the High Availability Manager will use.
`static String`	`PROP_HPEL_BUFFERING_ENABLED` Indicates if the HPEL feature is to enable buffering.
`static String`	`PROP_HPEL_ENABLED` Indicates if the HPEL feature is to be enable or not: true for enabled false for disabled.
`static String`	`PROP_HPEL_FILE_SWITCH_ENABLED` Indicates if the HPEL feature is to enable file switch.
`static String`	`PROP_HPEL_FILE_SWITCH_HOUR` Indicates the file switch hour (int value).
`static String`	`PROP_HPEL_INCLUDE_TRACE` Indicates if the HPEL text files are to include tracing.
`static String`	`PROP_HPEL_MAX_REPOSITORY_SIZE` Indicates the Maximum size of files generate in megabytes (long value).
`static String`	`PROP_HPEL_MAX_RETENTION_TIME` Indicates the maximum retention time to hold files (long value).
`static String`	`PROP_HPEL_OUT_OF_SPACE_ACTION` Indicates the action to be performed when the disk space has been exceeded (String value)
`static String`	`PROP_HPEL_OUTPUT_FORMAT` Indicates the format of the log files to be generated (String value).
`static String`	`PROP_HPEL_PURGE_BY_SIZE_ENABLED` Indicates if the HPEL feature is to purge log files by size.
`static String`	`PROP_HPEL_PURGE_BY_TIME_ENABLED` Indicates if the HPEL feature is to purge log files by time.
`static String`	`PROP_HPEL_REPOSITORY_PATH` Indicates the file repository path (int value).
`static String`	`PROP_JMX_CONNECTOR_PORT` The property that defines which SSL port the JMX service will bind to
`static String`	`PROP_JMX_SERVICE_PORT` The property that defines which port the JMX service will bind to
`static String`	`PROP_JVM_STATS_ENABLED` When set to true, enables log data for the JVM to be written to a CSV file.
`static String`	`PROP_JVM_STATS_FILE_NAME` Specifies the file name of the CSV statistics file for the JVM.
`static String`	`PROP_JVM_STATS_WRITE_RATE` Specifies the write rate of the CSV statistics files for the JVM in seconds.
`static String`	`PROP_LISTENER_HOST` Sets the host name that the ORB should bind to.
`static String`	`PROP_LISTENER_PORT` Sets the port that the ORB should bind to.
`static String`	`PROP_LOG_NOTIFICATION_FILTER` The log record filtering regular expression that the ObjectGrid server should initially use.
`static String`	`PROP_MAP_STATS_ENABLED` When set to true, enables log data for the Map to be written to a CSV file.
`static String`	`PROP_MAP_STATS_FILE_NAME` Specifies the file name of the CSV statistics file for the Map Stats.
`static String`	`PROP_MAP_STATS_WRITE_RATE` Specifies the write rate of the CSV statistics files for the Map Stats in seconds.
`static String`	`PROP_MAX_JVM_STATS_FILE_SIZE` Indicates the maximum file size, in megabytes, of the CSV statistics files for the JVM.
`static String`	`PROP_MAX_JVM_STATS_FILES` Indicates the maximum number of CSV statistics files that are generated for the JVM Stats.
`static String`	`PROP_MAX_MAP_STATS_FILE_SIZE` Indicates the maximum file size, in megabytes, of the CSV statistics files for the Map Stats.
`static String`	`PROP_MAX_MAP_STATS_FILES` Indicates the maximum number of CSV statistics files that are generated for the Map Stats.
`static String`	`PROP_MAX_OG_STATS_FILE_SIZE` Indicates the maximum file size, in megabytes, of the CSV statistics files for the Object Grid Stats.
`static String`	`PROP_MAX_OG_STATS_FILES` Indicates the maximum number of CSV statistics files that are generated for the Object Grid Stats.
`static String`	`PROP_MAXIMUM_EXTREMEMEMORY_SIZE` Sets the maximum amount of eXtremeMemory (in megabytes) to allocate when eXtremeMemory is enabled.
`static String`	`PROP_MAXIMUM_THREAD_POOL_SIZE` Sets the minimum thread pool size used by the server and client runtimes in this process
`static String`	`PROP_MAXIMUM_XIO_NETWORK_THREAD_POOL_SIZE` Sets the maximum number of threads to allocate in the eXtremeIO transport network thread pool.
`static String`	`PROP_MAXIMUM_XIO_WORKER_THREAD_POOL_SIZE` Sets the maximum number of threads to allocate in the eXtremeIO transport request processing thread pool.
`static String`	`PROP_MEMORY_USAGE_THRESHOLD` Sets the memory threshold (percentage of max heap) for memory based eviciton
`static String`	`PROP_MINIMUM_THREAD_POOL_SIZE` Sets the minimum thread pool size used by the server and client runtimes in this process
`static String`	`PROP_MINIMUM_XIO_NETWORK_THREAD_POOL_SIZE` Sets the minimum number of threads to allocate in the eXtremeIO transport network thread pool.
`static String`	`PROP_MINIMUM_XIO_WORKER_THREAD_POOL_SIZE` Sets the minimum number of threads to allocate in the eXtremeIO transport request processing thread pool.
`static String`	`PROP_OG_STATS_ENABLED` When set to true, enables log data for the Map to be written to a CSV file.
`static String`	`PROP_OG_STATS_FILE_NAME` Specifies the file name of the CSV statistics file for the Object Grid Stats.
`static String`	`PROP_OG_STATS_WRITE_RATE` Specifies the write rate of the CSV statistics files for the Object Grid Stats in seconds.
`static String`	`PROP_SERVER_NAME` Defines the name the server should use to identify itself.
`static String`	`PROP_STATS_SPEC` The statistics specification that the ObjectGrid should use for metric gathering.
`static String`	`PROP_SYSLOG_ENABLED` Indicates whether to enable the transmission (over UDP) of log messages to a remote syslogd server.
`static String`	`PROP_SYSLOG_FACILITY` Indicates the syslog facility with which to send out syslog messages
`static String`	`PROP_SYSLOG_HOST_NAME` Indicates the receiving syslogd server fully-qualified domain name or IP address.
`static String`	`PROP_SYSLOG_HOST_PORT` Indicates the syslogd server port number on which to receive syslog messages.
`static String`	`PROP_SYSLOG_THRESHOLD` Indicates the log level threshold of messages to trasmit to the configured syslogd server Possible values: {warning, error}
`static String`	`PROP_SYSTEM_STREAM_TO_FILE_ENABLED` Defines whether SystemOut and SystemErr should be sent to file or not.
`static String`	`PROP_TRACE_FILE` The name of the file that trace output should be sent to.
`static String`	`PROP_TRACE_SPEC` The trace specification that the ObjectGrid server should use initially.
`static String`	`PROP_WAS_MANAGED_CONTAINER_SHUTDOWN_ENABLED` Used by users of the embedded server API in WebSphere Application Server, when they want to stop the eXtreme Scale containers manually using the ContainerMBean.terminate() API.
`static String`	`PROP_WORKING_DIRECTORY` The property that defines which directory the ObjectGrid server should use for all default settings.
`static String`	`PROP_XIO_TIMEOUT` Sets the timeout for server requests using the XIO transport.
`static String`	`PROP_XIO_WAITING_MESSAGE_QUEUE_LIMIT` Deprecated. 8.6.0
`static String`	`PROP_XIOCHANNEL_PREFIX` The property prefix to use for all eXtremeIO transport channel properties.
`static String`	`PROP_XIOCHANNELNAME_CONTAINER_TCP_NON_SECURE` Deprecated. 8.6
`static String`	`PROP_XIOCHANNELNAME_CONTAINER_TCP_SECURE` Deprecated. 8.6
`static String`	`PROP_XIOCHANNELNAME_TCP` The eXtremeIO transport channel name for TCP/IP communication.
`static String`	`PROP_XIOCHANNELPROP_PORT` The eXtremeIO channel property to identify the port.
`static String`	`PROP_ZONE_NAME` Defines the name of the zone this server belongs to.
`static int`	`REPLICATION_IDLE_LEVEL_NONE` Constant representing a replication idle level that is turned off.
`static int`	`REPLICATION_IDLE_LEVEL_RELAXED` Constant representing a replication idle level at a relaxed rate.
`static int`	`REPLICATION_IDLE_LEVEL_SHORT` Constant representing a replication idle level at a short sleep.

Method Summary
`String`	`getCatalogServiceBootstrap()` Retrieves the catalog service corbaloc string.
`long`	`getDiskOverflowCapBytes()` Returns the maximum number of bytes that can be used by this JVM when overflowing bytes to disk.
`long`	`getDiskOverflowMinDiskSpaceBytes()` Returns the minimum number of bytes that must remain free on disk when overflowing bytes to disk.
`String`	`getDiskStoragePath()` Returns the root directory used for disk overflow.
`int`	`getHAManagerPort()` Retrieve the High Availability Manager (HA Manager) port.
`int`	`getHPELFileSwitchHour()` Indicates the HPEL File Switch Hour
`long`	`getHPELMaxRepositorySize()` Indicates the HPEL Maximum Repository Size
`long`	`getHPELMaxRetentionTime()` Indicates the HPEL Maximum Retention Time
`String`	`getHPELOutOfSpaceAction()` Indicates the HPEL Out Of Space Action
`String`	`getHPELOutputFormat()` Indicates the HPEL Output Format
`String`	`getHPELRepositoryPath()` Indicates the HPEL Repository Path
`int`	`getJMXConnectorPort()` Retrieves the JMX connector port that the JMX service is to bind to.
`int`	`getJMXServicePort()` Retrieves the port to be used by the JMX connection.
`String`	`getJvmStatsFileName()` Gets JVM Stats file name
`int`	`getJvmStatsWriteRate()` Gets the write rate of the CSV statistics files for the JVM in seconds.
`String`	`getListenerHost()` Retrieves the host to be used by the ORB.
`int`	`getListenerPort()` Retrieves the inbound port used by the dominant transport.
`String`	`getLogNotificationFilter()` Retrieves the regular expression filter to be applied to log records messages that are forwarded as JMX notifications by the ObjectGrid server through the LoggerListenerJMXNotifier
`String`	`getMapStatsFileName()` Gets the file name of the CSV statistics file for the Map.
`int`	`getMapStatsWriteRate()` Gets the write rate of the CSV statistics files for the Map in seconds.
`int`	`getMaximumJVMStatsFiles()` Indicates the maximum number of CSV statistics files that are generated for the JVM Stats.
`int`	`getMaximumJVMStatsFileSize()` Gets the maximum file size, in megabytes, of the CSV statistics files for the JVM.
`int`	`getMaximumMapStatsFiles()` Indicates the maximum number of CSV statistics files that are generated for the Map Stats.
`int`	`getMaximumMapStatsFileSize()` Gets the maximum file size, in megabytes, of the CSV statistics files for the Map.
`int`	`getMaximumOGStatsFiles()` Indicates the maximum number of CSV statistics files that are generated for the ObjectGrid Stats.
`int`	`getMaximumOGStatsFileSize()` Gets the maximum file size, in megabytes, of the CSV statistics files for the ObjectGrid.
`int`	`getMaximumThreadPoolSize()` Retrieve the maximum number of pooled threads.
`int`	`getMaximumXIONetworkThreads()` Gets the maximum number of threads to allocate in the eXtremeIO transport network thread pool.
`int`	`getMaximumXIOWaitingMessages()` Gets the maximum number of messages waiting to be processed.
`int`	`getMaximumXIOWorkerThreads()` Sets the maximum number of threads to allocate in the eXtremeIO transport request processing thread pool.
`int`	`getMaximumXMSize()` Retrieves the maximum amount of eXtremeMemory (in megabytes) to allocate when eXtremeMemory is enabled.
`int`	`getMemoryThresholdPercentage()` Gets the memory threshold usage percentage, -1 indicates that it was not set.
`int`	`getMinimumThreadPoolSize()` Retrieve the minimum number of pooled threads.
`int`	`getMinimumXIONetworkThreads()` Gets the minimum number of threads to allocate in the eXtremeIO transport network thread pool.
`int`	`getMinimumXIOWorkerThreads()` Retrieves the minimum number of threads to allocate in the eXtremeIO transport request processing thread pool.
`String`	`getOGStatsFileName()` Gets the file name of the CSV statistics file for the ObjectGrid.
`int`	`getOGStatsWriteRate()` Gets the write rate of the CSV statistics files for the ObjectGrid in seconds.
`String`	`getServerName()` Retrieves the name used in identifying this server.
`String`	`getStatsSpecification()` Retrieves the statistics specification that this process should start with.
`String`	`getSyslogFacility()` Indicates the Syslogd Facility
`String`	`getSyslogHostName()` Indicates the Syslogd Server host full name or IP address
`int`	`getSyslogHostPort()` Indicates the Syslogd Server Port Number
`String`	`getSyslogThreshold()` Indicates the Syslogd Threshold.
`String`	`getTraceFileName()` Retrieves a reference to the file name the server will use for trace.
`String`	`getTraceSpecification()` Retrieves the initial trace specification the server should use.
`String`	`getWorkingDirectory()` Retrieves the working directory for the ObjectGrid server runtime.
`Map<String,Properties>`	`getXIOChannelProps()` Returns a copy of the map of overriding properties for all channels.
`int`	`getXIOTimeout()` Returns the current timeout for server requests using the XIO transport.
`String`	`getZoneName()` Retrieve the zone name.
`boolean`	`isChannelFrameworkEnabled()` Returns if the ChannelFramework setting was enabled for the TransportMode on the IBM ORB properties
`boolean`	`isDiskOverflowEnabled()` Returns true if and only if the disk-overflow feature is enabled, false otherwise.
`boolean`	`isEnableXM()` Answers true if eXtremeMemory is enabled.
`boolean`	`isHPELBufferingEnabled()` Indicates if the HPEL file switch feature is to be enable or not: true for enabled false for disabled.
`boolean`	`isHPELEnabled()` Indicates if the HPEL feature is to be enable or not: true for enabled false for disabled.
`boolean`	`isHPELFileSwitchEnabled()` Indicates if the HPEL file switch feature is to be enable or not: true for enabled false for disabled.
`boolean`	`isHPELIncludeTrace()` Indicates if the HPEL include trace feature is to be enable or not: true for enabled false for disabled.
`boolean`	`isHPELPurgeBySizeEnabled()` Indicates if the HPEL feature purge by size feature enable or not: true for enabled false for disabled.
`boolean`	`isHPELPurgeByTimeEnabled()` Indicates if the HPEL feature purge by size is to be enable or not: true for enabled false for disabled.
`boolean`	`isJvmStatsLoggingEnabled()` Gets whether of not log data for the JVM will to be written to a CSV file.
`boolean`	`isMapStatsLoggingEnabled()` Gets whether of not log data for the Map will to be written to a CSV file.
`boolean`	`isMBeanEnabled()` Retrieves whether or not the MBeans are going to be registered.
`boolean`	`isOGStatsLoggingEnabled()` Gets whether of not log data for the ObjectGrid will to be written to a CSV file.
`boolean`	`isServer()` Answers whether or not this process is configured to be an ObjectGrid server process.
`boolean`	`isSyslogEnabled()` Indicates if the Syslogd feature is to be enable or not: true for enabled false for disabled.
`boolean`	`isSystemStreamToFileEnabled()` Retrieves the stream to file setting.
`boolean`	`isWASManagedContainerShutdownEnabled()` Answers true if WebSphere Application Server automatically stops the eXtreme Scale container when the hosting application server is stopped and the container was started using the eXtreme Scale Server.createContainer(com.ibm.websphere.objectgrid.deployment.DeploymentPolicy) API.
`void`	`load(InputStream input)` Loads the properties from `input` into this property object.
`void`	`setCatalogServiceBootstrap(String catalogServiceAddress)` Sets the catalog service grid addresses in the form [host:port,host:port,...].
`void`	`setChannelFramework(boolean enableChannelFramework)` Sets the TransportMode on the IBM ORB properties to ChannelFramework
`void`	`setDiskOverflowCapBytes(long bytes)` Sets the maximum number of bytes that can be used by this JVM for overflowing bytes to disk.
`void`	`setDiskOverflowEnabled(boolean diskOverflowEnabled)` Sets the disk-overflow enablement feature.
`void`	`setDiskOverflowMinDiskSpaceBytes(long bytes)` Sets the minimum number of bytes that must remain free on disk (in the partition named by diskStoragePath) when overflowing bytes to disk: a request to store data on disk will not be granted if the request will cause this constraint to be violated.
`void`	`setDiskStoragePath(String diskStoragePath)` Sets the root directory to use for disk overflow.
`void`	`setEnableXM(boolean enableXM)` Enables the eXtremeMemory memory storage mode for the server.
`void`	`setHAManagerPort(int port)` Sets the port number for the High Availability Manager (HA Manager).
`void`	`setHPELBufferingEnabled(boolean hpelBufferingEnabled)` When set to true, enables HPEL buffering.
`void`	`setHPELEnabled(boolean hpelEnabled)` When set to true, enables HPEL logging.
`void`	`setHPELFileSwitchEnabled(boolean hpelFileSwitchEnabled)` When set to true, enables HPEL file switch.
`void`	`setHPELFileSwitchHour(int hpelFileSwitchHour)` Specifies the HPEL File Switch Hour
`void`	`setHPELIncludeTrace(boolean hpelIncludeTrace)` When set to true, enables HPEL include trace.
`void`	`setHPELMaxRepositorySize(long hpelMaxRepositorySize)` Specifies the HPEL Maximum Repository Size
`void`	`setHPELMaxRetentionTime(long hpelMaxRetentionTime)` Specifies the HPEL Maximum Retention Time
`void`	`setHPELOutOfSpaceAction(String hpelOutOfSpaceAction)` Specifies the HPEL Out Of SpaceAction
`void`	`setHPELOutputFormat(String hpelOutputFormat)` Specifies the HPEL Output Format
`void`	`setHPELPurgeBySizeEnabled(boolean hpelPurgeBySizeEnabled)` When set to true, enables HPEL purge by size.
`void`	`setHPELPurgeByTimeEnabled(boolean hpelPurgeByTimeEnabled)` When set to true, enables HPEL purge by time.
`void`	`setHPELRepositoryPath(String hpelRepositoryPath)` Specifies the HPEL Repository Path
`void`	`setJMXConnectorPort(int jmxConnectorPort)` Assigns the JMX connector port that the JMX service is to bind to.
`void`	`setJMXServicePort(int jmxServicePort)` Assigns the port that the JMX service is to bind to.
`void`	`setJvmStatsFileName(String jvmStatsFileName)` Specifies the file name of the CSV statistics file for the JVM.
`void`	`setJvmStatsLoggingEnabled(boolean jvmStatsLoggingEnabled)` When set to true, enables log data for the JVM to be written to a CSV file.
`void`	`setJvmStatsWriteRate(int jvmStatsWriteRate)` Sets the write rate of the CSV statistics files for the JVM in seconds.
`void`	`setListenerHost(String listenerHost)` Assigns the host that the ORB is to bind to.
`void`	`setListenerPort(int listenerPort)` Assigns the port that the ORB is to bind to.
`void`	`setLogNotificationFilter(String regExFilter)` Sets the regular expression filter to be applied to log records messages that are forwarded as JMX notifications by the ObjectGrid server through the LoggerListenerJMXNotifier
`void`	`setMapStatsFileName(String mapStatsFileName)` Specifies the file name of the CSV statistics file for the Map.
`void`	`setMapStatsLoggingEnabled(boolean mapStatsLoggingEnabled)` When set to true, enables log data for the Map to be written to a CSV file.
`void`	`setMapStatsWriteRate(int mapStatsWriteRate)` Sets the write rate of the CSV statistics files for the Map in seconds.
`void`	`setMaximumJVMStatsFiles(int maximumJVMStatsFiles)` Sets the maximum number of CSV statistics files that are generated for the JVM Stats.
`void`	`setMaximumJVMStatsFileSize(int maximumJVMStatsFileSize)` Sets the maximum file size, in megabytes, of the CSV statistics files for the JVM.
`void`	`setMaximumMapStatsFiles(int maximumMapStatsFiles)` Sets the maximum number of CSV statistics files that are generated for the Map Stats.
`void`	`setMaximumMapStatsFileSize(int maximumMapStatsFileSize)` Sets the maximum file size, in megabytes, of the CSV statistics files for the Map.
`void`	`setMaximumOGStatsFiles(int maximumOGStatsFiles)` Sets the maximum number of CSV statistics files that are generated for the ObjectGrid Stats.
`void`	`setMaximumOGStatsFileSize(int maximumOGStatsFileSize)` Sets the maximum file size, in megabytes, of the CSV statistics files for the ObjectGrid.
`void`	`setMaximumThreadPoolSize(int maxNumThreads)` Sets the maximum number of threads in the pool.
`void`	`setMaximumXIONetworkThreads(int maxThreads)` Sets the maximum number of threads to allocate in the eXtremeIO transport network thread pool.
`void`	`setMaximumXIOWaitingMessages(int maxMessages)` Sets the maximum number of messages waiting to be processed.
`void`	`setMaximumXIOWorkerThreads(int maxThreads)` Retrieves the maximum number of threads to allocate in the eXtremeIO transport request processing thread pool.
`void`	`setMaximumXMSize(int sizeInMegabytes)` Sets the maximum amount of eXtremeMemory (in megabytes) to allocate when eXtremeMemory is enabled.
`void`	`setMBeansEnabled(boolean enableMBeans)` Enables or disables ObjectGrid MBean registration for this process.
`void`	`setMemoryThresholdPercentage(int threshold)` Sets the memory threshold usage percentage, (set up to 100% ).
`void`	`setMinimumThreadPoolSize(int minNumThreads)` Sets the minimum number of threads in the pool.
`void`	`setMinimumXIONetworkThreads(int minThreads)` Sets the minimum number of threads to allocate in the eXtremeIO transport network thread pool.
`void`	`setMinimumXIOWorkerThreads(int minThreads)` Sets the minimum number of threads to allocate in the eXtremeIO transport request processing thread pool.
`void`	`setOGStatsFileName(String ogStatsFileName)` Specifies the file name of the CSV statistics file for the ObjectGrid.
`void`	`setOGStatsLoggingEnabled(boolean ogStatsLoggingEnabled)` When set to true, enables log data for the ObjectGrid to be written to a CSV file.
`void`	`setOGStatsWriteRate(int ogStatsWriteRate)` Sets the write rate of the CSV statistics files for the ObjectGrid in seconds.
`void`	`setServerName(String serverName)` Sets the name used to identify this process.
`void`	`setStatsSpecification(String statsSpecification)` Sets the initial statistics specification that the ObjectGrid server should start with.
`void`	`setSyslogEnabled(boolean syslogEnabled)` When set to true, enables Syslog logging.
`void`	`setSyslogFacility(String syslogFacility)` Specifies the Syslogd Facility
`void`	`setSyslogHostName(String syslogHostName)` Specifies the Syslogd Server host full name or IP address
`void`	`setSyslogHostPort(int syslogHostPort)` Specifies the Syslogd Server host port number
`void`	`setSyslogThreshold(String syslogThreshold)` Specifies the Syslogd Threshold
`void`	`setSystemStreamsToFileEnabled(boolean streamsToFile)` Sets the trace logic to write SystemOut and SystemErr to file, or not write to file.
`void`	`setTraceFileName(String traceFileName)` Assigns the file to use for logging trace.
`void`	`setTraceSpecification(String traceSpecification)` Assigns the specification that the server should use on initialization.
`void`	`setWASManagedContainerShutdownEnabled(boolean enabled)` Set to true if the WebSphere Application Server should automatically stop the eXtreme Scale container when the hosting application server is stopped and the container was started using the eXtreme Scale Server.createContainer(com.ibm.websphere.objectgrid.deployment.DeploymentPolicy) API.
`void`	`setWorkingDirectory(String workingDirectory)` Sets the working directory for the ObjectGrid server runtime to use.
`void`	`setXIOChannelProps(Map<String,? extends Properties> channelProperties)` Sets the channel properties for the eXtremeIO transport, replacing all current channel properties with the specified map of properties.
`void`	`setXIOTimeout(int timeout)` Sets the current timeout for server requests using the XIO transport.
`void`	`setZoneName(String zoneName)` Sets the zone that this server belongs to.
`void`	`store(OutputStream output)` Writes the properties from this object into `output`.

Field Detail

DEFAULT_ZONE

static final String DEFAULT_ZONE

The name of the zone that all containers that do not specify a zone are in.

See Also:: setZoneName(String), Constant Field Values

PROP_SERVER_NAME

static final String PROP_SERVER_NAME

Defines the name the server should use to identify itself.

Since:: WAS XD 6.1.0.3
See Also:: setServerName(String), Constant Field Values

PROP_ZONE_NAME

static final String PROP_ZONE_NAME

Defines the name of the zone this server belongs to.

Since:: WAS XD 6.1.0.3
See Also:: setZoneName(String), Constant Field Values

PROP_WORKING_DIRECTORY

static final String PROP_WORKING_DIRECTORY

The property that defines which directory the ObjectGrid server should use for all default settings.

See Also:: setWorkingDirectory(String), Constant Field Values

PROP_LOG_NOTIFICATION_FILTER

static final String PROP_LOG_NOTIFICATION_FILTER

The log record filtering regular expression that the ObjectGrid server should initially use. The default is null, i.e. no filtering is applied based on log record, but only the default log level severity (SEVERE & WARNING).

Since:: 8.6
See Also:: DynamicServerMBean.setLogNotificationFilter(String), Constant Field Values

PROP_TRACE_SPEC

static final String PROP_TRACE_SPEC

The trace specification that the ObjectGrid server should use initially. The default is *=all=disabled.

See Also:: ObjectGridManager.setTraceSpecification(String), Constant Field Values

PROP_TRACE_FILE

static final String PROP_TRACE_FILE

The name of the file that trace output should be sent to.

See Also:: ObjectGridManager.setTraceFileName(String), Constant Field Values

PROP_STATS_SPEC

static final String PROP_STATS_SPEC

The statistics specification that the ObjectGrid should use for metric gathering.

See Also:: setStatsSpecification(String), Constant Field Values

PROP_ENABLE_MBEANS

static final String PROP_ENABLE_MBEANS

Determines whether or not the ObjectGrid will register MBeans in this process.

See Also:: setMBeansEnabled(boolean), Constant Field Values

PROP_SYSTEM_STREAM_TO_FILE_ENABLED

static final String PROP_SYSTEM_STREAM_TO_FILE_ENABLED

Defines whether SystemOut and SystemErr should be sent to file or not.

Valid values include: true and false.

See Also:: Constant Field Values

PROP_HAMANAGERPORT

static final String PROP_HAMANAGERPORT

Defines the port number the High Availability Manager will use. If this doesn't present, the catalog server will generate an available port automatically.

Since:: WAS XD 6.1.0.3
See Also:: setHAManagerPort(int), Constant Field Values

PROP_CATALOG_SERVICE_ENDPOINTS

static final String PROP_CATALOG_SERVICE_ENDPOINTS

Sets the end points to connect to the catalog service grid. This should be of the form host:port<,host:port> where the host value is the listenerHost and the port value is the listenerPort of the catalog service process.

Since:: WAS XD 6.1.0.3
See Also:: Constant Field Values

PROP_LISTENER_HOST

static final String PROP_LISTENER_HOST

Sets the host name that the ORB should bind to.

Since:: WAS XD 6.1.0.3
See Also:: setListenerHost(String), Constant Field Values

PROP_LISTENER_PORT

static final String PROP_LISTENER_PORT

Sets the port that the ORB should bind to.

Since:: WAS XD 6.1.0.3
See Also:: setListenerPort(int), Constant Field Values

PROP_MEMORY_USAGE_THRESHOLD

static final String PROP_MEMORY_USAGE_THRESHOLD

Sets the memory threshold (percentage of max heap) for memory based eviciton

Since:: WAS XD 6.1.0.3
See Also:: setMemoryThresholdPercentage(int), Constant Field Values

PROP_MINIMUM_THREAD_POOL_SIZE

static final String PROP_MINIMUM_THREAD_POOL_SIZE

Sets the minimum thread pool size used by the server and client runtimes in this process

Since:: 7.0.0.0 FIX2
See Also:: setMinimumThreadPoolSize(int), Constant Field Values

PROP_MAXIMUM_THREAD_POOL_SIZE

static final String PROP_MAXIMUM_THREAD_POOL_SIZE

Sets the minimum thread pool size used by the server and client runtimes in this process

Since:: 7.0.0.0 FIX2
See Also:: setMaximumThreadPoolSize(int), Constant Field Values

PROP_JMX_SERVICE_PORT

static final String PROP_JMX_SERVICE_PORT

The property that defines which port the JMX service will bind to

Since:: 7.1
See Also:: setJMXServicePort(int), Constant Field Values

PROP_JMX_CONNECTOR_PORT

static final String PROP_JMX_CONNECTOR_PORT

The property that defines which SSL port the JMX service will bind to

Since:: 7.1.0.3
See Also:: setJMXConnectorPort(int), Constant Field Values

PROP_ENABLE_CHANNEL_FRAMEWORK

static final String PROP_ENABLE_CHANNEL_FRAMEWORK

Sets the TransportMode on the IBM ORB properties to ChannelFramework

Since:: 7.1
See Also:: Constant Field Values

PROP_ENABLE_EXTREMEMEMORY

static final String PROP_ENABLE_EXTREMEMEMORY

Enables the eXtremeMemory memory storage mode for the server. When enabled, all data is stored outside of the Java heap.

Since:: 7.1.1
See Also:: Constant Field Values

PROP_MAXIMUM_EXTREMEMEMORY_SIZE

static final String PROP_MAXIMUM_EXTREMEMEMORY_SIZE

Sets the maximum amount of eXtremeMemory (in megabytes) to allocate when eXtremeMemory is enabled. If not set or set to -1, the maximum is not set.

Since:: 7.1.1
See Also:: Constant Field Values

PROP_XIOCHANNEL_PREFIX

static final String PROP_XIOCHANNEL_PREFIX

The property prefix to use for all eXtremeIO transport channel properties. The properties are in the form:

xioChannel.<channelname><propertyname>=<propertyvalue>

Since:: 7.1.1
See Also:: Constant Field Values

PROP_XIOCHANNELNAME_TCP

static final String PROP_XIOCHANNELNAME_TCP

The eXtremeIO transport channel name for TCP/IP communication.

Since:: 8.6
See Also:: Constant Field Values

PROP_XIOCHANNELNAME_CONTAINER_TCP_NON_SECURE

static final String PROP_XIOCHANNELNAME_CONTAINER_TCP_NON_SECURE

Deprecated. 8.6

The eXtremeIO transport container channel property name for non-secure TCP.

Since:: 7.1.1
See Also:: Constant Field Values

PROP_XIOCHANNELNAME_CONTAINER_TCP_SECURE

static final String PROP_XIOCHANNELNAME_CONTAINER_TCP_SECURE

Deprecated. 8.6

The eXtremeIO transport container channel property name for non-secure TCP.

Since:: 7.1.1
See Also:: Constant Field Values

PROP_XIOCHANNELPROP_PORT

static final String PROP_XIOCHANNELPROP_PORT

The eXtremeIO channel property to identify the port.

Since:: 7.1.1
See Also:: Constant Field Values

PROP_MINIMUM_XIO_WORKER_THREAD_POOL_SIZE

static final String PROP_MINIMUM_XIO_WORKER_THREAD_POOL_SIZE

Sets the minimum number of threads to allocate in the eXtremeIO transport request processing thread pool.

Since:: 7.1.1
See Also:: Constant Field Values

PROP_MAXIMUM_XIO_WORKER_THREAD_POOL_SIZE

static final String PROP_MAXIMUM_XIO_WORKER_THREAD_POOL_SIZE

Sets the maximum number of threads to allocate in the eXtremeIO transport request processing thread pool.

Since:: 7.1.1
See Also:: Constant Field Values

PROP_MINIMUM_XIO_NETWORK_THREAD_POOL_SIZE

static final String PROP_MINIMUM_XIO_NETWORK_THREAD_POOL_SIZE

Sets the minimum number of threads to allocate in the eXtremeIO transport network thread pool.

Since:: 7.1.1
See Also:: Constant Field Values

PROP_XIO_WAITING_MESSAGE_QUEUE_LIMIT

static final String PROP_XIO_WAITING_MESSAGE_QUEUE_LIMIT

Deprecated. 8.6.0

Property string for maximum number of waiting messages for XIO transport to process. The messages are not received after the limit has been reached.

Since:: 7.1.1
See Also:: Constant Field Values

PROP_MAXIMUM_XIO_NETWORK_THREAD_POOL_SIZE

static final String PROP_MAXIMUM_XIO_NETWORK_THREAD_POOL_SIZE

Sets the maximum number of threads to allocate in the eXtremeIO transport network thread pool.

Since:: 7.1.1
See Also:: Constant Field Values

REPLICATION_IDLE_LEVEL_SHORT

static final int REPLICATION_IDLE_LEVEL_SHORT

Constant representing a replication idle level at a short sleep.

A replication idle level set to short may slightly delay replication when a primary changes data again after a period of no change, but also decreases CPU and network utilization during times of low data change in comparison to when the system is actively replicating data.

See Also:: Constant Field Values

REPLICATION_IDLE_LEVEL_NONE

static final int REPLICATION_IDLE_LEVEL_NONE

Constant representing a replication idle level that is turned off.

A replication idle level set to none does not change the replication polling if there is a period of data not changing.

See Also:: Constant Field Values

REPLICATION_IDLE_LEVEL_RELAXED

static final int REPLICATION_IDLE_LEVEL_RELAXED

Constant representing a replication idle level at a relaxed rate.

A replication idle level set to relaxed may delay replication when a primary changes data again after a period of no change, but also decreases CPU and network utilization during times of low data change.

See Also:: Constant Field Values

PROP_HPEL_ENABLED

static final String PROP_HPEL_ENABLED

Indicates if the HPEL feature is to be enable or not: true for enabled false for disabled. HPEL is disabled by default.

Since:: 8.6
See Also:: Constant Field Values

PROP_HPEL_PURGE_BY_SIZE_ENABLED

static final String PROP_HPEL_PURGE_BY_SIZE_ENABLED

Indicates if the HPEL feature is to purge log files by size. This is enabled by default.

Since:: 8.6
See Also:: Constant Field Values

PROP_HPEL_PURGE_BY_TIME_ENABLED

static final String PROP_HPEL_PURGE_BY_TIME_ENABLED

Indicates if the HPEL feature is to purge log files by time. This is enabled by default.

Since:: 8.6
See Also:: Constant Field Values

PROP_HPEL_FILE_SWITCH_ENABLED

static final String PROP_HPEL_FILE_SWITCH_ENABLED

Indicates if the HPEL feature is to enable file switch. This is disabled by default.

Since:: 8.6
See Also:: Constant Field Values

PROP_HPEL_BUFFERING_ENABLED

static final String PROP_HPEL_BUFFERING_ENABLED

Indicates if the HPEL feature is to enable buffering. This is disabled by default.

Since:: 8.6
See Also:: Constant Field Values

PROP_HPEL_INCLUDE_TRACE

static final String PROP_HPEL_INCLUDE_TRACE

Indicates if the HPEL text files are to include tracing. This is disabled by default.

Since:: 8.6
See Also:: Constant Field Values

PROP_HPEL_OUT_OF_SPACE_ACTION

static final String PROP_HPEL_OUT_OF_SPACE_ACTION

Indicates the action to be performed when the disk space has been exceeded (String value)

Since:: 8.6
See Also:: Constant Field Values

PROP_HPEL_OUTPUT_FORMAT

static final String PROP_HPEL_OUTPUT_FORMAT

Indicates the format of the log files to be generated (String value).

Since:: 8.6
See Also:: Constant Field Values

PROP_HPEL_MAX_REPOSITORY_SIZE

static final String PROP_HPEL_MAX_REPOSITORY_SIZE

Indicates the Maximum size of files generate in megabytes (long value).

Since:: 8.6
See Also:: Constant Field Values

PROP_HPEL_MAX_RETENTION_TIME

static final String PROP_HPEL_MAX_RETENTION_TIME

Indicates the maximum retention time to hold files (long value).

Since:: 8.6
See Also:: Constant Field Values

PROP_HPEL_FILE_SWITCH_HOUR

static final String PROP_HPEL_FILE_SWITCH_HOUR

Indicates the file switch hour (int value).

Since:: 8.6
See Also:: Constant Field Values

PROP_HPEL_REPOSITORY_PATH

static final String PROP_HPEL_REPOSITORY_PATH

Indicates the file repository path (int value).

Since:: 8.6
See Also:: Constant Field Values

PROP_SYSLOG_ENABLED

static final String PROP_SYSLOG_ENABLED

Indicates whether to enable the transmission (over UDP) of log messages to a remote syslogd server. Possible values are true for enabled, false for disabled. Syslog is disabled by default.

Since:: 8.6
See Also:: Constant Field Values

PROP_SYSLOG_HOST_NAME

static final String PROP_SYSLOG_HOST_NAME

Indicates the receiving syslogd server fully-qualified domain name or IP address.

Since:: 8.6
See Also:: Constant Field Values

PROP_SYSLOG_HOST_PORT

static final String PROP_SYSLOG_HOST_PORT

Indicates the syslogd server port number on which to receive syslog messages.

Since:: 8.6
See Also:: Constant Field Values

PROP_SYSLOG_FACILITY

static final String PROP_SYSLOG_FACILITY

Indicates the syslog facility with which to send out syslog messages

Since:: 8.6
See Also:: Constant Field Values

PROP_SYSLOG_THRESHOLD

static final String PROP_SYSLOG_THRESHOLD

Indicates the log level threshold of messages to trasmit to the configured syslogd server Possible values: {warning, error}

Since:: 8.6
See Also:: Constant Field Values

PROP_JVM_STATS_ENABLED

static final String PROP_JVM_STATS_ENABLED

When set to true, enables log data for the JVM to be written to a CSV file.

Since:: 7.1.1
See Also:: Constant Field Values

PROP_MAX_JVM_STATS_FILES

static final String PROP_MAX_JVM_STATS_FILES

Indicates the maximum number of CSV statistics files that are generated for the JVM Stats.

Since:: 7.1.1
See Also:: Constant Field Values

PROP_MAX_JVM_STATS_FILE_SIZE

static final String PROP_MAX_JVM_STATS_FILE_SIZE

Indicates the maximum file size, in megabytes, of the CSV statistics files for the JVM.

Since:: 7.1.1
See Also:: Constant Field Values

PROP_JVM_STATS_FILE_NAME

static final String PROP_JVM_STATS_FILE_NAME

Specifies the file name of the CSV statistics file for the JVM.

Since:: 7.1.1
See Also:: Constant Field Values

PROP_JVM_STATS_WRITE_RATE

static final String PROP_JVM_STATS_WRITE_RATE

Specifies the write rate of the CSV statistics files for the JVM in seconds.

Since:: 7.1.1
See Also:: Constant Field Values

PROP_MAP_STATS_ENABLED

static final String PROP_MAP_STATS_ENABLED

When set to true, enables log data for the Map to be written to a CSV file.

Since:: 7.1.1
See Also:: Constant Field Values

PROP_MAX_MAP_STATS_FILES

static final String PROP_MAX_MAP_STATS_FILES

Indicates the maximum number of CSV statistics files that are generated for the Map Stats.

Since:: 7.1.1
See Also:: Constant Field Values

PROP_MAX_MAP_STATS_FILE_SIZE

static final String PROP_MAX_MAP_STATS_FILE_SIZE

Indicates the maximum file size, in megabytes, of the CSV statistics files for the Map Stats.

Since:: 7.1.1
See Also:: Constant Field Values

PROP_MAP_STATS_FILE_NAME

static final String PROP_MAP_STATS_FILE_NAME

Specifies the file name of the CSV statistics file for the Map Stats.

Since:: 7.1.1
See Also:: Constant Field Values

PROP_MAP_STATS_WRITE_RATE

static final String PROP_MAP_STATS_WRITE_RATE

Specifies the write rate of the CSV statistics files for the Map Stats in seconds.

Since:: 7.1.1
See Also:: Constant Field Values

PROP_OG_STATS_ENABLED

static final String PROP_OG_STATS_ENABLED

When set to true, enables log data for the Map to be written to a CSV file.

Since:: 7.1.1
See Also:: Constant Field Values

PROP_MAX_OG_STATS_FILES

static final String PROP_MAX_OG_STATS_FILES

Indicates the maximum number of CSV statistics files that are generated for the Object Grid Stats.

Since:: 7.1.1
See Also:: Constant Field Values

PROP_MAX_OG_STATS_FILE_SIZE

static final String PROP_MAX_OG_STATS_FILE_SIZE

Indicates the maximum file size, in megabytes, of the CSV statistics files for the Object Grid Stats.

Since:: 7.1.1
See Also:: Constant Field Values

PROP_OG_STATS_FILE_NAME

static final String PROP_OG_STATS_FILE_NAME

Specifies the file name of the CSV statistics file for the Object Grid Stats.

Since:: 7.1.1
See Also:: Constant Field Values

PROP_OG_STATS_WRITE_RATE

static final String PROP_OG_STATS_WRITE_RATE

Specifies the write rate of the CSV statistics files for the Object Grid Stats in seconds.

Since:: 7.1.1
See Also:: Constant Field Values

PROP_DISK_STORAGE_PATH

static final String PROP_DISK_STORAGE_PATH

Defines the root directory to use when disk overflow is enabled.

Since:: 8.6
See Also:: setDiskStoragePath(String), Constant Field Values

PROP_DISK_OVERFLOW_CAP_BYTES

static final String PROP_DISK_OVERFLOW_CAP_BYTES

Defines maximum number of bytes that can be used by this JVM for overflowing content to disk.

Since:: 8.6
See Also:: setDiskOverflowCapBytes(long), Constant Field Values

PROP_DISK_OVERFLOW_MIN_DISK_SPACE_BYTES

static final String PROP_DISK_OVERFLOW_MIN_DISK_SPACE_BYTES

Defines minimum number of bytes that must remain free on disk in the partition named by PROP_DISK_STORAGE_PATH.

Since:: 8.6
See Also:: getDiskOverflowMinDiskSpaceBytes(), Constant Field Values

PROP_DISK_OVERFLOW_ENABLED

static final String PROP_DISK_OVERFLOW_ENABLED

Defines whether the capability of overflowing data from main-memory to disk is enabled.

Since:: 8.6
See Also:: setDiskOverflowEnabled(boolean), Constant Field Values

PROP_XIO_TIMEOUT

static final String PROP_XIO_TIMEOUT

Sets the timeout for server requests using the XIO transport. The timeout is set in seconds. The default xioTimeout for server requests is set to 30 seconds. The valid range is timeout >= 1.

Since:: 8.6
See Also:: Constant Field Values

PROP_WAS_MANAGED_CONTAINER_SHUTDOWN_ENABLED

static final String PROP_WAS_MANAGED_CONTAINER_SHUTDOWN_ENABLED

Used by users of the embedded server API in WebSphere Application Server, when they want to stop the eXtreme Scale containers manually using the ContainerMBean.terminate() API.

The default is true, which allows the eXtreme Scale runtime to automatically stop the container servers when the application server is shut down.

Since:: 7.1.1.1 PM67857
See Also:: setWASManagedContainerShutdownEnabled(boolean), Constant Field Values

Method Detail

load

void load(InputStream input)
          throws IOException

Loads the properties from input into this property object.

Parameters:: input - A stream to load properties from.
Throws:: IOException - If the properties input has an invalid format.

store

void store(OutputStream output)
           throws IOException

Writes the properties from this object into output.

Parameters:: output - A stream to write out the properties to.
Throws:: IOException - If the properties input has an invalid format.

isServer

boolean isServer()

Answers whether or not this process is configured to be an ObjectGrid server process.

Returns:: Whether or not this process is a server process.

getServerName

String getServerName()

Retrieves the name used in identifying this server.

Returns:: The name of this server process.

setServerName

void setServerName(String serverName)

Sets the name used to identify this process.

This value is optional. For WebSphere Application Server processes, the server name match the WebSphere Application Server process name. For other processes, the name is automatically generated in the form:

 ogserver-[index]

For example, the first server name will be: ogserver-0, the second server: ogserver-1.

Parameters:: serverName - The name of the server process.

getZoneName

String getZoneName()

Retrieve the zone name.

Returns:: The name of the zone that this server belongs to.
See Also:: DEFAULT_ZONE

setZoneName

void setZoneName(String zoneName)

Sets the zone that this server belongs to. This can only be set initially, once the server has connected to the catalog service the zone is set and can not be modified.

Parameters:: zoneName - The name of the zone that this server belongs to.
See Also:: DEFAULT_ZONE

getListenerHost

String getListenerHost()

Retrieves the host to be used by the ORB. The listener host property defaults to 'localhost'.

Returns:: The host that the ORB is going to be bound to.

setListenerHost

void setListenerHost(String listenerHost)

Assigns the host that the ORB is to bind to.

Parameters:: listenerHost - The host name to be used when creating the ORB.

getListenerPort

int getListenerPort()

Retrieves the inbound port used by the dominant transport. If the ORB transport is used, then this is the ORB non-secure listener port. If the XIO transport is used, then then is the non-secure inbound port.

Returns:: The inbound port in use by the dominant transport.

setListenerPort

void setListenerPort(int listenerPort)

Assigns the port that the ORB is to bind to.

Parameters:: listenerPort - The port to be used when creating the ORB.

getCatalogServiceBootstrap

String getCatalogServiceBootstrap()

Retrieves the catalog service corbaloc string.

Returns:: The catalog service corbaloc string.

setCatalogServiceBootstrap

void setCatalogServiceBootstrap(String catalogServiceAddress)

Sets the catalog service grid addresses in the form [host:port,host:port,...]. This should generally be enough entries that redundancy is sufficient but does not need to be the complete set.

Parameters:: catalogServiceAddress - The addresses of all the catalog services that can be used to bootstrap to.

getJMXServicePort

int getJMXServicePort()

Retrieves the port to be used by the JMX connection. The JMX service port defaults to the ORB listener port.

Returns:: The port that the JMX connection is to be bound to.
See Also:: getJMXConnectorPort()

setJMXServicePort

void setJMXServicePort(int jmxServicePort)

Assigns the port that the JMX service is to bind to. If this is not set the JMX service is bound to the ORB port.

Parameters:: jmxServicePort - The port that the JMX service is to bind to.
See Also:: setJMXConnectorPort(int)

getJMXConnectorPort

int getJMXConnectorPort()

Retrieves the JMX connector port that the JMX service is to bind to.

If the JMX service port is specified and this port is not specified, the port that is chosen depends on different criteria. If SSL is not enabled, the JMXServicePort is used for the JMXConnectorPort is possible. If that fails, an ephemeral port is used. With SSL enabled, an ephemeral port is always used if the JMXConnectorPort is not provided.

The format of the JMX URL is the following format when a JMXServicePort is provided: service:jmx:rmi://listenerHost:JMXConnectorPort/jndi/rmi://listenerHost:JMXServicePort/objectgrid/MBeanServer

If the JMX service port is not specified, this property is ignored and the ORB is used for both TCP and SSL configurations.

Returns:: The connector port that the JMX connection is to bind to.
Since:: 7.1.0.3

setJMXConnectorPort

void setJMXConnectorPort(int jmxConnectorPort)

Assigns the JMX connector port that the JMX service is to bind to.

The format of the JMX URL is the following format when a JMXServicePort is provided: service:jmx:rmi://listenerHost:JMXConnectorPort/jndi/rmi://listenerHost:JMXServicePort/objectgrid/MBeanServer

The rmiHost and namingHost in the URL uses the listenerHost property.

If the JMX service port is not specified, this property is ignored and the ORB is used for both TCP and SSL configurations.

Parameters:: jmxConnectorPort - The connector port that the JMX connection is to bind to.
Since:: 7.1.0.3
See Also:: setJMXServicePort(int)

setLogNotificationFilter

void setLogNotificationFilter(String regExFilter)

Sets the regular expression filter to be applied to log records messages that are forwarded as JMX notifications by the ObjectGrid server through the LoggerListenerJMXNotifier

Parameters:: regExFilter - The initial regular expression filter for log record messages.
Since:: 8.6

getTraceSpecification

String getTraceSpecification()

Retrieves the initial trace specification the server should use.

Returns:: The initial trace specification.

setTraceSpecification

void setTraceSpecification(String traceSpecification)

Assigns the specification that the server should use on initialization.

Parameters:: traceSpecification - The initial trace specification for the server to use.

getTraceFileName

String getTraceFileName()

Retrieves a reference to the file name the server will use for trace.

Returns:: The trace file name.

setTraceFileName

void setTraceFileName(String traceFileName)

Assigns the file to use for logging trace.

Parameters:: traceFileName - The file name to use for logging trace.

getStatsSpecification

String getStatsSpecification()

Retrieves the statistics specification that this process should start with.

Returns:: The initial stats specification.

setStatsSpecification

void setStatsSpecification(String statsSpecification)

Sets the initial statistics specification that the ObjectGrid server should start with.

Parameters:: statsSpecification - The initial stats specification.
See Also:: StatsSpec

getLogNotificationFilter

String getLogNotificationFilter()

Retrieves the regular expression filter to be applied to log records messages that are forwarded as JMX notifications by the ObjectGrid server through the LoggerListenerJMXNotifier

Returns:: The current regular expression filter for log record messages.
Since:: 8.6

isMBeanEnabled

boolean isMBeanEnabled()

Retrieves whether or not the MBeans are going to be registered.

Returns:: Whether or not the ObjectGrid MBeans will be registered.

setMBeansEnabled

void setMBeansEnabled(boolean enableMBeans)

Enables or disables ObjectGrid MBean registration for this process.

Parameters:: enableMBeans - Whether or not MBeans should be registered.

getWorkingDirectory

String getWorkingDirectory()

Retrieves the working directory for the ObjectGrid server runtime.

Returns:: The ObjectGrid server runtime working directory.

setWorkingDirectory

void setWorkingDirectory(String workingDirectory)

Sets the working directory for the ObjectGrid server runtime to use.

Parameters:: workingDirectory - The directory that the ObjectGrid will default activity to.

isSystemStreamToFileEnabled

boolean isSystemStreamToFileEnabled()

Retrieves the stream to file setting.

Returns:: Whether or not the system streams will be written to file.

setSystemStreamsToFileEnabled

void setSystemStreamsToFileEnabled(boolean streamsToFile)

Sets the trace logic to write SystemOut and SystemErr to file, or not write to file.

Parameters:: streamsToFile - Whether or not the system streams should be written to file.

setHAManagerPort

void setHAManagerPort(int port)

Sets the port number for the High Availability Manager (HA Manager).

Parameters:: port - the port number
Since:: WAS XD 6.1.0.3

getHAManagerPort

int getHAManagerPort()

Retrieve the High Availability Manager (HA Manager) port.

Returns:: the port
Since:: WAS XD 6.1.0.3

setMemoryThresholdPercentage

void setMemoryThresholdPercentage(int threshold)

Sets the memory threshold usage percentage, (set up to 100% ).

Parameters:: threshold - the memory threshold percentage
Throws:: IllegalArgumentException - if the threshold is out of range.
Since:: WAS XD 6.1.0.3

getMemoryThresholdPercentage

int getMemoryThresholdPercentage()

Gets the memory threshold usage percentage, -1 indicates that it was not set.

Returns:: the memory threshold percentage
Since:: WAS XD 6.1.0.3

setMinimumThreadPoolSize

void setMinimumThreadPoolSize(int minNumThreads)

Sets the minimum number of threads in the pool.

Parameters:: minNumThreads - The minimum number of threads to hold in the pool.
Since:: 7.0.0.0 FIX2

getMinimumThreadPoolSize

int getMinimumThreadPoolSize()

Retrieve the minimum number of pooled threads.

Returns:: The minimum number of threads to hold in the pool.
Since:: 7.0.0.0 FIX2

setMaximumThreadPoolSize

void setMaximumThreadPoolSize(int maxNumThreads)

Sets the maximum number of threads in the pool.

Parameters:: maxNumThreads - The maximum number of threads to use.
Since:: 7.0.0.0 FIX2

getMaximumThreadPoolSize

int getMaximumThreadPoolSize()

Retrieve the maximum number of pooled threads.

Returns:: The maximum number of threads to use.
Since:: 7.0.0.0 FIX2

isChannelFrameworkEnabled

boolean isChannelFrameworkEnabled()

Returns if the ChannelFramework setting was enabled for the TransportMode on the IBM ORB properties

Returns:: Answers true if the ChannelFramework setting is enabled.
Since:: 7.1

setChannelFramework

void setChannelFramework(boolean enableChannelFramework)

Sets the TransportMode on the IBM ORB properties to ChannelFramework

Parameters:: enableChannelFramework - True if the ChannelFramework is enabled.
Since:: 7.1

setXIOChannelProps

void setXIOChannelProps(Map<String,? extends Properties> channelProperties)

Sets the channel properties for the eXtremeIO transport, replacing all current channel properties with the specified map of properties. To add a new property:

 ServerProperties serverProps = ServerFactory.getServerProperties();
 Map<String, Properties> allChannelProps = serverProps.getXIOChannelProps();
 Properties channelProps = allChannelProps.get("THECHANNEL");
 channelProps.put("PORT", "9000");
 serverProps.setXIOChannelProps(channelProps);

Parameters:: channelProperties - The map of channel names to the properties associated with the channel.
Since:: 7.1.1

getXIOChannelProps

Map<String,Properties> getXIOChannelProps()

Returns a copy of the map of overriding properties for all channels.

Returns:: the map of channel names to the properties associated with the channel.
Since:: 7.1.1

setEnableXM

void setEnableXM(boolean enableXM)

Enables the eXtremeMemory memory storage mode for the server. When enabled, all data is stored outside of the Java heap.

Since:: 7.1.1

isEnableXM

boolean isEnableXM()

Answers true if eXtremeMemory is enabled.

Since:: 7.1.1

setMaximumXMSize

void setMaximumXMSize(int sizeInMegabytes)

Sets the maximum amount of eXtremeMemory (in megabytes) to allocate when eXtremeMemory is enabled. This is ignored if isEnableXM() answers false.

Parameters:: sizeInMegabytes - the amount of eXtremeMemory to allocate in megabytes, or -1 if the maximum size is not set.
Since:: 7.1.1

getMaximumXMSize

int getMaximumXMSize()

Retrieves the maximum amount of eXtremeMemory (in megabytes) to allocate when eXtremeMemory is enabled.

Returns:: the amount of eXtremeMemory to allocate in megabytes, or -1 if not set.
Since:: 7.1.1

isHPELEnabled

boolean isHPELEnabled()

Indicates if the HPEL feature is to be enable or not: true for enabled false for disabled. HPEL is disabled by default.

Returns:: The value of true or false indicating if HPEL is enabled or disabled
Since:: 8.6

setHPELEnabled

void setHPELEnabled(boolean hpelEnabled)

When set to true, enables HPEL logging.

Parameters:: hpelEnabled - enables log data to be handled by HPEL.
Since:: 8.6

isHPELPurgeBySizeEnabled

boolean isHPELPurgeBySizeEnabled()

Indicates if the HPEL feature purge by size feature enable or not: true for enabled false for disabled. Purge by size is enabled by default.

Returns:: The value of true or false indicating if HPEL is enabled or disabled
Since:: 8.6

setHPELPurgeBySizeEnabled

void setHPELPurgeBySizeEnabled(boolean hpelPurgeBySizeEnabled)

When set to true, enables HPEL purge by size.

Parameters:: hpelPurgeBySizeEnabled - enables purge by size.
Since:: 8.6

isHPELPurgeByTimeEnabled

boolean isHPELPurgeByTimeEnabled()

Indicates if the HPEL feature purge by size is to be enable or not: true for enabled false for disabled. HPEL purge by time is enabled by default.

Returns:: The value of true or false indicating if HPEL purge by size is enabled or disabled
Since:: 8.6

setHPELPurgeByTimeEnabled

void setHPELPurgeByTimeEnabled(boolean hpelPurgeByTimeEnabled)

When set to true, enables HPEL purge by time.

Parameters:: hpelPurgeByTimeEnabled - enables purge by time.
Since:: 8.6

isHPELFileSwitchEnabled

boolean isHPELFileSwitchEnabled()

Indicates if the HPEL file switch feature is to be enable or not: true for enabled false for disabled. HPEL file switch is enabled by default.

Returns:: The value of true or false indicating if HPEL purge by time is enabled or disabled
Since:: 8.6

setHPELFileSwitchEnabled

void setHPELFileSwitchEnabled(boolean hpelFileSwitchEnabled)

When set to true, enables HPEL file switch.

Parameters:: hpelFileSwitchEnabled - enables file switch.
Since:: 8.6

isHPELBufferingEnabled

boolean isHPELBufferingEnabled()

Indicates if the HPEL file switch feature is to be enable or not: true for enabled false for disabled. HPEL buffering is disabled by default.

Returns:: The value of true or false indicating if HPEL buffering is enabled or disabled
Since:: 8.6

setHPELBufferingEnabled

void setHPELBufferingEnabled(boolean hpelBufferingEnabled)

When set to true, enables HPEL buffering.

Parameters:: hpelBufferingEnabled - enables buffering.
Since:: 8.6

isHPELIncludeTrace

boolean isHPELIncludeTrace()

Indicates if the HPEL include trace feature is to be enable or not: true for enabled false for disabled. HPEL include trace is disabled by default.

Returns:: The value of true or false indicating if HPEL include trace is enabled or disabled
Since:: 8.6

setHPELIncludeTrace

void setHPELIncludeTrace(boolean hpelIncludeTrace)

When set to true, enables HPEL include trace.

Parameters:: hpelIncludeTrace - enables include trace.
Since:: 8.6

setHPELMaxRepositorySize

void setHPELMaxRepositorySize(long hpelMaxRepositorySize)

Specifies the HPEL Maximum Repository Size

Parameters:: hpelMaxRepositorySize - The HPEL Maximum Repository Size
Since:: 8.6

getHPELMaxRepositorySize

long getHPELMaxRepositorySize()

Indicates the HPEL Maximum Repository Size

Returns:: The HPEL Maximum Repository Size
Since:: 8.6

setHPELMaxRetentionTime

void setHPELMaxRetentionTime(long hpelMaxRetentionTime)

Specifies the HPEL Maximum Retention Time

Parameters:: hpelMaxRetentionTime - The HPEL Retention Time
Since:: 8.6

getHPELMaxRetentionTime

long getHPELMaxRetentionTime()

Indicates the HPEL Maximum Retention Time

Returns:: The HPEL Maximum Retention Time
Since:: 8.6

setHPELFileSwitchHour

void setHPELFileSwitchHour(int hpelFileSwitchHour)

Specifies the HPEL File Switch Hour

Parameters:: hpelFileSwitchHour - The HPEL File Switch Hour
Since:: 8.6

getHPELFileSwitchHour

int getHPELFileSwitchHour()

Indicates the HPEL File Switch Hour

Returns:: The HPEL File Switch Hour
Since:: 8.6

setHPELOutOfSpaceAction

void setHPELOutOfSpaceAction(String hpelOutOfSpaceAction)

Specifies the HPEL Out Of SpaceAction

Parameters:: hpelOutOfSpaceAction - The HPEL Out Of SpaceAction
Since:: 8.6

getHPELOutOfSpaceAction

String getHPELOutOfSpaceAction()

Indicates the HPEL Out Of Space Action

Returns:: The HPEL Out Of Space Action
Since:: 8.6

setHPELOutputFormat

void setHPELOutputFormat(String hpelOutputFormat)

Specifies the HPEL Output Format

Parameters:: hpelOutputFormat - The HPEL Output Format
Since:: 8.6

getHPELOutputFormat

String getHPELOutputFormat()

Indicates the HPEL Output Format

Returns:: The HPEL Output Format
Since:: 8.6

setHPELRepositoryPath

void setHPELRepositoryPath(String hpelRepositoryPath)

Specifies the HPEL Repository Path

Parameters:: hpelRepositoryPath - The HPEL Repository Path
Since:: 8.6

getHPELRepositoryPath

String getHPELRepositoryPath()

Indicates the HPEL Repository Path

Returns:: The HPEL Repository Path
Since:: 8.6

isSyslogEnabled

boolean isSyslogEnabled()

Indicates if the Syslogd feature is to be enable or not: true for enabled false for disabled. Syslog is disabled by default.

Returns:: The value of true or false indicating if Syslog is enabled or disabled
Since:: 8.6

setSyslogEnabled

void setSyslogEnabled(boolean syslogEnabled)

When set to true, enables Syslog logging.

Parameters:: syslogEnabled - enables log data to be sent to Syslog server.
Since:: 8.6

getSyslogHostName

String getSyslogHostName()

Indicates the Syslogd Server host full name or IP address

Returns:: The Syslogd Server host full name or IP address
Since:: 8.6

setSyslogHostName

void setSyslogHostName(String syslogHostName)

Specifies the Syslogd Server host full name or IP address

Parameters:: syslogHostName - The Syslogd Server host full name or IP address
Since:: 8.6

getSyslogHostPort

int getSyslogHostPort()

Indicates the Syslogd Server Port Number

Returns:: The Syslogd Server Port Number
Since:: 8.6

setSyslogHostPort

void setSyslogHostPort(int syslogHostPort)

Specifies the Syslogd Server host port number

Parameters:: syslogHostPort - The Syslogd Server host Port Number
Since:: 8.6

getSyslogFacility

String getSyslogFacility()

Indicates the Syslogd Facility

Returns:: The Syslogd Facility
Since:: 8.6

setSyslogFacility

void setSyslogFacility(String syslogFacility)

Specifies the Syslogd Facility

Parameters:: syslogFacility - The Syslogd Server Facility
Since:: 8.6

getSyslogThreshold

String getSyslogThreshold()

Indicates the Syslogd Threshold. Possible value include warning and error

Returns:: The Syslogd Threshold
Since:: 8.6

setSyslogThreshold

void setSyslogThreshold(String syslogThreshold)

Specifies the Syslogd Threshold

Parameters:: syslogThreshold - The Syslogd Server Threshold
Since:: 8.6

getMaximumJVMStatsFiles

int getMaximumJVMStatsFiles()

Indicates the maximum number of CSV statistics files that are generated for the JVM Stats.

Returns:: The maximum number of CSV statistics files that are generated for the JVM Stats.
Since:: 7.1.1

isJvmStatsLoggingEnabled

boolean isJvmStatsLoggingEnabled()

Gets whether of not log data for the JVM will to be written to a CSV file.

Returns:: When true, log data for the JVM will be written to a CSV file.
Since:: 7.1.1

setJvmStatsLoggingEnabled

void setJvmStatsLoggingEnabled(boolean jvmStatsLoggingEnabled)

When set to true, enables log data for the JVM to be written to a CSV file.

Parameters:: jvmStatsLoggingEnabled - enables log data for the JVM to be written to a CSV file.
Since:: 7.1.1

setMaximumJVMStatsFiles

void setMaximumJVMStatsFiles(int maximumJVMStatsFiles)

Sets the maximum number of CSV statistics files that are generated for the JVM Stats.

Parameters:: maximumJVMStatsFiles - The maximum number of CSV statistics files that are generated for the JVM Stats.
Since:: 7.1.1

getMaximumJVMStatsFileSize

int getMaximumJVMStatsFileSize()

Gets the maximum file size, in megabytes, of the CSV statistics files for the JVM.

Returns:: The maximum file size, in megabytes, of the CSV statistics files for the JVM.
Since:: 7.1.1

setMaximumJVMStatsFileSize

void setMaximumJVMStatsFileSize(int maximumJVMStatsFileSize)

Sets the maximum file size, in megabytes, of the CSV statistics files for the JVM.

Parameters:: maximumJVMStatsFileSize - The maximum file size, in megabytes, of the CSV statistics files for the JVM.
Since:: 7.1.1

getJvmStatsFileName

String getJvmStatsFileName()

Gets JVM Stats file name

Returns:: The value of the associated property to set.
Since:: 7.1.1

setJvmStatsFileName

void setJvmStatsFileName(String jvmStatsFileName)

Specifies the file name of the CSV statistics file for the JVM.

Parameters:: jvmStatsFileName - The file name of the CSV statistics file for the JVM.
Since:: 7.1.1

getJvmStatsWriteRate

int getJvmStatsWriteRate()

Gets the write rate of the CSV statistics files for the JVM in seconds.

Returns:: The write rate of the CSV statistics files for the JVM in seconds.
Since:: 7.1.1

setJvmStatsWriteRate

void setJvmStatsWriteRate(int jvmStatsWriteRate)

Sets the write rate of the CSV statistics files for the JVM in seconds.

Parameters:: jvmStatsWriteRate - The write rate of the CSV statistics files for the JVM in seconds.
Since:: 7.1.1

getMaximumMapStatsFiles

int getMaximumMapStatsFiles()

Indicates the maximum number of CSV statistics files that are generated for the Map Stats.

Returns:: The maximum number of CSV statistics files that are generated for the Map Stats.
Since:: 7.1.1

isMapStatsLoggingEnabled

boolean isMapStatsLoggingEnabled()

Gets whether of not log data for the Map will to be written to a CSV file.

Returns:: When true, log data for the Map will be written to a CSV file.
Since:: 7.1.1

setMapStatsLoggingEnabled

void setMapStatsLoggingEnabled(boolean mapStatsLoggingEnabled)

When set to true, enables log data for the Map to be written to a CSV file.

Parameters:: mapStatsLoggingEnabled - enables log data for the Map to be written to a CSV file.
Since:: 7.1.1

setMaximumMapStatsFiles

void setMaximumMapStatsFiles(int maximumMapStatsFiles)

Sets the maximum number of CSV statistics files that are generated for the Map Stats.

Parameters:: maximumMapStatsFiles - The maximum number of CSV statistics files that are generated for the Map Stats.
Since:: 7.1.1

getMaximumMapStatsFileSize

int getMaximumMapStatsFileSize()

Gets the maximum file size, in megabytes, of the CSV statistics files for the Map.

Returns:: The maximum file size, in megabytes, of the CSV statistics files for the Map.
Since:: 7.1.1

setMaximumMapStatsFileSize

void setMaximumMapStatsFileSize(int maximumMapStatsFileSize)

Sets the maximum file size, in megabytes, of the CSV statistics files for the Map.

Parameters:: maximumMapStatsFileSize - The maximum file size, in megabytes, of the CSV statistics files for the Map.
Since:: 7.1.1

getMapStatsFileName

String getMapStatsFileName()

Gets the file name of the CSV statistics file for the Map.

Returns:: The file name of the CSV statistics file for the Map.
Since:: 7.1.1

setMapStatsFileName

void setMapStatsFileName(String mapStatsFileName)

Specifies the file name of the CSV statistics file for the Map.

Parameters:: mapStatsFileName - The file name of the CSV statistics file for the Map.
Since:: 7.1.1

getMapStatsWriteRate

int getMapStatsWriteRate()

Gets the write rate of the CSV statistics files for the Map in seconds.

Returns:: The write rate of the CSV statistics files for the Map in seconds.
Since:: 7.1.1

setMapStatsWriteRate

void setMapStatsWriteRate(int mapStatsWriteRate)

Sets the write rate of the CSV statistics files for the Map in seconds.

Parameters:: mapStatsWriteRate - The write rate of the CSV statistics files for the Map in seconds.
Since:: 7.1.1

getMaximumOGStatsFiles

int getMaximumOGStatsFiles()

Indicates the maximum number of CSV statistics files that are generated for the ObjectGrid Stats.

Returns:: The maximum number of CSV statistics files that are generated for the ObjectGrid Stats.
Since:: 7.1.1

isOGStatsLoggingEnabled

boolean isOGStatsLoggingEnabled()

Gets whether of not log data for the ObjectGrid will to be written to a CSV file.

Returns:: When true, log data for the ObjectGrid will be written to a CSV file.
Since:: 7.1.1

setOGStatsLoggingEnabled

void setOGStatsLoggingEnabled(boolean ogStatsLoggingEnabled)

When set to true, enables log data for the ObjectGrid to be written to a CSV file.

Parameters:: ogStatsLoggingEnabled - enables log data for the ObjectGrid to be written to a CSV file.
Since:: 7.1.1

setMaximumOGStatsFiles

void setMaximumOGStatsFiles(int maximumOGStatsFiles)

Sets the maximum number of CSV statistics files that are generated for the ObjectGrid Stats.

Parameters:: maximumOGStatsFiles - The maximum number of CSV statistics files that are generated for the ObjectGrid Stats.
Since:: 7.1.1

getMaximumOGStatsFileSize

int getMaximumOGStatsFileSize()

Gets the maximum file size, in megabytes, of the CSV statistics files for the ObjectGrid.

Returns:: The maximum file size, in megabytes, of the CSV statistics files for the ObjectGrid.
Since:: 7.1.1

setMaximumOGStatsFileSize

void setMaximumOGStatsFileSize(int maximumOGStatsFileSize)

Sets the maximum file size, in megabytes, of the CSV statistics files for the ObjectGrid.

Parameters:: maximumOGStatsFileSize - The maximum file size, in megabytes, of the CSV statistics files for the ObjectGrid.
Since:: 7.1.1

getOGStatsFileName

String getOGStatsFileName()

Gets the file name of the CSV statistics file for the ObjectGrid.

Returns:: The file name of the CSV statistics file for the ObjectGrid.
Since:: 7.1.1

setOGStatsFileName

void setOGStatsFileName(String ogStatsFileName)

Specifies the file name of the CSV statistics file for the ObjectGrid.

Parameters:: ogStatsFileName - The file name of the CSV statistics file for the ObjectGrid.
Since:: 7.1.1

getOGStatsWriteRate

int getOGStatsWriteRate()

Gets the write rate of the CSV statistics files for the ObjectGrid in seconds.

Returns:: The write rate of the CSV statistics files for the ObjectGrid in seconds.
Since:: 7.1.1

setOGStatsWriteRate

void setOGStatsWriteRate(int ogStatsWriteRate)

Sets the write rate of the CSV statistics files for the ObjectGrid in seconds.

Parameters:: ogStatsWriteRate - The write rate of the CSV statistics files for the ObjectGrid in seconds.
Since:: 7.1.1

getMinimumXIOWorkerThreads

int getMinimumXIOWorkerThreads()

Retrieves the minimum number of threads to allocate in the eXtremeIO transport request processing thread pool.

Returns:: the mininum number of threads.
Since:: 7.1.1

setMinimumXIOWorkerThreads

void setMinimumXIOWorkerThreads(int minThreads)

Sets the minimum number of threads to allocate in the eXtremeIO transport request processing thread pool.

Parameters:: minThreads - the minimum number of threads.
Since:: 7.1.1

getMaximumXIOWorkerThreads

int getMaximumXIOWorkerThreads()

Sets the maximum number of threads to allocate in the eXtremeIO transport request processing thread pool.

Returns:: the maximum number of threads.
Since:: 7.1.1

setMaximumXIOWorkerThreads

void setMaximumXIOWorkerThreads(int maxThreads)

Retrieves the maximum number of threads to allocate in the eXtremeIO transport request processing thread pool.

Parameters:: maxThreads - the maximum number of threads.
Since:: 7.1.1

getMinimumXIONetworkThreads

int getMinimumXIONetworkThreads()

Gets the minimum number of threads to allocate in the eXtremeIO transport network thread pool.

Returns:: the minimum number of threads
Since:: 7.1.1

setMinimumXIONetworkThreads

void setMinimumXIONetworkThreads(int minThreads)

Sets the minimum number of threads to allocate in the eXtremeIO transport network thread pool.

Parameters:: minThreads - the minimum number of threads
Since:: 7.1.1

getMaximumXIONetworkThreads

int getMaximumXIONetworkThreads()

Gets the maximum number of threads to allocate in the eXtremeIO transport network thread pool.

Returns:: the maximum number of threads.
Since:: 7.1.1

setMaximumXIONetworkThreads

void setMaximumXIONetworkThreads(int maxThreads)

Sets the maximum number of threads to allocate in the eXtremeIO transport network thread pool.

Parameters:: maxThreads - the maximum number of threads.
Since:: 7.1.1

setMaximumXIOWaitingMessages

void setMaximumXIOWaitingMessages(int maxMessages)

Sets the maximum number of messages waiting to be processed.

Parameters:: maxMessages - a negative number indicates no limit which may cause OutOfMemory error in exceptional cases.
Since:: 7.1.1

getMaximumXIOWaitingMessages

int getMaximumXIOWaitingMessages()

Gets the maximum number of messages waiting to be processed.

Returns:: maximum number of messages that can wait for processing. A negative number indicates no limit.
Since:: 7.1.1

isDiskOverflowEnabled

boolean isDiskOverflowEnabled()

Returns true if and only if the disk-overflow feature is enabled, false otherwise. If the property is not set, the default value is "false".

Returns:: true if and only if the disk-overflow feature is enabled, false otherwise.
Since:: 8.6

setDiskOverflowEnabled

void setDiskOverflowEnabled(boolean diskOverflowEnabled)

Sets the disk-overflow enablement feature. This is ignored if isEnableXM() returns false.

Parameters:: diskOverflowEnabled - true if and only if the disk-overflow feature should be enabled, false otherwise.
Since:: 8.6

setDiskStoragePath

void setDiskStoragePath(String diskStoragePath)

Sets the root directory to use for disk overflow. The effect is to create a new File instance using diskStoragePath as the parent abstract pathname and "wxsDiskStore" as the child pathname string. For example, is client supplies "/tmp", the system will create a "/tmp/wxsDiskStore" directory and overflow to it. All files that reside in this partition are deleted before data are overflowed to this location. This is ignored if either isEnableXM() or isDiskOverflowEnabled() return false.

Parameters:: diskStoragePath - location of the root directory.
Since:: 8.6

getDiskStoragePath

String getDiskStoragePath()

Returns the root directory used for disk overflow. It is an error to access this value without having first set the property: that is, no default value is assigned to this property.

Returns:: The root directory used for disk overflow.
Since:: 8.6

setDiskOverflowCapBytes

void setDiskOverflowCapBytes(long bytes)

Sets the maximum number of bytes that can be used by this JVM for overflowing bytes to disk. This is ignored if either isEnableXM() or isDiskOverflowEnabled() return false.

Parameters:: bytes - the cap specified in bytes.
Since:: 8.6

getDiskOverflowCapBytes

long getDiskOverflowCapBytes()

Returns the maximum number of bytes that can be used by this JVM when overflowing bytes to disk. If this property is not set, the value defaults to Long.MAX_LONG.

Returns:: the maximum number of bytes that can be used by this JVM when overflowing bytes to disk.
Since:: 8.6

setDiskOverflowMinDiskSpaceBytes

void setDiskOverflowMinDiskSpaceBytes(long bytes)

Sets the minimum number of bytes that must remain free on disk (in the partition named by diskStoragePath) when overflowing bytes to disk: a request to store data on disk will not be granted if the request will cause this constraint to be violated. This is ignored if either isEnableXM() or isDiskOverflowEnabled() return false.

Parameters:: bytes - the minimum number of bytes that must remain free on disk.
Since:: 8.6

getDiskOverflowMinDiskSpaceBytes

long getDiskOverflowMinDiskSpaceBytes()

Returns the minimum number of bytes that must remain free on disk when overflowing bytes to disk. If the property is not set, the default value is "0" bytes: that is, the system is allowed to fill the partition.

Returns:: the minimum number of bytes that must remain free on disk when overflowing bytes to disk.
Since:: 8.6

isWASManagedContainerShutdownEnabled

boolean isWASManagedContainerShutdownEnabled()

Answers true if WebSphere Application Server automatically stops the eXtreme Scale container when the hosting application server is stopped and the container was started using the eXtreme Scale Server.createContainer(com.ibm.websphere.objectgrid.deployment.DeploymentPolicy) API.

Answers false, if the application manually stops the container.

Returns:: true if the container is stopped automatically, false if the application
Since:: 7.1.1.1 PM67857

setWASManagedContainerShutdownEnabled

void setWASManagedContainerShutdownEnabled(boolean enabled)

Set to true if the WebSphere Application Server should automatically stop the eXtreme Scale container when the hosting application server is stopped and the container was started using the eXtreme Scale Server.createContainer(com.ibm.websphere.objectgrid.deployment.DeploymentPolicy) API.

Set to false, if the application manually stops the container using the ContainerMBean.terminate() API.

Since:: 7.1.1.1 PM67857

getXIOTimeout

int getXIOTimeout()

Returns the current timeout for server requests using the XIO transport.

Returns:: the current timeout in seconds
Since:: 8.6

setXIOTimeout

void setXIOTimeout(int timeout)

Sets the current timeout for server requests using the XIO transport. The timeout is set in seconds. The valid range is timeout >= 1.

Parameters:: timeout - the timeout in seconds
Since:: 8.6

Overview

Package

Class

Tree

Serialized

Deprecated

Index

Help

IBM WebSphere^TM eXtreme Scale, Release 8.6
API Specification

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ibm.websphere.objectgrid.server Interface ServerProperties

DEFAULT_ZONE

PROP_SERVER_NAME

PROP_ZONE_NAME

PROP_WORKING_DIRECTORY

PROP_LOG_NOTIFICATION_FILTER

PROP_TRACE_SPEC

PROP_TRACE_FILE

PROP_STATS_SPEC

PROP_ENABLE_MBEANS

PROP_SYSTEM_STREAM_TO_FILE_ENABLED

PROP_HAMANAGERPORT

PROP_CATALOG_SERVICE_ENDPOINTS

PROP_LISTENER_HOST

PROP_LISTENER_PORT

PROP_MEMORY_USAGE_THRESHOLD

PROP_MINIMUM_THREAD_POOL_SIZE

PROP_MAXIMUM_THREAD_POOL_SIZE

PROP_JMX_SERVICE_PORT

PROP_JMX_CONNECTOR_PORT

PROP_ENABLE_CHANNEL_FRAMEWORK

PROP_ENABLE_EXTREMEMEMORY

PROP_MAXIMUM_EXTREMEMEMORY_SIZE

PROP_XIOCHANNEL_PREFIX

PROP_XIOCHANNELNAME_TCP

PROP_XIOCHANNELNAME_CONTAINER_TCP_NON_SECURE

PROP_XIOCHANNELNAME_CONTAINER_TCP_SECURE

PROP_XIOCHANNELPROP_PORT

PROP_MINIMUM_XIO_WORKER_THREAD_POOL_SIZE

PROP_MAXIMUM_XIO_WORKER_THREAD_POOL_SIZE

PROP_MINIMUM_XIO_NETWORK_THREAD_POOL_SIZE

PROP_XIO_WAITING_MESSAGE_QUEUE_LIMIT

PROP_MAXIMUM_XIO_NETWORK_THREAD_POOL_SIZE

REPLICATION_IDLE_LEVEL_SHORT

REPLICATION_IDLE_LEVEL_NONE

REPLICATION_IDLE_LEVEL_RELAXED

PROP_HPEL_ENABLED

PROP_HPEL_PURGE_BY_SIZE_ENABLED

PROP_HPEL_PURGE_BY_TIME_ENABLED

PROP_HPEL_FILE_SWITCH_ENABLED

PROP_HPEL_BUFFERING_ENABLED

PROP_HPEL_INCLUDE_TRACE

PROP_HPEL_OUT_OF_SPACE_ACTION

PROP_HPEL_OUTPUT_FORMAT

PROP_HPEL_MAX_REPOSITORY_SIZE

PROP_HPEL_MAX_RETENTION_TIME

PROP_HPEL_FILE_SWITCH_HOUR

PROP_HPEL_REPOSITORY_PATH

PROP_SYSLOG_ENABLED

PROP_SYSLOG_HOST_NAME

PROP_SYSLOG_HOST_PORT

PROP_SYSLOG_FACILITY

PROP_SYSLOG_THRESHOLD

PROP_JVM_STATS_ENABLED

PROP_MAX_JVM_STATS_FILES

PROP_MAX_JVM_STATS_FILE_SIZE

PROP_JVM_STATS_FILE_NAME

PROP_JVM_STATS_WRITE_RATE

PROP_MAP_STATS_ENABLED

PROP_MAX_MAP_STATS_FILES

PROP_MAX_MAP_STATS_FILE_SIZE

PROP_MAP_STATS_FILE_NAME

PROP_MAP_STATS_WRITE_RATE

PROP_OG_STATS_ENABLED

PROP_MAX_OG_STATS_FILES

PROP_MAX_OG_STATS_FILE_SIZE

PROP_OG_STATS_FILE_NAME

PROP_OG_STATS_WRITE_RATE

PROP_DISK_STORAGE_PATH

PROP_DISK_OVERFLOW_CAP_BYTES

PROP_DISK_OVERFLOW_MIN_DISK_SPACE_BYTES

PROP_DISK_OVERFLOW_ENABLED

PROP_XIO_TIMEOUT

PROP_WAS_MANAGED_CONTAINER_SHUTDOWN_ENABLED

load

store

isServer

getServerName

setServerName

getZoneName

com.ibm.websphere.objectgrid.server
Interface ServerProperties