- AbstractActionExecutionEvent - Class in org.xwiki.bridge.event
-
Base class for all action execution related events.
- AbstractActionExecutionEvent() - Constructor for class org.xwiki.bridge.event.AbstractActionExecutionEvent
-
- AbstractActionExecutionEvent(String) - Constructor for class org.xwiki.bridge.event.AbstractActionExecutionEvent
-
Constructor initializing the action name of the event.
- AbstractDocumentEvent - Class in org.xwiki.bridge.event
-
Base class for all document related Event
.
- AbstractDocumentEvent() - Constructor for class org.xwiki.bridge.event.AbstractDocumentEvent
-
This event will match any other document event of the same type.
- AbstractDocumentEvent(DocumentReference) - Constructor for class org.xwiki.bridge.event.AbstractDocumentEvent
-
This event will match only events of the same type affecting the same document.
- AbstractDocumentEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.AbstractDocumentEvent
-
Constructor using a custom EventFilter
.
- AbstractWikiEvent - Class in org.xwiki.bridge.event
-
Base class for all wiki related Event
.
- AbstractWikiEvent() - Constructor for class org.xwiki.bridge.event.AbstractWikiEvent
-
This event will match any other document event of the same type.
- AbstractWikiEvent(String) - Constructor for class org.xwiki.bridge.event.AbstractWikiEvent
-
This event will match only events of the same type affecting the same document.
- AbstractWikiEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.AbstractWikiEvent
-
Constructor using a custom EventFilter
.
- ActionExecutedEvent - Class in org.xwiki.bridge.event
-
An event triggered whenever a client request (action) is processed, like /upload/ or /view/.
- ActionExecutedEvent() - Constructor for class org.xwiki.bridge.event.ActionExecutedEvent
-
- ActionExecutedEvent(String) - Constructor for class org.xwiki.bridge.event.ActionExecutedEvent
-
Constructor initializing the action name of the event.
- ActionExecutingEvent - Class in org.xwiki.bridge.event
-
An event triggered whenever a client request (action) is processed, like /upload/ or /view/.
- ActionExecutingEvent() - Constructor for class org.xwiki.bridge.event.ActionExecutingEvent
-
- ActionExecutingEvent(String) - Constructor for class org.xwiki.bridge.event.ActionExecutingEvent
-
Constructor initializing the action name of the event.
- ActionExecutionEvent - Interface in org.xwiki.bridge.event
-
An event triggered whenever a client request (action) is processed, like /upload/
or /view/
.
- ApplicationReadyEvent - Class in org.xwiki.bridge.event
-
An event triggered when the XWiki application is ready to service requests.
- ApplicationReadyEvent() - Constructor for class org.xwiki.bridge.event.ApplicationReadyEvent
-
- DocumentAccessBridge - Interface in org.xwiki.bridge
-
Exposes methods for accessing Document data.
- DocumentCreatedEvent - Class in org.xwiki.bridge.event
-
An event triggered after a document is created.
- DocumentCreatedEvent() - Constructor for class org.xwiki.bridge.event.DocumentCreatedEvent
-
Constructor initializing the event filter with an
AlwaysMatchingEventFilter
, meaning that this event will match any
other document delete event.
- DocumentCreatedEvent(DocumentReference) - Constructor for class org.xwiki.bridge.event.DocumentCreatedEvent
-
Constructor initializing the event filter with a FixedNameEventFilter
,
meaning that this event will match only delete events affecting the same document.
- DocumentCreatedEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.DocumentCreatedEvent
-
Constructor using a custom EventFilter
.
- DocumentCreatingEvent - Class in org.xwiki.bridge.event
-
An event triggered before a document is created.
- DocumentCreatingEvent() - Constructor for class org.xwiki.bridge.event.DocumentCreatingEvent
-
Constructor initializing the event filter with an
AlwaysMatchingEventFilter
, meaning that this event will match any
other document delete event.
- DocumentCreatingEvent(DocumentReference) - Constructor for class org.xwiki.bridge.event.DocumentCreatingEvent
-
Constructor initializing the event filter with a FixedNameEventFilter
,
meaning that this event will match only delete events affecting the same document.
- DocumentCreatingEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.DocumentCreatingEvent
-
Constructor using a custom EventFilter
.
- DocumentDeletedEvent - Class in org.xwiki.bridge.event
-
An event triggered after a document is deleted.
- DocumentDeletedEvent() - Constructor for class org.xwiki.bridge.event.DocumentDeletedEvent
-
Constructor initializing the event filter with an
AlwaysMatchingEventFilter
, meaning that this event will match any
other document delete event.
- DocumentDeletedEvent(DocumentReference) - Constructor for class org.xwiki.bridge.event.DocumentDeletedEvent
-
Constructor initializing the event filter with a FixedNameEventFilter
,
meaning that this event will match only delete events affecting the same document.
- DocumentDeletedEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.DocumentDeletedEvent
-
Constructor using a custom EventFilter
.
- DocumentDeletingEvent - Class in org.xwiki.bridge.event
-
An event triggered before a document is deleted.
- DocumentDeletingEvent() - Constructor for class org.xwiki.bridge.event.DocumentDeletingEvent
-
Constructor initializing the event filter with an
AlwaysMatchingEventFilter
, meaning that this event will match any
other document delete event.
- DocumentDeletingEvent(DocumentReference) - Constructor for class org.xwiki.bridge.event.DocumentDeletingEvent
-
Constructor initializing the event filter with a FixedNameEventFilter
,
meaning that this event will match only delete events affecting the same document.
- DocumentDeletingEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.DocumentDeletingEvent
-
Constructor using a custom EventFilter
.
- DocumentModelBridge - Interface in org.xwiki.bridge
-
Exposes methods for accessing Documents.
- DocumentRolledBackEvent - Class in org.xwiki.bridge.event
-
An event triggered after a document is rolled back to a previous revision.
- DocumentRolledBackEvent() - Constructor for class org.xwiki.bridge.event.DocumentRolledBackEvent
-
- DocumentRolledBackEvent(DocumentReference) - Constructor for class org.xwiki.bridge.event.DocumentRolledBackEvent
-
- DocumentRolledBackEvent(DocumentReference, String) - Constructor for class org.xwiki.bridge.event.DocumentRolledBackEvent
-
- DocumentRolledBackEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.DocumentRolledBackEvent
-
Constructor using a custom EventFilter
.
- DocumentRollingBackEvent - Class in org.xwiki.bridge.event
-
An event triggered before a document is rolled back to a previous revision.
- DocumentRollingBackEvent() - Constructor for class org.xwiki.bridge.event.DocumentRollingBackEvent
-
- DocumentRollingBackEvent(DocumentReference) - Constructor for class org.xwiki.bridge.event.DocumentRollingBackEvent
-
- DocumentRollingBackEvent(DocumentReference, String) - Constructor for class org.xwiki.bridge.event.DocumentRollingBackEvent
-
- DocumentRollingBackEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.DocumentRollingBackEvent
-
Constructor using a custom EventFilter
.
- DocumentsDeletingEvent - Class in org.xwiki.bridge.event
-
An event triggered before a list of documents is deleted.
- DocumentsDeletingEvent() - Constructor for class org.xwiki.bridge.event.DocumentsDeletingEvent
-
- DocumentUpdatedEvent - Class in org.xwiki.bridge.event
-
An event triggered after a document is updated.
- DocumentUpdatedEvent() - Constructor for class org.xwiki.bridge.event.DocumentUpdatedEvent
-
Constructor initializing the event filter with an
AlwaysMatchingEventFilter
, meaning that this event will match any
other document delete event.
- DocumentUpdatedEvent(DocumentReference) - Constructor for class org.xwiki.bridge.event.DocumentUpdatedEvent
-
Constructor initializing the event filter with a FixedNameEventFilter
,
meaning that this event will match only delete events affecting the same document.
- DocumentUpdatedEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.DocumentUpdatedEvent
-
Constructor using a custom EventFilter
.
- DocumentUpdatingEvent - Class in org.xwiki.bridge.event
-
An event triggered before a document is updated.
- DocumentUpdatingEvent() - Constructor for class org.xwiki.bridge.event.DocumentUpdatingEvent
-
Constructor initializing the event filter with an
AlwaysMatchingEventFilter
, meaning that this event will match any
other document delete event.
- DocumentUpdatingEvent(DocumentReference) - Constructor for class org.xwiki.bridge.event.DocumentUpdatingEvent
-
Constructor initializing the event filter with a FixedNameEventFilter
,
meaning that this event will match only delete events affecting the same document.
- DocumentUpdatingEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.DocumentUpdatingEvent
-
Constructor using a custom EventFilter
.
- DocumentVersionRangeDeletedEvent - Class in org.xwiki.bridge.event
-
An event triggered after one or several versions of a document history have been deleted.
- DocumentVersionRangeDeletedEvent() - Constructor for class org.xwiki.bridge.event.DocumentVersionRangeDeletedEvent
-
- DocumentVersionRangeDeletedEvent(DocumentReference, String, String) - Constructor for class org.xwiki.bridge.event.DocumentVersionRangeDeletedEvent
-
- DocumentVersionRangeDeletedEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.DocumentVersionRangeDeletedEvent
-
Constructor using a custom EventFilter
to match the document reference.
- getActionName() - Method in class org.xwiki.bridge.event.AbstractActionExecutionEvent
-
- getActionName() - Method in interface org.xwiki.bridge.event.ActionExecutionEvent
-
Gets the name of the action causing this event.
- getAttachmentContent(String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
- getAttachmentContent(AttachmentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
Returns the content of a document attachment.
- getAttachmentReferences(DocumentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
Retrieves all attachments in the passed document.
- getAttachmentURL(String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
- getAttachmentURL(AttachmentReference, boolean) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
Retrieves the URL (either relative ie the path without the hostname and port, or the full URL) that can be used
to access an attachment.
- getAttachmentURL(AttachmentReference, String, boolean) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
Retrieves the URL (either relative ie the path without the hostname and port, or the full URL) that can be used
to access an attachment.
- getAttachmentURLs(DocumentReference, boolean) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
- getAttachmentVersion(AttachmentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
Returns the current version of a document attachment.
- getContent() - Method in interface org.xwiki.bridge.DocumentModelBridge
-
Retrieves the textual content of the document.
- getContentAuthorReference() - Method in interface org.xwiki.bridge.DocumentModelBridge
-
- getCreationDate() - Method in interface org.xwiki.bridge.DocumentModelBridge
-
- getCurrentAuthorReference() - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
- getCurrentDocumentReference() - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
Get the reference to the current document (found in the Context).
- getCurrentUser() - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
- getCurrentUserReference() - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
Utility method to retrieve the current user document reference.
- getCurrentWiki() - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
- getDefaultEncoding() - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
- getDocument(String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
- getDocument(DocumentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
- getDocumentContent(String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
- getDocumentContent(DocumentReference, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
Retrieves the textual content of the document, in the given language.
- getDocumentContent(String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
- getDocumentContentForDefaultLanguage(DocumentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
Retrieves the textual content of the document, in the document's default language.
- getDocumentContentForDefaultLanguage(String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
- getDocumentInstance(DocumentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
Get the document object associated with the passed document.
- getDocumentInstance(EntityReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
Get the document object associated with the passed reference.
- getDocumentReference(EntityReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
Find the document reference corresponding to the entity reference based on what exist in the database (page
reference can means two different documents for example).
- getDocumentReference() - Method in interface org.xwiki.bridge.DocumentModelBridge
-
- getDocumentSyntaxId(String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
- getDocumentURL(DocumentReference, String, String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
Retrieves the internal (without the hostname) URL that can be used to access a document, using a specific action.
- getDocumentURL(EntityReference, String, String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
Retrieves the internal (without the hostname) URL that can be used to access a document, using a specific action.
- getDocumentURL(DocumentReference, String, String, String, boolean) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
Retrieves the relative (without the hostname) or absolute (with the hostname) URL that can be used to access a
document, using a specific action.
- getDocumentURL(EntityReference, String, String, String, boolean) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
Retrieves the relative (without the hostname) or absolute (with the hostname) URL that can be used to access a
document, using a specific action.
- getFrom() - Method in class org.xwiki.bridge.event.DocumentVersionRangeDeletedEvent
-
- getFullName() - Method in interface org.xwiki.bridge.DocumentModelBridge
-
- getIconURL(String) - Method in interface org.xwiki.bridge.SkinAccessBridge
-
- getObjectNumber(DocumentReference, DocumentReference, String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
Get the number of the first object that has a property that match the expectation.
- getOriginalDocument() - Method in interface org.xwiki.bridge.DocumentModelBridge
-
Retrieves a copy of the document before it was changed.
- getPageName() - Method in interface org.xwiki.bridge.DocumentModelBridge
-
- getProperties(String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
- getProperty(String, String, int, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
Retrieves the value for an object property.
- getProperty(String, String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
- getProperty(ObjectReference, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
Retrieves the value for an object property.
- getProperty(ObjectPropertyReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
Retrieves the value for an object property.
- getProperty(DocumentReference, DocumentReference, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
Retrieves the value for an object property, from the first object of the given class.
- getProperty(DocumentReference, DocumentReference, int, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
Retrieves the value for an object property, from the Nth object of the given class.
- getProperty(String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
Retrieves the value for an object property, from the first object of any class that has a property with that
name.
- getPropertyType(String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
- getRealLanguage() - Method in interface org.xwiki.bridge.DocumentModelBridge
-
Retrieve the actual language of the document variant.
- getReason() - Method in class org.xwiki.bridge.event.ActionExecutingEvent
-
- getRevision() - Method in class org.xwiki.bridge.event.DocumentRolledBackEvent
-
- getRevision() - Method in class org.xwiki.bridge.event.DocumentRollingBackEvent
-
- getSkinFile(String) - Method in interface org.xwiki.bridge.SkinAccessBridge
-
Gets a specific file from the current skin.
- getSourceWikiId() - Method in class org.xwiki.bridge.event.WikiCopiedEvent
-
- getSpaceName() - Method in interface org.xwiki.bridge.DocumentModelBridge
-
- getSyntax() - Method in interface org.xwiki.bridge.DocumentModelBridge
-
- getSyntaxId() - Method in interface org.xwiki.bridge.DocumentModelBridge
-
- getTargetWikiId() - Method in class org.xwiki.bridge.event.WikiCopiedEvent
-
- getTitle() - Method in interface org.xwiki.bridge.DocumentModelBridge
-
- getTo() - Method in class org.xwiki.bridge.event.DocumentVersionRangeDeletedEvent
-
- getTranslatedDocumentInstance(DocumentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
Get the document object associated with the passed document name and context locale.
- getTranslatedDocumentInstance(DocumentModelBridge) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
Get the document object associated with the passed document and context locale.
- getTranslatedDocumentInstance(EntityReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
Get the document object associated with the passed entity reference and context locale.
- getURL(String, String, String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
-
- getVersion() - Method in interface org.xwiki.bridge.DocumentModelBridge
-
- getWikiId() - Method in class org.xwiki.bridge.event.AbstractWikiEvent
-
- getWikiId() - Method in interface org.xwiki.bridge.event.WikiEvent
-
- getWikiName() - Method in interface org.xwiki.bridge.DocumentModelBridge
-
- getXDOM() - Method in interface org.xwiki.bridge.DocumentModelBridge
-
- WikiCopiedEvent - Class in org.xwiki.bridge.event
-
An event triggered after a wiki has been copied.
- WikiCopiedEvent() - Constructor for class org.xwiki.bridge.event.WikiCopiedEvent
-
- WikiCopiedEvent(String, String) - Constructor for class org.xwiki.bridge.event.WikiCopiedEvent
-
Matches events affecting the same wikis.
- WikiCreatedEvent - Class in org.xwiki.bridge.event
-
An event triggered after a wiki has been created.
- WikiCreatedEvent() - Constructor for class org.xwiki.bridge.event.WikiCreatedEvent
-
Constructor initializing the event filter with an
AlwaysMatchingEventFilter
, meaning that this event will match any
other document delete event.
- WikiCreatedEvent(String) - Constructor for class org.xwiki.bridge.event.WikiCreatedEvent
-
Constructor initializing the event filter with a FixedNameEventFilter
,
meaning that this event will match only events affecting the same wiki.
- WikiCreatedEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.WikiCreatedEvent
-
Constructor using a custom EventFilter
.
- WikiCreateFailedEvent - Class in org.xwiki.bridge.event
-
An event triggered after trying to create a wiki if the creation failed.
- WikiCreateFailedEvent() - Constructor for class org.xwiki.bridge.event.WikiCreateFailedEvent
-
- WikiCreateFailedEvent(String) - Constructor for class org.xwiki.bridge.event.WikiCreateFailedEvent
-
Constructor initializing the event filter with a FixedNameEventFilter
,
meaning that this event will match only events affecting the same wiki.
- WikiCreateFailedEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.WikiCreateFailedEvent
-
Constructor using a custom EventFilter
.
- WikiCreatingEvent - Class in org.xwiki.bridge.event
-
An event triggered just before a wiki is about to be created.
- WikiCreatingEvent() - Constructor for class org.xwiki.bridge.event.WikiCreatingEvent
-
- WikiCreatingEvent(String) - Constructor for class org.xwiki.bridge.event.WikiCreatingEvent
-
Constructor initializing the event filter with a FixedNameEventFilter
,
meaning that this event will match only events affecting the same wiki.
- WikiCreatingEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.WikiCreatingEvent
-
Constructor using a custom EventFilter
.
- WikiDeletedEvent - Class in org.xwiki.bridge.event
-
An event triggered after a wiki is deleted.
- WikiDeletedEvent() - Constructor for class org.xwiki.bridge.event.WikiDeletedEvent
-
- WikiDeletedEvent(String) - Constructor for class org.xwiki.bridge.event.WikiDeletedEvent
-
Constructor initializing the event filter with a FixedNameEventFilter
,
meaning that this event will match only events affecting the same wiki.
- WikiDeletedEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.WikiDeletedEvent
-
Constructor using a custom EventFilter
.
- WikiEvent - Interface in org.xwiki.bridge.event
-
COmmon interface for all wiki related events.
- WikiProvisionedEvent - Class in org.xwiki.bridge.event
-
An event triggered just after a provisioning job is finished.
- WikiProvisionedEvent() - Constructor for class org.xwiki.bridge.event.WikiProvisionedEvent
-
- WikiProvisionedEvent(String) - Constructor for class org.xwiki.bridge.event.WikiProvisionedEvent
-
Constructor initializing the event filter with a FixedNameEventFilter
,
meaning that this event will match only events affecting the same wiki.
- WikiProvisionedEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.WikiProvisionedEvent
-
Constructor using a custom EventFilter
.
- WikiProvisioningEvent - Class in org.xwiki.bridge.event
-
An event triggered just before a provisioning job is started for a wiki.
- WikiProvisioningEvent() - Constructor for class org.xwiki.bridge.event.WikiProvisioningEvent
-
- WikiProvisioningEvent(String) - Constructor for class org.xwiki.bridge.event.WikiProvisioningEvent
-
Constructor initializing the event filter with a FixedNameEventFilter
,
meaning that this event will match only events affecting the same wiki.
- WikiProvisioningEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.WikiProvisioningEvent
-
Constructor using a custom EventFilter
.
- WikiProvisioningFailedEvent - Class in org.xwiki.bridge.event
-
An event triggered when a provisioning job has failed to perform its task.
- WikiProvisioningFailedEvent() - Constructor for class org.xwiki.bridge.event.WikiProvisioningFailedEvent
-
- WikiProvisioningFailedEvent(String) - Constructor for class org.xwiki.bridge.event.WikiProvisioningFailedEvent
-
Constructor initializing the event filter with a FixedNameEventFilter
,
meaning that this event will match only events affecting the same wiki.
- WikiProvisioningFailedEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.WikiProvisioningFailedEvent
-
Constructor using a custom EventFilter
.
- WikiReadyEvent - Class in org.xwiki.bridge.event
-
An event triggered when a (sub)wiki is ready to service requests.
- WikiReadyEvent() - Constructor for class org.xwiki.bridge.event.WikiReadyEvent
-
- WikiReadyEvent(String) - Constructor for class org.xwiki.bridge.event.WikiReadyEvent
-
Constructor initializing the event filter with a FixedNameEventFilter
,
meaning that this event will match only events affecting the same wiki.
- WikiReadyEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.WikiReadyEvent
-
Constructor using a custom EventFilter
.