Class NamingEvent
- All Implemented Interfaces:
Serializable
public class NamingEvent extends EventObject
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:
When an object named "x/y" is subsequently deleted, the correspondingNamespaceChangeListener listener = ...; src.addNamingListener("x", SUBTREE_SCOPE, listener);
NamingEvent
(evt
) must contain: Care must be taken when multiple threads are accessing the sameevt.getEventContext() == src evt.getOldBinding().getName().equals("x/y")
EventContext
concurrently. See the package description for more information on threading issues.- Since:
- 1.3
- See Also:
Field Summary
Modifier and Type | Field | Description |
---|---|---|
protected Object |
changeInfo |
Contains information about the change that generated this event. |
protected Binding |
newBinding |
Contains information about the object after the change. |
static final int |
OBJECT_ADDED |
Naming event type for indicating that a new object has been added. |
static final int |
OBJECT_CHANGED |
Naming event type for indicating that an object has been changed. |
static final int |
OBJECT_REMOVED |
Naming event type for indicating that an object has been removed. |
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. |
protected int |
type |
Contains the type of this event. |
Fields declared in class java.util.EventObject
source
Constructor Summary
Constructor | Description |
---|---|
NamingEvent |
Constructs an instance of NamingEvent . |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
void |
dispatch |
Invokes the appropriate listener method on this event. |
Object |
getChangeInfo() |
Retrieves the change information for this event. |
EventContext |
getEventContext() |
Retrieves the event source that fired this event. |
Binding |
getNewBinding() |
Retrieves the binding of the object after the change. |
Binding |
getOldBinding() |
Retrieves the binding of the object before the change. |
int |
getType() |
Returns the type of this event. |
Methods declared in class java.util.EventObject
getSource, toString
Field Details
OBJECT_ADDED
public static final int OBJECT_ADDED
0
.- See Also:
OBJECT_REMOVED
public static final int OBJECT_REMOVED
1
.- See Also:
OBJECT_RENAMED
public static final int OBJECT_RENAMED
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
.
- See Also:
OBJECT_CHANGED
public static final int OBJECT_CHANGED
The value of this constant is 3
.
- See Also:
changeInfo
protected Object changeInfo
type
protected int type
oldBinding
protected Binding oldBinding
newBinding
protected Binding newBinding
Constructor Details
NamingEvent
public NamingEvent(EventContext source, int type, Binding newBd, Binding oldBd, Object changeInfo)
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
- The non-null context that fired this event. -
type
- The type of the event. -
newBd
- A possibly null binding before the change. See method description. -
oldBd
- A possibly null binding after the change. See method description. -
changeInfo
- A possibly null object containing information about the change. - See Also:
Method Details
getType
public int getType()
- Returns:
- The type of this event.
- See Also:
getEventContext
public EventContext getEventContext()
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:
- The non-null context that fired this event.
getOldBinding
public Binding getOldBinding()
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:
- The possibly null binding of the object before the change.
getNewBinding
public Binding getNewBinding()
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:
- The possibly null binding of the object after the change.
getChangeInfo
public Object getChangeInfo()
- Returns:
- The possibly null change information of this event.
dispatch
public void dispatch(NamingListener listener)
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
- The nonnull listener.
© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.naming/javax/naming/event/NamingEvent.html