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

Contains methods for registering listeners to be notified of events fired when objects named in a directory context changes.

The methods in this interface support identification of objects by RFC 2254 search filters.

Using the search filter, it is possible to register interest in objects that do not exist at the time of registration but later come into existence and satisfy the filter. However, there might be limitations in the extent to which this can be supported by the service provider and underlying protocol/service. If the caller submits a filter that cannot be supported in this way, addNamingListener() throws an InvalidSearchFilterException.

See EventContext for a description of event source and target, and information about listener registration/deregistration that are also applicable to methods in this interface. See the package description for information on threading issues.

A SearchControls or array object passed as a parameter to any method is owned by the caller. The service provider will not modify the object or keep a reference to it.

Field Summary

Inherited from javax.naming.directory.DirContext:: ADD_ATTRIBUTE REMOVE_ATTRIBUTE REPLACE_ATTRIBUTE
Inherited from javax.naming.event.EventContext:: OBJECT_SCOPE ONELEVEL_SCOPE SUBTREE_SCOPE

Method Summary

Modifier and Type	Method and Description
public void	addNamingListener(Name The nonnull name of the object resolved relative to this context. target, String The nonnull string filter (see RFC2254). filter, SearchControls The possibly null search controls. If null, the default search controls are used. ctls, NamingListener The nonnull listener. l) Adds a listener for receiving naming events fired when objects identified by the search filter `filter` at the object named by target are modified.
public void	addNamingListener(String The nonnull string name of the object resolved relative to this context. target, String The nonnull string filter (see RFC2254). filter, SearchControls The possibly null search controls. If null, the default search controls is used. ctls, NamingListener The nonnull listener. l) Adds a listener for receiving naming events fired when objects identified by the search filter `filter` at the object named by the string target name are modified.
public void	addNamingListener(Name The nonnull name of the object resolved relative to this context. target, String The nonnull string filter (see RFC2254). filter, Object[] The possibly null array of arguments for the filter. filterArgs, SearchControls The possibly null search controls. If null, the default search controls are used. ctls, NamingListener The nonnull listener. l) Adds a listener for receiving naming events fired when objects identified by the search filter `filter` and filter arguments at the object named by the target are modified.
public void	addNamingListener(String The nonnull string name of the object resolved relative to this context. target, String The nonnull string filter (see RFC2254). filter, Object[] The possibly null array of arguments for the filter. filterArgs, SearchControls The possibly null search controls. If null, the default search controls is used. ctls, NamingListener The nonnull listener. l) Adds a listener for receiving naming events fired when objects identified by the search filter `filter` and filter arguments at the object named by the string target name are modified.

Method Detail

addNamingListener back to summary

addNamingListener	back to summary
public void addNamingListener(Name target, String filter, SearchControls ctls, NamingListener l) throws NamingException Adds a listener for receiving naming events fired when objects identified by the search filter `filter` at the object named by target are modified. The scope, returningObj flag, and returningAttributes flag from the search controls `ctls` are used to control the selection of objects that the listener is interested in, and determines what information is returned in the eventual `NamingEvent` object. Note that the requested information to be returned might not be present in the `NamingEvent` object if they are unavailable or could not be obtained by the service provider or service. Parameters target:Name The nonnull name of the object resolved relative to this context. filter:String The nonnull string filter (see RFC2254). ctls:SearchControls The possibly null search controls. If null, the default search controls are used. l:NamingListener The nonnull listener. Exceptions NamingException: If a problem was encountered while adding the listener. See Also `EventContext#removeNamingListener`, `javax.naming.directory.DirContext#search(javax.naming.Name, java.lang.String, javax.naming.directory.SearchControls)`

public void addNamingListener(Name target, String filter, SearchControls ctls, NamingListener l) throws NamingException

Adds a listener for receiving naming events fired when objects identified by the search filter filter at the object named by target are modified.

The scope, returningObj flag, and returningAttributes flag from the search controls ctls are used to control the selection of objects that the listener is interested in, and determines what information is returned in the eventual NamingEvent object. Note that the requested information to be returned might not be present in the NamingEvent object if they are unavailable or could not be obtained by the service provider or service.

Parameters

target:Name: The nonnull name of the object resolved relative to this context.
filter:String: The nonnull string filter (see RFC2254).
ctls:SearchControls: The possibly null search controls. If null, the default search controls are used.
l:NamingListener: The nonnull listener.

Exceptions

NamingException:: If a problem was encountered while adding the listener.

addNamingListener back to summary

addNamingListener	back to summary
public void addNamingListener(String target, String filter, SearchControls ctls, NamingListener l) throws NamingException Adds a listener for receiving naming events fired when objects identified by the search filter `filter` at the object named by the string target name are modified. See the overload that accepts a `Name` for details of how this method behaves. Parameters target:String The nonnull string name of the object resolved relative to this context. filter:String The nonnull string filter (see RFC2254). ctls:SearchControls The possibly null search controls. If null, the default search controls is used. l:NamingListener The nonnull listener. Exceptions NamingException: If a problem was encountered while adding the listener. See Also `EventContext#removeNamingListener`, `javax.naming.directory.DirContext#search(java.lang.String, java.lang.String, javax.naming.directory.SearchControls)`

public void addNamingListener(String target, String filter, SearchControls ctls, NamingListener l) throws NamingException

Adds a listener for receiving naming events fired when objects identified by the search filter filter at the object named by the string target name are modified. See the overload that accepts a Name for details of how this method behaves.

Parameters

target:String: The nonnull string name of the object resolved relative to this context.
filter:String: The nonnull string filter (see RFC2254).
ctls:SearchControls: The possibly null search controls. If null, the default search controls is used.
l:NamingListener: The nonnull listener.

Exceptions

NamingException:: If a problem was encountered while adding the listener.

addNamingListener back to summary

addNamingListener	back to summary
public void addNamingListener(Name target, String filter, Object[] filterArgs, SearchControls ctls, NamingListener l) throws NamingException Adds a listener for receiving naming events fired when objects identified by the search filter `filter` and filter arguments at the object named by the target are modified. The scope, returningObj flag, and returningAttributes flag from the search controls `ctls` are used to control the selection of objects that the listener is interested in, and determines what information is returned in the eventual `NamingEvent` object. Note that the requested information to be returned might not be present in the `NamingEvent` object if they are unavailable or could not be obtained by the service provider or service. Parameters target:Name The nonnull name of the object resolved relative to this context. filter:String The nonnull string filter (see RFC2254). filterArgs:Object[] The possibly null array of arguments for the filter. ctls:SearchControls The possibly null search controls. If null, the default search controls are used. l:NamingListener The nonnull listener. Exceptions NamingException: If a problem was encountered while adding the listener. See Also `EventContext#removeNamingListener`, `javax.naming.directory.DirContext#search(javax.naming.Name, java.lang.String, java.lang.Object[], javax.naming.directory.SearchControls)`

public void addNamingListener(Name target, String filter, Object[] filterArgs, SearchControls ctls, NamingListener l) throws NamingException

Adds a listener for receiving naming events fired when objects identified by the search filter filter and filter arguments at the object named by the target are modified. The scope, returningObj flag, and returningAttributes flag from the search controls ctls are used to control the selection of objects that the listener is interested in, and determines what information is returned in the eventual NamingEvent object. Note that the requested information to be returned might not be present in the NamingEvent object if they are unavailable or could not be obtained by the service provider or service.

Parameters

target:Name: The nonnull name of the object resolved relative to this context.
filter:String: The nonnull string filter (see RFC2254).
filterArgs:Object[]: The possibly null array of arguments for the filter.
ctls:SearchControls: The possibly null search controls. If null, the default search controls are used.
l:NamingListener: The nonnull listener.

Exceptions

NamingException:: If a problem was encountered while adding the listener.

See Also

EventContext#removeNamingListener,

javax.naming.directory.DirContext#search(javax.naming.Name, java.lang.String, java.lang.Object[], javax.naming.directory.SearchControls)

addNamingListener back to summary

addNamingListener	back to summary
public void addNamingListener(String target, String filter, Object[] filterArgs, SearchControls ctls, NamingListener l) throws NamingException Adds a listener for receiving naming events fired when objects identified by the search filter `filter` and filter arguments at the object named by the string target name are modified. See the overload that accepts a `Name` for details of how this method behaves. Parameters target:String The nonnull string name of the object resolved relative to this context. filter:String The nonnull string filter (see RFC2254). filterArgs:Object[] The possibly null array of arguments for the filter. ctls:SearchControls The possibly null search controls. If null, the default search controls is used. l:NamingListener The nonnull listener. Exceptions NamingException: If a problem was encountered while adding the listener. See Also `EventContext#removeNamingListener`, `javax.naming.directory.DirContext#search(java.lang.String, java.lang.String, java.lang.Object[], javax.naming.directory.SearchControls)`

public void addNamingListener(String target, String filter, Object[] filterArgs, SearchControls ctls, NamingListener l) throws NamingException

Adds a listener for receiving naming events fired when objects identified by the search filter filter and filter arguments at the object named by the string target name are modified. See the overload that accepts a Name for details of how this method behaves.

Parameters

target:String: The nonnull string name of the object resolved relative to this context.
filter:String: The nonnull string filter (see RFC2254).
filterArgs:Object[]: The possibly null array of arguments for the filter.
ctls:SearchControls: The possibly null search controls. If null, the default search controls is used.
l:NamingListener: The nonnull listener.

Exceptions

NamingException:: If a problem was encountered while adding the listener.

See Also

EventContext#removeNamingListener,

javax.naming.directory.DirContext#search(java.lang.String, java.lang.String, java.lang.Object[], javax.naming.directory.SearchControls)

public Interface EventDirContext

Field Summary

Method Summary

Method Detail