|
IBM WebSphereTM eXtreme Scale, Release 8.5 API Specification |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
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 |
---|
boolean getServerStatus(String serverName)
serverName
- name of server to get status for
true
if the server is started, false
if server is stopped
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 clusterboolean stopServer(String serverName)
serverName
- name of the server to be stopped
true
if the server was stopped, otherwise
false
if server is already stopped, or if any error occurred when stopping the server.
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 clusterboolean stopCluster(boolean force)
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.
force
- indicates whether to forcibly stop the cluster
true
AccessControlException
- If the client is not authorized to stop the cluster
ObjectGridRuntimeException
- If the client authentication fails.forceStopServer(String)
boolean forceStopServer(String serverName)
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)
.
serverName
- name of the server to be forcibly stopped
true
if the server was stopped, otherwise
false
if the server was already stopped, or if any error occurred when stopping the server.
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 clustervoid setClusterTraceSpec(String spec)
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.
spec
- the new trace specification for each server in the cluster
AccessControlException
- If the client is not authorized to get the cluster trace spec
ObjectGridRuntimeException
- If the client authentication fails.void setServerTraceSpec(String server, String spec)
The server will have its trace specification set to the value provided. This operation is a replace operation, not an append operation.
server
- the name of the server that should have its trace
specification updatedspec
- the new trace specification for the server specified
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 clusterString[] getReplicationGroupStatus(String replicationGroupName)
replicationGroupName
- name of the replication group
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 clusterStatsModule retrieveStatsModule(String[] paths, int moduleType, String serverName)
StatsModule
. If serverName is null, the StatsModules
will be combined.
paths
- moduleType
- serverName
-
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 clusterStatsModule.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 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |