IBM WebSphere® DataPower® XC10 Appliance
Release 2.0 Client API Specification

com.ibm.websphere.objectgrid.management
Interface CatalogServiceManagementMBean


public interface CatalogServiceManagementMBean

This MBean interface allows user to manipulate the behaviors of heartbeat and leader manager. The object name pattern for this MBean is:

 com.ibm.websphere.objectgrid:type=CatalogService
 
If ObjectGrid is running in a WebSphere Application Server process, more key=value pairs may be added to the object name.

Since:
7.1, XC10

Field Summary
static java.lang.String COREGROUP_MEMBERSHIP_CHANGE
          Constant representing a core group membership change notification.
static int HEARTBEAT_FREQUENCY_LEVEL_AGGRESSIVE
          Constant representing a heartbeat frequency level at an aggressive rate.
static int HEARTBEAT_FREQUENCY_LEVEL_RELAXED
          Constant representing a heartbeat frequency level at relaxed rate.
static int HEARTBEAT_FREQUENCY_LEVEL_TYPICAL
          Constant representing a heartbeat frequency level at a typical rate.
static java.lang.String SERVER_EVENT_STARTED
          Constant representing an eXtreme Scale server start notification.
static java.lang.String SERVER_EVENT_STOPPED
          Constant representing an eXtreme Scale server stop notification.
 
Method Summary
 int getHeartBeatFrequencyLevel()
          Retrieves the heartbeat frequency level.
 int getNumberOfServers()
          Retrieves the number eXtreme Scale servers that are currently registered with the catalog service.
 javax.management.openmbean.CompositeData getServers()
          Retrieves a CompositeData of each eXtreme Scale server that is currently registered with the catalog service.
 

Field Detail

COREGROUP_MEMBERSHIP_CHANGE

static final java.lang.String COREGROUP_MEMBERSHIP_CHANGE
Constant representing a core group membership change notification. The user data associated with this notification is a CompositeData.

The CompositeData includes the following items:

Item NameTypeDescription
MemberName String The name of the server that is included in the core group.

See Also:
Constant Field Values

SERVER_EVENT_STARTED

static final java.lang.String SERVER_EVENT_STARTED
Constant representing an eXtreme Scale server start notification.

The UserData argument of the Notification includes a TabularData that includes information for each of the servers. Each CompositeData (row in the TabularData) contains the following items:

Item NameTypeDescription
HAPort String The port number of the high availability manager.
Host String The host/ip address of the server.
JMXServiceURL String The JMX service url used to access the server.
ServerName String The name of the server.
ZoneName String The name of the zone that the server belongs.

See Also:
Constant Field Values

SERVER_EVENT_STOPPED

static final java.lang.String SERVER_EVENT_STOPPED
Constant representing an eXtreme Scale server stop notification.

The UserData argument of the Notification includes a TabularData instance where each CompositeData contains the following items:

Item NameTypeDescription
ServerName String The name of the server.

See Also:
Constant Field Values

HEARTBEAT_FREQUENCY_LEVEL_TYPICAL

static final int HEARTBEAT_FREQUENCY_LEVEL_TYPICAL
Constant representing a heartbeat frequency level at a typical rate.

A typical heartbeat frequency allows reasonable failover detection and resource utilization. This value is the default.

See Also:
Constant Field Values

HEARTBEAT_FREQUENCY_LEVEL_AGGRESSIVE

static final int HEARTBEAT_FREQUENCY_LEVEL_AGGRESSIVE
Constant representing a heartbeat frequency level at an aggressive rate.

An increased heartbeat frequency allows failures to be detected more quickly, but can also uses additional CPU and network resources. This level is more sensitive to missing heartbeats when the server is stressed.

See Also:
Constant Field Values

HEARTBEAT_FREQUENCY_LEVEL_RELAXED

static final int HEARTBEAT_FREQUENCY_LEVEL_RELAXED
Constant representing a heartbeat frequency level at relaxed rate.

A decreased heartbeat frequency increases the time to detect failures, but also decreases CPU and network utilization.

See Also:
Constant Field Values
Method Detail

getHeartBeatFrequencyLevel

int getHeartBeatFrequencyLevel()
Retrieves the heartbeat frequency level.

Valid values include:

Returns:
the heartbeat frequency level: -1, 0 or 1 as defined by the constants that begin with name HEARTBEAT_FREQUENCY_LEVEL.

getServers

javax.management.openmbean.CompositeData getServers()
Retrieves a CompositeData of each eXtreme Scale server that is currently registered with the catalog service.

The CompositeData includes the following items:

Item NameTypeDescription
serverName String The name of the server that is registered with the catalog service.

Returns:
the CompositeData representing the currently registered eXtreme Scale servers.

getNumberOfServers

int getNumberOfServers()
Retrieves the number eXtreme Scale servers that are currently registered with the catalog service.

Returns:
the number of registered eXtreme Scale servers.

IBM WebSphere® DataPower® XC10 Appliance
Release 2.0 Client API Specification

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