lumis.portal.monitor

Interface IMonitorManager

All Known Subinterfaces:

IMonitorManagerSPI

All Known Implementing Classes:

DummyMonitorManager, MonitorManager

@StableMinor(version="10.1",
             sinceVersion="9.0")
public interface IMonitorManager

Provides operations and access to the portal monitoring framework.

Each monitor obtained will generate one monitoring entry. The monitoring data will be saved in the default big data repository.

Since:

9.0.0

Version:

$Revision: 19961 $ $Date: 2017-02-21 21:39:20 +0000 (Tue, 21 Feb 2017) $

See Also:

IMonitor

Method Summary

Modifier and Type	Method and Description
void	addEvent(IMonitorEvent event) Adds a event to persistence.
void	addField(IMonitorField field) Adds the given field to persistence.
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.
IMonitorField	getField(String fieldId) Returns a persistent field instance.
IMonitorContext	getMonitorContext() Returns the current monitor context.
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.

Method Detail

monitor

IMonitor monitor(String eventId)
          throws PortalException

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

  getMonitor(eventId, null);

Parameters:

eventId - the event identifier.

Returns:

the monitor.

Throws:

PortalObjectNotFoundException - if there's no such event.

NullPointerException - if the given eventId is null or empty.

PortalException

Since:

9.0.0

See Also:

IMonitorManager, monitor(String, ITransaction)

monitor

IMonitor monitor(String eventId,
                 ITransaction transaction)
          throws PortalException

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.

Parameters:

event - the event.

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

Returns:

the monitor.

Throws:

PortalObjectNotFoundException - if there's no such event.

NullPointerException - if the given eventId is null or empty.

PortalException

Since:

9.0.0

See Also:

IMonitorManager

getMonitorContext

IMonitorContext getMonitorContext()

Returns the current monitor context.

Returns:

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

Since:

9.0.0

createEvent

IMonitorEvent createEvent(String eventId)
                   throws PortalException

Creates a transient event instance.

Parameters:

eventId - the desired event identifier.

Returns:

the created instance.

Throws:

PortalException

Since:

9.0.0

See Also:

#addEvent(SessionConfig, IMonitorEvent, ITransaction)

addEvent

void addEvent(IMonitorEvent event)
       throws PortalException

Adds a event to persistence.

Parameters:

event - the transient event instance to be persisted.

Throws:

PortalException

Since:

9.0.0

getEvent

IMonitorEvent getEvent(String eventId)
                throws PortalException

Returns a persistent event instance.

Parameters:

eventId - the event's identifier.

Returns:

a persistent event instance.

Throws:

PortalObjectNotFoundException - if no event with such id was found.

PortalException

Since:

9.0.0

deleteEvent

void deleteEvent(IMonitorEvent event)
          throws PortalException

Deletes a event from persistence.

Parameters:

event - the persistent event instance to be deleted.

Throws:

PortalException

Since:

9.0.0

createField

IMonitorField createField(String fieldId)
                   throws PortalException

Creates a transient field instance with the given identifier.

Parameters:

fieldId - the field identifier.

Returns:

the created field.

Throws:

PortalException

Since:

9.0.0

addField

void addField(IMonitorField field)
       throws PortalException

Adds the given field to persistence.

Parameters:

field - the field.

Throws:

PortalException

Since:

9.0.0

getField

IMonitorField getField(String fieldId)
                throws PortalException

Returns a persistent field instance.

Parameters:

fieldId - the field's identifier.

Returns:

a persistent field instance.

Throws:

PortalObjectNotFoundException - if no field with such id was found.

PortalException

Since:

9.0.0

deleteField

void deleteField(IMonitorField field)
          throws PortalException

Deletes a field from persistence.

Parameters:

field - the persistent field to be deleted.

Throws:

PortalException

Since:

9.0.0