com.ibm.websphere.objectgrid.management
Interface DynamicServerMBean

All Superinterfaces:

ServerMBean

All Known Subinterfaces:

Server

public interface DynamicServerMBean
extends ServerMBean

This MBean interface allows a client process to access different attributes about a specific server process in a dynamic environment. The object name pattern for this MBean is:

 com.ibm.websphere.objectgrid:type=ObjectGridServer,name=<server>,host=<host>,ogServerName=<server>
 

If ObjectGrid is running in a WebSphere Application Server process, more key=value pairs may be added to the object name.

The following notifications are available:

og.server.container.coregroup.membership.change

Description:	All core group membership changes detected by the server's core group manager.
UserData:	The number of members in the core group.
Message:	The name of the core group.
Since:	6.1 FIX 3

com.ibm.websphere.objectgrid.log

Description:

All log messages detected by the log notification filter. See the setLogNotificationFilter(String) attribute.

UserData:

A CompositeData with the following items:

Item Name	Type	Description	Since
LevelName	String	The log record severity level.	8.6
LoggerName	String	The name of the logger.	8.6
SourceClassName	String	The originating log record class name.	8.6
SourceMethodName	String	The originating log record method name.	8.6
SequenceNumber	Long	The log record sequence number	8.6
ThreadID	Integer	The originating log record thread id.	8.6
ThrownMessage	String	The thrown exception message or empty string, if not available.	8.6

Message:

The log message.

Since:

8.6

com.ibm.websphere.objectgrid.ffdc

Description:

All first-failure data captured by the grid server.

UserData:

A CompositeData with the following items:

Item Name	Type	Description	Since
SourceID	String	The source code generating the exception.	8.6
ProbeID	String	The source code location associated with the exception captured.	8.6
ExceptionName	String	The exception captured.	8.6
Count	Integer	The current occurrence count for the specified exception.	8.6
DateOfFirstOccurrence	String	The exception's first occurrence time stamp.	8.6
Label	String	The label associated with the captured exception occurrence.	8.6

Message:

A notification was generated on the server for a new exception.

Since:

8.6

Since:

WAS XD 6.1 FIX3, XC10

Field Summary

static String	COUNT
static String	DATE_OF_FIRST_OCCURRENCE
static String	EXCEPTION_NAME
static String	FFDC_INCIDENT_DATA
static String	FFDC_NOTIFICATION
static String	LABEL
static String	LEVEL_NAME
static String	LOG_MESSAGE_NOTIFICATION The constant identifying the notification type for log messages.
static String	LOG_RECORD_DATA
static String	LOGGER_NAME
static String	PROBE_ID
static String	SEQUENCE_NUMBER
static String	SERVER_COREGROUP_MEMBERSHIP_CHANGE A constant identifying the notification type for all core group membership changes detected by this server.
static String	SOURCE_CLASS_NAME
static String	SOURCE_ID
static String	SOURCE_METHOD_NAME
static String	THREAD_ID
static String	THROWN_MESSAGE

Method Summary

void	checkFFDCNotification() Triggers a simulated exception to be captured as a first-failure data capture (FFDC) event (and subsequently broadcasted as a JMX notification), as a means to test and verify the monitoring being enabled on the server.
void	checkLoggingNotification() Generates a set of log records with various severity levels, providing a simple means to test and verify when the JMX notification monitoring being enabled on the grid server.
int	getAvailableProcessors() Returns the number of available processors for the JVM hosting this server.
CompositeData	getEnvironmentInfo() Retrieve the environment information for the server (host name, WebSphere eXtreme Scale version, and additional information).
long	getFreeMemory() Returns the available memory in bytes for the JVM hosting this server.
String	getHostName() Returns the host name for this process.
String	getLogNotificationFilter() Retrieves current regular expression filter being applied while screening log record messages before being broadcasted as JMX notifications by the grid server as a JMX Notification of type:
long	getMaxMemory() Returns the maximum memory in bytes for the JVM hosting this server.
TabularData	getPrimaryRevisions() Provides revisions for all primary shards in the container in the form of a TabularData object, where each CompositeData (row in the TabularData) contains the following items:
TabularData	getRevisions() Provides revisions for all shards in the server in the form of a TabularData object, where each CompositeData (row in the TabularData) contains the following items:
boolean	getSafeToShutdown() Returns true if a replica exists for each primary hosted on this server.
String	getStatsSpec() Retrieve the current statistics specification for the server.
long	getTotalMemory() Returns the total memory in bytes for the JVM hosting this server.
String	getTraceSpec() Retrieve the current trace specification for the server.
String	getZoneName() Returns the zone name for this process
void	setLogNotificationFilter(String regExFilter) Sets the regular expression filter to be applied in screening log record messages before being broadcasted by the grid server as a JMX Notification of type:
void	setStatsSpec(String statsSpec) Set the statistics specification for the server.
void	setTraceSpec(String traceSpec) Set the trace specification for the server.

Methods inherited from interface com.ibm.websphere.objectgrid.management.ServerMBean

getServerName, modifyServerTraceSpec, stopServer

Field Detail

SERVER_COREGROUP_MEMBERSHIP_CHANGE

static final String SERVER_COREGROUP_MEMBERSHIP_CHANGE

A constant identifying the notification type for all core group membership changes detected by this server.

Since:

6.1 FIX 3

See Also:

Constant Field Values

LOG_MESSAGE_NOTIFICATION

static final String LOG_MESSAGE_NOTIFICATION

The constant identifying the notification type for log messages.

Since:

8.6

See Also:

Constant Field Values

FFDC_NOTIFICATION

static final String FFDC_NOTIFICATION

See Also:

Constant Field Values

LOG_RECORD_DATA

static final String LOG_RECORD_DATA

See Also:

Constant Field Values

THROWN_MESSAGE

static final String THROWN_MESSAGE

See Also:

Constant Field Values

THREAD_ID

static final String THREAD_ID

See Also:

Constant Field Values

SEQUENCE_NUMBER

static final String SEQUENCE_NUMBER

See Also:

Constant Field Values

SOURCE_METHOD_NAME

static final String SOURCE_METHOD_NAME

See Also:

Constant Field Values

SOURCE_CLASS_NAME

static final String SOURCE_CLASS_NAME

See Also:

Constant Field Values

LOGGER_NAME

static final String LOGGER_NAME

See Also:

Constant Field Values

LEVEL_NAME

static final String LEVEL_NAME

See Also:

Constant Field Values

FFDC_INCIDENT_DATA

static final String FFDC_INCIDENT_DATA

See Also:

Constant Field Values

SOURCE_ID

static final String SOURCE_ID

See Also:

Constant Field Values

PROBE_ID

static final String PROBE_ID

See Also:

Constant Field Values

LABEL

static final String LABEL

See Also:

Constant Field Values

DATE_OF_FIRST_OCCURRENCE

static final String DATE_OF_FIRST_OCCURRENCE

See Also:

Constant Field Values

COUNT

static final String COUNT

See Also:

Constant Field Values

EXCEPTION_NAME

static final String EXCEPTION_NAME

See Also:

Constant Field Values

Method Detail

getAvailableProcessors

int getAvailableProcessors()

Returns the number of available processors for the JVM hosting this server.

Returns:

The answer from the Runtime call on the JVM hosting this server.

See Also:

Runtime.availableProcessors()

getFreeMemory

long getFreeMemory()

Returns the available memory in bytes for the JVM hosting this server.

Returns:

The answer from the Runtime call on the JVM hosting this server.

See Also:

Runtime.freeMemory()

getMaxMemory

long getMaxMemory()

Returns the maximum memory in bytes for the JVM hosting this server.

Returns:

The answer from the Runtime call on the JVM hosting this server.

See Also:

Runtime.maxMemory()

getTotalMemory

long getTotalMemory()

Returns the total memory in bytes for the JVM hosting this server.

Returns:

The answer from the Runtime call on the JVM hosting this server.

See Also:

Runtime.totalMemory()

getHostName

String getHostName()

Returns the host name for this process.

Returns:

The answer from the Runtime call on the JVM hosting this server.

See Also:

InetAddress.getHostName()

getZoneName

String getZoneName()

Returns the zone name for this process

Returns:

the zone name that was included in the properties used to start the server or DefaultZone if no zone name was used

getSafeToShutdown

boolean getSafeToShutdown()

Returns true if a replica exists for each primary hosted on this server. Returns false if the server has the only copy of data.

Returns:

If server is safe to shutdown.

getStatsSpec

String getStatsSpec()

Retrieve the current statistics specification for the server.

Returns:

a string representation of the statistics specification.

Since:

7.1

See Also:

StatsSpec

setStatsSpec

void setStatsSpec(String statsSpec)

Set the statistics specification for the server.

Parameters:

statsSpec - the statistics specification string.

Since:

7.1

See Also:

StatsSpec

getTraceSpec

String getTraceSpec()

Retrieve the current trace specification for the server.

Returns:

the trace specification string.

Since:

7.1

setTraceSpec

void setTraceSpec(String traceSpec)

Set the trace specification for the server.

Parameters:

traceSpec - the statistics specification string.

Since:

7.1

See Also:

ObjectGridManager.setTraceSpecification(String)

getEnvironmentInfo

CompositeData getEnvironmentInfo()

Retrieve the environment information for the server (host name, WebSphere eXtreme Scale version, and additional information). The CompositeData contains the following items:

Item Name	Type	Description
JMXServicePort	String	JMX Service Port
WASServerName	String	WebSphere Application Server Full Server Name
JVMVersion	String	JAVA Version
JMXConnectorPort	String	JMX Connector Port
IPAddress	String	IP Address
JavaVM	String	JVM Version
WASInstallRoot	String	WebSphere Application Server Product Directory
OSGIFrameworkVersion	String	OSGi Version
ClientPort	String	Client Port
HostName	String	Host name
Timestamp	String	Time Stamp from Server
WASBaseVersion	String	IBM WebSphere Application Server Version
OSName	String	Operating System
XSInstallRoot	String	WebSphere eXtreme Scale Product Directory
OSArch	String	OS Architecture
PeerPort	String	Peer Port
ServerType	String	Server Type
HAManagerPort	String	HAManager Port
JVMInstallPath	String	JAVA Directory
XC10Model	String	Machine Type and Model
JavaRuntimeInfo	String	JVM Runtime Version
xioContainerTCPNonSecure	String	XIO TCP/IP Port
JMXServiceURL	String	JMX Service Port
listenerPort	String	Listener Port (ORB)
ServerName	String	Server Name
WASXDVersion	String	IBM WebSphere Application Server - XD Version
WASExpressVersion	String	IBM WebSphere Application Server - ND Version
JavaBitMode	String	JAVA Bit Mode
XSVersion	String	WebSphere eXtreme Scale Version
JVMVendor	String	JAVA Vendor
OSVersion	String	Operating System Version
xioContainerTCPSecure	String	XIO TCP/IP SSL Port
PID	String	Process ID
WASNDVersion	String	IBM WebSphere Application Server - ND Version
ORB Version	String	ORB Version

Returns:

CompositeData containing the environment information

Since:

8.5

setLogNotificationFilter

void setLogNotificationFilter(String regExFilter)

Sets the regular expression filter to be applied in screening log record messages before being broadcasted by the grid server as a JMX Notification of type:

com.ibm.websphere.objectgrid.log

UserData:

A CompositeData with the following items:

Item Name	Type	Description	Since
LevelName	String	The logging level.	8.6
LoggerName	String	The name of the logger.	8.6
SourceClassName	String	The class name.	8.6
SourceMethodName	String	The method name.	8.6
SequenceNumber	Long	The sequence number	8.6
ThreadID	Integer	The thread id.	8.6
ThrownMessage	String	The thrown exception message or empty string, if not available.	8.6

Message:

The log message.

Since:

8.6

Parameters:

regExFilter - The regular expression filter to applied in screening log record messages.

Since:

8.6

getLogNotificationFilter

String getLogNotificationFilter()

Retrieves current regular expression filter being applied while screening log record messages before being broadcasted as JMX notifications by the grid server as a JMX Notification of type:

com.ibm.websphere.objectgrid.log

UserData:

A CompositeData with the following items:

Item Name	Type	Description	Since
LevelName	String	The logging level.	8.6
LoggerName	String	The name of the logger.	8.6
SourceClassName	String	The class name.	8.6
SourceMethodName	String	The method name.	8.6
SequenceNumber	Long	The sequence number	8.6
ThreadID	Integer	The thread id.	8.6
ThrownMessage	String	The thrown exception message or empty string, if not available.	8.6

Message:

The log message.

Since:

8.6

Returns:

Current regular expression filter being applied in screening log record messages.

Since:

8.6

checkFFDCNotification

void checkFFDCNotification()

Triggers a simulated exception to be captured as a first-failure data capture (FFDC) event (and subsequently broadcasted as a JMX notification), as a means to test and verify the monitoring being enabled on the server. The JMX notification generated and broadcasted has the following type and content:

com.ibm.websphere.objectgrid.ffdc

Description:

All first-failure data captured by the grid server.

UserData:

A CompositeData with the following items:

Item Name	Type	Description	Since
SourceID	String	The source code generating the exception.	8.6
ProbeID	String	The source code location associated with the exception captured.	8.6
ExceptionName	String	The exception captured.	8.6
Count	Integer	The current occurrence count for the specified exception.	8.6
DateOfFirstOccurrence	String	The exception's first occurrence time stamp.	8.6
Label	String	The label associated with the captured exception occurrence.	8.6

Message:

A simulated first-failure data capture (FFDC) exception notification was generated by the server.

Since:

8.6

Since:

8.6

checkLoggingNotification

void checkLoggingNotification()

Generates a set of log records with various severity levels, providing a simple means to test and verify when the JMX notification monitoring being enabled on the grid server. Each of the JMX notifications generated and broadcasted has the following type and content:

com.ibm.websphere.objectgrid.log

UserData:

A CompositeData with the following items:

Item Name	Type	Description	Since
LevelName	String	The logging level.	8.6
LoggerName	String	The name of the logger.	8.6
SourceClassName	String	The class name.	8.6
SourceMethodName	String	The method name.	8.6
SequenceNumber	Long	The sequence number	8.6
ThreadID	Integer	The thread id.	8.6
ThrownMessage	String	A simulated log info/warning/error notification was generated by the server	8.6

Message:

A simulated log info/warning/error notification was generated by the server.

Since:

8.6

Since:

8.6

getRevisions

TabularData getRevisions()

Provides revisions for all shards in the server in the form of a TabularData object, where each CompositeData (row in the TabularData) contains the following items:

Item Name	Type	Description	Since
Grid	String	The object grid name.	8.6
MapSet	String	The name of the mapSet.	8.6
PartitionNumber	Integer	The number of a given partition.	8.6
ContainerName	String	Name of the container.	8.6
ShardType	String	Type of the shard.	8.6
RevisionState	TabularData	The lifetimeId / revisionNumber info for a given partition.	8.6

The RevisionState TabularData's CompositeData contains the following items:

Item Name	Type	Description	Since
LifetimeId	Long	The LifetimeId for the shard	8.6
Revision	Long	The revision number	8.6

Returns:

A TabularData object with the revision information.

Since:

8.6

getPrimaryRevisions

TabularData getPrimaryRevisions()

Provides revisions for all primary shards in the container in the form of a TabularData object, where each CompositeData (row in the TabularData) contains the following items:

Item Name	Type	Description	Since
Grid	String	The object grid name.	8.6
MapSet	String	The name of the mapSet.	8.6
PartitionNumber	Integer	The number of a given partition.	8.6
ContainerName	String	Name of the container.	8.6
ShardType	String	Type of the shard.	8.6
RevisionState	TabularData	The lifetimeId / revisionNumber info for a given partition.	8.6

The RevisionState TabularData's CompositeData contains the following items:

Item Name	Type	Description	Since
LifetimeId	Long	The LifetimeId for the shard	8.6
Revision	Long	The revision number	8.6

Returns:

A TabularData object with the revision information.

Since:

8.6