IBM WebSphereTM eXtreme Scale, Release 8.6
API Specification

com.ibm.websphere.objectgrid.server
Interface Server

All Superinterfaces:
DynamicServerMBean, ServerMBean

public interface Server
extends DynamicServerMBean

The Server is a singleton instance that represents the process scoped elements of an ObjectGrid server.

Since:
WAS XD 6.1 FIX3

Field Summary
static int DISCONNECTED_SERVER_STOP
          Constant that represents that the server stopped due to the server no longer being connected to its catalog server.
static int NORMAL_SERVER_STOP
          Constant that represents that the server stopped normally.
 
Fields inherited from interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
COUNT, DATE_OF_FIRST_OCCURRENCE, EXCEPTION_NAME, FFDC_INCIDENT_DATA, FFDC_NOTIFICATION, LABEL, LEVEL_NAME, LOG_MESSAGE_NOTIFICATION, LOG_RECORD_DATA, LOGGER_NAME, PROBE_ID, SEQUENCE_NUMBER, SERVER_COREGROUP_MEMBERSHIP_CHANGE, SOURCE_CLASS_NAME, SOURCE_ID, SOURCE_METHOD_NAME, THREAD_ID, THROWN_MESSAGE
 
Method Summary
 Container createContainer(DeploymentPolicy policy)
          Instantiates an ObjectGrid container capable of hosting shards for the object grids specified in the policy.
 Collection getContainers()
          Retrieves a Collection of active Container Objects belonging to this Server
 int waitFor()
          Blocks until this server has been shutdown.
 
Methods inherited from interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
checkFFDCNotification, checkLoggingNotification, getAvailableProcessors, getEnvironmentInfo, getFreeMemory, getHostName, getLogNotificationFilter, getMaxMemory, getPrimaryRevisions, getRevisions, getSafeToShutdown, getStatsSpec, getTotalMemory, getTraceSpec, getZoneName, setLogNotificationFilter, setStatsSpec, setTraceSpec
 
Methods inherited from interface com.ibm.websphere.objectgrid.management.ServerMBean
getServerName, modifyServerTraceSpec, stopServer
 

Field Detail

NORMAL_SERVER_STOP

static final int NORMAL_SERVER_STOP
Constant that represents that the server stopped normally.

Since:
7.1
See Also:
waitFor(), Constant Field Values

DISCONNECTED_SERVER_STOP

static final int DISCONNECTED_SERVER_STOP
Constant that represents that the server stopped due to the server no longer being connected to its catalog server.

Since:
7.1
See Also:
waitFor(), Constant Field Values
Method Detail

createContainer

Container createContainer(DeploymentPolicy policy)
                          throws ObjectGridException
Instantiates an ObjectGrid container capable of hosting shards for the object grids specified in the policy. The policy may be built with the DeploymentPolicyFactory from xml files. Precondition: The current Thread context ClassLoader contains the classes used by this container.

Parameters:
policy - The deployment policy used to build the container, may not be null.
Returns:
The container reference.
Throws:
ObjectGridException - If the policy can not be parsed correctly.
See Also:
Thread.setContextClassLoader(java.lang.ClassLoader)

waitFor

int waitFor()
Blocks until this server has been shutdown.

Returns:
The return code indicating the result of the stop.
See Also:
NORMAL_SERVER_STOP, DISCONNECTED_SERVER_STOP

getContainers

Collection getContainers()
Retrieves a Collection of active Container Objects belonging to this Server

Returns:
A Collection of active Container Objects belonging to this Server.
Since:
7.0.0.0 FIX1

IBM WebSphereTM eXtreme Scale, Release 8.6
API Specification

© Copyright International Business Machines Corp 2005,2012. All rights reserved.