com.nitido.nim
Class EventMonitorService

java.lang.Object
  com.nitido.nim.NiMKernelService
      com.nitido.nim.EventMonitorService

All Implemented Interfaces:

NiMConstants

Direct Known Subclasses:

EventMonitorServiceImpl

public abstract class EventMonitorService
extends NiMKernelService

EventMonitorService is the NiMKernel module responsible for logging application level event messages.

Field Summary

Fields inherited from interface com.nitido.nim.NiMConstants

ACTION_CREATE_NUGGET, ACTION_CREATE_NUGGET_BY_NAME, ACTION_CRED_SPACE_ADD, ACTION_CRED_SPACE_GET_KEYS, ACTION_CRED_SPACE_GET_KEYS_START_WITH, ACTION_CRED_SPACE_GET_VALUE, ACTION_CRED_SPACE_GET_VALUES, ACTION_CRED_SPACE_MODIFY, ACTION_CRED_SPACE_REMOVE_VALUE, ACTION_CRED_SPACE_REMOVE_VALUES, ACTION_CRED_SPACE_REPLACE, ACTION_DEPROVISION_ENTITY, ACTION_ENTITY_CHANGE_CRED, ACTION_LOG_EVENT, ACTION_PROVISION_ENTITY, ACTION_USER_SPACE_ADD, ACTION_USER_SPACE_GET_KEYS, ACTION_USER_SPACE_GET_KEYS_START_WITH, ACTION_USER_SPACE_GET_VALUE, ACTION_USER_SPACE_GET_VALUES, ACTION_USER_SPACE_MODIFY, ACTION_USER_SPACE_REMOVE_VALUE, ACTION_USER_SPACE_REMOVE_VALUES, ACTION_USER_SPACE_REPLACE, CONF_PREFIX_SECURITY_ACCESS, CONF_PREFIX_SECURITY_ALLOW, CONF_PREFIX_SECURITY_ASSIGN, CONF_PREFIX_SECURITY_RESOURCE, PARAM_CHANGE_CRED, PARAM_DEPROVISION_CREDENTIAL, PARAM_EVENT_NAME, PARAM_MODIFIER_CONTAINER, PARAM_NUGGET_CREATE_CRED, PARAM_NUGGET_NAME, PARAM_NUGGET_SETTINGS, PARAM_NUGGET_TYPE, PARAM_PROVISION_DESCRIPTOR, PARAM_SPACE_KEY, PARAM_SPACE_KEYS_START_WITH, PARAM_SPACE_VALUE, PREFIX_ACCESS_CLASS_IN_PACKAGE

Constructor Summary

EventMonitorService(NiMKernelServiceVisa visa)
This class constructor is used by NiMKernel to instantiate a new EventMonitorService

Method Summary

protected abstract void	init(NiMKernel kernel, ConfigurationService confService) This method is used to initialize the kernel service.
abstract void	logEvent(java.lang.String eventName, java.lang.String msg, Credential credential) This method is used to log the given message for the given event name.
abstract boolean	needToLogEvent(java.lang.String eventName, Credential credential) This method indicates whether the given event needs to be logged.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventMonitorService

public EventMonitorService(NiMKernelServiceVisa visa)

This class constructor is used by NiMKernel to instantiate a new EventMonitorService

Parameters:

visa - Reference to the NiMKernelServiceVisa object required to instantiate the service. This parameter is required to ensure that only the NiMkernel can instantiate a reference to this service.

Method Detail

init

protected abstract void init(NiMKernel kernel,
                             ConfigurationService confService)
                      throws InitializationFailedException,
                             NiMException

Description copied from class: NiMKernelService

This method is used to initialize the kernel service. Extenders of this class must implement this method.

Specified by:

init in class NiMKernelService

Parameters:

kernel - Reference to the NiMKernel object that instantiated the service.

confService - A reference to the configuration service. All the service implementations (except ConfigurationService) should retrieve the setting information from it.

Throws:

InitializationFailedException - If unable to initialize the kernel service.

NiMException - If service initialization can not be done due to failure in establish a connection to the back-end service. Not all service implementation will throw this exception.

logEvent

public abstract void logEvent(java.lang.String eventName,
                              java.lang.String msg,
                              Credential credential)

This method is used to log the given message for the given event name. The given credential is used to verify that the entity has permission to log the event. If this credential is not entitled to perform the requested operation, the event will not be logged.

Parameters:

eventName - The name of the event to be logged.

msg - The message associated with the event being logged

credential - The credential of the user logging the event.

needToLogEvent

public abstract boolean needToLogEvent(java.lang.String eventName,
                                       Credential credential)

This method indicates whether the given event needs to be logged.

The creation of the log message can consume a significant amount of time, a developer can first call this method to determine whether the corresponding log message is to be logged.

Parameters:

eventName - The name that uniquely identifies the event to be logged.

credential - The credential of the user logging the event

Returns:

True if the event needs to be "logged" otherwise it returns false.