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: 23861 $ $Date: 2020-06-03 23:24:25 +0000 (Wed, 03 Jun 2020) $

Field Summary

Fields

Modifier and Type	Field and Description
static String	BIG_DATA_ANONYMIZATION_STRING_VALUE

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
void	addMonitorUser(UserConfig userConfig) Adds a new monitor user to persistence.
void	anonymizeAllMonitorUser() Anonymizes all monitor users without consent.
void	anonymizeMonitorUser(String monitorUserId) Anonymizes the given monitor user.
static void	anonymizeMonitorUserPendingData(MonitorUser monitorUser) Anonymizes data for the given user that should be anonimized but it is not.
void	anonymizeMonitorUsers(Collection<String> monitorUserIds) Anonymizes the given monitor users.
void	clearRequestRulesCache() Clears the request rules cache.
IMonitorValuesProvider	createMonitorUserValuesProviderForTrackId(String trackId) Creates a new monitor values provider that returns the values for monitor user fields corresponding to the given track identifier.
IMonitorValuesProvider	createMonitorUserValuesProviderForUserId(String monitorUserId) Creates a new monitor values provider that returns the values for monitor user fields corresponding to the given user identifier.
void	deleteMonitorUser(String userId) Deletes monitor user.
void	deleteUserActivities(String userId) Delete monitor user activities.
Collection<IMonitorEvent>	getAllEvents() Returns all monitor events.
Collection<IMonitorField>	getAllFields() Returns all monitor fields.
String	getCurrentMonitorUserId() Returns the identifier of the current monitor user.
String	getCurrentMonitorUserTrackId() Returns the track 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.
String	getMonitorUserIdByTrackId(String monitorUserTrackId) Returns the user identifier for a track identifier.
PrincipalConfig	getMonitorUserPrincipal(String principalId) Returns the principal object that represents a monitor user.
String	getMonitorUserTrackId(String monitorUserId) Returns the track identifier for a monitor user.
IMonitorStatistics	getStatistics() Returns statistics about monitoring framework.
void	init() Initializes the monitor manager.
void	initializeMonitoringData(ITransaction transaction, boolean forceEventProcess) Method called during portal database initialization to populate the monitoring related data.
void	initializeMonitorRequestRules() Initializes the monitor request rules.
void	loadMonitorUserInfo(String userId, IUserConfigInitializer userConfigInitializer) Provides a monitor user information to IUserConfigInitializer.
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.
boolean	monitorUserHasPortalUser(String monitorUserId) Returns whether the monitor user with the given identifier has a portal user.
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	reindexMonitorUsers(Collection<String> monitorUserIds) Reindex the given monitor users.
void	restartExecutorService() Restarts executor service.
void	scheduleReindexMonitorUser(String id, Long visitorId) 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.
IMonitor	syncMonitor(String eventId) Returns a synchronous monitor.
void	updateAllEventsDocumentTypes() Updates all events document types.
void	updateAllMonitorEventDocumentTypes() Updates all monitor event document types.
void	updateMonitorDefinition(Set<String> definitionPaths) Updates the monitor definition from the given file paths.
void	updateMonitorUser(UserConfig userConfig, UserConfig originalUserConfig) Updates the data stored in a monitor user with the corresponding data on a portal user.
void	updateMonitorUserDocumentType(IBigDataRepository repository) Updates monitor user document types.
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

Methods inherited from interface lumis.portal.monitor.IMonitorManagerSPI

updateMonitorUserDocumentType

Field Detail

BIG_DATA_ANONYMIZATION_STRING_VALUE

public static final String BIG_DATA_ANONYMIZATION_STRING_VALUE

See Also:

Constant Field Values

Constructor Detail

MonitorManager

public MonitorManager()

Method Detail

getStatistics

public IMonitorStatistics getStatistics()

Description copied from interface: IMonitorManagerSPI

Returns statistics about monitoring framework.

Specified by:

getStatistics in interface IMonitorManagerSPI

Returns:

statistics about monitoring framework.

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 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.

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

syncMonitor

public IMonitor syncMonitor(String eventId)
                     throws PortalException

Description copied from interface: IMonitorManagerSPI

Returns a synchronous monitor.

Specified by:

syncMonitor in interface IMonitorManagerSPI

Parameters:

eventId - the event identifier

Returns:

a synchronous monitor.

Throws:

PortalException

See Also:

IMonitorManager.monitor(String)

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,
                                     boolean forceEventProcess)
                              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.

forceEventProcess - if true will reprocess all events, otherwise false will only process the needed events.

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

updateAllEventsDocumentTypes

public void updateAllEventsDocumentTypes()

Description copied from interface: IMonitorManagerSPI

Updates all events document types.

Specified by:

updateAllEventsDocumentTypes in interface IMonitorManagerSPI

scheduleReindexMonitorUser

public void scheduleReindexMonitorUser(String id,
                                       Long visitorId)
                                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.

visitorId - the monitor user visitor identifier.

Throws:

PortalException

createMonitorUserValuesProviderForUserId

public IMonitorValuesProvider createMonitorUserValuesProviderForUserId(String monitorUserId)

Description copied from interface: IMonitorManagerSPI

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

Specified by:

createMonitorUserValuesProviderForUserId in interface IMonitorManagerSPI

Parameters:

monitorUserId - the monitor user identifier.

Returns:

the monitor values provider.

createMonitorUserValuesProviderForTrackId

public IMonitorValuesProvider createMonitorUserValuesProviderForTrackId(String trackId)

Description copied from interface: IMonitorManagerSPI

Creates a new monitor values provider that returns the values for monitor user fields corresponding to the given track identifier. This provider will persist a monitor user when requested for values if no monitor user with the given identifier exists.

Specified by:

createMonitorUserValuesProviderForTrackId in interface IMonitorManagerSPI

Parameters:

trackId - the monitor user track 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.

getCurrentMonitorUserTrackId

public String getCurrentMonitorUserTrackId()

Description copied from interface: IMonitorManagerSPI

Returns the track identifier of the current monitor user.

Specified by:

getCurrentMonitorUserTrackId in interface IMonitorManagerSPI

Returns:

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

addMonitorUser

public void 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.

Throws:

PortalException

updateMonitorUser

public void updateMonitorUser(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:

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.

This method uses its own transaction for this operation.

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.

Note: this method uses its own transaction.

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

monitorUserHasPortalUser

public boolean monitorUserHasPortalUser(String monitorUserId)

Description copied from interface: IMonitorManagerSPI

Returns whether the monitor user with the given identifier has a portal user.

Specified by:

monitorUserHasPortalUser in interface IMonitorManagerSPI

Parameters:

monitorUserId - the monitor user identifier.

Returns:

true if the corresponding monitor user has a portal user, false if the monitor user does not have a portal user or if it was not found.

getMonitorUserTrackId

public String getMonitorUserTrackId(String monitorUserId)

Description copied from interface: IMonitorManagerSPI

Returns the track identifier for a monitor user.

Specified by:

getMonitorUserTrackId in interface IMonitorManagerSPI

Parameters:

monitorUserId - the monitor user identifier.

Returns:

the track identifier, or null if no such monitor user is available.

getMonitorUserIdByTrackId

public String getMonitorUserIdByTrackId(String monitorUserTrackId)

Description copied from interface: IMonitorManagerSPI

Returns the user identifier for a track identifier.

Specified by:

getMonitorUserIdByTrackId in interface IMonitorManagerSPI

Parameters:

monitorUserTrackId - the track identifier.

Returns:

the user identifier, or null if no such track identifier is unavailable.

deleteMonitorUser

public void deleteMonitorUser(String userId)

Description copied from interface: IMonitorManagerSPI

Deletes monitor user. This is to be used internally when a portal user will be deleted.

Specified by:

deleteMonitorUser in interface IMonitorManagerSPI

Parameters:

userId - the user identifier.

deleteUserActivities

public void deleteUserActivities(String userId)
                          throws PortalException

Description copied from interface: IMonitorManagerSPI

Delete monitor user activities.

Specified by:

deleteUserActivities in interface IMonitorManagerSPI

Parameters:

userId - the user identifier.

Throws:

PortalException

loadMonitorUserInfo

public void loadMonitorUserInfo(String userId,
                                IUserConfigInitializer userConfigInitializer)
                         throws PortalException

Description copied from interface: IMonitorManagerSPI

Provides a monitor user information to IUserConfigInitializer.

Specified by:

loadMonitorUserInfo in interface IMonitorManagerSPI

Parameters:

userId - the user identifier.

userConfigInitializer - the initializer.

Throws:

PortalException

getMonitorUserPrincipal

public PrincipalConfig getMonitorUserPrincipal(String principalId)

Description copied from interface: IMonitorManagerSPI

Returns the principal object that represents a monitor user.

Specified by:

getMonitorUserPrincipal in interface IMonitorManagerSPI

Parameters:

principalId - the principal identifier.

Returns:

the principal or null if no such monitor user exists.

updateAllMonitorEventDocumentTypes

public void updateAllMonitorEventDocumentTypes()
                                        throws PortalException

Description copied from interface: IMonitorManagerSPI

Updates all monitor event document types. Ignores the events that doesn't have the document types created.

Specified by:

updateAllMonitorEventDocumentTypes in interface IMonitorManagerSPI

Throws:

PortalException

updateMonitorUserDocumentType

public void updateMonitorUserDocumentType(IBigDataRepository repository)
                                   throws PortalException

Description copied from interface: IMonitorManagerSPI

Updates monitor user document types. Ignores the events that doesn't have the document types created.

Specified by:

updateMonitorUserDocumentType in interface IMonitorManagerSPI

Parameters:

repository - the big data repository to use.

Throws:

PortalException

anonymizeAllMonitorUser

public void anonymizeAllMonitorUser()
                             throws PortalException

Description copied from interface: IMonitorManagerSPI

Anonymizes all monitor users without consent.

Specified by:

anonymizeAllMonitorUser in interface IMonitorManagerSPI

Throws:

PortalException

anonymizeMonitorUserPendingData

public static void anonymizeMonitorUserPendingData(MonitorUser monitorUser)
                                            throws PortalException

Anonymizes data for the given user that should be anonimized but it is not.

Parameters:

monitorUser - the monitor user to perform the operation.

Throws:

PortalException

Since:

12.3.0

anonymizeMonitorUser

public void anonymizeMonitorUser(String monitorUserId)
                          throws PortalException

Description copied from interface: IMonitorManagerSPI

Anonymizes the given monitor user. Any consents in the given user will be removed.

Specified by:

anonymizeMonitorUser in interface IMonitorManagerSPI

Parameters:

monitorUserId - the monitor user identifier.

Throws:

PortalException

anonymizeMonitorUsers

public void anonymizeMonitorUsers(Collection<String> monitorUserIds)
                           throws PortalException

Description copied from interface: IMonitorManagerSPI

Anonymizes the given monitor users. Any consents in the given user will be removed. This operation will be performed in background.

Specified by:

anonymizeMonitorUsers in interface IMonitorManagerSPI

Parameters:

monitorUserIds - the monitor user identifiers.

Throws:

PortalException

reindexMonitorUsers

public void reindexMonitorUsers(Collection<String> monitorUserIds)
                         throws PortalException

Description copied from interface: IMonitorManagerSPI

Reindex the given monitor users.

Specified by:

reindexMonitorUsers in interface IMonitorManagerSPI

Parameters:

monitorUserIds - the monitor user identifiers.

Throws:

PortalException