|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.util.EventObject org.apache.wiki.event.WikiEvent org.apache.wiki.event.WikiPageEvent
public class WikiPageEvent
WikiPageEvent indicates a change in the state or processing of a WikiPage. There are basically two types of page events:
E.g., a typical event sequence for the pre-translate phase would be:
These two events are fired once per page request, at the beginning
and after delivery of the page (respectively). They are generated
by the WikiServletFilter
.
Page lock and unlock events occur only once during an editing session,
so there are no begin and end events. They are generated
by the PageManager
.
Other WikiPageEvents include both phase boundary and in-phase
events for saving, pre- and post-translating content. These are very noisy
event types, but are not fired unless a listener is available. They are
generated by the DefaultFilterManager
,
PageEventFilter
, and potentially other
implementing classes.
Note that due to the asynchronous nature of event processing, any threads spawned by such events will not necessarily have completed during their specific phase; we can assume only that no more events of that phase will be fired after its *_END event has been fired.
WikiEvent
,
Serialized FormField Summary | |
---|---|
static int |
PAGE_DELETE_REQUEST
Indicates a wiki page delete event (the beginning of a delete request). |
static int |
PAGE_DELETED
Indicates a wiki page deleted event (after the delete has been completed). |
static int |
PAGE_DELIVERED
Indicates a wiki page delivery event (the end of a request). |
static int |
PAGE_LOCK
Indicates a page lock event. |
static int |
PAGE_REQUESTED
Indicates a wiki page request event (the start of a request). |
static int |
PAGE_UNLOCK
Indicates a page unlock event. |
static int |
POST_SAVE
Indicates a wiki post-save page event. |
static int |
POST_SAVE_BEGIN
Indicates the beginning of all wiki post-save page events. |
static int |
POST_SAVE_END
Indicates the end of all wiki post-save page events. |
static int |
POST_TRANSLATE
Indicates a wiki post-translate page event. |
static int |
POST_TRANSLATE_BEGIN
Indicates the beginning of all wiki post-translate page events. |
static int |
POST_TRANSLATE_END
Indicates the end of all wiki post-translate page events. |
static int |
PRE_SAVE
Indicates a wiki pre-save page event. |
static int |
PRE_SAVE_BEGIN
Indicates the beginning of all wiki pre-save page events. |
static int |
PRE_SAVE_END
Indicates the end of all wiki pre-save page events. |
static int |
PRE_TRANSLATE
Indicates a wiki pre-translate page event. |
static int |
PRE_TRANSLATE_BEGIN
Indicates the beginning of all wiki pre-translate page events. |
static int |
PRE_TRANSLATE_END
Indicates the end of all wiki pre-translate page events. |
Fields inherited from class org.apache.wiki.event.WikiEvent |
---|
ERROR, UNDEFINED |
Fields inherited from class java.util.EventObject |
---|
source |
Constructor Summary | |
---|---|
WikiPageEvent(Object src,
int type,
String pagename)
Constructs an instance of this event. |
Method Summary | |
---|---|
String |
eventName()
Returns a textual representation of the event type. |
String |
getPageName()
Returns the Wiki page name associated with this event. |
String |
getTypeDescription()
Returns a human-readable description of the event type. |
static boolean |
isValidType(int type)
Returns true if the int value is a WikiPageEvent type. |
Methods inherited from class org.apache.wiki.event.WikiEvent |
---|
getSrc, getType, getWhen, setType, toString |
Methods inherited from class java.util.EventObject |
---|
getSource |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int PAGE_LOCK
PageManager
.
public static final int PAGE_UNLOCK
PageManager
.
public static final int PRE_TRANSLATE_BEGIN
DefaultFilterManager
.
public static final int PRE_TRANSLATE
PageEventFilter
.
public static final int PRE_TRANSLATE_END
DefaultFilterManager
.
public static final int POST_TRANSLATE_BEGIN
DefaultFilterManager
.
public static final int POST_TRANSLATE
PageEventFilter
.
public static final int POST_TRANSLATE_END
DefaultFilterManager
.
public static final int PRE_SAVE_BEGIN
DefaultFilterManager
.
public static final int PRE_SAVE
PageEventFilter
.
public static final int PRE_SAVE_END
DefaultFilterManager
.
public static final int POST_SAVE_BEGIN
DefaultFilterManager
.
public static final int POST_SAVE
PageEventFilter
.
public static final int POST_SAVE_END
DefaultFilterManager
.
public static final int PAGE_REQUESTED
WikiServletFilter
.
public static final int PAGE_DELIVERED
WikiServletFilter
.
public static final int PAGE_DELETE_REQUEST
WikiServletFilter
.
public static final int PAGE_DELETED
WikiServletFilter
.
Constructor Detail |
---|
public WikiPageEvent(Object src, int type, String pagename)
src
- the Object that is the source of the event.type
- the type of the event (see the enumerated int values defined
in WikiEvent
).pagename
- the WikiPage being acted upon.Method Detail |
---|
public String getPageName()
public static boolean isValidType(int type)
public String eventName()
eventName
in class WikiEvent
public String getTypeDescription()
getTypeDescription
in class WikiEvent
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |