Package org.ametys.core.observation

Interface Observer

All Known Subinterfaces:
AsyncObserver
All Known Implementing Classes:
AbstractCacheObserver, AbstractCommentObserver, AbstractContentObserver, AbstractContentObserver, AbstractConvertMinisiteEventObserver, AbstractInitializeProjectObserver, AbstractInvalidateZoneItemCacheOnWallObserver, AbstractJobOfferObserver, AbstractLiveSolrObserver, AbstractMemberMailNotifierObserver, AbstractMemberObserver, AbstractNotifyMentionsObserver, AbstractODFObserver, AbstractRulesStepObserver, AbstractSiteCacheObserver, AbstractSolrContentAsyncObserver, AbstractSolrContentAsyncObserver, AbstractSolrContentObserver, AbstractSolrContentObserver, AbstractSolrIndexResourceObserver, AbstractSolrObserver, AbstractSolrODFObserver, AbstractSolrOnSiteConfModifiedObserver, AbstractSolrOrgUnitObserver, AbstractSurveyCacheObserver, AbstractSynchronizeObserver, AbstractSynchronizePageObserver, AbstractTagObserver, AbstractThematicRulesObserver, AbstractUGCContentObserver, AbstractZoneItemCacheObserver, AbstractZoneItemCacheOnContentObserver, AbstractZoneItemCacheOnZoneItemObserver, CleanFlipbookCacheOnContentDeletedObserver, CleanFlipbookCacheOnResourceDeletedObserver, ClearCachesObserver, ClearCachesObserver, ClearLevelCacheObserver, ClearODFPageCacheObserver, CMISTreeFactory, ContentAttachmentsSolrObserver, ContentCommentsObserver, ContentDeletedObserver, ContentOrphanStatusPart1Observer, ContentOrphanStatusPart2Observer, ContentPrivacyObserver, ContentValidatedObserver, ConvertContentValidatedEvent2MinisitePageEventObserver, ConvertPageEvent2MinisitePageEventObserver, CourseDeletedObserver, CoursePartTitleObserver, EducationalPathRemovedObserver, FileThumbnailObserver, ForensicLogger, FormWorkflowRibbonObserver, IndexArchivedContentObserver, IndexContentObserver, IndexMemberObserver, IndexSharedPropertyOnHierarchyChangedObserver, IndexSynchronizedContentObserver, InitializeCatalogConfigurationObserver, InitializeCatalogSitemapObserver, InitializeProjectSitemapObserver, InvalidateCacheOnContentCommentedObserver, InvalidateCacheOnContentDeletionObserver, InvalidateCacheOnContentPageModificationObserver, InvalidateCacheOnContentPageModificationObserver, InvalidateCacheOnContentReactionObserver, InvalidateCacheOnContentUnpublishObserver, InvalidateCacheOnContentValidationObserver, InvalidateCacheOnContentValidationObserver, InvalidateCacheOnContentValidationOrTaggingObserver, InvalidateCacheOnContentValidationOrUnpublishingObserver, InvalidateCacheOnFormModifiedObserver, InvalidateCacheOnMemberUpdatedObserver, InvalidateCacheOnOrgunitChangedObserver, InvalidateCacheOnPageDeletionObserver, InvalidateCacheOnPageMinorChangeObserver, InvalidateCacheOnPageModificationObserver, InvalidateCacheOnPageMoveObserver, InvalidateCacheOnQueryChangesObserver, InvalidateCacheOnResourceUpdateObserver, InvalidateCacheOnRobotsChangeObserver, InvalidateCacheOnSitemapACLUpdateObserver, InvalidateCacheOnSkillsExclusionChangedObserver, InvalidateCacheOnSurveyAclUpdated, InvalidateCacheOnSurveyReInitializedObserver, InvalidateCacheOnZoneItemAdditionObserver, InvalidateCacheOnZoneItemDeletionObserver, InvalidateFlipbookCacheOnResourceUpdateObserver, InvalidateODFRootPageCacheOnPageDeleteObserver, InvalidatePageCacheExplorerObserver, InvalidatePageElementCacheObserver, InvalidatePageElementCacheOnPageACLUpdateListener, InvalidatePageElementCacheOnSiteChangeObserver, InvalidateSiteCacheObserver, InvalidateSiteCacheOnSignupPageUpdatedObserver, InvalidateSitemapSaxerCacheObserver, InvalidateZoneItemCacheOnContentCommentedObserver, InvalidateZoneItemCacheOnContentModificationObserver, InvalidateZoneItemCacheOnContentModificationObserver, InvalidateZoneItemCacheOnContentModificationObserver, InvalidateZoneItemCacheOnContentReactionObserver, InvalidateZoneItemCacheOnContentTaggedObserver, InvalidateZoneItemCacheOnContentValidationObserver, InvalidateZoneItemCacheOnContentValidationObserver, InvalidateZoneItemCacheOnContentValidationObserver, InvalidateZoneItemCacheOnMemberModificationObserver, InvalidateZoneItemCacheOnMemberUpdatedObserver, InvalidateZoneItemCacheOnRootUpdatedObserver, InvalidateZoneItemCacheOnServiceModificationObserver, InvalidateZoneItemCacheOnViewParametersModifiedObserver, InvalidateZoneItemCacheOnWallContentCommentedObserver, InvalidateZoneItemCacheOnWallContentObserver, InvalidateZoneItemCacheOnZoneItemModifiedObserver, InvalidateZoneItemCacheOnZoneItemMoveObserver, InvalidTagCloudCacheOnContentModification, InvalidTagCloudCacheOnServiceModification, InvalidTagCloudCacheOnSiteModification, JcrDataMigrationEndedObserver, MaintenanceObserver, MccRegimeObserver, MemberAddedObserver, MemberRemovedObserver, MemberValidatedObserver, MigrationAdministratorNotificator, ModifiedJobOfferObserver, ModifyingJobOfferObserver, NotifyActivityAsyncObserver, NotifyActivityObserver, NotifyContentMentionsObserver, NotifyContentMentionsObserver, ODFCartUserPreferencesObserver, PageAttachmentsSolrObserver, PageDAO, ProfileAssignmentStorageObserver, ProjectActivityObserver, ProjectAddedObserver, ProjectDeletedObserver, ProjectDeletedObserver, ProjectManager, QueryDeletedObserver, ReloadSolrCacheForAclUpdatedObserver, RemoteProgramDeletedObserver, RemoveEducationalPathOnContentDeletionObserver, RemoveMemberMailManagersNotifierObserver, RemoveMemberMailNotifierObserver, RemoveSearchServiceInstanceObserver, ResourceDeletedObserver, SendMailToContributorCommentListener, SendMailToVisitorCommentListener, SetReadAccessOnSiteAddedObserver, SetReadAccessOnSitemapAddedObserver, ShareableFieldCourseObserver, SharedContentValidationObserver, SkillsDisplayObserver, SolrContentDeletedObserver, SolrContentDeletedObserver, SolrContentModifiedObserver, SolrContentModifiedObserver, SolrContentRootPageDeletedObserver, SolrContentRootPageDeletedObserver, SolrContentRootPageUpdatedObserver, SolrContentRootPageUpdatedObserver, SolrContentUnpublishedObserver, SolrContentUnpublishedObserver, SolrContentUnpublishedPart1Observer, SolrContentUnpublishedPart2Observer, SolrContentValidatedObserver, 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, StoreActivityObserver, SynchronizeACLObserver, SynchronizeArchivesSiteAdditionObserver, SynchronizeArchivesSiteChangeObserver, SynchronizeArchivesSiteDeletionObserver, SynchronizeContentAdditionObserver, SynchronizeContentCommentedObserver, SynchronizeContentDeletionObserver, SynchronizeContentPrivacyChangeObserver, SynchronizeContentReactionObserver, SynchronizeContentTaggedObserver, SynchronizeContentUnpublishObserver, SynchronizeContentValidationObserver, SynchronizedContentTranslatedObserver, SynchronizePageAttachmentsObserver, SynchronizePageChangeObserver, SynchronizePageDataUpdateObserver, SynchronizePageDeletionObserver, SynchronizePageMoveObserver, SynchronizePageRenameObserver, SynchronizeRobotsChangeObserver, SynchronizeServiceModificationObserver, SynchronizeSiteAdditionObserver, SynchronizeSiteChangeObserver, SynchronizeSitemapAdditionObserver, SynchronizeSitemapChangeObserver, SynchronizeSitemapZonesObserver, SynchronizeSiteMoveObserver, SynchronizeSiteOrSitemapDeletionObserver, SynchronizeUserPopulationsObserver, TagAddedObserver, TagAutopostingSiteParameterObserverPart1, TagAutopostingSiteParameterObserverPart2, TagDeletedObserver, TagUpdatedObserver, ThematicCreationObserver, ThematicDeletionObserver, UGCContentRefusedObserver, UGCContentValidatedObserver, UnindexContentObserver, UnindexProgramObserver, UnindexUnarchivedContentObserver, UpdateContainerRulesStep1Observer, UpdateContainerRulesStep2Observer, UpdateProgramRulesStep1Observer, UpdateProgramRulesStep2Observer, UpdateThematicRulesStep1Observer, UpdateThematicRulesStep2Observer, UpdateTraversableProgramPartRulesStep1Observer, UpdateTraversableProgramPartRulesStep2Observer, UserContentCacheObserver, UserContentCollectionSynchronizedObserver, UserPageCacheObserver, WelcomeMemberMailNotifierObserver, XMLResourceBundleFactory
public interface Observer
Observer for consuming events.

  • Field Summary

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

  • Method Summary

    Modifier and Type
    Method
    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 Details

  • Method Details

    • 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.