Index (XWiki Commons - Observation

A B C E F G H I M N O R W
All Classes All Packages

A

AbstractCancelableEvent - Class in org.xwiki.observation.event: Abstract base class for cancelable events.
AbstractCancelableEvent() - Constructor for class org.xwiki.observation.event.AbstractCancelableEvent: Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other event of the same type.
AbstractCancelableEvent(String) - Constructor for class org.xwiki.observation.event.AbstractCancelableEvent: Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only events of the same type affecting the same passed name.
AbstractCancelableEvent(EventFilter) - Constructor for class org.xwiki.observation.event.AbstractCancelableEvent: Constructor using a custom EventFilter.
AbstractEventListener - Class in org.xwiki.observation: Base class for EventListeners.
AbstractEventListener(String, Object...) - Constructor for class org.xwiki.observation.AbstractEventListener
AbstractEventListener(String, List<? extends Event>) - Constructor for class org.xwiki.observation.AbstractEventListener
AbstractEventListener(String, Event...) - Constructor for class org.xwiki.observation.AbstractEventListener
AbstractFilterableEvent - Class in org.xwiki.observation.event: An helper to extend for all Events associated to a single String value.
AbstractFilterableEvent() - Constructor for class org.xwiki.observation.event.AbstractFilterableEvent: Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other event of the same type.
AbstractFilterableEvent(String) - Constructor for class org.xwiki.observation.event.AbstractFilterableEvent: Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only events of the same type affecting the same passed name.
AbstractFilterableEvent(EventFilter) - Constructor for class org.xwiki.observation.event.AbstractFilterableEvent: Constructor using a custom EventFilter.
AbstractThreadEventListener - Class in org.xwiki.observation: Filter events by keeping only events produced by the provided Thread.
AbstractThreadEventListener() - Constructor for class org.xwiki.observation.AbstractThreadEventListener: Use Thread.currentThread().
AbstractThreadEventListener(Thread) - Constructor for class org.xwiki.observation.AbstractThreadEventListener
ActionExecutionEvent - Class in org.xwiki.observation.event: Deprecated.
since 3.2M3, use the org.xwiki.bridge.event.ActionExecutedEvent class from XWiki Platform instead
ActionExecutionEvent(String) - Constructor for class org.xwiki.observation.event.ActionExecutionEvent: Deprecated.

Constructor initializing the action name of the event.
addEvent(String, Event) - Method in interface org.xwiki.observation.ObservationManager: Adds an Event to an already registered listener.
addListener(EventListener) - Method in interface org.xwiki.observation.ObservationManager: Manually add a listener.
AllEvent - Class in org.xwiki.observation.event: Special event matcher used by a listener which need to listened to all possible events.
ALLEVENT - Static variable in class org.xwiki.observation.event.AllEvent: Unique instance of the event matcher.
AlwaysMatchingEventFilter - Class in org.xwiki.observation.event.filter: An EventFilter that always matches another event filter.
AlwaysMatchingEventFilter() - Constructor for class org.xwiki.observation.event.filter.AlwaysMatchingEventFilter: Deprecated.
since 6.0M1, use AlwaysMatchingEventFilter.INSTANCE instead
ApplicationStartedEvent - Class in org.xwiki.observation.event: An event triggered when the XWiki application is started.
ApplicationStartedEvent() - Constructor for class org.xwiki.observation.event.ApplicationStartedEvent
ApplicationStoppedEvent - Class in org.xwiki.observation.event: An event triggered when the XWiki application is stopped.
ApplicationStoppedEvent() - Constructor for class org.xwiki.observation.event.ApplicationStoppedEvent

B

BeginEvent - Interface in org.xwiki.observation.event: Implemented by event indicating some task is starting.
BeginFoldEvent - Interface in org.xwiki.observation.event: Implemented by event indicating a task which generates other events during its process is starting.

C

cancel() - Method in class org.xwiki.observation.event.AbstractCancelableEvent
cancel() - Method in interface org.xwiki.observation.event.CancelableEvent: Cancel the event.
cancel(String) - Method in class org.xwiki.observation.event.AbstractCancelableEvent
cancel(String) - Method in interface org.xwiki.observation.event.CancelableEvent: Cancel the event, giving a reason why.
CancelableEvent - Interface in org.xwiki.observation.event: This event can be canceled by the receiver.

E

EndEvent - Interface in org.xwiki.observation.event: Implemented by event indicating some task is stopping.
EndFoldEvent - Interface in org.xwiki.observation.event: Implemented by event indicating the process which generates other events during its process is stopping.
equals(Object) - Method in class org.xwiki.observation.event.AbstractFilterableEvent
equals(Object) - Method in class org.xwiki.observation.event.ActionExecutionEvent: Deprecated.
equals(Object) - Method in class org.xwiki.observation.event.filter.AlwaysMatchingEventFilter
equals(Object) - Method in class org.xwiki.observation.event.filter.FixedNameEventFilter
equals(Object) - Method in class org.xwiki.observation.event.filter.RegexEventFilter
Event - Interface in org.xwiki.observation.event: All Event types must implement this interface.
EventFilter - Interface in org.xwiki.observation.event.filter: Allows writing complex Event matching algorithms for the Event.matches(Object) method.
EventListener - Interface in org.xwiki.observation: Components wanting to receive Observation events must implement this interface.

F

FilterableEvent - Interface in org.xwiki.observation.event: An Event that supports EventFilters.
FixedNameEventFilter - Class in org.xwiki.observation.event.filter: An EventFilter that matches exactly one document name.
FixedNameEventFilter(String) - Constructor for class org.xwiki.observation.event.filter.FixedNameEventFilter: Constructor initializing this event filter with a document name that should be matched.

G

getActionName() - Method in class org.xwiki.observation.event.ActionExecutionEvent: Deprecated.

Gets the name of the action causing this event.
getEventFilter() - Method in class org.xwiki.observation.event.AbstractFilterableEvent
getEventFilter() - Method in interface org.xwiki.observation.event.FilterableEvent: Retrieves the filter used to match this event against other events, used in Event.matches(Object).
getEvents() - Method in class org.xwiki.observation.AbstractEventListener
getEvents() - Method in interface org.xwiki.observation.EventListener
getEvents() - Method in class org.xwiki.observation.WrappedThreadEventListener
getFilter() - Method in class org.xwiki.observation.event.filter.AlwaysMatchingEventFilter
getFilter() - Method in interface org.xwiki.observation.event.filter.EventFilter: Provides access to the filter's criterion.
getFilter() - Method in class org.xwiki.observation.event.filter.FixedNameEventFilter
getFilter() - Method in class org.xwiki.observation.event.filter.RegexEventFilter
getListener(String) - Method in interface org.xwiki.observation.ObservationManager
getName() - Method in class org.xwiki.observation.AbstractEventListener
getName() - Method in interface org.xwiki.observation.EventListener
getName() - Method in class org.xwiki.observation.WrappedThreadEventListener
getReason() - Method in class org.xwiki.observation.event.AbstractCancelableEvent
getReason() - Method in interface org.xwiki.observation.event.CancelableEvent: Get the reason why the event was canceled.

H

hashCode() - Method in class org.xwiki.observation.event.AbstractFilterableEvent
hashCode() - Method in class org.xwiki.observation.event.ActionExecutionEvent: Deprecated.
hashCode() - Method in class org.xwiki.observation.event.filter.AlwaysMatchingEventFilter
hashCode() - Method in class org.xwiki.observation.event.filter.FixedNameEventFilter
hashCode() - Method in class org.xwiki.observation.event.filter.RegexEventFilter

I

INSTANCE - Static variable in class org.xwiki.observation.event.filter.AlwaysMatchingEventFilter: Unique instance of AlwaysMatchingEventFilter.
isCanceled() - Method in class org.xwiki.observation.event.AbstractCancelableEvent
isCanceled() - Method in interface org.xwiki.observation.event.CancelableEvent: Check if this event was canceled by one of the receivers.
isIn(BeginEvent) - Method in interface org.xwiki.observation.ObservationContext: Indicates if the provided begin event is still in the current event stack.

M

matches(Object) - Method in class org.xwiki.observation.event.AbstractFilterableEvent: Compares two events to see if they match, meaning that a listener that registered to receive notifications like referenceEvent will be notified of any occuring event for which referenceEvent.matches(occuringEvent) will return true.
matches(Object) - Method in class org.xwiki.observation.event.ActionExecutionEvent: Deprecated.
matches(Object) - Method in class org.xwiki.observation.event.AllEvent
matches(Object) - Method in class org.xwiki.observation.event.ApplicationStartedEvent
matches(Object) - Method in class org.xwiki.observation.event.ApplicationStoppedEvent
matches(Object) - Method in interface org.xwiki.observation.event.Event: Compares two events to see if they match, meaning that a listener that registered to receive notifications like referenceEvent will be notified of any occuring event for which referenceEvent.matches(occuringEvent) will return true.
matches(EventFilter) - Method in class org.xwiki.observation.event.filter.AlwaysMatchingEventFilter
matches(EventFilter) - Method in interface org.xwiki.observation.event.filter.EventFilter: Compares two event filters to see if they match, meaning that the "contexts" of two events are compatible.
matches(EventFilter) - Method in class org.xwiki.observation.event.filter.FixedNameEventFilter
matches(EventFilter) - Method in class org.xwiki.observation.event.filter.RegexEventFilter

N

notify(Event, Object) - Method in interface org.xwiki.observation.ObservationManager: Convenience front-end where the additional data parameter is null.
notify(Event, Object, Object) - Method in interface org.xwiki.observation.ObservationManager: Call the registered listeners matching the passed Event.

O

ObservationContext - Interface in org.xwiki.observation: Allow to get observation related information from the execution context.
ObservationManager - Interface in org.xwiki.observation: The main orchestrator for event notification.
onEvent(Event, Object, Object) - Method in class org.xwiki.observation.AbstractThreadEventListener
onEvent(Event, Object, Object) - Method in interface org.xwiki.observation.EventListener: The ObservationManager calls this method when an event matches one of the events for which this listener is registered (see EventListener.getEvents().
onEventInternal(Event, Object, Object) - Method in class org.xwiki.observation.AbstractThreadEventListener: Called when the event has been produce by the proper Thread.
onEventInternal(Event, Object, Object) - Method in class org.xwiki.observation.WrappedThreadEventListener
org.xwiki.observation - package org.xwiki.observation
org.xwiki.observation.event - package org.xwiki.observation.event
org.xwiki.observation.event.filter - package org.xwiki.observation.event.filter

R

RegexEventFilter - Class in org.xwiki.observation.event.filter: An EventFilter that selects only events whose affected document name matches a regular expression.
RegexEventFilter(String) - Constructor for class org.xwiki.observation.event.filter.RegexEventFilter: Constructor initializing this event filter with a regular expression that should be matched.
removeEvent(String, Event) - Method in interface org.xwiki.observation.ObservationManager: Removes an Event to an already registered listener.
removeListener(String) - Method in interface org.xwiki.observation.ObservationManager: Remove a listener from the list of registered listeners.

W

WrappedThreadEventListener - Class in org.xwiki.observation: Wraps a provided EventListener and filters events by only keeping those coming from the provided Thread.
WrappedThreadEventListener(EventListener) - Constructor for class org.xwiki.observation.WrappedThreadEventListener: Use Thread.currentThread().
WrappedThreadEventListener(EventListener, Thread) - Constructor for class org.xwiki.observation.WrappedThreadEventListener

A B C E F G H I M N O R W
All Classes All Packages