org.springframework.jmx.support

Class NotificationListenerHolder

java.lang.Object

org.springframework.jmx.support.NotificationListenerHolder

Direct Known Subclasses:

NotificationListenerBean, NotificationListenerRegistrar

public class NotificationListenerHolder
extends java.lang.Object

Helper class that aggregates a <code>NotificationListener</code>, a <code>NotificationFilter</code>, and an arbitrary handback object, as well as the names of MBeans from which the listener wishes to receive <code>Notifications</code>.

Since:

2.5.2

Author:

Juergen Hoeller

See Also:

NotificationListenerBean, NotificationListenerRegistrar

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Object	handback
protected java.util.Set<java.lang.Object>	mappedObjectNames
private javax.management.NotificationFilter	notificationFilter
private javax.management.NotificationListener	notificationListener

Constructor Summary

Constructors

Constructor and Description
NotificationListenerHolder()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)
java.lang.Object	getHandback() Return the (arbitrary) object that will be 'handed back' as-is by an <code>NotificationBroadcaster</code> when notifying any <code>NotificationListener</code>.
javax.management.NotificationFilter	getNotificationFilter() Return the <code>NotificationFilter</code> associated with the encapsulated NotificationFilter.
javax.management.NotificationListener	getNotificationListener() Get the <code>NotificationListener</code>.
javax.management.ObjectName[]	getResolvedObjectNames() Return the list of <code>ObjectName</code> String representations for which the encapsulated NotificationFilter will be registered as a listener for <code>Notifications</code>.
int	hashCode()
void	setHandback(java.lang.Object handback) Set the (arbitrary) object that will be 'handed back' as-is by an <code>NotificationBroadcaster</code> when notifying any <code>NotificationListener</code>.
void	setMappedObjectName(java.lang.Object mappedObjectName) Set the <code>ObjectName</code>-style name of the single MBean that the encapsulated NotificationFilter will be registered with to listen for <code>Notifications</code>.
void	setMappedObjectNames(java.lang.Object[] mappedObjectNames) Set an array of <code>ObjectName</code>-style names of the MBeans that the encapsulated NotificationFilter will be registered with to listen for <code>Notifications</code>.
void	setNotificationFilter(javax.management.NotificationFilter notificationFilter) Set the <code>NotificationFilter</code> associated with the encapsulated NotificationFilter.
void	setNotificationListener(javax.management.NotificationListener notificationListener) Set the <code>NotificationListener</code>.

Methods inherited from class java.lang.Object

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

Field Detail

notificationListener

private javax.management.NotificationListener notificationListener

notificationFilter

private javax.management.NotificationFilter notificationFilter

handback

private java.lang.Object handback

mappedObjectNames

protected java.util.Set<java.lang.Object> mappedObjectNames

Constructor Detail

NotificationListenerHolder

public NotificationListenerHolder()

Method Detail

setNotificationListener

public void setNotificationListener(javax.management.NotificationListener notificationListener)

Set the <code>NotificationListener</code>.

getNotificationListener

public javax.management.NotificationListener getNotificationListener()

Get the <code>NotificationListener</code>.

setNotificationFilter

public void setNotificationFilter(javax.management.NotificationFilter notificationFilter)

Set the <code>NotificationFilter</code> associated with the encapsulated NotificationFilter.

May be null.

getNotificationFilter

public javax.management.NotificationFilter getNotificationFilter()

Return the <code>NotificationFilter</code> associated with the encapsulated NotificationFilter.

May be null.

setHandback

public void setHandback(java.lang.Object handback)

Set the (arbitrary) object that will be 'handed back' as-is by an <code>NotificationBroadcaster</code> when notifying any <code>NotificationListener</code>.

Parameters:

handback - the handback object (can be null)

See Also:

NotificationListener.handleNotification(javax.management.Notification, Object)

getHandback

public java.lang.Object getHandback()

Return the (arbitrary) object that will be 'handed back' as-is by an <code>NotificationBroadcaster</code> when notifying any <code>NotificationListener</code>.

Returns:

the handback object (may be null)

See Also:

NotificationListener.handleNotification(javax.management.Notification, Object)

setMappedObjectName

public void setMappedObjectName(java.lang.Object mappedObjectName)

Set the <code>ObjectName</code>-style name of the single MBean that the encapsulated NotificationFilter will be registered with to listen for <code>Notifications</code>. Can be specified as ObjectName instance or as String.

See Also:

setMappedObjectNames(java.lang.Object[])

setMappedObjectNames

public void setMappedObjectNames(java.lang.Object[] mappedObjectNames)

Set an array of <code>ObjectName</code>-style names of the MBeans that the encapsulated NotificationFilter will be registered with to listen for <code>Notifications</code>. Can be specified as ObjectName instances or as Strings.

See Also:

setMappedObjectName(java.lang.Object)

getResolvedObjectNames

public javax.management.ObjectName[] getResolvedObjectNames()
                                                     throws javax.management.MalformedObjectNameException

Return the list of <code>ObjectName</code> String representations for which the encapsulated NotificationFilter will be registered as a listener for <code>Notifications</code>.

Throws:

javax.management.MalformedObjectNameException - if an ObjectName is malformed

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object