com.ibm.websphere.objectgrid.management
Interface ManagementConcentratorMBean

public interface ManagementConcentratorMBean

This MBean interface allows a client process to access JMX notification history broadcasted by the grid catalog and/or server processes in a dynamic environment. The MBean dynamically re-broadcasts all notifications generated by any of the MBean objects registered in the grid catalogs and servers in both its original format and also a generalised "canonical" format. The object name pattern for this MBean is:

 com.ibm.websphere.objectgrid:type=ManagementConcentrator
 

The following notifications are available:

com.ibm.websphere.objectgrid.management.message

Description:

A notification received from any of the registered MBean objects in the grid catalogs and servers.

UserData:

A CompositeData with the following items representing the generalised "canonical" format:

Item Name	Type	Description	Since
SourceServer	String	The name of the server that generated the notification.	8.6
SeverityLevel	String	The level of severity associated with the notification.	8.6
OriginalType	String	The type of notification before the canonical formatting was applied.	8.6

Message:

The notification message.

Since:

8.6

Since:

8.6

Field Summary

static String	MANAGEMENT_MBEAN_NAME A constant identifying the Management Concentrator MBean name used during MBeanServer registration.
static String	MESSAGE_HUB_NOTIFICATION A constant identifying the canonical formatted notification type for the Management Concentrator.
static String	NOTIFICATION_DATA A constant identifying the composite data name for the Management Concentrator notification.
static String	ORIGINAL_TYPE A constant identifying the composite data representing notification original type.
static String	SEVERITY_LEVEL A constant identifying the composite data representing notification severity level.
static String	SOURCE_SERVER A constant identifying the composite data representing the source of notification.

Method Summary

List<Notification>	getFormattedMessageHistory() Retrieves the most recent history list subset (last 1000) containing notifications in a generalised "canonical" form.
List<Notification>	getFormattedMessageHistory(long first, long last) Retrieves the most recent history list subset of notifications in a generalised "canonical" form, starting with the specified first index and ending with the last index specified.
List<Notification>	getNotificationHistory() Retrieves the most recent (last 1000) notifications list history subset available.
List<Notification>	getNotificationHistory(long first, long last) Retrieves the most recent history list subset of notifications starting with the specified first index and ending with the last index specified.

Field Detail

MESSAGE_HUB_NOTIFICATION

static final String MESSAGE_HUB_NOTIFICATION

A constant identifying the canonical formatted notification type for the Management Concentrator.

Since:

8.6

See Also:

Constant Field Values

MANAGEMENT_MBEAN_NAME

static final String MANAGEMENT_MBEAN_NAME

A constant identifying the Management Concentrator MBean name used during MBeanServer registration.

Since:

8.6

See Also:

Constant Field Values

NOTIFICATION_DATA

static final String NOTIFICATION_DATA

A constant identifying the composite data name for the Management Concentrator notification.

Since:

8.6

See Also:

Constant Field Values

SOURCE_SERVER

static final String SOURCE_SERVER

A constant identifying the composite data representing the source of notification.

Since:

8.6

See Also:

Constant Field Values

SEVERITY_LEVEL

static final String SEVERITY_LEVEL

A constant identifying the composite data representing notification severity level.

Since:

8.6

See Also:

Constant Field Values

ORIGINAL_TYPE

static final String ORIGINAL_TYPE

A constant identifying the composite data representing notification original type.

Since:

8.6

See Also:

Constant Field Values

Method Detail

getNotificationHistory

List<Notification> getNotificationHistory(long first,
                                          long last)

Retrieves the most recent history list subset of notifications starting with the specified first index and ending with the last index specified. Some of the notifications specified by a certain index may no longer be available to return, depending on the timing of request relative to the rate of notifications being generated. In such case, the most recently available notifications (subsequent to the first index specified) will be returned. The notifications in the history list preserve the original content and formatting generated by the originating MBean object registered in the grid catalog or server container.

Parameters:

first - notification (sequence number) of the subset to be retrieved

last - notification (sequence number) of the subset to be retrieved

Returns:

notifications list history subset

Since:

8.6

getNotificationHistory

List<Notification> getNotificationHistory()

Retrieves the most recent (last 1000) notifications list history subset available. The notifications in the history list preserve the original content and formatting generated by the originating MBean object registered in the grid catalog or server container.

Returns:

notifications list history subset (last 1000)

Since:

8.6

getFormattedMessageHistory

List<Notification> getFormattedMessageHistory(long first,
                                              long last)

Retrieves the most recent history list subset of notifications in a generalised "canonical" form, starting with the specified first index and ending with the last index specified. Some of the notifications specified by a certain index may no longer be available to return, depending on the timing of request relative to the rate of notifications being generated. In such case, the most recently available notifications (subsequent to the first index specified) will be returned. The notifications in the history list have the following content:

com.ibm.websphere.objectgrid.management.message

Description:

A notification received from any of the registered MBean objects in the grid catalogs and servers.

UserData:

A CompositeData with the following items representing the generalised "canonical" format:

Item Name	Type	Description	Since
SourceServer	String	The name of the server that generated the notification.	8.6
SeverityLevel	String	The level of severity associated with the notification.	8.6
OriginalType	String	The type of notification before the canonical formatting was applied.	8.6

Message:

The notification message.

Since:

8.6

Parameters:

first - notification (sequence number) of the subset to be retrieved

last - notification (sequence number) of the subset to be retrieved

Returns:

canonically formatted notifications list history subset

Since:

8.6

getFormattedMessageHistory

List<Notification> getFormattedMessageHistory()

Retrieves the most recent history list subset (last 1000) containing notifications in a generalised "canonical" form. The notifications in the history list have the following content:

com.ibm.websphere.objectgrid.management.message

Description:

A notification received from any of the registered MBean objects in the grid catalogs and servers.

UserData:

A CompositeData with the following items representing the generalised "canonical" format:

Item Name	Type	Description	Since
SourceServer	String	The name of the server that generated the notification.	8.6
SeverityLevel	String	The level of severity associated with the notification.	8.6
OriginalType	String	The type of notification before the canonical formatting was applied.	8.6

Message:

The notification message.

Since:

8.6

Returns:

canonically formatted notifications list history subset (last 1000)

Since:

8.6