IBM WebSphereTM eXtreme Scale, Release 8.5
API Specification

com.ibm.websphere.objectgrid
Interface ObjectGridAdministrator


Deprecated. The static deployment topology is deprecated in version 7.0. Use the dynamic deployment topology.

public interface ObjectGridAdministrator

This interface allows users to call system management functions on an ObjectGrid cluster from a client process. The methods in this interface can only be used in a static ObjectGrid deployment topology.

Since:
WAS XD 6.0.1
See Also:
ObjectGridManager.getObjectGridAdministrator(ClientClusterContext)

Method Summary
 boolean forceStopServer(String serverName)
          Deprecated. Forcibly stops a server in the ObjectGrid cluster that this object is associated with.
 String[] getReplicationGroupStatus(String replicationGroupName)
          Deprecated. Returns an array showing which servers are the primary and replicas.
 boolean getServerStatus(String serverName)
          Deprecated. Returns the status of server for a specific server in the ObjectGrid cluster that this object is associated with.
 StatsModule retrieveStatsModule(String[] paths, int moduleType, String serverName)
          Deprecated. Retrieves the requested StatsModule.
 void setClusterTraceSpec(String spec)
          Deprecated. Sets the trace specification for the ObjectGrid cluster that this object is associated with.
 void setServerTraceSpec(String server, String spec)
          Deprecated. Sets the trace specification for the specified server in the cluster that this object is associated with.
 boolean stopCluster(boolean force)
          Deprecated. Stops the ObjectGrid cluster that this object is associated with.
 boolean stopServer(String serverName)
          Deprecated. Stops a server in the ObjectGrid cluster that this object is associated with.
 

Method Detail

getServerStatus

boolean getServerStatus(String serverName)
Deprecated. 
Returns the status of server for a specific server in the ObjectGrid cluster that this object is associated with.

Parameters:
serverName - name of server to get status for
Returns:
true if the server is started, false if server is stopped
Throws:
AccessControlException - If the client is not authorized to get the server status
ObjectGridRuntimeException - If the client authentication fails.
IllegalArgumentException - If server does not exist in the cluster

stopServer

boolean stopServer(String serverName)
Deprecated. 
Stops a server in the ObjectGrid cluster that this object is associated with.

Parameters:
serverName - name of the server to be stopped
Returns:
true if the server was stopped, otherwise false if server is already stopped, or if any error occurred when stopping the server.
Throws:
AccessControlException - If the client is not authorized to stop the server
ObjectGridRuntimeException - If the client authentication fails.
IllegalArgumentException - If server does not exist in the cluster

stopCluster

boolean stopCluster(boolean force)
Deprecated. 
Stops the ObjectGrid cluster that this object is associated with.

Specifically, this method stops all of the servers in the cluster to which this object is connected. The method makes a best attempt to stop each server in the cluster, so it always returns true.

Parameters:
force - indicates whether to forcibly stop the cluster
Returns:
true
Throws:
AccessControlException - If the client is not authorized to stop the cluster
ObjectGridRuntimeException - If the client authentication fails.
See Also:
forceStopServer(String)

forceStopServer

boolean forceStopServer(String serverName)
Deprecated. 
Forcibly stops a server in the ObjectGrid cluster that this object is associated with.

Forcibly stopping a server means that if a the server does not stop after a set amount of time the server will be brought down with a call to System.exit(int).

Parameters:
serverName - name of the server to be forcibly stopped
Returns:
true if the server was stopped, otherwise false if the server was already stopped, or if any error occurred when stopping the server.
Throws:
AccessControlException - If the client is not authorized to stop the server
ObjectGridRuntimeException - If the client authentication fails.
IllegalArgumentException - If server does not exist in the cluster

setClusterTraceSpec

void setClusterTraceSpec(String spec)
Deprecated. 
Sets the trace specification for the ObjectGrid cluster that this object is associated with.

Each server in the cluster which this object is connected to will have its trace specification set to the value provided. This operation is a replace operation, not an append operation.

Parameters:
spec - the new trace specification for each server in the cluster
Throws:
AccessControlException - If the client is not authorized to get the cluster trace spec
ObjectGridRuntimeException - If the client authentication fails.

setServerTraceSpec

void setServerTraceSpec(String server,
                        String spec)
Deprecated. 
Sets the trace specification for the specified server in the cluster that this object is associated with.

The server will have its trace specification set to the value provided. This operation is a replace operation, not an append operation.

Parameters:
server - the name of the server that should have its trace specification updated
spec - the new trace specification for the server specified
Throws:
AccessControlException - If the client is not authorized to set the server trace spec
ObjectGridRuntimeException - If the client authentication fails.
IllegalArgumentException - If server does not exist in the cluster

getReplicationGroupStatus

String[] getReplicationGroupStatus(String replicationGroupName)
Deprecated. 
Returns an array showing which servers are the primary and replicas. The first element is the primary and the rest are the replicas.

Parameters:
replicationGroupName - name of the replication group
Returns:
an array of servers names
Throws:
AccessControlException - If the client is not authorized to get the replication status
ObjectGridRuntimeException - If the client authentication fails.
IllegalArgumentException - If replication group does not exist in the cluster

retrieveStatsModule

StatsModule retrieveStatsModule(String[] paths,
                                int moduleType,
                                String serverName)
Deprecated. 
Retrieves the requested StatsModule. If serverName is null, the StatsModules will be combined.

Parameters:
paths -
moduleType -
serverName -
Returns:
StatsModule
Throws:
AccessControlException - If the client is not authorized to retrieve the statistic module
ObjectGridRuntimeException - If the client authentication fails.
IllegalArgumentException - If server does not exist in the cluster
See Also:
StatsModule.MODULE_TYPE_MAP, StatsModule.MODULE_TYPE_OBJECT_GRID, StatsModule.MODULE_TYPE_REPLICATION, StatsModule.MODULE_TYPE_SERVER

IBM WebSphereTM eXtreme Scale, Release 8.5
API Specification

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