javax.slee.management
Class ResourceAdaptorEntityNotification

java.lang.Object
  javax.slee.management.ResourceAdaptorEntityNotification

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable, NotificationSource

public final class ResourceAdaptorEntityNotification
extends java.lang.Object
implements NotificationSource

This class identifies a notification such as an alarm or trace notification as being generated in response to some action performed by a resource adaptor entity. For example, if a resource adaptor entity raises an alarm using the alarm facility, an alarm notification will be generated containing a ResourceAdaptorEntityNotification object that identifies the resource adaptor entity that raised the alarm.

Since:

SLEE 1.1

See Also:

Serialized Form

Field Summary

static java.lang.String	ALARM_NOTIFICATION_TYPE The JMX notification type of alarm notifications that are generated in response to a resource adaptor entity interacting with the AlarmFacility.
static java.lang.String	RESOURCE_ADAPTOR_ENTITY_NAME_KEY The JMX Object Name property key that identifies the name of the resource adaptor entity in a Usage MBean whose UsageMBean.NOTIFICATION_SOURCE_KEY property has a value equal to USAGE_NOTIFICATION_TYPE.
static java.lang.String	TRACE_NOTIFICATION_TYPE The JMX notification type of trace notifications that are generated in response to a resource adaptor entity interacting with a Tracer object.
static java.lang.String	USAGE_NOTIFICATION_TYPE The JMX notification type of usage notifications that are generated by a UsageMBean containing a ResourceAdaptorEntityNotification as a notification source.

Constructor Summary

ResourceAdaptorEntityNotification(java.lang.String entityName)
Create a new ResourceAdaptorEntityNotification object that uniquely identifies a resource adaptor entity.

Method Summary

int	compareTo(java.lang.Object obj) Compare this notification source with the specified object for order.
protected int	compareTo(java.lang.String thisClassName, java.lang.Object that)
boolean	equals(java.lang.Object obj) Compare this notification source for equality with another object.
java.lang.String	getAlarmNotificationType() Get the JMX notification type of alarm notifications generated in response to a resource adaptor entity interacting with the Alarm Facility.
protected java.lang.String	getClassName() Get the class name of this notification source.
java.lang.String	getEntityName() Get the name of the resource adaptor entity of this notification source.
java.lang.String	getTraceNotificationType() Get the JMX notification type of trace notifications generated in response to a resource adaptor entity interacting with the Trace Facility.
java.lang.String	getUsageMBeanProperties() Get a JMX Object Name property string that uniquely identifies the resource adaptor entity of this notification source, suitable for inclusion in the Object Name of a Usage MBean.
static java.lang.String	getUsageMBeanProperties(java.lang.String entityName) Get a JMX Object Name property string that uniquely identifies the specified resource adaptor entity, suitable for inclusion in the Object Name of a Usage MBean.
java.lang.String	getUsageNotificationType() Get the JMX notification type of usage notifications generated in response to a resource adaptor entity interacting with its usage parameters.
int	hashCode() Get a hash code value for this notification source.
java.lang.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 java.lang.String ALARM_NOTIFICATION_TYPE

The JMX notification type of alarm notifications that are generated in response to a resource adaptor entity interacting with the AlarmFacility.

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

See Also:

Constant Field Values

TRACE_NOTIFICATION_TYPE

public static final java.lang.String TRACE_NOTIFICATION_TYPE

The JMX notification type of trace notifications that are generated in response to a resource adaptor entity interacting with a Tracer object.

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

See Also:

Constant Field Values

USAGE_NOTIFICATION_TYPE

public static final java.lang.String USAGE_NOTIFICATION_TYPE

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

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

See Also:

Constant Field Values

RESOURCE_ADAPTOR_ENTITY_NAME_KEY

public static final java.lang.String RESOURCE_ADAPTOR_ENTITY_NAME_KEY

The JMX Object Name property key that identifies the name of the resource adaptor entity 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 "raEntityName".

Since:

SLEE 1.1

See Also:

UsageMBean.BASE_OBJECT_NAME, UsageMBean.NOTIFICATION_SOURCE_KEY, Constant Field Values

Constructor Detail

ResourceAdaptorEntityNotification

public ResourceAdaptorEntityNotification(java.lang.String entityName)

Create a new ResourceAdaptorEntityNotification object that uniquely identifies a resource adaptor entity.

Parameters:

entityName - the name of the resource adaptor entity.

Throws:

java.lang.NullPointerException - if entityName is null.

Method Detail

getEntityName

public java.lang.String getEntityName()

Get the name of the resource adaptor entity of this notification source.

Returns:

the name of the resource adaptor entity.

getAlarmNotificationType

public java.lang.String getAlarmNotificationType()

Get the JMX notification type of alarm notifications generated in response to a resource adaptor entity interacting with the Alarm Facility.

Specified by:

getAlarmNotificationType in interface NotificationSource

Returns:

the string defined by ALARM_NOTIFICATION_TYPE.

getTraceNotificationType

public java.lang.String getTraceNotificationType()

Get the JMX notification type of trace notifications generated in response to a resource adaptor entity interacting with the Trace Facility.

Specified by:

getTraceNotificationType in interface NotificationSource

Returns:

the string defined by TRACE_NOTIFICATION_TYPE.

getUsageNotificationType

public java.lang.String getUsageNotificationType()

Get the JMX notification type of usage notifications generated in response to a resource adaptor entity interacting with its usage parameters.

Specified by:

getUsageNotificationType in interface NotificationSource

Returns:

the string defined by USAGE_NOTIFICATION_TYPE.

getUsageMBeanProperties

public static java.lang.String getUsageMBeanProperties(java.lang.String entityName)

Get a JMX Object Name property string that uniquely identifies the specified resource adaptor entity, 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 resource adaptor entity 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 + "=" + ResourceAdaptorEntityNotification.USAGE_NOTIFICATION_TYPE + "," +
ResourceAdaptorEntityNotification.getUsageMBeanProperties(entityName)
);

Parameters:

entityName - the name of the resource adaptor entity.

Returns:

an Object Name property string that uniquely identifies the resource adaptor entity.

Throws:

java.lang.NullPointerException - if entityName is null.

getUsageMBeanProperties

public java.lang.String getUsageMBeanProperties()

Get a JMX Object Name property string that uniquely identifies the resource adaptor entity of this notification source, suitable for inclusion in the Object Name of a Usage MBean.

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

Returns:

an Object Name property string that uniquely identifies the resource adaptor entity of this notification source.

equals

public boolean equals(java.lang.Object obj)

Compare this notification source for equality with another object.

Specified by:

equals in interface NotificationSource

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to compare this with.

Returns:

true if obj is an instance of this class and contains the same resource adaptor entity 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 java.lang.Object

Returns:

a hash code value for this notification source.

See Also:

Object.hashCode()

toString

public java.lang.String toString()

Get a string representation for this notification source.

Specified by:

toString in interface NotificationSource

Overrides:

toString in class java.lang.Object

Returns:

a string representation for this notification source.

See Also:

Object.toString()

compareTo

public int compareTo(java.lang.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 ResourceAdaptorEntityNotification, order is determined by comparing the encapsulated resource adaptor entity 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 java.lang.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:

java.lang.ClassCastException - if obj does not implement the NotificationSource interface.

See Also:

Comparable.compareTo(Object)

getClassName

protected java.lang.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(java.lang.String thisClassName,
                              java.lang.Object that)