Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- ABORTED - Static variable in class org.apache.wiki.event.WorkflowEvent
-
If a Step has elected to abort the Workflow.
- ACCESS_ALLOWED - Static variable in class org.apache.wiki.event.WikiSecurityEvent
-
When access to a resource is allowed.
- ACCESS_DENIED - Static variable in class org.apache.wiki.event.WikiSecurityEvent
-
When access to a resource is allowed.
- actionPerformed(WikiEvent) - Method in interface org.apache.wiki.event.WikiEventListener
-
Fired when a WikiEvent is triggered by an event source.
- addWikiEventListener(Object, WikiEventListener) - Static method in class org.apache.wiki.event.WikiEventManager
-
Registers a WikiEventListener with a WikiEventDelegate for the provided client object.
- attach(WikiEventListener) - Static method in enum org.apache.wiki.event.WikiEventEmitter
-
Registers a
WikiEventListener
so it listens events fired from theWikiEventEmitter
instance.
C
- COMPLETED - Static variable in class org.apache.wiki.event.WorkflowEvent
-
After the Workflow has finished processing all Steps, without errors.
- CREATED - Static variable in class org.apache.wiki.event.WorkflowEvent
-
After Workflow instantiation.
D
- DQ_ADDITION - Static variable in class org.apache.wiki.event.WorkflowEvent
-
When the workflow wishes to add a Decision to the DecisionQueue
- DQ_DECIDE - Static variable in class org.apache.wiki.event.WorkflowEvent
-
When the decision queue decides the outcome of a Decision
- DQ_REASSIGN - Static variable in class org.apache.wiki.event.WorkflowEvent
-
When the decision queue reassigns a Decision
- DQ_REMOVAL - Static variable in class org.apache.wiki.event.WorkflowEvent
-
When the workflow wishes to remove a Decision from the DecisionQueue
E
- ERROR - Static variable in class org.apache.wiki.event.WikiEvent
-
Indicates a exception or error state.
- eventName() - Method in class org.apache.wiki.event.WikiEngineEvent
-
Returns a textual representation of the event type.
- eventName() - Method in class org.apache.wiki.event.WikiEvent
-
Returns a textual representation of an event type.
- eventName() - Method in class org.apache.wiki.event.WikiPageEvent
-
Returns a textual representation of the event type.
- eventName() - Method in class org.apache.wiki.event.WikiPageRenameEvent
-
Returns a textual representation of the event type.
- eventName(int) - Method in class org.apache.wiki.event.WikiSecurityEvent
-
Returns a textual representation of an event type.
- eventName(int) - Method in class org.apache.wiki.event.WorkflowEvent
-
Returns a textual representation of an event type.
F
- fireEvent(Object, WikiEvent) - Static method in class org.apache.wiki.event.WikiEventManager
-
Notify all listeners of the WikiEventDelegate having a registered interest in change events of the supplied WikiEvent.
- fireWorkflowEvent(Object, int) - Static method in enum org.apache.wiki.event.WikiEventEmitter
-
Fires a Workflow Event from provided source and workflow type.
- fireWorkflowEvent(Object, int, Object...) - Static method in enum org.apache.wiki.event.WikiEventEmitter
-
Fires a Workflow Event from provided source and workflow type.
G
- get() - Static method in enum org.apache.wiki.event.WikiEventEmitter
- getArg(int, Class<T>) - Method in class org.apache.wiki.event.WikiEvent
-
Returns the requested arg, if any.
- getArgs() - Method in class org.apache.wiki.event.WikiEvent
-
Returns the args associated to src, if any.
- getInstance() - Static method in class org.apache.wiki.event.WikiEventManager
-
As this is a singleton class, this returns the single instance of this class provided with the property file filename and bit-wise application settings.
- getNewPageName() - Method in class org.apache.wiki.event.WikiPageRenameEvent
-
Returns the new Wiki page name associated with this event.
- getOldPageName() - Method in class org.apache.wiki.event.WikiPageRenameEvent
-
Returns the old Wiki page name associated with this event.
- getPageName() - Method in class org.apache.wiki.event.WikiPageEvent
-
Returns the Wiki page name associated with this event.
- getPrincipal() - Method in class org.apache.wiki.event.WikiSecurityEvent
-
Returns the principal to whom the operation applied, if supplied.
- getSrc() - Method in class org.apache.wiki.event.WikiEvent
-
Convenience method that returns the typed object to which the event applied.
- getTarget() - Method in class org.apache.wiki.event.WikiSecurityEvent
-
Returns the object that was operated on, if supplied.
- getType() - Method in class org.apache.wiki.event.WikiEvent
-
Returns the type of this event.
- getTypeDescription() - Method in class org.apache.wiki.event.WikiEngineEvent
-
Returns a human-readable description of the event type.
- getTypeDescription() - Method in class org.apache.wiki.event.WikiEvent
-
Returns a String (human-readable) description of an event type.
- getTypeDescription() - Method in class org.apache.wiki.event.WikiPageEvent
-
Returns a human-readable description of the event type.
- getTypeDescription() - Method in class org.apache.wiki.event.WikiPageRenameEvent
-
Returns a human-readable description of the event type.
- getTypeDescription() - Method in class org.apache.wiki.event.WikiSecurityEvent
-
Returns a human-readable description of the event type.
- getWhen() - Method in class org.apache.wiki.event.WikiEvent
-
Returns the timestamp of when this WikiEvent occurred.
- getWikiEventListeners(Object) - Static method in class org.apache.wiki.event.WikiEventManager
-
Return the Set containing the WikiEventListeners attached to the delegate for the supplied client.
- GROUP_ADD - Static variable in class org.apache.wiki.event.WikiSecurityEvent
-
When a new wiki group is added.
- GROUP_CLEAR_GROUPS - Static variable in class org.apache.wiki.event.WikiSecurityEvent
-
When all wiki groups are removed from GroupDatabase.
- GROUP_REMOVE - Static variable in class org.apache.wiki.event.WikiSecurityEvent
-
When a wiki group is deleted.
I
- INITIALIZED - Static variable in class org.apache.wiki.event.WikiEngineEvent
-
Indicates a Engine initialized event, fired after the wiki service is fully available.
- INITIALIZING - Static variable in class org.apache.wiki.event.WikiEngineEvent
-
Indicates a Engine initialization event, fired as the wiki service is being initialized (in progress).
- INSTANCE - Enum constant in enum org.apache.wiki.event.WikiEventEmitter
- isListening(Object) - Static method in class org.apache.wiki.event.WikiEventManager
-
Returns true if there are one or more listeners registered with the provided client Object (undelegated event source).
- isValidType(int) - Static method in class org.apache.wiki.event.WikiEngineEvent
-
Returns
true
if the int value is a WikiPageEvent type. - isValidType(int) - Static method in class org.apache.wiki.event.WikiEvent
-
Returns true if the int value is a valid WikiEvent type.
- isValidType(int) - Static method in class org.apache.wiki.event.WikiPageEvent
-
Returns true if the int value is a WikiPageEvent type.
- isValidType(int) - Static method in class org.apache.wiki.event.WikiPageRenameEvent
-
Returns true if the int value is a WikiPageRenameEvent type.
L
- LOGIN_ACCOUNT_EXPIRED - Static variable in class org.apache.wiki.event.WikiSecurityEvent
-
When a login fails due to account expiration.
- LOGIN_ANONYMOUS - Static variable in class org.apache.wiki.event.WikiSecurityEvent
-
When a user first accesses JSPWiki, but before logging in or setting a cookie.
- LOGIN_ASSERTED - Static variable in class org.apache.wiki.event.WikiSecurityEvent
-
When a user sets a cookie to assert their identity.
- LOGIN_AUTHENTICATED - Static variable in class org.apache.wiki.event.WikiSecurityEvent
-
When a user authenticates with a username and password, or via container auth.
- LOGIN_CREDENTIAL_EXPIRED - Static variable in class org.apache.wiki.event.WikiSecurityEvent
-
When a login fails due to credential expiration.
- LOGIN_FAILED - Static variable in class org.apache.wiki.event.WikiSecurityEvent
-
When a login fails due to wrong username or password.
- LOGIN_INITIATED - Static variable in class org.apache.wiki.event.WikiSecurityEvent
-
When a user's attempts to log in as guest, via cookies, using a password or otherwise.
- LOGOUT - Static variable in class org.apache.wiki.event.WikiSecurityEvent
-
When a user logs out.
O
- org.apache.wiki.event - package org.apache.wiki.event
P
- PAGE_DELETE_REQUEST - Static variable in class org.apache.wiki.event.WikiPageEvent
-
Indicates a wiki page delete event (the beginning of a delete request).
- PAGE_DELETED - Static variable in class org.apache.wiki.event.WikiPageEvent
-
Indicates a wiki page deleted event (after the delete has been completed).
- PAGE_DELIVERED - Static variable in class org.apache.wiki.event.WikiPageEvent
-
Indicates a wiki page delivery event (the end of a request).
- PAGE_LOCK - Static variable in class org.apache.wiki.event.WikiPageEvent
-
Indicates a page lock event.
- PAGE_REINDEX - Static variable in class org.apache.wiki.event.WikiPageEvent
-
Indicates a wiki page reindex event (a page was changed when requested to a provided)
- PAGE_RENAMED - Static variable in class org.apache.wiki.event.WikiPageRenameEvent
-
Indicates a page rename event.
- PAGE_REQUESTED - Static variable in class org.apache.wiki.event.WikiPageEvent
-
Indicates a wiki page request event (the start of a request).
- PAGE_UNLOCK - Static variable in class org.apache.wiki.event.WikiPageEvent
-
Indicates a page unlock event.
- POST_SAVE - Static variable in class org.apache.wiki.event.WikiPageEvent
-
Indicates a wiki post-save page event.
- POST_SAVE_BEGIN - Static variable in class org.apache.wiki.event.WikiPageEvent
-
Indicates the beginning of all wiki post-save page events.
- POST_SAVE_END - Static variable in class org.apache.wiki.event.WikiPageEvent
-
Indicates the end of all wiki post-save page events.
- POST_TRANSLATE - Static variable in class org.apache.wiki.event.WikiPageEvent
-
Indicates a wiki post-translate page event.
- POST_TRANSLATE_BEGIN - Static variable in class org.apache.wiki.event.WikiPageEvent
-
Indicates the beginning of all wiki post-translate page events.
- POST_TRANSLATE_END - Static variable in class org.apache.wiki.event.WikiPageEvent
-
Indicates the end of all wiki post-translate page events.
- PRE_SAVE - Static variable in class org.apache.wiki.event.WikiPageEvent
-
Indicates a wiki pre-save page event.
- PRE_SAVE_BEGIN - Static variable in class org.apache.wiki.event.WikiPageEvent
-
Indicates the beginning of all wiki pre-save page events.
- PRE_SAVE_END - Static variable in class org.apache.wiki.event.WikiPageEvent
-
Indicates the end of all wiki pre-save page events.
- PRE_TRANSLATE - Static variable in class org.apache.wiki.event.WikiPageEvent
-
Indicates a wiki pre-translate page event.
- PRE_TRANSLATE_BEGIN - Static variable in class org.apache.wiki.event.WikiPageEvent
-
Indicates the beginning of all wiki pre-translate page events.
- PRE_TRANSLATE_END - Static variable in class org.apache.wiki.event.WikiPageEvent
-
Indicates the end of all wiki pre-translate page events.
- PRINCIPAL_ADD - Static variable in class org.apache.wiki.event.WikiSecurityEvent
-
When a Principal should be added to the Session
- PROFILE_NAME_CHANGED - Static variable in class org.apache.wiki.event.WikiSecurityEvent
-
When a user profile name changes.
- PROFILE_SAVE - Static variable in class org.apache.wiki.event.WikiSecurityEvent
-
When a user profile is saved.
R
- register(WikiEventListener) - Static method in enum org.apache.wiki.event.WikiEventEmitter
-
Registers a
WikiEventListener
so it listens events fired from theWikiEventEmitter
instance. - removeWikiEventListener(Object, WikiEventListener) - Static method in class org.apache.wiki.event.WikiEventManager
-
Un-registers a WikiEventListener with the WikiEventDelegate for the provided client object.
- removeWikiEventListener(WikiEventListener) - Static method in class org.apache.wiki.event.WikiEventManager
-
Un-registers a WikiEventListener from any WikiEventDelegate client managed by this WikiEventManager.
- RUNNING - Static variable in class org.apache.wiki.event.WorkflowEvent
-
After the Workflow has been started (or re-started) using the
org.apache.wiki.workflow.Workflow#start()
method, but before it has finished processing all Steps.
S
- SESSION_EXPIRED - Static variable in class org.apache.wiki.event.WikiSecurityEvent
-
When a session expires.
- setType(int) - Method in class org.apache.wiki.event.WikiEngineEvent
-
Sets the type of this event.
- setType(int) - Method in class org.apache.wiki.event.WikiEvent
-
Sets the type of this event.
- shutdown() - Static method in class org.apache.wiki.event.WikiEventManager
- SHUTDOWN - Static variable in class org.apache.wiki.event.WikiEngineEvent
-
Indicates a Engine closing event, fired as a signal that the wiki service is shutting down.
- STARTED - Static variable in class org.apache.wiki.event.WorkflowEvent
-
After the Workflow has been instantiated, but before it has been started using the
org.apache.wiki.workflow.Workflow#start()
method. - STOPPED - Static variable in class org.apache.wiki.event.WikiEngineEvent
-
Indicates a Engine stopped event, fired after halting the wiki service.
T
- toString() - Method in class org.apache.wiki.event.WikiEvent
-
Prints a String (human-readable) representation of this object.
- toString() - Method in class org.apache.wiki.event.WikiSecurityEvent
-
Prints a String (human-readable) representation of this object.
- toString() - Method in class org.apache.wiki.event.WorkflowEvent
-
Prints a String (human-readable) representation of this object.
U
V
- valueOf(String) - Static method in enum org.apache.wiki.event.WikiEventEmitter
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.apache.wiki.event.WikiEventEmitter
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- WAITING - Static variable in class org.apache.wiki.event.WorkflowEvent
-
When the Workflow has temporarily paused, for example because of a pending Decision.
- WikiEngineEvent - Class in org.apache.wiki.event
-
WikiEngineEvent indicates a change in the state of the Engine.
- WikiEngineEvent(Object, int) - Constructor for class org.apache.wiki.event.WikiEngineEvent
-
Constructs an instance of this event.
- WikiEvent - Class in org.apache.wiki.event
-
Abstract parent class for wiki events.
- WikiEvent(Object, int) - Constructor for class org.apache.wiki.event.WikiEvent
-
Constructs an instance of this event.
- WikiEvent(Object, int, Object...) - Constructor for class org.apache.wiki.event.WikiEvent
-
Constructs an instance of this event.
- WikiEventEmitter - Enum in org.apache.wiki.event
-
Emits all kind of
WikiEvent
s. - WikiEventListener - Interface in org.apache.wiki.event
-
Defines an interface for an object that listens for WikiEvents.
- WikiEventManager - Class in org.apache.wiki.event
-
A singleton class that manages the addition and removal of WikiEvent listeners to a event source, as well as the firing of events to those listeners.
- WikiPageEvent - Class in org.apache.wiki.event
-
WikiPageEvent indicates a change in the state or processing of a WikiPage.
- WikiPageEvent(Object, int, String) - Constructor for class org.apache.wiki.event.WikiPageEvent
-
Constructs an instance of this event.
- WikiPageRenameEvent - Class in org.apache.wiki.event
-
WikiPageRenameEvent extends WikiPageEvent to indicate a change in the name of a WikiPage.
- WikiPageRenameEvent(Object, String, String) - Constructor for class org.apache.wiki.event.WikiPageRenameEvent
-
Constructs an instance of this event.
- WikiSecurityEvent - Class in org.apache.wiki.event
-
Event class for security events: login/logout, wiki group adds/changes, and authorization decisions.
- WikiSecurityEvent(Object, int, Object) - Constructor for class org.apache.wiki.event.WikiSecurityEvent
-
Constructs a new instance of this event type, which signals a security event has occurred.
- WikiSecurityEvent(Object, int, Principal, Object) - Constructor for class org.apache.wiki.event.WikiSecurityEvent
-
Constructs a new instance of this event type, which signals a security event has occurred.
- WorkflowEvent - Class in org.apache.wiki.event
-
WorkflowEvent indicates that a state change to a Workflow: started, running, waiting, completed, aborted.
- WorkflowEvent(Object, int) - Constructor for class org.apache.wiki.event.WorkflowEvent
-
Constructs a new instance of this event type, which signals a security event has occurred.
- WorkflowEvent(Object, int, Object...) - Constructor for class org.apache.wiki.event.WorkflowEvent
-
Constructs a new instance of this event type, which signals a security event has occurred.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form