Class NotificationListenerHolder

java.lang.Object

org.springframework.jmx.support.NotificationListenerHolder

Direct Known subclasses:

NotificationListenerBean, NotificationListenerRegistrar

public class NotificationListenerHolder
extends Object

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

since:

2.5.2

Author:

Juergen Hoeller

see Also:

• NotificationListenerBean
• NotificationListenerRegistrar

Field summary

Fields

Modifier and Type	Field	Description
protected @Nullable set<Object>	mappedObjectNames	&nbsp;

Constructor summary

Constructors

Constructor	Description
NotificationListenerHolder()	 

Method summary

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

Methods inherited from class Object

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

Field Details

mappedObjectNames

protected&nbsp;@Nullable set<Object>&nbsp;mappedObjectNames

Constructor Details

NotificationListenerHolder

public NotificationListenerHolder()

Method Details

setNotificationListener

public void setNotificationListener(@Nullable NotificationListener notificationListener)

set the NotificationListener.

getNotificationListener

public @Nullable NotificationListener getNotificationListener()

Get the NotificationListener.

setNotificationFilter

public void setNotificationFilter(@Nullable NotificationFilter notificationFilter)

set the NotificationFilter associated with the encapsulated NotificationFilter.

May be null.

getNotificationFilter

public @Nullable NotificationFilter getNotificationFilter()

Return the NotificationFilter associated with the encapsulated NotificationListener.

May be null.

setHandback

public void setHandback(@Nullable Object handback)

set the (arbitrary) object that will be 'handed back' as-is by an NotificationBroadcaster when notifying any NotificationListener.

Parameters:

handback - the handback object (can be null)

see Also:

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

getHandback

public @Nullable Object getHandback()

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

Returns:

the handback object (may be null)

see Also:

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

setMappedObjectName

public void setMappedObjectName(@Nullable Object mappedObjectName)

set the ObjectName-style name of the single MBean that the encapsulated NotificationFilter will be registered with to listen for Notifications. Can be specified as ObjectName instance or as string.

see Also:

• setMappedObjectNames(Object...)

setMappedObjectNames

public void setMappedObjectNames(Object... mappedObjectNames)

set an array of ObjectName-style names of the MBeans that the encapsulated NotificationFilter will be registered with to listen for Notifications. Can be specified as ObjectName instances or as strings.

see Also:

• setMappedObjectName(Object)

getResolvedObjectNames

public ObjectName @Nullable [] getResolvedObjectNames()
                                               throws MalformedObjectNameException

Return the list of ObjectName string representations for which the encapsulated NotificationFilter will be registered as a listener for Notifications.

Throws:

MalformedObjectNameException - if an ObjectName is malformed

equals

public boolean equals(@Nullable Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object