|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@StableMinor(version="4.1", sinceVersion="4.0") public interface IPortalEventManager
Provides operations and access to the portal monitoring framework.
lumis.portal.event
Method Summary | |
---|---|
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 |
---|
void registerObservers(SessionConfig sessionConfig, String observersConfigPath, ITransaction transaction) throws PortalException
sessionConfig
- the user session information.observersConfigPath
- the path to the observer configuration file,
relative to the definition folder.transaction
- the transaction for persistence access.
PortalException
void initObservers(SessionConfig sessionConfig, ITransaction transaction) throws PortalException
sessionConfig
- the user session information.transaction
- the transaction for persistence access.
PortalException
ObserverConfig getObserver(SessionConfig sessionConfig, String observerId, ITransaction transaction) throws PortalException
sessionConfig
- the user session information.observerId
- the observer's identifier.transaction
- the transaction for persistence access.
PortalException
ObserverConfig getObserverByClassName(SessionConfig sessionConfig, String observerClassName, ITransaction transaction) throws PortalException
sessionConfig
- the user session information.observerClassName
- the observer's class name.transaction
- the transaction for persistence access.
PortalException
String addObserver(SessionConfig sessionConfig, ObserverConfig observerConfig, ITransaction transaction) throws PortalException
sessionConfig
- the user session information.observerConfig
- the observer configuration.transaction
- the transaction for persistence access.
PortalException
void updateObserver(SessionConfig sessionConfig, ObserverConfig observerConfig, ITransaction transaction) throws PortalException
sessionConfig
- the user session information.observerConfig
- the observer configuration.transaction
- the transaction for persistence access.
PortalException
void deleteObserver(SessionConfig sessionConfig, String observerId, ITransaction transaction) throws PortalException
sessionConfig
- the user session information.observerId
- the observer's identifier.transaction
- the transaction for persistence access.
PortalException
@Deprecated void notifyObservers(Object arg0)
notifyObservers(IPortalEvent)
.
void notifyObservers(IPortalEvent event) throws PortalException
event
- the event.
PortalException
- if an observer throws an exception.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |