javax.slee.management

Class SubsystemNotification

java.lang.Object

javax.slee.management.SubsystemNotification

All Implemented Interfaces:

Serializable, Comparable, NotificationSource

public final class SubsystemNotification
extends Object
implements NotificationSource

This class identifies a notification such as an alarm or trace notification as being generated from some internal subsystem in the SLEE.

Since:

SLEE 1.1

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALARM_NOTIFICATION_TYPE The JMX notification type of alarm notifications that are generated in response to an internal component or subsystem of the SLEE interacting with the AlarmFacility (or a similar internal interface).
static String	SUBSYSTEM_NAME_KEY The JMX Object Name property key that identifies the name of the internal subsystem in a Usage MBean whose UsageMBean.NOTIFICATION_SOURCE_KEY property has a value equal to USAGE_NOTIFICATION_TYPE.
static String	TRACE_NOTIFICATION_TYPE The JMX notification type of trace notifications that are generated in response to an internal component or subsystem of the SLEE interacting with a Tracer object (or a similar internal interface).
static String	USAGE_NOTIFICATION_TYPE The JMX notification type of usage notifications that are generated by a UsageMBean containing a SubsystemNotification as a notification source.

Constructor Summary

Constructors

Constructor and Description
SubsystemNotification(String subsystemName) Create a new SubsystemNotification object that uniquely identifies an internal component or subsystem of the SLEE.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Object obj) Compare this notification source with the specified object for order.
protected int	compareTo(String thisClassName, Object that)
boolean	equals(Object obj) Compare this notification source for equality with another object.
String	getAlarmNotificationType() Get the JMX notification type of alarm notifications generated in response to a SLEE internal component or subsystem interacting with the Alarm Facility.
protected String	getClassName() Get the class name of this notification source.
String	getSubsystemName() Get the name of the internal component or subsystem of the SLEE identified by this notification source.
String	getTraceNotificationType() Get the JMX notification type of trace notifications generated in response to a SLEE internal component or subsystem interacting with the Trace Facility.
String	getUsageMBeanProperties() Get a JMX Object Name property string that uniquely identifies the SLEE internal component or subsystem of this notification source, suitable for inclusion in the Object Name of a Usage MBean.
static String	getUsageMBeanProperties(String subsystemName) Get a JMX Object Name property string that uniquely identifies the specified SLEE internal component or subsystem, suitable for inclusion in the Object Name of a Usage MBean.
String	getUsageNotificationType() Get the JMX notification type of usage notifications generated in response to a SLEE internal component or subsystem interacting with its usage parameters.
int	hashCode() Get a hash code value for this notification source.
String	toString() Get a string representation for this notification source.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALARM_NOTIFICATION_TYPE

public static final String ALARM_NOTIFICATION_TYPE

The JMX notification type of alarm notifications that are generated in response to an internal component or subsystem of the SLEE interacting with the AlarmFacility (or a similar internal interface).

The notification type is equal to the string "javax.slee.management.alarm.subsystem".

See Also:

Constant Field Values

TRACE_NOTIFICATION_TYPE

public static final String TRACE_NOTIFICATION_TYPE

The JMX notification type of trace notifications that are generated in response to an internal component or subsystem of the SLEE interacting with a Tracer object (or a similar internal interface).

The notification type is equal to the string "javax.slee.management.trace.subsystem".

See Also:

Constant Field Values

USAGE_NOTIFICATION_TYPE

public static final String USAGE_NOTIFICATION_TYPE

The JMX notification type of usage notifications that are generated by a UsageMBean containing a SubsystemNotification as a notification source.

The notification type is equal to the string "javax.slee.management.usage.subsystem".

See Also:

Constant Field Values

SUBSYSTEM_NAME_KEY

public static final String SUBSYSTEM_NAME_KEY

The JMX Object Name property key that identifies the name of the internal subsystem in a Usage MBean whose UsageMBean.NOTIFICATION_SOURCE_KEY property has a value equal to USAGE_NOTIFICATION_TYPE. This key is equal to the string "subsystemName".

Since:

SLEE 1.1

See Also:

UsageMBean.BASE_OBJECT_NAME, UsageMBean.NOTIFICATION_SOURCE_KEY, Constant Field Values

Constructor Detail

SubsystemNotification

public SubsystemNotification(String subsystemName)

Create a new SubsystemNotification object that uniquely identifies an internal component or subsystem of the SLEE.

Parameters:

subsystemName - the name of the SLEE internal component or subsystem. Subsystem names may be any vendor-defined string.

Throws:

NullPointerException - if subsystemName is null.

Method Detail

getSubsystemName

public String getSubsystemName()

Get the name of the internal component or subsystem of the SLEE identified by this notification source.

Returns:

the name of the internal component or subsystem.

getAlarmNotificationType

public String getAlarmNotificationType()

Get the JMX notification type of alarm notifications generated in response to a SLEE internal component or subsystem interacting with the Alarm Facility.

Specified by:

getAlarmNotificationType in interface NotificationSource

Returns:

the string defined by ALARM_NOTIFICATION_TYPE.

getTraceNotificationType

public String getTraceNotificationType()

Get the JMX notification type of trace notifications generated in response to a SLEE internal component or subsystem interacting with the Trace Facility.

Specified by:

getTraceNotificationType in interface NotificationSource

Returns:

the string defined by TRACE_NOTIFICATION_TYPE.

getUsageNotificationType

public String getUsageNotificationType()

Get the JMX notification type of usage notifications generated in response to a SLEE internal component or subsystem interacting with its usage parameters.

Specified by:

getUsageNotificationType in interface NotificationSource

Returns:

the string defined by USAGE_NOTIFICATION_TYPE.

getUsageMBeanProperties

public static String getUsageMBeanProperties(String subsystemName)

Get a JMX Object Name property string that uniquely identifies the specified SLEE internal component or subsystem, suitable for inclusion in the Object Name of a Usage MBean. This method makes use of the ObjectName.quote(java.lang.String) method to ensure that the name is valid for inclusion as property values in an Object Name.

This method can be used as follows to manually construct a complete Object Name for a Usage MBean:

ObjectName name = new ObjectName(
UsageMBean.BASE_OBJECT_NAME + "," +
UsageMBean.USAGE_PARAMETER_SET_NAME_KEY + "=" + ObjectName.quote(paramSetName) + "," // optional
UsageMBean.NOTIFICATION_SOURCE_KEY + "=" + SubsystemNotification.USAGE_NOTIFICATION_TYPE + "," +
SubsystemNotification.getUsageMBeanProperties(subsystemName)
);

Parameters:

subsystemName - the name of the SLEE internal component or subsystem.

Returns:

an Object Name property string that uniquely identifies the specified internal component or subsystem.

Throws:

NullPointerException - if subsystem is null.

getUsageMBeanProperties

public String getUsageMBeanProperties()

Get a JMX Object Name property string that uniquely identifies the SLEE internal component or subsystem of this notification source, suitable for inclusion in the Object Name of a Usage MBean.

This method is equivalent to getUsageMBeanProperties(getSubsystemName()).

Returns:

an Object Name property string that uniquely identifies the internal component or subsystem.

equals

public boolean equals(Object obj)

Compare this notification source for equality with another object.

Specified by:

equals in interface NotificationSource

Overrides:

equals in class Object

Parameters:

obj - the object to compare this with.

Returns:

true if obj is an instance of this class and contains the subsystem name as this, false otherwise.

See Also:

Object.equals(Object)

hashCode

public int hashCode()

Get a hash code value for this notification source.

Specified by:

hashCode in interface NotificationSource

Overrides:

hashCode in class Object

Returns:

a hash code value for this notification source.

See Also:

Object.hashCode()

toString

public String toString()

Get a string representation for this notification source.

Specified by:

toString in interface NotificationSource

Overrides:

toString in class Object

Returns:

a string representation for this notification source.

See Also:

Object.toString()

compareTo

public int compareTo(Object obj)

Compare this notification source with the specified object for order. Returns a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object.

If obj is a SubsystemNotification, order is determined by comparing the encapsulated subsystem name. Otherwise, if obj is a NotificationSource, ordering is determined by comparing the class name of this class with the class name of obj.

Specified by:

compareTo in interface Comparable

Specified by:

compareTo in interface NotificationSource

Parameters:

obj - the object to compare this with.

Returns:

a negative integer, zero, or a positive integer if this notification source is considered less than, equal to, or greater than the specified object.

Throws:

ClassCastException - if obj does not implement the NotificationSource interface.

See Also:

Comparable.compareTo(Object)

getClassName

protected String getClassName()

Get the class name of this notification source. More efficient than getClass().getName().

Returns:

the class name of this notification source.

compareTo

protected final int compareTo(String thisClassName,
            Object that)