lumis.portal.monitor
Interface IMonitorManager

All Known Implementing Classes:

DummyMonitorManager, MonitorManager

public interface IMonitorManager

Provides operations and access to the portal monitoring framework.

When obtaining a monitor, the current state of the IMonitorContext may affect the monitor returned:

• If the monitor context is disabled, the monitor returned will not collect any data.
• If any aggregation type value is not specified in the given aggregation values map, the value is taken from the monitor context. If also not found there, the monitor returned will not collect any data.

Note that the state of the monitor context is checked at the moment of obtaining the monitor and further changes does not affect it.

Since:

4.1.0

See Also:

IMonitor

Method Summary

void	addAggregationType(SessionConfig sessionConfig, IAggregationType aggregationType, ITransaction transaction) Adds a aggregationType to persistence.
void	addCategory(SessionConfig sessionConfig, ICategory category, ITransaction transaction) Adds a category to persistence.
void	addEvent(SessionConfig sessionConfig, IEvent event, ITransaction transaction) Adds a event to persistence.
void	addMeasureType(SessionConfig sessionConfig, IMeasureType measureType, ITransaction transaction) Adds a measureType to persistence.
boolean	consolidateCollectedMeasures() Consolidate collected measures into its final persistence.
IAggregationType	createAggregationType() Creates a aggregationType transient instance.
ICategory	createCategory() Creates a category transient instance.
IEvent	createEvent() Creates a event transient instance.
IMeasureType	createMeasureType() Creates a measureType transient instance.
void	deleteAggregationType(SessionConfig sessionConfig, IAggregationType aggregationType, ITransaction transaction) Deletes a aggregationType from persistence.
void	deleteCategory(SessionConfig sessionConfig, ICategory category, ITransaction transaction) Deletes a category from persistence.
void	deleteEvent(SessionConfig sessionConfig, IEvent event, ITransaction transaction) Deletes a event from persistence.
void	deleteMeasureType(SessionConfig sessionConfig, IMeasureType measureType, ITransaction transaction) Deletes a measureType from persistence.
IAggregationType	getAggregationType(SessionConfig sessionConfig, String aggregationTypeId, ITransaction transaction) Returns a persistent aggregationType instance.
IAggregationType	getAggregationTypeByKey(SessionConfig sessionConfig, String aggregationTypeKey, ITransaction transaction) Returns a persistent aggregationType instance, finding it by the aggregationTypeKey.
ICategory	getCategory(SessionConfig sessionConfig, String categoryId, ITransaction transaction) Returns a persistent category instance.
IEvent	getEvent(SessionConfig sessionConfig, String eventId, ITransaction transaction) Returns a persistent event instance.
IEvent	getEventByKey(SessionConfig sessionConfig, String eventKey, ITransaction transaction) Returns a persistent event instance, finding it by the eventKey.
IMeasureType	getMeasureType(SessionConfig sessionConfig, String measureTypeId, ITransaction transaction) Returns a persistent measureType instance.
IMeasureType	getMeasureTypeByKey(SessionConfig sessionConfig, String measureTypeKey, ITransaction transaction) Returns a persistent measureType instance, finding it by the measureTypeKey.
IMonitor	getMonitor(String eventKey, Map<String,String> aggregationValues) Returns the monitor for an event with the given aggregation values.
IMonitor	getMonitor(String eventKey, Map<String,String> aggregationValues, long eventDateTimeMillis) Returns the monitor for an event with the given aggregation values.
IMonitorContext	getMonitorContext() Returns the current monitor context.
void	initializeMonitoringData(ITransaction transaction) Method called during portal database initialization to populate the monitoring related data.

Method Detail

getMonitor

IMonitor getMonitor(String eventKey,
                    Map<String,String> aggregationValues)
                    throws PortalException

Returns the monitor for an event with the given aggregation values.

Parameters:

eventKey - the event's key.

aggregationValues - a map with the aggregation values for the event the monitor will collect data for. The map key is the aggregation type key and the value is its corresponding value.

Returns:

the monitor.

Throws:

PortalException

Since:

4.1.0

See Also:

IMonitorManager

getMonitor

IMonitor getMonitor(String eventKey,
                    Map<String,String> aggregationValues,
                    long eventDateTimeMillis)
                    throws PortalException

Returns the monitor for an event with the given aggregation values.

Parameters:

eventKey - the event's key.

aggregationValues - a map with the aggregation values for the event the monitor will collect data for. The map key is the aggregation type key and the value is its corresponding value.

eventDateTimeMillis - the instant of the event, as the number of milliseconds since midnight January 1, 1970 GMT.

Returns:

the monitor.

Throws:

PortalException

Since:

4.1.0

See Also:

IMonitorManager

initializeMonitoringData

void initializeMonitoringData(ITransaction transaction)
                              throws PortalException

Method called during portal database initialization to populate the monitoring related data.

Parameters:

transaction - the transaction for persistence access.

Throws:

PortalException

Since:

4.1.0

consolidateCollectedMeasures

boolean consolidateCollectedMeasures()
                                     throws PortalException

Consolidate collected measures into its final persistence. This method consolidates some collected measures, but not necessarily all. This method is intended not to take much time to complete its execution.

Returns:

true if some consolidation was done (and possibly there is more to do) or false if there was nothing to consolidate.

Throws:

PortalException

Since:

4.1.0

getMonitorContext

IMonitorContext getMonitorContext()

Returns the current monitor context.

Returns:

the current monitor context, or null if there is no current monitor context.

Since:

4.1.0

createCategory

ICategory createCategory()
                         throws PortalException

Creates a category transient instance.

Returns:

the created instance.

Throws:

PortalException

Since:

4.1.0

See Also:

addCategory(SessionConfig, ICategory, ITransaction)

addCategory

void addCategory(SessionConfig sessionConfig,
                 ICategory category,
                 ITransaction transaction)
                 throws PortalException

Adds a category to persistence.

Parameters:

sessionConfig - the user session information.

category - the transient category instance to be persisted.

transaction - the transaction for persistence access.

Throws:

PortalException

Since:

4.1.0

getCategory

ICategory getCategory(SessionConfig sessionConfig,
                      String categoryId,
                      ITransaction transaction)
                      throws PortalException

Returns a persistent category instance.

Parameters:

sessionConfig - the user session information.

categoryId - the category's identifier.

transaction - the transaction for persistence access.

Returns:

a persistent category instance.

Throws:

PortalObjectNotFoundException - if no category with such id was found.

PortalException

Since:

4.1.0

deleteCategory

void deleteCategory(SessionConfig sessionConfig,
                    ICategory category,
                    ITransaction transaction)
                    throws PortalException

Deletes a category from persistence.

Parameters:

sessionConfig - the user session information.

category - the persistent category instance to be deleted.

transaction - the transaction for persistence access.

Throws:

PortalException

Since:

4.1.0

createEvent

IEvent createEvent()
                   throws PortalException

Creates a event transient instance.

Returns:

the created instance.

Throws:

PortalException

Since:

4.1.0

See Also:

addEvent(SessionConfig, IEvent, ITransaction)

addEvent

void addEvent(SessionConfig sessionConfig,
              IEvent event,
              ITransaction transaction)
              throws PortalException

Adds a event to persistence.

Parameters:

sessionConfig - the user session information.

event - the transient event instance to be persisted.

transaction - the transaction for persistence access.

Throws:

PortalException

Since:

4.1.0

getEvent

IEvent getEvent(SessionConfig sessionConfig,
                String eventId,
                ITransaction transaction)
                throws PortalException

Returns a persistent event instance.

Parameters:

sessionConfig - the user session information.

eventId - the event's identifier.

transaction - the transaction for persistence access.

Returns:

a persistent event instance.

Throws:

PortalObjectNotFoundException - if no event with such id was found.

PortalException

Since:

4.1.0

deleteEvent

void deleteEvent(SessionConfig sessionConfig,
                 IEvent event,
                 ITransaction transaction)
                 throws PortalException

Deletes a event from persistence.

Parameters:

sessionConfig - the user session information.

event - the persistent event instance to be deleted.

transaction - the transaction for persistence access.

Throws:

PortalException

Since:

4.1.0

getEventByKey

IEvent getEventByKey(SessionConfig sessionConfig,
                     String eventKey,
                     ITransaction transaction)
                     throws PortalException

Returns a persistent event instance, finding it by the eventKey.

Parameters:

sessionConfig - the user session information.

eventKey - the event's key.

transaction - the transaction for persistence access.

Returns:

a persistent event instance.

Throws:

PortalObjectNotFoundException - if no event with such key was found.

PortalException

Since:

4.1.0

createMeasureType

IMeasureType createMeasureType()
                               throws PortalException

Creates a measureType transient instance.

Returns:

the created instance.

Throws:

PortalException

Since:

4.1.0

See Also:

addMeasureType(SessionConfig, IMeasureType, ITransaction)

addMeasureType

void addMeasureType(SessionConfig sessionConfig,
                    IMeasureType measureType,
                    ITransaction transaction)
                    throws PortalException

Adds a measureType to persistence.

Parameters:

sessionConfig - the user session information.

measureType - the transient measureType instance to be persisted.

transaction - the transaction for persistence access.

Throws:

PortalException

Since:

4.1.0

getMeasureType

IMeasureType getMeasureType(SessionConfig sessionConfig,
                            String measureTypeId,
                            ITransaction transaction)
                            throws PortalException

Returns a persistent measureType instance.

Parameters:

sessionConfig - the user session information.

measureTypeId - the measureType's identifier.

transaction - the transaction for persistence access.

Returns:

a persistent measureType instance.

Throws:

PortalObjectNotFoundException - if no measureType with such id was found.

PortalException

Since:

4.1.0

deleteMeasureType

void deleteMeasureType(SessionConfig sessionConfig,
                       IMeasureType measureType,
                       ITransaction transaction)
                       throws PortalException

Deletes a measureType from persistence.

Parameters:

sessionConfig - the user session information.

measureType - the persistent measureType instance to be deleted.

transaction - the transaction for persistence access.

Throws:

PortalException

Since:

4.1.0

getMeasureTypeByKey

IMeasureType getMeasureTypeByKey(SessionConfig sessionConfig,
                                 String measureTypeKey,
                                 ITransaction transaction)
                                 throws PortalException

Returns a persistent measureType instance, finding it by the measureTypeKey.

Parameters:

sessionConfig - the user session information.

measureTypeKey - the measureType's key.

transaction - the transaction for persistence access.

Returns:

a persistent measureType instance.

Throws:

PortalObjectNotFoundException - if no measureType with such key was found.

PortalException

Since:

4.1.0

createAggregationType

IAggregationType createAggregationType()
                                       throws PortalException

Creates a aggregationType transient instance.

Returns:

the created instance.

Throws:

PortalException

Since:

4.1.0

See Also:

addAggregationType(SessionConfig, IAggregationType, ITransaction)

addAggregationType

void addAggregationType(SessionConfig sessionConfig,
                        IAggregationType aggregationType,
                        ITransaction transaction)
                        throws PortalException

Adds a aggregationType to persistence.

Parameters:

sessionConfig - the user session information.

aggregationType - the transient aggregationType instance to be persisted.

transaction - the transaction for persistence access.

Throws:

PortalException

Since:

4.1.0

getAggregationType

IAggregationType getAggregationType(SessionConfig sessionConfig,
                                    String aggregationTypeId,
                                    ITransaction transaction)
                                    throws PortalException

Returns a persistent aggregationType instance.

Parameters:

sessionConfig - the user session information.

aggregationTypeId - the aggregationType's identifier.

transaction - the transaction for persistence access.

Returns:

a persistent aggregationType instance.

Throws:

PortalObjectNotFoundException - if no aggregationType with such id was found.

PortalException

Since:

4.1.0

deleteAggregationType

void deleteAggregationType(SessionConfig sessionConfig,
                           IAggregationType aggregationType,
                           ITransaction transaction)
                           throws PortalException

Deletes a aggregationType from persistence.

Parameters:

sessionConfig - the user session information.

aggregationType - the persistent aggregationType instance to be deleted.

transaction - the transaction for persistence access.

Throws:

PortalException

Since:

4.1.0

getAggregationTypeByKey

IAggregationType getAggregationTypeByKey(SessionConfig sessionConfig,
                                         String aggregationTypeKey,
                                         ITransaction transaction)
                                         throws PortalException

Returns a persistent aggregationType instance, finding it by the aggregationTypeKey.

Parameters:

sessionConfig - the user session information.

aggregationTypeKey - the aggregationType's key.

transaction - the transaction for persistence access.

Returns:

a persistent aggregationType instance.

Throws:

PortalObjectNotFoundException - if no aggregationType with such key was found.

PortalException

Since:

4.1.0