lumis.portal.monitor
Class DummyMonitorManager

java.lang.Object
  lumis.portal.monitor.DummyMonitorManager

All Implemented Interfaces:

IMonitorManager

Direct Known Subclasses:

MonitorManager

public class DummyMonitorManager
extends Object
implements IMonitorManager

An implementation of IMonitorManager that does not monitor anything. This is used when the portal does not have the monitoring module installed.

Since:

4.1.0

Constructor Summary

DummyMonitorManager()

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DummyMonitorManager

public DummyMonitorManager()

Method Detail

getMonitor

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

Description copied from interface: IMonitorManager

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

Specified by:

getMonitor in interface IMonitorManager

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

See Also:

IMonitorManager

getMonitor

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

Description copied from interface: IMonitorManager

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

Specified by:

getMonitor in interface IMonitorManager

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

See Also:

IMonitorManager

getMonitorContext

public IMonitorContext getMonitorContext()

Description copied from interface: IMonitorManager

Returns the current monitor context.

Specified by:

getMonitorContext in interface IMonitorManager

Returns:

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

initializeMonitoringData

public void initializeMonitoringData(ITransaction transaction)
                              throws PortalException

Description copied from interface: IMonitorManager

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

Specified by:

initializeMonitoringData in interface IMonitorManager

Parameters:

transaction - the transaction for persistence access.

Throws:

PortalException

consolidateCollectedMeasures

public boolean consolidateCollectedMeasures()
                                     throws PortalException

Description copied from interface: IMonitorManager

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.

Specified by:

consolidateCollectedMeasures in interface IMonitorManager

Returns:

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

Throws:

PortalException

addCategory

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

Description copied from interface: IMonitorManager

Adds a category to persistence.

Specified by:

addCategory in interface IMonitorManager

Parameters:

sessionConfig - the user session information.

category - the transient category instance to be persisted.

transaction - the transaction for persistence access.

Throws:

PortalException

addEvent

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

Description copied from interface: IMonitorManager

Adds a event to persistence.

Specified by:

addEvent in interface IMonitorManager

Parameters:

sessionConfig - the user session information.

event - the transient event instance to be persisted.

transaction - the transaction for persistence access.

Throws:

PortalException

createCategory

public ICategory createCategory()
                         throws PortalException

Description copied from interface: IMonitorManager

Creates a category transient instance.

Specified by:

createCategory in interface IMonitorManager

Returns:

the created instance.

Throws:

PortalException

See Also:

IMonitorManager.addCategory(SessionConfig, ICategory, ITransaction)

createEvent

public IEvent createEvent()
                   throws PortalException

Description copied from interface: IMonitorManager

Creates a event transient instance.

Specified by:

createEvent in interface IMonitorManager

Returns:

the created instance.

Throws:

PortalException

See Also:

IMonitorManager.addEvent(SessionConfig, IEvent, ITransaction)

deleteCategory

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

Description copied from interface: IMonitorManager

Deletes a category from persistence.

Specified by:

deleteCategory in interface IMonitorManager

Parameters:

sessionConfig - the user session information.

category - the persistent category instance to be deleted.

transaction - the transaction for persistence access.

Throws:

PortalException

deleteEvent

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

Description copied from interface: IMonitorManager

Deletes a event from persistence.

Specified by:

deleteEvent in interface IMonitorManager

Parameters:

sessionConfig - the user session information.

event - the persistent event instance to be deleted.

transaction - the transaction for persistence access.

Throws:

PortalException

getCategory

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

Description copied from interface: IMonitorManager

Returns a persistent category instance.

Specified by:

getCategory in interface IMonitorManager

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

getEvent

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

Description copied from interface: IMonitorManager

Returns a persistent event instance.

Specified by:

getEvent in interface IMonitorManager

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

getEventByKey

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

Description copied from interface: IMonitorManager

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

Specified by:

getEventByKey in interface IMonitorManager

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

addAggregationType

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

Description copied from interface: IMonitorManager

Adds a aggregationType to persistence.

Specified by:

addAggregationType in interface IMonitorManager

Parameters:

sessionConfig - the user session information.

aggregationType - the transient aggregationType instance to be persisted.

transaction - the transaction for persistence access.

Throws:

PortalException

addMeasureType

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

Description copied from interface: IMonitorManager

Adds a measureType to persistence.

Specified by:

addMeasureType in interface IMonitorManager

Parameters:

sessionConfig - the user session information.

measureType - the transient measureType instance to be persisted.

transaction - the transaction for persistence access.

Throws:

PortalException

createAggregationType

public IAggregationType createAggregationType()
                                       throws PortalException

Description copied from interface: IMonitorManager

Creates a aggregationType transient instance.

Specified by:

createAggregationType in interface IMonitorManager

Returns:

the created instance.

Throws:

PortalException

See Also:

IMonitorManager.addAggregationType(SessionConfig, IAggregationType, ITransaction)

createMeasureType

public IMeasureType createMeasureType()
                               throws PortalException

Description copied from interface: IMonitorManager

Creates a measureType transient instance.

Specified by:

createMeasureType in interface IMonitorManager

Returns:

the created instance.

Throws:

PortalException

See Also:

IMonitorManager.addMeasureType(SessionConfig, IMeasureType, ITransaction)

deleteAggregationType

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

Description copied from interface: IMonitorManager

Deletes a aggregationType from persistence.

Specified by:

deleteAggregationType in interface IMonitorManager

Parameters:

sessionConfig - the user session information.

aggregationType - the persistent aggregationType instance to be deleted.

transaction - the transaction for persistence access.

Throws:

PortalException

deleteMeasureType

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

Description copied from interface: IMonitorManager

Deletes a measureType from persistence.

Specified by:

deleteMeasureType in interface IMonitorManager

Parameters:

sessionConfig - the user session information.

measureType - the persistent measureType instance to be deleted.

transaction - the transaction for persistence access.

Throws:

PortalException

getAggregationType

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

Description copied from interface: IMonitorManager

Returns a persistent aggregationType instance.

Specified by:

getAggregationType in interface IMonitorManager

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

getAggregationTypeByKey

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

Description copied from interface: IMonitorManager

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

Specified by:

getAggregationTypeByKey in interface IMonitorManager

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

getMeasureType

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

Description copied from interface: IMonitorManager

Returns a persistent measureType instance.

Specified by:

getMeasureType in interface IMonitorManager

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

getMeasureTypeByKey

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

Description copied from interface: IMonitorManager

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

Specified by:

getMeasureTypeByKey in interface IMonitorManager

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