com.nitido.nimx.services.notification
Class NotificationServiceStub

java.lang.Object
  com.nitido.nim.NiMKernelService
      com.nitido.nim.NotificationService
          com.nitido.nimx.services.notification.NotificationServiceStub

All Implemented Interfaces:

NiMConstants

public class NotificationServiceStub
extends NotificationService

This is a stub implementation of the notification service which throws an exception when any of its methods are invoked.

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

NotificationServiceStub(NiMKernelServiceVisa visa)

Method Summary

NotificationStatus	getStatus(java.lang.String ticket) Retrieves the latest status for a given status ticket.
java.lang.String	sendNotification(NotificationMessage msg) Send out the notification message to the recipient(s) supplied in the message object.
void	signalBirth() Invoked by the system's listener when the whole server is starting up.
void	signalDeath() Invoked by the system's listener when the whole server is shutting down.

Methods inherited from class com.nitido.nim.NotificationService

init

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationServiceStub

public NotificationServiceStub(NiMKernelServiceVisa visa)

Method Detail

getStatus

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

Description copied from class: NotificationService

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.

Specified by:

getStatus in class NotificationService

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

sendNotification

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

Description copied from class: NotificationService

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.

Specified by:

sendNotification in class NotificationService

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

signalBirth

public void signalBirth()

Description copied from class: NotificationService

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

Specified by:

signalBirth in class NotificationService

signalDeath

public void signalDeath()

Description copied from class: NotificationService

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

Specified by:

signalDeath in class NotificationService