CatalogServiceManagementMBean (IBM WebSphere eXtreme Scale API Specification)

Overview

Package

Class

Tree

Serialized

Deprecated

Index

Help

IBM WebSphere^TM eXtreme Scale, Release 8.6
API Specification

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ibm.websphere.objectgrid.management
Interface CatalogServiceManagementMBean

public interface CatalogServiceManagementMBean

This MBean interface allows user to manipulate the behaviors of heartbeat and leader manager and other catalog service specific actions. 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 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 String`	`ORB` Constant representing the ORB or Object Request Broker transport
`static String`	`SERVER_EVENT_STARTED` Constant representing an eXtreme Scale server start notification.
`static String`	`SERVER_EVENT_STOPPED` Constant representing an eXtreme Scale server stop notification.
`static String`	`XIO` Constant representing the eXtremeIO transport

Method Summary
`TabularData`	`getContainerReplicationState()` Provides the numbers of outstanding in-bound and out-bound revisions which need to be replicated cross containers within one domain.
`TabularData`	`getDomainReplicationState()` Provides the numbers of outstanding in-bound and out-bound revisions which need to be replicated cross domains.
`int`	`getHeartBeatFrequencyLevel()` Retrieves the heartbeat frequency level.
`int`	`getNumberOfServers()` Retrieves the number eXtreme Scale servers that are currently registered with the catalog service.
`CompositeData`	`getServers()` Retrieves a CompositeData of each eXtreme Scale server that is currently registered with the catalog service.
`String`	`getTransport()` Returns the transport used by the catalog service domain.
`boolean`	`isPrimary()` Provides indication if the catalog is primary.
`void`	`logMessage(String level, String message)` Provides support for logging user messages from processes outside the catalog and/or container servers.

Field Detail

COREGROUP_MEMBERSHIP_CHANGE

static final 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 Name	Type	Description
MemberName	String	The name of the server that is included in the core group.

See Also:: Constant Field Values

SERVER_EVENT_STARTED

static final 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 Name	Type	Description
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 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 Name	Type	Description
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

ORB

static final String ORB

Constant representing the ORB or Object Request Broker transport

See Also:: Constant Field Values

XIO

static final String XIO

Constant representing the eXtremeIO transport

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

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 Name	Type	Description
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.

logMessage

void logMessage(String level,
                String message)

Provides support for logging user messages from processes outside the catalog and/or container servers. Example: XC10 surfaced SNMP trap messages can be flowed from the SNMP agent which throws traps in the console server (sMash) process, not typically an XS catalog/container server.

Parameters:: level - name describing the severity of the event which is compatible with java.util.logging.Level.parse(String name) where name may be either level name (ex. "SEVERE") or an integer value (ex. "1000") - @see Level.parse(String); message - for the end user (already sNLS rendered)
Since:: 8.6

isPrimary

boolean isPrimary()

Provides indication if the catalog is primary.

Returns:: true for primary catalog.
Since:: 8.6

getContainerReplicationState

TabularData getContainerReplicationState()

Provides the numbers of outstanding in-bound and out-bound revisions which need to be replicated cross containers within one domain. For a given container, outstanding out-bound revisions need to be replicated from primary shards located in this container into replicas located in other containers. In similar way, outstanding in-bound revisions need to be replicated from primary shards located in other containers into corresponding replicas located in this container. This operation can be used to check the differences in data revisions between containers within one domain.

The result is a TabularData object, where each CompositeData (row in the TabularData) contains the following items:

Item Name	Type	Description	Since
Container	String	The container ID.	8.6
OutboundRevisions	Long	Number of out-bound revisions for container.	8.6
InboundRevisions	Long	Number of in-bound revisions for container.	8.6

Returns:: A TabularData object with the container replication state information.
Since:: 8.6

getDomainReplicationState

TabularData getDomainReplicationState()

Provides the numbers of outstanding in-bound and out-bound revisions which need to be replicated cross domains. Outstanding out-bound revisions need to be replicated from local primary shards into corresponding remote primary shards. Outstanding in-bound revisions need to be replicated from remote primary shards into corresponding local primary shards. This operation can be used to check the differences in data revisions between different domains linked by MMR replication.