lumis.portal.event

Interface IPortalEventManager

All Known Implementing Classes:

PortalEventManager

@StableMinor(version="12.4",
             sinceVersion="4.0")
public interface IPortalEventManager

Provides operations and access to the portal monitoring framework.

Since:

4.0.0

Version:

$Revision: 23904 $ $Date: 2020-06-16 15:23:44 +0000 (Tue, 16 Jun 2020) $

See Also:

lumis.portal.event

Method Summary

Modifier and Type	Method and Description
String	addObserver(SessionConfig sessionConfig, ObserverConfig observerConfig, ITransaction transaction) Adds an observer to the persistence.
void	deleteObserver(SessionConfig sessionConfig, String observerId, ITransaction transaction) Deletes an observer configuration from persistence.
ObserverConfig	getObserver(SessionConfig sessionConfig, String observerId, ITransaction transaction) Returns an observer configuration.
ObserverConfig	getObserverByClassName(SessionConfig sessionConfig, String observerClassName, ITransaction transaction) Searches for an observer configuration based on its class name.
void	initObservers(SessionConfig sessionConfig, ITransaction transaction) Initializes the observers.
void	notifyObservers(IPortalEvent event) Notify event observers of the given event.
void	notifyObservers(Object arg0) Deprecated. Since 4.1.0, replaced by notifyObservers(IPortalEvent).
void	registerObservers(SessionConfig sessionConfig, String observersConfigPath, ITransaction transaction) Registers the observers in the specified observer configuration file.
void	updateObserver(SessionConfig sessionConfig, ObserverConfig observerConfig, ITransaction transaction) Updates an observer configuration in persistence.

Method Detail

registerObservers

void registerObservers(SessionConfig sessionConfig,
                       String observersConfigPath,
                       ITransaction transaction)
                throws PortalException

Registers the observers in the specified observer configuration file.

Parameters:

sessionConfig - the user session information.

observersConfigPath - the path to the observer configuration file, relative to the definition folder.

transaction - the transaction for persistence access.

Throws:

PortalException

initObservers

void initObservers(SessionConfig sessionConfig,
                   ITransaction transaction)
            throws PortalException

Initializes the observers.

Parameters:

sessionConfig - the user session information.

transaction - the transaction for persistence access.

Throws:

PortalException

getObserver

ObserverConfig getObserver(SessionConfig sessionConfig,
                           String observerId,
                           ITransaction transaction)
                    throws PortalException

Returns an observer configuration.

Parameters:

sessionConfig - the user session information.

observerId - the observer's identifier.

transaction - the transaction for persistence access.

Returns:

Returns the observer configuration.

Throws:

PortalException

getObserverByClassName

ObserverConfig getObserverByClassName(SessionConfig sessionConfig,
                                      String observerClassName,
                                      ITransaction transaction)
                               throws PortalException

Searches for an observer configuration based on its class name.

Parameters:

sessionConfig - the user session information.

observerClassName - the observer's class name.

transaction - the transaction for persistence access.

Returns:

Returns the observer configuration.

Throws:

PortalException

addObserver

String addObserver(SessionConfig sessionConfig,
                   ObserverConfig observerConfig,
                   ITransaction transaction)
            throws PortalException

Adds an observer to the persistence. The corresponding observer implementation will be initialized after the transaction is committed.

Parameters:

sessionConfig - the user session information.

observerConfig - the observer configuration.

transaction - the transaction for persistence access.

Returns:

the identifier for the observer configuration saved.

Throws:

PortalException

updateObserver

void updateObserver(SessionConfig sessionConfig,
                    ObserverConfig observerConfig,
                    ITransaction transaction)
             throws PortalException

Updates an observer configuration in persistence. The corresponding observer implementation will be initialized after the transaction is committed.

Parameters:

sessionConfig - the user session information.

observerConfig - the observer configuration.

transaction - the transaction for persistence access.

Throws:

PortalException

deleteObserver

void deleteObserver(SessionConfig sessionConfig,
                    String observerId,
                    ITransaction transaction)
             throws PortalException

Deletes an observer configuration from persistence. The corresponding observer implementation will cease to be notified of events after the transaction is committed.

Parameters:

sessionConfig - the user session information.

observerId - the observer's identifier.

transaction - the transaction for persistence access.

Throws:

PortalException

notifyObservers

@Deprecated
void notifyObservers(Object arg0)

Deprecated. Since 4.1.0, replaced by notifyObservers(IPortalEvent).

notifyObservers

void notifyObservers(IPortalEvent event)
              throws PortalException

Notify event observers of the given event.

Parameters:

event - the event.

Throws:

PortalException - if an observer throws an exception.

Since:

4.1.0