lumis.portal.monitor

Interface IMonitorManagerSPI

All Superinterfaces:

IMonitorManager

All Known Implementing Classes:

DummyMonitorManager, MonitorManager

public interface IMonitorManagerSPI
extends IMonitorManager

Monitor SPI interface.

Since:

9.0.0

Version:

$Revision: 22644 $ $Date: 2019-04-06 00:08:21 +0000 (Sat, 06 Apr 2019) $

Field Summary

Fields

Modifier and Type	Field and Description
static String	FRIENDLY_ID_FIELD_EMAIL Indicates the field to be used to generate friendly identifier of monitor users from UserConfig is UserConfig.getEmail().
static String	FRIENDLY_ID_FIELD_ID Indicates the field to be used to generate friendly identifier of monitor users from UserConfig is UserConfig.getId().
static String	FRIENDLY_ID_FIELD_LOGIN Indicates the field to be used to generate friendly identifier of monitor users from UserConfig is UserConfig.getLogin().

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.
ExecutorService	getExecutorService() Returns the executor service to be used when monitoring values.
String	getFriendlyIdUserField() Returns the field used to calculated the monitor user's friendly id for portal users.
IMonitorContextSPI	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.
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 field) 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 original) 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 interface lumis.portal.monitor.IMonitorManager

getCurrentMonitorUserId, getEvent, getField, getFieldGroup, monitor, monitor

Field Detail

FRIENDLY_ID_FIELD_EMAIL

static final String FRIENDLY_ID_FIELD_EMAIL

Indicates the field to be used to generate friendly identifier of monitor users from UserConfig is UserConfig.getEmail().

Since:

11.0.0

See Also:

setFriendlyIdUserField(String), Constant Field Values

FRIENDLY_ID_FIELD_ID

static final String FRIENDLY_ID_FIELD_ID

Indicates the field to be used to generate friendly identifier of monitor users from UserConfig is UserConfig.getId().

Since:

11.0.0

See Also:

setFriendlyIdUserField(String), Constant Field Values

FRIENDLY_ID_FIELD_LOGIN

static final String FRIENDLY_ID_FIELD_LOGIN

Indicates the field to be used to generate friendly identifier of monitor users from UserConfig is UserConfig.getLogin().

Since:

11.0.0friendlyIdUserField

See Also:

setFriendlyIdUserField(String), Constant Field Values

Method Detail

initializeMonitoringData

void initializeMonitoringData(ITransaction transaction)
                       throws PortalException

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

Parameters:

transaction - the transaction for persistence access.

Throws:

PortalException

Since:

9.0.0

init

void init()

Initializes the monitor manager.

Since:

9.0.0

shutdown

void shutdown()

Shutdowns the monitor manager.

Since:

9.0.0

getExecutorService

ExecutorService getExecutorService()

Returns the executor service to be used when monitoring values.

Returns:

the executor service to be used when monitoring values.

Since:

9.0.0

restartExecutorService

void restartExecutorService()

Restarts executor service.

Since:

9.0.0

updateMonitorDefinition

void updateMonitorDefinition(Set<String> definitionPaths)
                      throws PortalException

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

Parameters:

definitionPaths - the definition paths.

Throws:

PortalException

Since:

11.0.0

scheduleReindexMonitorUser

void scheduleReindexMonitorUser(String id)
                         throws PortalException

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

Parameters:

id - the monitor user identifier.

Throws:

PortalException

Since:

11.0.0

getMonitorUserValuesProvider

IMonitorValuesProvider getMonitorUserValuesProvider(String monitorUserId)

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.

Parameters:

monitorUserId - the monitor user identifier.

Returns:

the monitor values provider.

Since:

11.0.0

addMonitorUser

String addMonitorUser(UserConfig userConfig)
               throws PortalException

Adds a new monitor user to persistence.

Parameters:

userConfig - the portal user.

Returns:

the added monitor user identifier.

Throws:

PortalException

Since:

11.0.0

updateMonitorUser

void updateMonitorUser(String monitorUserId,
                       UserConfig userConfig,
                       UserConfig original)
                throws PortalException

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

Parameters:

monitorUserId - the monitor user's identifier.

userConfig - the portal user with the updated information.

userConfig - the portal user with its information before update was done on it.

Throws:

PortalException

Since:

11.0.0

mergeMonitorUserDuringAuthentication

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

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.

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:

IllegalArgumentException - if destMonitorUserId represents a monitor user without an associated portal user.

IllegalArgumentException - if srcMonitorUserId and destMonitorUserId are equal.

PortalException

Since:

11.0.0

getAllEvents

Collection<IMonitorEvent> getAllEvents()
                                throws PortalException

Returns all monitor events.

Returns:

all monitor events.

Throws:

PortalException

Since:

11.0.0

getAllFields

Collection<IMonitorField> getAllFields()
                                throws PortalException

Returns all monitor fields.

Returns:

all monitor fields.

Throws:

PortalException

Since:

11.0.0

getMonitorContext

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

shouldMonitorRequest

boolean shouldMonitorRequest(HttpServletRequest request)
                      throws PortalException

Returns whether the given request should have the events monitored.

Parameters:

request - the request.

Returns:

whether the given request should have the events monitored.

Throws:

PortalException

Since:

11.0.0

initializeMonitorRequestRules

void initializeMonitorRequestRules()
                            throws PortalException

Initializes the monitor request rules.

Throws:

PortalException

Since:

11.0.0

clearRequestRulesCache

void clearRequestRulesCache()
                     throws PortalException

Clears the request rules cache.

Throws:

PortalException

Since:

11.0.0

reindexAllMonitorUser

void reindexAllMonitorUser()
                    throws PortalException

Reindex all monitor users and their event data.

Throws:

PortalException

Since:

11.0.0

setFriendlyIdUserField

void setFriendlyIdUserField(String field)
                     throws PortalException

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

Note: this method uses its own transaction.

Parameters:

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

Throws:

PortalException

Since:

11.0.0

getFriendlyIdUserField

String getFriendlyIdUserField()
                       throws PortalException

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

Returns:

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

Throws:

PortalException

Since:

11.0.0

reindexGroupMember

void reindexGroupMember(Collection<String> principalIds)
                 throws PortalException

Schedule reindex of monitor users due to membership change.

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.

Since:

11.0.0

upgradeEventData

void upgradeEventData()
               throws PortalException

Schedules the upgrade of event data in BigData.

Throws:

PortalException

Since:

11.0.0

mergeMonitorUsers

void mergeMonitorUsers(String srcMonitorUserId,
                       String destMonitorUserId)
                throws PortalException

Merger monitor users.

Throws:

PortalException

Since:

11.0.0