IBM WebSphereTM eXtreme Scale, Release 8.5
API Specification

com.ibm.websphere.objectgrid.stats
Interface ReplicationStatsModule

All Superinterfaces:
StatsModule

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

public interface ReplicationStatsModule
extends StatsModule

This interface represents a statistic module for a replication group member. This statistic module is only applicable in a static ObjectGrid deployment topology.

The path to an replication statistic module is the map set name, concatenated with "/", the partition name, another "/", and then the server name. You can also use an array to represent the path, with the first element being the map set name, the second being the partition name, and the third being the server name.

Since:
WAS XD 6.0.1
See Also:
ObjectGridAdministrator.retrieveStatsModule(String[], int, String)

Field Summary
static int PRIMARY
          Deprecated. Constant used to indicate the type of this replication group member as being a PRIMARY, thus being the read/write source of the cache for this replication group.
static int REPLICA
          Deprecated. Constant used to indicate the type of this replication group member as being a REPLICA, thus receiving completed transactional changes and acting as a backup to the PRIMARY in case of failure.
static int STANDBY
          Deprecated. Constant used to indicate the type of this replication group member as being a STANDBY, thus waiting to be called into service as either a REPLICA or PRIMARY.
 
Fields inherited from interface com.ibm.websphere.objectgrid.stats.StatsModule
MODULE_TYPE_AGENT, MODULE_TYPE_HASHINDEX, MODULE_TYPE_MAP, MODULE_TYPE_OBJECT_GRID, MODULE_TYPE_QUERY, MODULE_TYPE_REPLICATION, MODULE_TYPE_SERVER, MODULE_TYPE_SESSION, MODULE_TYPE_UNDEFINED, PATH_DELIMITER
 
Method Summary
 PercentageStatistic getReplicationGroupMemberState(boolean copyMode)
          Deprecated. Determines the state of a given REPLICA.
 int getReplicationGroupMemberType()
          Deprecated. Determines what type of replication group member is represented by this ReplicationStatsModule.
 
Methods inherited from interface com.ibm.websphere.objectgrid.stats.StatsModule
combine, copy, getPath, getStatsSpec, reset, setGroupModule, statsToString, update
 

Field Detail

STANDBY

static final int STANDBY
Deprecated. 
Constant used to indicate the type of this replication group member as being a STANDBY, thus waiting to be called into service as either a REPLICA or PRIMARY.

See Also:
Constant Field Values

REPLICA

static final int REPLICA
Deprecated. 
Constant used to indicate the type of this replication group member as being a REPLICA, thus receiving completed transactional changes and acting as a backup to the PRIMARY in case of failure.

See Also:
Constant Field Values

PRIMARY

static final int PRIMARY
Deprecated. 
Constant used to indicate the type of this replication group member as being a PRIMARY, thus being the read/write source of the cache for this replication group.

See Also:
Constant Field Values
Method Detail

getReplicationGroupMemberType

int getReplicationGroupMemberType()
Deprecated. 
Determines what type of replication group member is represented by this ReplicationStatsModule.

The constants defined in this interface (STANDBY, REPLICA, PRIMARY) should be used to determine valid return values.

Returns:
an integer indicating what type of replication group member is represented by this ReplicationStatsModule.
See Also:
PRIMARY, REPLICA, STANDBY

getReplicationGroupMemberState

PercentageStatistic getReplicationGroupMemberState(boolean copyMode)
Deprecated. 
Determines the state of a given REPLICA.

If a REPLICA is in the process of being populated by the PRIMARY, the value returned by this method will indicate how close the REPLICA is to being in peer mode. Peer mode means that the REPLICA is now receiving data from the PRIMARY as each transaction completes.

The returned percentages can range from 0 (brand new REPLICA) to 100 (the REPLICA is now in peer mode). A replication group member with type of STANDBY will return a PercentageStatistic of 0. A replication group member with type of PRIMARY will return a PercentageStatistic of 100.

Parameters:
copyMode - if set to true, a copy is returned.
Returns:
PercentageStatistic representing the relative state of a REPLICA

IBM WebSphereTM eXtreme Scale, Release 8.5
API Specification

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