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 cluster.
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_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_MEMORY_USAGE_THRESHOLD Sets the memory threshold (percentage of max heap) for memory based eviciton
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_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_WORKING_DIRECTORY The property that defines which directory the ObjectGrid server should use for all default settings.
static String	PROP_ZONE_NAME Defines the name of the zone this server belongs to.

Method Summary

String	getCatalogServiceBootstrap() Retrieves the catalog service corbaloc string.
int	getHAManagerPort() Retrieve the High Availability Manager (HA Manager) port.
int	getJMXServicePort() Retrieves the port to be used by the JMX connection.
String	getListenerHost() Retrieves the host to be used by the ORB.
int	getListenerPort() Retrieves the port to be used by the ORB.
int	getMemoryThresholdPercentage() Gets the memory threshold usage percentage, -1 indicates that it was not set.
String	getServerName() Retrieves the name used in identifying this server.
String	getStatsSpecification() Retrieves the statistics specification that this process should start with.
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.
String	getZoneName() Retrieve the zone name.
boolean	isMBeanEnabled() Retrieves whether or not the MBeans are going to be registered.
boolean	isServer() Answers whether or not this process is configured to be an ObjectGrid server process.
boolean	isSystemStreamToFileEnabled() Retrieves the stream to file setting.
void	load(InputStream input) Loads the properties from input into this property object.
void	setCatalogServiceBootstrap(String catalogClusterAddress) Sets the catalog cluster addresses in the form [host:port,host:port,...].
void	setHAManagerPort(int port) Sets the port number for the High Availability Manager (HA Manager).
void	setJMXServicePort(int jmxServicePort) Assigns the port that the JMX service is to bind to.
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	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	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	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	setWorkingDirectory(String workingDirectory) Sets the working directory for the ObjectGrid server runtime to use.
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_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 cluster. 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 server.

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

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 port to be used by the ORB. The listener port property defaults to the corbaloc port, 2809.

Returns:

The port that the ORB is going to be bound to.

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 catalogClusterAddress)

Sets the catalog cluster 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:

catalogClusterAddress - 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.

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.

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

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