lumis.portal.monitor.impl

Class MonitorManager

java.lang.Object

lumis.portal.monitor.impl.MonitorManager

All Implemented Interfaces:

IMonitorManager, IMonitorManagerSPI

public class MonitorManager
extends Object
implements IMonitorManagerSPI

Implementation for the IMonitorManagerSPI interface.

Since:

9.0.0

Version:

$Revision: 21881 $ $Date: 2018-09-21 20:09:37 +0000 (Fri, 21 Sep 2018) $

Field Summary

Fields inherited from interface lumis.portal.monitor.IMonitorManagerSPI

FRIENDLY_ID_FIELD_EMAIL, FRIENDLY_ID_FIELD_ID, FRIENDLY_ID_FIELD_LOGIN

Constructor Summary

Constructors

Constructor and Description
MonitorManager()

Method Summary

Modifier and Type	Method and Description
String	addMonitorUser(UserConfig userConfig) Adds a new monitor user to persistence.
void	clearRequestRulesCache() Clears the request rules cache.
Collection<IMonitorEvent>	getAllEvents() Returns all monitor events.
Collection<IMonitorField>	getAllFields() Returns all monitor fields.
String	getCurrentMonitorUserId() Returns the identifier of the current monitor user.
IMonitorEventSPI	getEvent(String eventId) Returns an unmodifiable event.
ExecutorService	getExecutorService() Returns the executor service to be used when monitoring values.
IMonitorFieldSPI	getField(String fieldId) Returns an unmodifiable field.
IMonitorFieldGroup	getFieldGroup(String fieldGroupId) Returns an unmodifiable field group.
String	getFriendlyIdUserField() Returns the field used to calculated the monitor user's friendly id for portal users.
lumis.portal.monitor.impl.MonitorContext	getMonitorContext() Returns the current monitor context.
IMonitorValuesProvider	getMonitorUserValuesProvider(String monitorUserId) Returns a monitor values provider that returns the values for monitor user fields.
void	init() Initializes the monitor manager.
void	initializeMonitoringData(ITransaction transaction) Method called during portal database initialization to populate the monitoring related data.
void	initializeMonitorRequestRules() Initializes the monitor request rules.
void	mergeMonitorUserDuringAuthentication(String httpSessionId, String srcMonitorUserId, String destMonitorUserId) Merges a monitor user to another, because a http session identified as the first monitor user was authenticated as the second monitor user.
void	mergeMonitorUsers(String srcMonitorUserId, String destMonitorUserId) Merger monitor users.
IMonitor	monitor(String eventId) Returns the monitor for an event with the given identifier.
IMonitor	monitor(String eventId, ITransaction transaction) Returns the monitor for an event with the given identifier.
protected void	persistFieldRecursively(org.hibernate.Session session, IMonitorField field) Persist the given field and any inner fields recursively.
void	reindexAllMonitorUser() Reindex all monitor users and their event data.
void	reindexGroupMember(Collection<String> principalIds) Schedule reindex of monitor users due to membership change.
void	restartExecutorService() Restarts executor service.
void	scheduleReindexMonitorUser(String id) Schedules the reindexing of the monitor user with the given identifier on big data after the commit of the current transaction.
void	setFriendlyIdUserField(String requestField) Sets the field used to calculated the monitor user's friendly id for portal users.
boolean	shouldMonitorRequest(HttpServletRequest request) Returns whether the given request should have the events monitored.
void	shutdown() Shutdowns the monitor manager.
void	updateMonitorDefinition(Set<String> definitionPaths) Updates the monitor definition from the given file paths.
void	updateMonitorUser(String monitorUserId, UserConfig userConfig, UserConfig originalUserConfig) Updates the data stored in a monitor user with the corresponding data on a portal user.
void	upgradeEventData() Schedules the upgrade of event data in BigData.

Methods inherited from class java.lang.Object

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

Constructor Detail

MonitorManager

public MonitorManager()

Method Detail

getMonitorContext

public lumis.portal.monitor.impl.MonitorContext getMonitorContext()

Description copied from interface: IMonitorManager

Returns the current monitor context.

Specified by:

getMonitorContext in interface IMonitorManager

Specified by:

getMonitorContext in interface IMonitorManagerSPI

Returns:

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

monitor

public IMonitor monitor(String eventId)
                 throws PortalException

Description copied from interface: IMonitorManager

Returns the monitor for an event with the given identifier.

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

Specified by:

monitor in interface IMonitorManager

Parameters:

eventId - the event identifier.

Returns:

the monitor.

Throws:

PortalException

See Also:

IMonitor, 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 with the given identifier.

If no event with the given identifier exists then a warn message will be generated in the Lumis Portal 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.

Specified by:

monitor in interface IMonitorManager

Parameters:

eventId - the event identifier.

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

Returns:

the monitor.

Throws:

PortalException

See Also:

IMonitor

getEvent

public IMonitorEventSPI getEvent(String eventId)
                          throws PortalException

Description copied from interface: IMonitorManager

Returns an unmodifiable event.

Specified by:

getEvent in interface IMonitorManager

Parameters:

eventId - the event's identifier.

Returns:

an unmodifiable event.

Throws:

PortalObjectNotFoundException - if no event with such id was found.

PortalException

getField

public IMonitorFieldSPI getField(String fieldId)
                          throws PortalException

Description copied from interface: IMonitorManager

Returns an unmodifiable field.

Specified by:

getField in interface IMonitorManager

Parameters:

fieldId - the field's identifier.

Returns:

an unmodifiable field.

Throws:

PortalObjectNotFoundException - if no field with such id was found.

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

persistFieldRecursively

protected void persistFieldRecursively(org.hibernate.Session session,
                                       IMonitorField field)

Persist the given field and any inner fields recursively.

Parameters:

session - the session.

field - the field.

Since:

10.2.0

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

getFieldGroup

public IMonitorFieldGroup getFieldGroup(String fieldGroupId)
                                 throws PortalException

Description copied from interface: IMonitorManager

Returns an unmodifiable field group.

Specified by:

getFieldGroup in interface IMonitorManager

Parameters:

fieldGroupId - the field group's identifier.

Returns:

an unmodifiable field group.

Throws:

PortalObjectNotFoundException - if no such field group was found.

PortalException

updateMonitorDefinition

public void updateMonitorDefinition(Set<String> definitionPaths)
                             throws PortalException

Description copied from interface: IMonitorManagerSPI

Updates the monitor definition from the given file paths. The files will be read from the class loader.

Specified by:

updateMonitorDefinition in interface IMonitorManagerSPI

Parameters:

definitionPaths - the definition paths.

Throws:

PortalException

scheduleReindexMonitorUser

public void scheduleReindexMonitorUser(String id)
                                throws PortalException

Description copied from interface: IMonitorManagerSPI

Schedules the reindexing of the monitor user with the given identifier on big data after the commit of the current transaction.

Specified by:

scheduleReindexMonitorUser in interface IMonitorManagerSPI

Parameters:

id - the monitor user identifier.

Throws:

PortalException

getMonitorUserValuesProvider

public IMonitorValuesProvider getMonitorUserValuesProvider(String monitorUserId)

Description copied from interface: IMonitorManagerSPI

Returns a monitor values provider that returns the values for monitor user fields. This provider will persist a monitor user when requested for values if no monitor user with the given identifier exists.

Specified by:

getMonitorUserValuesProvider in interface IMonitorManagerSPI

Parameters:

monitorUserId - the monitor user identifier.

Returns:

the monitor values provider.

getCurrentMonitorUserId

public String getCurrentMonitorUserId()

Description copied from interface: IMonitorManager

Returns the identifier of the current monitor user.

Specified by:

getCurrentMonitorUserId in interface IMonitorManager

Returns:

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

addMonitorUser

public String addMonitorUser(UserConfig userConfig)
                      throws PortalException

Description copied from interface: IMonitorManagerSPI

Adds a new monitor user to persistence.

Specified by:

addMonitorUser in interface IMonitorManagerSPI

Parameters:

userConfig - the portal user.

Returns:

the added monitor user identifier.

Throws:

PortalException

updateMonitorUser

public void updateMonitorUser(String monitorUserId,
                              UserConfig userConfig,
                              UserConfig originalUserConfig)
                       throws PortalException

Description copied from interface: IMonitorManagerSPI

Updates the data stored in a monitor user with the corresponding data on a portal user.

Specified by:

updateMonitorUser in interface IMonitorManagerSPI

Parameters:

monitorUserId - the monitor user's identifier.

userConfig - the portal user with the updated information.

Throws:

PortalException

mergeMonitorUserDuringAuthentication

public void mergeMonitorUserDuringAuthentication(String httpSessionId,
                                                 String srcMonitorUserId,
                                                 String destMonitorUserId)
                                          throws PortalException

Description copied from interface: IMonitorManagerSPI

Merges a monitor user to another, because a http session identified as the first monitor user was authenticated as the second monitor user.

If the source monitor user has some identification (an associated portal user or friendlyId set) then a partial merge will be performed. Otherwise a full merge will be performed.

A partial merge will move non-authenticated event data that belongs to the specified HTTP session and the source monitor user to the destination monitor user.

A full merge will move all event data that belongs to the source monitor user to the destination monitor user, will copy source monitor user's properties to the destination monitor user (but will not overwrite data of destination monitor user's portal user as per monitor user standard behavior) and will delete the source monitor user.

Specified by:

mergeMonitorUserDuringAuthentication in interface IMonitorManagerSPI

Parameters:

httpSessionId - http session identifier used for partial merge.

srcMonitorUserId - the monitor user that will be merged to another.

destMonitorUserId - the monitor user destination of the merge.

Throws:

PortalException

getAllEvents

public Collection<IMonitorEvent> getAllEvents()

Description copied from interface: IMonitorManagerSPI

Returns all monitor events.

Specified by:

getAllEvents in interface IMonitorManagerSPI

Returns:

all monitor events.

getAllFields

public Collection<IMonitorField> getAllFields()

Description copied from interface: IMonitorManagerSPI

Returns all monitor fields.

Specified by:

getAllFields in interface IMonitorManagerSPI

Returns:

all monitor fields.

shouldMonitorRequest

public boolean shouldMonitorRequest(HttpServletRequest request)
                             throws PortalException

Description copied from interface: IMonitorManagerSPI

Returns whether the given request should have the events monitored.

Specified by:

shouldMonitorRequest in interface IMonitorManagerSPI

Parameters:

request - the request.

Returns:

whether the given request should have the events monitored.

Throws:

PortalException

initializeMonitorRequestRules

public void initializeMonitorRequestRules()
                                   throws PortalException

Description copied from interface: IMonitorManagerSPI

Initializes the monitor request rules.

Specified by:

initializeMonitorRequestRules in interface IMonitorManagerSPI

Throws:

PortalException

clearRequestRulesCache

public void clearRequestRulesCache()
                            throws PortalException

Description copied from interface: IMonitorManagerSPI

Clears the request rules cache.

Specified by:

clearRequestRulesCache in interface IMonitorManagerSPI

Throws:

PortalException

reindexAllMonitorUser

public void reindexAllMonitorUser()
                           throws PortalException

Description copied from interface: IMonitorManagerSPI

Reindex all monitor users and their event data.

Specified by:

reindexAllMonitorUser in interface IMonitorManagerSPI

Throws:

PortalException

setFriendlyIdUserField

public void setFriendlyIdUserField(String requestField)
                            throws PortalException

Description copied from interface: IMonitorManagerSPI

Sets the field used to calculated the monitor user's friendly id for portal users.

Specified by:

setFriendlyIdUserField in interface IMonitorManagerSPI

Parameters:

requestField - one of IMonitorManagerSPI.FRIENDLY_ID_FIELD_ID, IMonitorManagerSPI.FRIENDLY_ID_FIELD_LOGIN, IMonitorManagerSPI.FRIENDLY_ID_FIELD_EMAIL, the identifier of a UserAttribute or null to indicate no friendly id.

Throws:

PortalException

getFriendlyIdUserField

public String getFriendlyIdUserField()
                              throws PortalException

Description copied from interface: IMonitorManagerSPI

Returns the field used to calculated the monitor user's friendly id for portal users.

Specified by:

getFriendlyIdUserField in interface IMonitorManagerSPI

Returns:

the friendly identifier field. One of IMonitorManagerSPI.FRIENDLY_ID_FIELD_ID, IMonitorManagerSPI.FRIENDLY_ID_FIELD_LOGIN, IMonitorManagerSPI.FRIENDLY_ID_FIELD_EMAIL, the identifier of a UserAttribute or null to indicate no friendly id.

Throws:

PortalException

reindexGroupMember

public void reindexGroupMember(Collection<String> principalIds)
                        throws PortalException

Description copied from interface: IMonitorManagerSPI

Schedule reindex of monitor users due to membership change.

Specified by:

reindexGroupMember in interface IMonitorManagerSPI

Parameters:

principalIds - the principal identifiers where all monitor users that belongs to them must be reindexed.

Throws:

PortalException - if the reindexing could not be scheduled.

upgradeEventData

public void upgradeEventData()
                      throws PortalException

Description copied from interface: IMonitorManagerSPI

Schedules the upgrade of event data in BigData.

Specified by:

upgradeEventData in interface IMonitorManagerSPI

Throws:

PortalException

mergeMonitorUsers

public void mergeMonitorUsers(String srcMonitorUserId,
                              String destMonitorUserId)
                       throws PortalException

Description copied from interface: IMonitorManagerSPI

Merger monitor users.

Specified by:

mergeMonitorUsers in interface IMonitorManagerSPI

Throws:

PortalException