com.nitido.nim
Class NotificationService

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

All Implemented Interfaces:

NiMConstants

Direct Known Subclasses:

NotificationServiceImpl, NotificationServiceStub

public abstract class NotificationService
extends NiMKernelService

The NotificationService is the NiMKernel component responsible for sending notification to the user. It is a compulsory service.

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

NotificationService(NiMKernelServiceVisa visa)

Method Summary

abstract NotificationStatus	getStatus(java.lang.String ticket) Retrieves the latest status for a given status ticket.
protected void	init(NiMKernel kernel, ConfigurationService confService) This method is used to initialize the kernel service.
abstract java.lang.String	sendNotification(NotificationMessage msg) Send out the notification message to the recipient(s) supplied in the message object.
abstract void	signalBirth() Invoked by the system's listener when the whole server is starting up.
abstract void	signalDeath() Invoked by the system's listener when the whole server is shutting down.

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationService

public NotificationService(NiMKernelServiceVisa visa)

Method Detail

init

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

sendNotification

public abstract java.lang.String sendNotification(NotificationMessage msg)
                                           throws NotificationServiceException

Send out the notification message to the recipient(s) supplied in the message object. If the message returns without an exception being thrown then the service has accepted the message for delivery, meaning that there were no immediate errors in the message object. It does not imply that the message has been sent out or delivered successfully.

Parameters:

msg - the notification message object containing the recipient(s) and the message content.

Returns:

The ticket ID returned can be used to retrieve the latest status for this message.

Throws:

NotificationServiceException - thrown for one of two reasons - unable to create a status ticket to return to the client - invalid data in the notification message object

getStatus

public abstract NotificationStatus getStatus(java.lang.String ticket)
                                      throws StatusNotFoundException

Retrieves the latest status for a given status ticket. The status object allows the client to determine whether their notification has been sent out and/or delivered. In case of failure the status object will contain the cause of the failure as an exception and/or error code.

Parameters:

ticket - the ticket ID that was returned by the sendNotification method

Returns:

a status object containing details about the message that was accepted to be sent out to each of the recipients.

Throws:

StatusNotFoundException - if the ticket does not match any tickets known to the service

signalBirth

public abstract void signalBirth()

Invoked by the system's listener when the whole server is starting up.

signalDeath

public abstract void signalDeath()

Invoked by the system's listener when the whole server is shutting down. This is mainly used to stop the clean up thread.