org.ametys.core.observation

Interface Observer

All Known Subinterfaces:

AsyncObserver

All Known Implementing Classes:

AbstractBlogObserver, AbstractCacheObserver, AbstractCommentObserver, AbstractContentObserver, AbstractLiveSolrObserver, AbstractODFObserver, AbstractPageSubscriptionObserver, AbstractSendNotificationObserver, AbstractSiteCacheObserver, AbstractSolrContentAsyncObserver, AbstractSolrContentObserver, AbstractSolrIndexResourceObserver, AbstractSolrObserver, AbstractSolrODFObserver, AbstractSolrOnSiteConfModifiedObserver, AbstractSolrOrgUnitObserver, AbstractSynchronizeObserver, AbstractSynchronizePageObserver, AbstractTagObserver, AbstractWorkspacesEventsObserver, AbstractZoneItemCacheObserver, AddEventOnCalendarEventUpdatedObserver, AddEventOnMemberAddedObserver, AddEventOnPageAddedOrDeletedObserver, AddEventOnPageUpdatedObserver, AddEventOnResourceUpdatedObserver, AddEventOnTaskUpdatedObserver, AddEventOnThreadUpdatedObserver, AddMemberMailNotifierObserver, ClearLevelCacheObserver, ClearODFPageCacheObserver, CMISTreeFactory, ContentAttachmentsSolrObserver, ContentCommentsObserver, ContentDeletedObserver, ContentOrphanStatusObserver, ContentPrivacyObserver, IndexArchivedContentObserver, IndexContentObserver, IndexSynchronizedContentObserver, InitializeBlogSiteObserver, InitializeProjectSitemapObserver, InvalidateCacheOnContentCommentedObserver, InvalidateCacheOnContentDeletionObserver, InvalidateCacheOnContentPageModificationObserver, InvalidateCacheOnContentUnpublishObserver, InvalidateCacheOnContentValidationObserver, InvalidateCacheOnContentValidationOrTaggingObserver, InvalidateCacheOnContentValidationOrUnpublishingObserver, InvalidateCacheOnOrgunitChangedObserver, InvalidateCacheOnPageDeletionObserver, InvalidateCacheOnPageMinorChangeObserver, InvalidateCacheOnPageModificationObserver, InvalidateCacheOnPageMoveObserver, InvalidateCacheOnQueryChangesObserver, InvalidateCacheOnResourceUpdateObserver, InvalidateCacheOnRobotsChangeObserver, InvalidateCacheOnSitemapACLUpdateObserver, InvalidateCacheOnZoneItemAdditionObserver, InvalidateCacheOnZoneItemDeletionObserver, InvalidateFlipbookCacheOnResourceUpdateObserver, InvalidatePageCacheExplorerObserver, InvalidatePageElementCacheObserver, InvalidatePageElementCacheOnPageACLUpdateListener, InvalidatePageElementCacheOnSiteChangeObserver, InvalidateSiteCacheObserver, InvalidateZoneItemCacheOnContentCommentedObserver, InvalidateZoneItemCacheOnContentModificationObserver, InvalidateZoneItemCacheOnContentModificationObserver, InvalidateZoneItemCacheOnContentValidationObserver, InvalidateZoneItemCacheOnContentValidationObserver, InvalidateZoneItemCacheOnServiceModificationObserver, InvalidateZoneItemCacheOnZoneItemMoveObserver, InvalidTagCloudCacheOnContentModification, InvalidTagCloudCacheOnServiceModification, InvalidTagCloudCacheOnSiteModification, LuceneBlogContentDeletedOrUnpublishedObserver, LuceneBlogContentValidatedObserver, ODFCartUserPreferencesObserver, PageAttachmentsSolrObserver, PageSubscriptionDeletePageObserver, PageSubscriptionExplorerObserver, PageSubscriptionValidateContentObserver, PostObserver, ProfileAssignmentStorageObserver, ReloadSolrCacheForAclUpdatedObserver, ReloadSolrCacheForModifiedGroupObserver, RemoteProgramDeletedObserver, ResourceDeletedObserver, ResourcesMailNotifierObserver, SendMailToContributorCommentListener, SendMailToVisitorCommentListener, SetReadAccessOnSiteAddedObserver, SetReadAccessOnSitemapAddedObserver, SharedContentValidationObserver, SiteUpdatedBlogObserver, SolrContentDeletedObserver, SolrContentModifiedObserver, SolrContentRootPageDeletedObserver, SolrContentRootPageUpdatedObserver, SolrContentUnpublishedObserver, SolrContentUnpublishedPart1Observer, SolrContentUnpublishedPart2Observer, SolrContentValidatedObserver, SolrContentValidatedObserver, SolrContentValidatedPart1Observer, SolrContentValidatedPart2Observer, SolrIndexProjectResourceObserver, SolrIndexResourceObserver, SolrIndexWebResourceObserver, SolrLiveContentValidatedOrTaggedObserver, SolrOdfContentModifiedObserver, SolrOnSiteConfModifiedPart1Observer, SolrOnSiteConfModifiedPart2Observer, SolrOrgUnitChangedPart1Observer, SolrOrgUnitChangedPart2Observer, SolrPageChangePart1Observer, SolrPageChangePart2Observer, SolrPageContentModifiedObserver, SolrPageDataUpdateObserver, SolrPageDeletionObserver, SolrPageMovePart1Observer, SolrPageMovePart2Observer, SolrPageRenameObserver, SolrProjectDeletedObserver, SolrSiteAddedObserver, SolrSiteDeletionObserver, SolrSitemapDeletionObserver, SolrUnindexResourceObserver, SynchronizeACLObserver, SynchronizeArchivesSiteAdditionObserver, SynchronizeArchivesSiteChangeObserver, SynchronizeArchivesSiteDeletionObserver, SynchronizeContentAdditionObserver, SynchronizeContentCommentedObserver, SynchronizeContentDeletionObserver, SynchronizeContentPrivacyChangeObserver, SynchronizeContentTaggedObserver, SynchronizeContentUncommentedObserver, SynchronizeContentUnpublishObserver, SynchronizeContentValidationObserver, SynchronizedContentTranslatedObserver, SynchronizePageAttachmentsObserver, SynchronizePageChangeObserver, SynchronizePageDataUpdateObserver, SynchronizePageDeletionObserver, SynchronizePageMoveObserver, SynchronizePageRenameObserver, SynchronizeRobotsChangeObserver, SynchronizeServiceModificationObserver, SynchronizeSiteAdditionObserver, SynchronizeSiteChangeObserver, SynchronizeSitemapAdditionObserver, SynchronizeSitemapChangeObserver, SynchronizeSiteMoveObserver, SynchronizeSiteOrSitemapDeletionObserver, SynchronizeUserPopulationsObserver, TagAddedObserver, TagAutopostingSiteParameterObserverPart1, TagAutopostingSiteParameterObserverPart2, TagDeletedObserver, TagUpdatedObserver, TaskMailNotifierObserver, ThreadsMailNotifierObserver, UnindexContentObserver, UnindexProgramObserver, UnindexUnarchivedContentObserver, UpdatePageOnContentValidatedObserver, UserContentCacheObserver, UserContentCollectionSynchronizedObserver

public interface Observer

Observer for consuming events.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_PRIORITY Maximum priority.
static int	MIN_PRIORITY Minimum priority.

Method Summary

Modifier and Type	Method and Description
int	getPriority(Event event) Retrieves the priority to observe this event. This can be used to process a supported event before others observers.
void	observe(Event event, Map<String,Object> transientVars) Observes an event.
boolean	supports(Event event) Checks if the event is supported.

Field Detail

MIN_PRIORITY

static final int MIN_PRIORITY

Minimum priority.

See Also:

Constant Field Values

MAX_PRIORITY

static final int MAX_PRIORITY

Maximum priority.

See Also:

Constant Field Values

Method Detail

supports

boolean supports(Event event)

Checks if the event is supported. If true, the observe(Event) method will be called.

Parameters:

event - the event.

Returns:

true for observing this event, false otherwise.

getPriority

int getPriority(Event event)

Retrieves the priority to observe this event.
This can be used to process a supported event before others observers.

Parameters:

event - the event.

Returns:

the priority where 0 the max priority and Integer.MAX_VALUE the min priority.

observe

void observe(Event event,
             Map<String,Object> transientVars)
      throws Exception

Observes an event.

Parameters:

event - the event.

transientVars - transientVars passed from one Observer to another when processing a single Event. This may allow optimizations between observers.

Throws:

Exception - if an error occurs. All exceptions will be logged but not propagated, as the observation mechanism should never fail.