Package lumis.portal.monitor

Interface IMonitorManager

All Known Subinterfaces:

IMonitorManagerSPI

All Known Implementing Classes:

MonitorManager

@StableMinor(version="16.0",
             sinceVersion="11.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: 25808 $ $Date: 2023-07-04 15:20:55 -0300 (Tue, 04 Jul 2023) $

See Also:

IMonitor

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCurrentMonitorUserId()	Returns the identifier of the current monitor user.
IMonitorEvent	getEvent(java.lang.String eventId)	Returns an unmodifiable event.
IMonitorField	getField(java.lang.String fieldId)	Returns an unmodifiable field.
IMonitorFieldGroup	getFieldGroup(java.lang.String fieldGroupId)	Returns an unmodifiable field group.
IMonitorContext	getMonitorContext()	Returns the current monitor context.
IMonitor	monitor(java.lang.String eventId)	Returns the monitor for an event with the given identifier.
IMonitor	monitor(java.lang.String eventId, ITransaction transaction)	Returns the monitor for an event with the given identifier.

Method Detail

monitor

IMonitor monitor(java.lang.String eventId)
          throws PortalException

Returns the monitor for an event with the given identifier.

The call to this method is equivalent of monitor(eventId, null).

Parameters:

eventId - the event identifier.

Returns:

the monitor.

Throws:

java.lang.NullPointerException - if the given eventId is null or empty.

PortalException

Since:

9.0.0

See Also:

IMonitor, monitor(String, ITransaction)

monitor

IMonitor monitor(java.lang.String eventId,
                 ITransaction transaction)
          throws PortalException

Returns the monitor for an event with the given identifier.

If no event with the given identifier exists then a warn message will be generated in the LumisXP log.

If no event with the given identifier exists or if the event is disabled then a dummy monitor object will be returned (a IMonitor implementation that will not persist any data).

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, values for transaction result fields will provided automatically if the event has any of those fields.

Parameters:

eventId - the event identifier.

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

Returns:

the monitor.

Throws:

java.lang.NullPointerException - if the given eventId is null or empty.

PortalException

Since:

9.0.0

See Also:

IMonitor

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

getEvent

IMonitorEvent getEvent(java.lang.String eventId)
                throws PortalException

Returns an unmodifiable event.

Parameters:

eventId - the event's identifier.

Returns:

an unmodifiable event.

Throws:

PortalObjectNotFoundException - if no event with such id was found.

PortalException

Since:

9.0.0

getField

IMonitorField getField(java.lang.String fieldId)
                throws PortalException

Returns an unmodifiable field.

Parameters:

fieldId - the field's identifier.

Returns:

an unmodifiable field.

Throws:

PortalObjectNotFoundException - if no field with such id was found.

PortalException

Since:

9.0.0

getFieldGroup

IMonitorFieldGroup getFieldGroup(java.lang.String fieldGroupId)
                          throws PortalException

Returns an unmodifiable field group.

Parameters:

fieldGroupId - the field group's identifier.

Returns:

an unmodifiable field group.

Throws:

PortalObjectNotFoundException - if no such field group was found.

PortalException

Since:

11.0.0

getCurrentMonitorUserId

java.lang.String getCurrentMonitorUserId()

Returns the identifier of the current monitor user.

Returns:

the monitor user identifier, or null if it is not set.

Since:

11.0.0