OpenJDK 27 · javax.naming.event.NamingEvent · APIdia, the JavaDoc alternative

This class represents an event fired by a naming/directory service.

The NamingEvent's state consists of

The event source: the EventContext which fired this event.
The event type.
The new binding: information about the object after the change.
The old binding: information about the object before the change.
Change information: information about the change that triggered this event; usually service provider-specific or server-specific information.

Note that the event source is always the same EventContext instance that the listener has registered with. Furthermore, the names of the bindings in the NamingEvent are always relative to that instance. For example, suppose a listener makes the following registration:

     NamespaceChangeListener listener = ...;
     src.addNamingListener("x", SUBTREE_SCOPE, listener);

When an object named "x/y" is subsequently deleted, the corresponding NamingEvent (evt) must contain:

     evt.getEventContext() == src
     evt.getOldBinding().getName().equals("x/y")

Care must be taken when multiple threads are accessing the same EventContext concurrently. See the package description for more information on threading issues.

Field Summary

Modifier and Type	Field and Description
protected Object	changeInfo Contains information about the change that generated this event.
protected Binding	newBinding Contains information about the object after the change.
public static final int	OBJECT_ADDED Naming event type for indicating that a new object has been added.
public static final int	OBJECT_CHANGED Naming event type for indicating that an object has been changed.
public static final int	OBJECT_REMOVED Naming event type for indicating that an object has been removed.
public static final int	OBJECT_RENAMED Naming event type for indicating that an object has been renamed.
protected Binding	oldBinding Contains information about the object before the change.
private static final long	serialVersionUID Hides java.util.EventObject.serialVersionUID.
protected int	type Contains the type of this event.

Inherited from java.util.EventObject:: source

Constructor Summary

Access	Constructor and Description
public	NamingEvent(EventContext The non-null context that fired this event. source, int The type of the event. type, Binding A possibly null binding before the change. See method description. newBd, Binding A possibly null binding after the change. See method description. oldBd, Object A possibly null object containing information about the change. changeInfo) Constructs an instance of `NamingEvent`.

Method Summary

Modifier and Type	Method and Description
public void	dispatch(NamingListener The nonnull listener. listener) Invokes the appropriate listener method on this event.
public Object	Returns: The possibly null change information of this event. getChangeInfo() Retrieves the change information for this event.
public EventContext	Returns: The non-null context that fired this event. getEventContext() Retrieves the event source that fired this event.
public Binding	Returns: The possibly null binding of the object after the change. getNewBinding() Retrieves the binding of the object after the change.
public Binding	Returns: The possibly null binding of the object before the change. getOldBinding() Retrieves the binding of the object before the change.
public int	Returns: The type of this event. getType() Returns the type of this event.

Inherited from java.util.EventObject:: getSource toString

Field Detail

changeInfo	back to summary
protected Object changeInfo Contains information about the change that generated this event. Annotations @SuppressWarnings:serial

newBinding	back to summary
protected Binding newBinding Contains information about the object after the change.

OBJECT_ADDED	back to summary
public static final int OBJECT_ADDED Naming event type for indicating that a new object has been added. The value of this constant is `0`.

OBJECT_CHANGED back to summary

OBJECT_CHANGED	back to summary
public static final int OBJECT_CHANGED Naming event type for indicating that an object has been changed. The changes might include the object's attributes, or the object itself. Note that some services might fire multiple events for a single modification. For example, the modification might be implemented by first removing the old binding and adding a new binding containing the same name but a different object. The value of this constant is `3`.

public static final int OBJECT_CHANGED

Naming event type for indicating that an object has been changed. The changes might include the object's attributes, or the object itself. Note that some services might fire multiple events for a single modification. For example, the modification might be implemented by first removing the old binding and adding a new binding containing the same name but a different object.

The value of this constant is 3.

OBJECT_REMOVED	back to summary
public static final int OBJECT_REMOVED Naming event type for indicating that an object has been removed. The value of this constant is `1`.

OBJECT_RENAMED back to summary

OBJECT_RENAMED	back to summary
public static final int OBJECT_RENAMED Naming event type for indicating that an object has been renamed. Note that some services might fire multiple events for a single logical rename operation. For example, the rename operation might be implemented by adding a binding with the new name and removing the old binding. The old/new binding in `NamingEvent` may be null if the old name or new name is outside of the scope for which the listener has registered. When an interior node in the namespace tree has been renamed, the topmost node which is part of the listener's scope should used to generate a rename event. The extent to which this can be supported is provider-specific. For example, a service might generate rename notifications for all descendants of the changed interior node and the corresponding provider might not be able to prevent those notifications from being propagated to the listeners. The value of this constant is `2`.

public static final int OBJECT_RENAMED

Naming event type for indicating that an object has been renamed. Note that some services might fire multiple events for a single logical rename operation. For example, the rename operation might be implemented by adding a binding with the new name and removing the old binding.

The old/new binding in NamingEvent may be null if the old name or new name is outside of the scope for which the listener has registered.

When an interior node in the namespace tree has been renamed, the topmost node which is part of the listener's scope should used to generate a rename event. The extent to which this can be supported is provider-specific. For example, a service might generate rename notifications for all descendants of the changed interior node and the corresponding provider might not be able to prevent those notifications from being propagated to the listeners.

The value of this constant is 2.

oldBinding	back to summary
protected Binding oldBinding Contains information about the object before the change.

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.util.EventObject.serialVersionUID.

type back to summary

type	back to summary
protected int type Contains the type of this event. See Also `OBJECT_ADDED`, `OBJECT_REMOVED`, `OBJECT_RENAMED`, `OBJECT_CHANGED`

protected int type

Contains the type of this event.

See Also: OBJECT_ADDED, OBJECT_REMOVED, OBJECT_RENAMED, OBJECT_CHANGED

Constructor Detail

NamingEvent back to summary

NamingEvent	back to summary
public NamingEvent(EventContext source, int type, Binding newBd, Binding oldBd, Object changeInfo) Constructs an instance of `NamingEvent`. The names in `newBd` and `oldBd` are to be resolved relative to the event source `source`. For an `OBJECT_ADDED` event type, `newBd` must not be null. For an `OBJECT_REMOVED` event type, `oldBd` must not be null. For an `OBJECT_CHANGED` event type, `newBd` and `oldBd` must not be null. For an `OBJECT_RENAMED` event type, one of `newBd` or `oldBd` may be null if the new or old binding is outside of the scope for which the listener has registered. Parameters source:EventContext The non-null context that fired this event. type:int The type of the event. newBd:Binding A possibly null binding before the change. See method description. oldBd:Binding A possibly null binding after the change. See method description. changeInfo:Object A possibly null object containing information about the change. See Also `OBJECT_ADDED`, `OBJECT_REMOVED`, `OBJECT_RENAMED`, `OBJECT_CHANGED`

public NamingEvent(EventContext source, int type, Binding newBd, Binding oldBd, Object changeInfo)

Constructs an instance of NamingEvent.

The names in newBd and oldBd are to be resolved relative to the event source source. For an OBJECT_ADDED event type, newBd must not be null. For an OBJECT_REMOVED event type, oldBd must not be null. For an OBJECT_CHANGED event type, newBd and oldBd must not be null. For an OBJECT_RENAMED event type, one of newBd or oldBd may be null if the new or old binding is outside of the scope for which the listener has registered.

Parameters

source:EventContext: The non-null context that fired this event.
type:int: The type of the event.
newBd:Binding: A possibly null binding before the change. See method description.
oldBd:Binding: A possibly null binding after the change. See method description.
changeInfo:Object: A possibly null object containing information about the change.

Method Detail

dispatch back to summary

dispatch	back to summary
public void dispatch(NamingListener listener) Invokes the appropriate listener method on this event. The default implementation of this method handles the following event types: `OBJECT_ADDED, OBJECT_REMOVED, OBJECT_RENAMED, OBJECT_CHANGED`. The listener method is executed in the same thread as this method. See the package description for more information on threading issues. Parameters listener:NamingListener The nonnull listener.

public void dispatch(NamingListener listener)

Invokes the appropriate listener method on this event. The default implementation of this method handles the following event types: OBJECT_ADDED, OBJECT_REMOVED, OBJECT_RENAMED, OBJECT_CHANGED.

The listener method is executed in the same thread as this method. See the package description for more information on threading issues.

Parameters

listener:NamingListener: The nonnull listener.

getChangeInfo	back to summary
public Object getChangeInfo() Retrieves the change information for this event. The value of the change information is service-specific. For example, it could be an ID that identifies the change in a change log on the server. Returns:Object The possibly null change information of this event.

getChangeInfo

back to summary

public Object getChangeInfo()

Retrieves the change information for this event. The value of the change information is service-specific. For example, it could be an ID that identifies the change in a change log on the server.

Returns:Object: The possibly null change information of this event.

getEventContext back to summary

getEventContext	back to summary
public EventContext getEventContext() Retrieves the event source that fired this event. This returns the same object as `EventObject.getSource()`. If the result of this method is used to access the event source, for example, to look up the object or get its attributes, then it needs to be locked because implementations of `Context` are not guaranteed to be thread-safe (and `EventContext` is a subinterface of `Context`). See the package description for more information on threading issues. Returns:EventContext The non-null context that fired this event.

public EventContext getEventContext()

Retrieves the event source that fired this event. This returns the same object as EventObject.getSource().

If the result of this method is used to access the event source, for example, to look up the object or get its attributes, then it needs to be locked because implementations of Context are not guaranteed to be thread-safe (and EventContext is a subinterface of Context). See the package description for more information on threading issues.

Returns:EventContext: The non-null context that fired this event.

getNewBinding back to summary

getNewBinding	back to summary
public Binding getNewBinding() Retrieves the binding of the object after the change. The binding must be nonnull if the object existed after the change relative to the source context (`getEventContext()`). That is, it must be nonnull for `OBJECT_ADDED` and `OBJECT_CHANGED`. For `OBJECT_RENAMED`, it is null if the object after the rename is outside the scope for which the listener registered interest; it is nonnull if the object is inside the scope after the rename. The name in the binding is to be resolved relative to the event source `getEventContext()`. The object returned by `Binding.getObject()` may be null if such information is unavailable. Returns:Binding The possibly null binding of the object after the change.

public Binding getNewBinding()

Retrieves the binding of the object after the change.

The binding must be nonnull if the object existed after the change relative to the source context (getEventContext()). That is, it must be nonnull for OBJECT_ADDED and OBJECT_CHANGED. For OBJECT_RENAMED, it is null if the object after the rename is outside the scope for which the listener registered interest; it is nonnull if the object is inside the scope after the rename.

The name in the binding is to be resolved relative to the event source getEventContext(). The object returned by Binding.getObject() may be null if such information is unavailable.

Returns:Binding: The possibly null binding of the object after the change.

getOldBinding back to summary

getOldBinding	back to summary
public Binding getOldBinding() Retrieves the binding of the object before the change. The binding must be nonnull if the object existed before the change relative to the source context (`getEventContext()`). That is, it must be nonnull for `OBJECT_REMOVED` and `OBJECT_CHANGED`. For `OBJECT_RENAMED`, it is null if the object before the rename is outside of the scope for which the listener has registered interest; it is nonnull if the object is inside the scope before the rename. The name in the binding is to be resolved relative to the event source `getEventContext()`. The object returned by `Binding.getObject()` may be null if such information is unavailable. Returns:Binding The possibly null binding of the object before the change.

public Binding getOldBinding()

Retrieves the binding of the object before the change.

The binding must be nonnull if the object existed before the change relative to the source context (getEventContext()). That is, it must be nonnull for OBJECT_REMOVED and OBJECT_CHANGED. For OBJECT_RENAMED, it is null if the object before the rename is outside of the scope for which the listener has registered interest; it is nonnull if the object is inside the scope before the rename.

The name in the binding is to be resolved relative to the event source getEventContext(). The object returned by Binding.getObject() may be null if such information is unavailable.

Returns:Binding: The possibly null binding of the object before the change.

getType back to summary

getType	back to summary
public int getType() Returns the type of this event. Returns:int The type of this event. See Also `OBJECT_ADDED`, `OBJECT_REMOVED`, `OBJECT_RENAMED`, `OBJECT_CHANGED`

public int getType()

Returns the type of this event.