org.kuali.rice.kcb.api.service

Interface MessagingService

All Known Implementing Classes:

MessagingServiceImpl

public interface MessagingService

The KCB MessagingService provides an API to deliver messages to arbitrary multiple endpoints.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

Modifier and Type	Method and Description
Long	deliver(MessageDTO message) Delivers a message
void	remove(long messageId, String user, String cause) Removes a specific message and all deliveries
Long	removeByOriginId(String originId, String user, String cause) Removes a specific message and all deliveries.

Method Detail

deliver

Long deliver(MessageDTO message)
      throws MessageDeliveryException,
             RiceIllegalArgumentException

Delivers a message

Parameters:

message - message to deliver

Returns:

identifier for the message

Throws:

MessageDeliveryException - if unable to deliver message.

RiceIllegalArgumentException - if the message is null.

remove

void remove(long messageId,
            String user,
            String cause)
     throws MessageDismissalException,
            RiceIllegalArgumentException

Removes a specific message and all deliveries

Parameters:

messageId - id of the message to remove

user - the user under which the action was taken

cause - the cause or action taken to remove the message

Throws:

MessageDismissalException - if no message for the given messageId is found.

RiceIllegalArgumentException - if user, cause is null.

removeByOriginId

Long removeByOriginId(String originId,
                      String user,
                      String cause)
               throws MessageDismissalException,
                      RiceIllegalArgumentException

Removes a specific message and all deliveries. Does not throw an exception if no message with the origin id is found.

Parameters:

originId - origin id of the message to remove

user - the user under which the action was taken

cause - the cause or action taken to remove the message

Returns:

Long the message id of the message removed, if any

Throws:

MessageDismissalException - if no message for the given messageId is found.

RiceIllegalArgumentException - if originId is null