org.xwiki.observation.event

Class ActionExecutionEvent

java.lang.Object

org.xwiki.observation.event.ActionExecutionEvent

All Implemented Interfaces:

Serializable, Event

Deprecated.

since 3.2M3, use org.xwiki.bridge.event.ActionExecutedEvent instead

@Deprecated
public class ActionExecutionEvent
extends Object
implements Event, Serializable

An event triggered whenever a client request (action) is processed, like /upload/ or /view/. A specific event corresponds to only one action type.

Version:

$Id: 6ae92b02b03195ba9f82fdbe5f6de0a0ce48af32 $

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ActionExecutionEvent(String actionName) Deprecated. Constructor initializing the action name of the event.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object object) Deprecated.
String	getActionName() Deprecated. Gets the name of the action causing this event.
int	hashCode() Deprecated.
boolean	matches(Object otherEvent) Deprecated. 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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ActionExecutionEvent

public ActionExecutionEvent(String actionName)

Deprecated.

Constructor initializing the action name of the event.

Parameters:

actionName - the name of the executed action

Method Detail

getActionName

public String getActionName()

Deprecated.

Gets the name of the action causing this event.

Returns:

the action causing this event, like upload or login

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Deprecated.

Overrides:

equals in class Object

matches

public boolean matches(Object otherEvent)

Deprecated.

Description copied from interface: 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. The matching algorithm depends on the event implementation. For example for Document events two events match if they implement the same event class and if their EventFilter match. Note that the implementation is left open in order to cater for all the possible ways this Observation component can be used.

Specified by:

matches in interface Event

Parameters:

otherEvent - the occuring event matched against the current object

Returns:

true if the passed event matches this event, false otherwise.