|
IBM WebSphere® DataPower® XC10 Appliance Release 1.0 Client API Specification |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PlacementServiceMBean
This MBean interface allows a client process to perform operations on and get status from the PlacementService running in a dynamic environment. The object name pattern for this MBean is:
com.ibm.websphere.objectgrid:type=PlacementServiceIf ObjectGrid is running in a WebSphere Application Server process, more key=value pairs may be added to the object name.
Field Summary | |
---|---|
static int |
ALL
Constant representing a all shard types |
static int |
ASYNCHRONOUS_REPLICA
Constant representing an asynchronous replica shard type. |
static int |
PRIMARY
Constant representing a primary shard type. |
static int |
SYNCHRONOUS_REPLICA
Constant representing a synchronous replica shard type. |
Fields inherited from interface com.ibm.websphere.objectgrid.management.CoreGroupServiceMBean |
---|
HEARTBEAT_FREQUENCY_LEVEL_AGGRESSIVE, HEARTBEAT_FREQUENCY_LEVEL_RELAXED, HEARTBEAT_FREQUENCY_LEVEL_TYPICAL, STATUS_QUORUM_DISABLED, STATUS_QUORUM_ENABLED_NORMAL, STATUS_QUORUM_ENABLED_WAITING, STATUS_QUORUM_INCONSISTENT, STATUS_QUORUM_OVERRIDE |
Method Summary | |
---|---|
java.lang.String |
collectContainerStatus(java.lang.String objectGridName,
java.lang.String mapSetName)
Retrieves the container status for all containers in the domain. |
java.lang.String |
getCoreGroups()
Gets the coregroup status. |
java.lang.String |
getObjectGridNames()
Gets the names of all ObjectGrids and their mapsets in the domain. |
java.lang.String |
listCoreGroupMembers(java.lang.String coreGroupName)
List the coregroup members for a given coregroup. |
java.lang.String |
listObjectGridPlacement(java.lang.String objectGridName,
java.lang.String mapSetName)
List the placement of shards for each container in the domain. |
java.lang.String |
listObjectGridPlacementStatus(java.lang.String objectGridName,
java.lang.String mapSetName)
List the current placement status. |
java.lang.String |
listPartition(java.lang.String objectGridName,
java.lang.String mapSetName,
java.lang.String partitionId)
List the partition placement status in the domain. |
java.lang.String |
listShards(java.lang.String objectGridName,
java.lang.String mapSetName,
java.lang.String containerName,
int mask)
List the shard placement status. |
java.lang.String |
listVerifiedRoutingTable(java.lang.String objectGridName)
Calling this method will return an XML string of the current known routing table. |
java.lang.String |
replaceLostShards(java.lang.String objectGridName,
java.lang.String mapSetName)
Lost shards are placed onto the UNREPAIRED container when autoReplaceLostShards is disabled. |
java.util.List |
retrieveAllServersJMXAddresses()
Retrieves a List of JMX addresses for all servers that have registered with the placement service. |
java.lang.String |
retrieveMapSetName(java.lang.String gridName,
java.lang.String mapName)
Retrieves the name of the MapSet in which the specified map is defined. |
java.util.List |
retrieveServerJMXAddress(java.lang.String hostName,
java.lang.String serverName)
Retrieves a List of JMX address strings for a specific host and server name that has registered with the placement service. |
java.lang.String |
tearDownServers(java.lang.String[] servers)
Each of the container servers that are passed into this method will be stopped. |
java.lang.String |
triggerPlacement(java.lang.String objectGridName,
java.lang.String mapSetName)
Placement normally occurs implicitly after an event such as an ObjectGrid container starting or stopping. |
Methods inherited from interface com.ibm.websphere.objectgrid.management.CoreGroupServiceMBean |
---|
getHeartBeatFrequencyLevel, getQuorumActivationStatus, overrideQuorum, setHeartBeatFrequencyLevel |
Field Detail |
---|
static final int PRIMARY
static final int SYNCHRONOUS_REPLICA
static final int ASYNCHRONOUS_REPLICA
static final int ALL
Method Detail |
---|
java.util.List retrieveServerJMXAddress(java.lang.String hostName, java.lang.String serverName)
hostName
- The name of the host to retrieve the JMX addresses.serverName
- The name of the server to retrieve the JMX addresses.
java.util.List retrieveAllServersJMXAddresses()
java.lang.String collectContainerStatus(java.lang.String objectGridName, java.lang.String mapSetName)
The results are returned in the following format:
<container name="<container>" zoneName="<zone>" hostName="<host>" serverName="<server>"> <shard type="<type>" partitionName="<partition>"/> </container>
objectGridName
- The name of the ObjectGrid for which to get container status.mapSetName
- The name of the mapset for which to get the container status.
java.lang.String listObjectGridPlacement(java.lang.String objectGridName, java.lang.String mapSetName)
The results are returned in the following format:
<objectGrid name="<objectgrid>" mapSetName="<mapset"> <container name="<container>" zoneName="<zone>" hostName="<host>" serverName="<server>"> <shard type="<type>" partitionName="<partition>" reserved="<true>"/> /container> </objectGrid>NOTE: The default value for the "reserved" is false.
objectGridName
- The name of the ObjectGrid for which to get placement status.mapSetName
- The name of the mapset for which to get the placement status.
java.lang.String listObjectGridPlacementStatus(java.lang.String objectGridName, java.lang.String mapSetName)
The results are returned in the following format:
<objectGrid name="<objectgrid>" mapSetName="<mapset>"> <configuration> <attribute name="<placementStrategy>" value="<strategy>"/> <attribute name="<numInitialContainers>" value="<num>"/> <attribute name="<minSyncReplicas>" value="<min>"/> <attribute name="<developmentMode>" value="<mode>"/> </configuration> <runtime> <attribute name="<numContainers>" value="<num>"/> <attribute name="<numMachines>" value="<num>"/> <attribute name="<numOutstandingWorkItems>" value="<num>"/> <attribute name="<numActiveZones>" value="<num>"/> </runtime> </objectGrid>
objectGridName
- The name of the ObjectGrid for which to get placement status.mapSetName
- The name of the mapset for which to get the placement status.
java.lang.String getCoreGroups()
The results are returned in the following format:
<coreGroup name="<coregroup>"> <coreGroupLeader hostName="<host>" serverName="<server>"/> <coreGroupMember hostName="<host>" serverName="<server>"/> </coreGroup>
java.lang.String listCoreGroupMembers(java.lang.String coreGroupName)
The results are returned in the following format:
<coreGroup name="<coregroup>"> <coreGroupMember hostName="<host>" serverName="<server>"/> </coreGroup>
coreGroupName
- The name of the coregroup for which to get the members.
java.lang.String listPartition(java.lang.String objectGridName, java.lang.String mapSetName, java.lang.String partitionId)
<partition name="<partition>"> <shard type="<type>" containerName="<container>" hostName="<host>" serverName="<server>"/> </partition>
objectGridName
- The name of the ObjectGrid for which to get placement status.mapSetName
- The name of the mapset for which to get the placement status.partitionId
- The name of the partition for which to get the placement status.
java.lang.String listShards(java.lang.String objectGridName, java.lang.String mapSetName, java.lang.String containerName, int mask)
The results are returned in the following format:
<objectGrid name="<objectgrid>" mapSetName="<mapset>"> <container name="<container>" zoneName="<zone>" hostName="<host>" serverName="<server>"> <shard type="<type>" partitionName="<partition>"/> </container> </objectGrid>
objectGridName
- The name of the ObjectGrid for which to get placement status.mapSetName
- The name of the mapset for which to get the placement status.containerName
- The name of the container for which to get the placement status. If empty string ( "" ), get shard
placement for all containers.mask
- The Integer mask to determine for which shard types to get status.
ALL
,
PRIMARY
,
SYNCHRONOUS_REPLICA
,
ASYNCHRONOUS_REPLICA
java.lang.String getObjectGridNames()
The results are returned in the following format:
<objectGrid name="<objectgrid>" mapSetName="<mapset>"/>
java.lang.String replaceLostShards(java.lang.String objectGridName, java.lang.String mapSetName)
Calling this method will move shards off the UNREPAIRED container onto the UNASSIGNED container.
Balance and placement operations will be queued up for the MapSet specified. These operations will execute when all outstanding placement work from previous events has completed.
The string returned is an XML representation of the shards that moved as a result of the call to this method.
<objectGrid name="<objectgrid>" mapSetName="<mapset>"> <shard type="<type>" partitionName="<partition>"> <currentContainer name="<container>" zoneName="<zone>" hostName="<host>" serverName="<server>"/> <previousContainer name="<container>" zoneName="<zone>" hostName="<host>" serverName="<server>"/> </shard> </objectGrid>
The returned XML will look as follows when no shards have been moved:
<objectGrid name="<objectgrid>" mapSetName="<mapset>"> <!-- No shards were moved --> </objectGrid>
objectGridName
- replace lost shards for this ObjectGridmapSetName
- replace lost shards for this MapSet
java.lang.String triggerPlacement(java.lang.String objectGridName, java.lang.String mapSetName)
Calling this method will trigger a placement operation for the ObjectGrid and MapSet specified.
Under normal circumstances, the numInitialContainers attribute (in the deployment policy) must be met in order for placement to occur. However, when this method is called, the numInitialContainers value is ignored.
The string returned is an XML representation of the shards that moved as a result of the call to this method.
<objectGrid name="<objectgrid>" mapSetName="<mapset>"> <shard type="<type>" partitionName="<partition>"> <currentContainer name="<container>" zoneName="<zone>" hostName="<host>" serverName="<server>"/> <previousContainer name="<container>" zoneName="<zone>" hostName="<host>" serverName="<server>"/> </shard> </objectGrid>
The returned XML will look as follows when no shards have been moved:
<objectGrid name="<objectgrid>" mapSetName="<mapset>"> <!-- No shards were moved --> </objectGrid>
objectGridName
- trigger placement for this ObjectGridmapSetName
- trigger placement for this MapSet
ObjectGridDeployment.addMapSet(com.ibm.websphere.objectgrid.deployment.MapSet)
,
MapSet.setNumInitialContainers(int)
java.lang.String tearDownServers(java.lang.String[] servers)
Use this method if servers are found to be in a corrupt state or bindings need to be cleared from the catalog server.
The string returned is an XML representation of the results of the attempt to tear down each of the servers.
<domain name="<domain>"> <server name="<server>" tearDownSuccessful="<boolean>"/> <server name="<server>" tearDownSuccessful="<boolean>"/> </domain>
servers
- String array of servers to tear down.
java.lang.String listVerifiedRoutingTable(java.lang.String objectGridName)
<objectGrid name="<objectgrid>" name="<name>"> <primary zone="<zone>"> partition="<partition>"> state="<reachable>"> ipaddress="<ipaddress>"> <replica zone="<zone>"> partition="<partition>"> state="<reachable>"> ipaddress="<ipaddress>"> </primary> </objectGrid>
objectGridName
- retrieve routing table for this ObjectGrid
java.lang.String retrieveMapSetName(java.lang.String gridName, java.lang.String mapName)
gridName
- the name of the ObjectGridmapName
- the name of the map
|
IBM WebSphere® DataPower® XC10 Appliance Release 1.0 Client API Specification |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |