lumis.portal.event

Interface IPortalEventObserver

All Known Implementing Classes:

AbstractPortalEventObserver, ActivityDocumentObserver, ActivityStreamBigDataInitObserver, AutoAdministrationObserver, ClearDouiRestCacheEventObserver, ClusterMembershipObserver, CommandPaletteBigDataInitializedEventObserver, CommentItContentDeleteObserver, ContentIndexerObserver, ContentUrlUpdateObserver, DouiBigDataUtil.DouiBigDataInitObserver, HtmlInjectorEventObserver, HtmlProcessorEventObserver, LikeItContentDeleteObserver, LocalizationCacheClearObserver, MicroblogPortalObserver, MonitorBigDataInitObserver, PageBlockRenderDataChangedObserver, PageCacheObserver, PagePersonalizationObserver, RssObserver, ServiceInterfaceInstanceDeleteObserver, ServiceInterfaceInstanceObserver, SocialProfilePortalObserver, URLConversionCacheObserver, UserPostContentPublicationUpdateObserver, WebFileReplicationObserver, WidgetRenderDataChangedObserver

@StableMinor(version="12.3",
             sinceVersion="4.2")
public interface IPortalEventObserver

An observer of IPortalEvent's. All portal event observer implementations must implement this interface.

Instead of implementing this class directly, consider extending AbstractPortalEventObserver.

Since:

4.1.0

Version:

$Revision: 23746 $ $Date: 2020-04-07 23:14:34 +0000 (Tue, 07 Apr 2020) $

See Also:

lumis.portal.event

Method Summary

Modifier and Type	Method and Description
IPortalEventFilter	getEventFilter() Returns the event filter for this observer.
void	onEvent(IPortalEvent event) Notifies that an event has been raised.

Method Detail

getEventFilter

IPortalEventFilter getEventFilter()

Returns the event filter for this observer.

PortalEventFilters provides methods for generating commonly used filters.

Returns:

a collection of event group identifiers.

Since:

4.1.0

See Also:

PortalEventFilters

onEvent

void onEvent(IPortalEvent event)
      throws PortalException

Notifies that an event has been raised. This method will be called only for events that belong to the groups specified by #getExpectedEventGroups().

Important: The implementation of this method must not be time consuming, as it may impact the overall time response of the portal.

Parameters:

event - the event.

Throws:

PortalException

Since:

4.1.0