lumis.portal.monitor

Class DummyMonitorManager

java.lang.Object

lumis.portal.monitor.DummyMonitorManager

All Implemented Interfaces:

IMonitorManager, IMonitorManagerSPI

public class DummyMonitorManager
extends Object
implements IMonitorManagerSPI

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

Since:

9.0.0

Version:

$Revision: 19136 $ $Date: 2016-06-02 21:14:45 +0000 (Thu, 02 Jun 2016) $

Constructor Summary

Constructors

Constructor and Description
DummyMonitorManager()

Method Summary

Modifier and Type	Method and Description
void	addEvent(IMonitorEvent event) Adds a event to persistence.
void	addEvent(SessionConfig sessionConfig, IMonitorEvent event, ITransaction transaction)
void	addField(IMonitorField field) Adds the given field to persistence.
boolean	consolidateCollectedMeasures()
IMonitorEvent	createEvent(String eventId) Creates a transient event instance.
IMonitorField	createField(String fieldId) Creates a transient field instance with the given identifier.
void	deleteEvent(IMonitorEvent event) Deletes a event from persistence.
void	deleteField(IMonitorField field) Deletes a field from persistence.
IMonitorEvent	getEvent(String eventId) Returns a persistent event instance.
ExecutorService	getExecutorService() Returns the executor service to be used when monitoring values.
IMonitorField	getField(String fieldId) Returns a persistent field instance.
IMonitor	getMonitor(String eventKey, Map<String,String> aggregationValues)
IMonitor	getMonitor(String eventKey, Map<String,String> aggregationValues, long eventDateTimeMillis)
IMonitorContext	getMonitorContext() Returns the current monitor context.
void	init() Initializes the monitor manager.
void	initializeMonitoringData(ITransaction transaction)
void	initializeMonitoringData(ITransaction transaction) Method called during portal database initialization to populate the monitoring related data.
IMonitor	monitor(String eventId) Returns the monitor for an event which has a given identifier.
IMonitor	monitor(String eventId, ITransaction transaction) Returns the monitor for an event which has a given identifier.
void	restartExecutorService() Restarts executor service.
void	shutdown() Shutdowns the monitor manager.

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

Throws:

PortalException

getMonitor

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

Throws:

PortalException

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

Throws:

PortalException

consolidateCollectedMeasures

public boolean consolidateCollectedMeasures()
                                     throws PortalException

Throws:

PortalException

addEvent

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

Throws:

PortalException

createEvent

public IMonitorEvent createEvent(String eventId)
                          throws PortalException

Description copied from interface: IMonitorManager

Creates a transient event instance.

Specified by:

createEvent in interface IMonitorManager

Parameters:

eventId - the desired event identifier.

Returns:

the created instance.

Throws:

PortalException

See Also:

#addEvent(SessionConfig, IMonitorEvent, ITransaction)

monitor

public IMonitor monitor(String eventId)
                 throws PortalException

Description copied from interface: IMonitorManager

Returns the monitor for an event which has a given identifier. The call to this method is equivalent of:

  getMonitor(eventId, null);

Specified by:

monitor in interface IMonitorManager

Parameters:

eventId - the event identifier.

Returns:

the monitor.

Throws:

PortalObjectNotFoundException - if there's no such event.

PortalException

See Also:

IMonitorManager, IMonitorManager.monitor(String, ITransaction)

monitor

public IMonitor monitor(String eventId,
                        ITransaction transaction)
                 throws PortalException

Description copied from interface: IMonitorManager

Returns the monitor for an event which has a given identifier.

If the given transaction is not null, the monitoring data will be saved after the transaction has terminated (either by a successful commit or by a rollback) and the monitor has been closed.

If the given transaction is null, the monitoring data will be saved when the monitor has been closed.

If the given transaction is not null, transaction monitoring will be recorded automatically, if the event of the given identifier has transaction results fields.

Specified by:

monitor in interface IMonitorManager

transaction - the transaction the given monitor will be bound to.

Returns:

the monitor.

Throws:

PortalObjectNotFoundException - if there's no such event.

PortalException

See Also:

IMonitorManager

addEvent

public void addEvent(IMonitorEvent event)
              throws PortalException

Description copied from interface: IMonitorManager

Adds a event to persistence.

Specified by:

addEvent in interface IMonitorManager

Parameters:

event - the transient event instance to be persisted.

Throws:

PortalException

getEvent

public IMonitorEvent getEvent(String eventId)
                       throws PortalException

Description copied from interface: IMonitorManager

Returns a persistent event instance.

Specified by:

getEvent in interface IMonitorManager

Parameters:

eventId - the event's identifier.

Returns:

a persistent event instance.

Throws:

PortalObjectNotFoundException - if no event with such id was found.

PortalException

deleteEvent

public void deleteEvent(IMonitorEvent event)
                 throws PortalException

Description copied from interface: IMonitorManager

Deletes a event from persistence.

Specified by:

deleteEvent in interface IMonitorManager

Parameters:

event - the persistent event instance to be deleted.

Throws:

PortalException

createField

public IMonitorField createField(String fieldId)
                          throws PortalException

Description copied from interface: IMonitorManager

Creates a transient field instance with the given identifier.

Specified by:

createField in interface IMonitorManager

Parameters:

fieldId - the field identifier.

Returns:

the created field.

Throws:

PortalException

addField

public void addField(IMonitorField field)
              throws PortalException

Description copied from interface: IMonitorManager

Adds the given field to persistence.

Specified by:

addField in interface IMonitorManager

Parameters:

field - the field.

Throws:

PortalException

getField

public IMonitorField getField(String fieldId)
                       throws PortalException

Description copied from interface: IMonitorManager

Returns a persistent field instance.

Specified by:

getField in interface IMonitorManager

Parameters:

fieldId - the field's identifier.

Returns:

a persistent field instance.

Throws:

PortalObjectNotFoundException - if no field with such id was found.

PortalException

deleteField

public void deleteField(IMonitorField field)
                 throws PortalException

Description copied from interface: IMonitorManager

Deletes a field from persistence.

Specified by:

deleteField in interface IMonitorManager

Parameters:

field - the persistent field to be deleted.

Throws:

PortalException

initializeMonitoringData

public void initializeMonitoringData(ITransaction transaction)
                              throws PortalException

Description copied from interface: IMonitorManagerSPI

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

Specified by:

initializeMonitoringData in interface IMonitorManagerSPI

Parameters:

transaction - the transaction for persistence access.

Throws:

PortalException

init

public void init()

Description copied from interface: IMonitorManagerSPI

Initializes the monitor manager.

Specified by:

init in interface IMonitorManagerSPI

shutdown

public void shutdown()

Description copied from interface: IMonitorManagerSPI

Shutdowns the monitor manager.

Specified by:

shutdown in interface IMonitorManagerSPI

getExecutorService

public ExecutorService getExecutorService()

Description copied from interface: IMonitorManagerSPI

Returns the executor service to be used when monitoring values.

Specified by:

getExecutorService in interface IMonitorManagerSPI

Returns:

the executor service to be used when monitoring values.

restartExecutorService

public void restartExecutorService()

Description copied from interface: IMonitorManagerSPI

Restarts executor service.

Specified by:

restartExecutorService in interface IMonitorManagerSPI