org.xwiki.bridge.event

Class ActionExecutingEvent

java.lang.Object

org.xwiki.bridge.event.AbstractActionExecutionEvent

org.xwiki.bridge.event.ActionExecutingEvent

All Implemented Interfaces:

Serializable, ActionExecutionEvent, org.xwiki.observation.event.BeginEvent, org.xwiki.observation.event.CancelableEvent, org.xwiki.observation.event.Event

public class ActionExecutingEvent
extends AbstractActionExecutionEvent
implements org.xwiki.observation.event.CancelableEvent, org.xwiki.observation.event.BeginEvent

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

The event also send the following parameters:

• source: the current {com.xpn.xwiki.doc.XWikiDocument} instance
• data: the current {com.xpn.xwiki.XWikiContext} instance

Since:

3.2M3

Version:

$Id: a31d8166bb2986eee08ed06e05f29abf4d6663cb $

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ActionExecutingEvent() Match any ActionExecutingEvent.
ActionExecutingEvent(String actionName) Constructor initializing the action name of the event.

Method Summary

Modifier and Type	Method and Description
void	cancel()
void	cancel(String reason)
String	getReason()
boolean	isCanceled()

Methods inherited from class org.xwiki.bridge.event.AbstractActionExecutionEvent

equals, getActionName, hashCode, matches, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xwiki.observation.event.Event

matches

Constructor Detail

ActionExecutingEvent

public ActionExecutingEvent()

Match any ActionExecutingEvent.

ActionExecutingEvent

public ActionExecutingEvent(String actionName)

Constructor initializing the action name of the event.

Parameters:

actionName - the name of the executed action

Method Detail

isCanceled

public boolean isCanceled()

Specified by:

isCanceled in interface org.xwiki.observation.event.CancelableEvent

cancel

public void cancel()

Specified by:

cancel in interface org.xwiki.observation.event.CancelableEvent

cancel

public void cancel(String reason)

Specified by:

cancel in interface org.xwiki.observation.event.CancelableEvent

getReason

public String getReason()

Specified by:

getReason in interface org.xwiki.observation.event.CancelableEvent