| javax.jcr.observation.ObservationManager
| Method Summary | |
| public void | addEventListener(EventListener listener, int eventTypes, String absPath, boolean isDeep, String[] uuid, String[] nodeTypeName, boolean noLocal)
Adds an event listener that listens for the specified eventTypes (a combination of one or more
event types encoded as a bit mask value).
The set of events will be further filtered by the access rights of the
current Session as well as the restrictions specified by the
parameters of this method. | | public EventListenerIterator | getRegisteredEventListeners()
Returns all event listeners that have been registered through this session. | | public void | removeEventListener(EventListener listener)
Deregisters an event listener.
A listener may be deregistered while it is being executed. | | public void | setUserData(String userData)
Sets the user data information that will be returned by
Event.getUserData . |
| addEventListener | | public void addEventListener(EventListener listener, int eventTypes, String absPath, boolean isDeep, String[] uuid, String[] nodeTypeName, boolean noLocal) throws RepositoryException(Code) | | Adds an event listener that listens for the specified eventTypes (a combination of one or more
event types encoded as a bit mask value).
The set of events will be further filtered by the access rights of the
current Session as well as the restrictions specified by the
parameters of this method. These restrictions are stated in terms of
characteristics of the associated parent node of the event.
The associated parent node of an event is the parent node of the item at (or formerly at) the
path returned by
Event.getPath . The following restrictions are available:
-
absPath, isDeep: Only events whose associated parent node is at
absPath (or within its subtree, if isDeep is true) will be received.
It is permissible to register a listener for a path where no node currently exists.
-
uuid: Only events whose associated parent node has one of the identifiers in this list will be
received. If his parameter is null then no identifier-related restriction is placed on events
received. Note that specifying an empty array instead of null
would result in no nodes being listened to. The term "UUID" is used for
compatibility with JCR 1.0.
-
nodeTypeName: Only events whose associated parent node has one of the node types
(or a subtype of one of the node types) in this list will be received. If his parameter is
null then no node type-related restriction is placed on events received.
Note that specifying an empty array instead of null
would result in no nodes types being listened to.
The restrictions are "ANDed" together. In other words, for a particular node to be "listened to" it must meet all the restrictions.
Additionally, if noLocal is true, then events generated by the session through which
the listener was registered are ignored. Otherwise, they are not ignored.
The filters of an already-registered EventListener can be changed at runtime by re-registering the
same EventListener object (i.e. the same actual Java object) with a new set of filter arguments.
The implementation must ensure that no events are lost during the changeover.
In addition to the filters placed on a listener above, the scope of observation
support, in terms of which subtrees are observable, may also be subject to
implementation-specific restrictions. For example, in some repositories
observation of changes in the jcr:system subtree may not be supported
Parameters:
listener - an EventListener object.
Parameters:
eventTypes - A combination of one or more event type constants encoded as a bitmask.
Parameters:
absPath - an absolute path.
Parameters:
isDeep - a boolean.
Parameters:
uuid - array of identifiers.
Parameters:
nodeTypeName - array of node type names.
Parameters:
noLocal - a boolean.
throws:
RepositoryException - If an error occurs. |
| getRegisteredEventListeners | | public EventListenerIterator getRegisteredEventListeners() throws RepositoryException(Code) | | Returns all event listeners that have been registered through this session.
If no listeners have been registered, an empty iterator is returned.
an EventListenerIterator.
throws:
RepositoryException - If an error occurs |
| removeEventListener | | public void removeEventListener(EventListener listener) throws RepositoryException(Code) | | Deregisters an event listener.
A listener may be deregistered while it is being executed. The
deregistration method will block until the listener has completed
executing. An exception to this rule is a listener which deregisters
itself from within the onEvent method. In this case, the
deregistration method returns immediately, but deregistration will
effectively be delayed until the listener completes.
Parameters:
listener - The listener to deregister.
throws:
RepositoryException - If an error occurs. |
|
|