org.kuali.rice.kcb.service.impl
Class MessagingServiceImpl

java.lang.Object
  org.kuali.rice.kcb.service.impl.MessagingServiceImpl

All Implemented Interfaces:

MessagingService

public class MessagingServiceImpl
extends Object
implements MessagingService

MessagingService implementation

Author:

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

Nested Class Summary

static class

MessagingServiceImpl.QueueProcessingJobSynchronization

Constructor Summary

MessagingServiceImpl()

Method Summary

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.
void	setJobGroup(String jobGroup) Sets the group of the target job to run to process messages
void	setJobName(String jobName) Sets the name of the target job to run to process messages
void	setMessageDeliveryService(MessageDeliveryService messageDeliveryService) Sets the MessageDeliveryService
void	setMessageService(MessageService messageService) Sets the MessageService
void	setRecipientPreferenceService(RecipientPreferenceService prefs) Sets the RecipientPreferencesService
void	setSynchronous(boolean sync) Sets whether to perform the processing synchronously

Methods inherited from class java.lang.Object

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

Constructor Detail

MessagingServiceImpl

public MessagingServiceImpl()

Method Detail

setJobName

public void setJobName(String jobName)

Sets the name of the target job to run to process messages

Parameters:

jobName - the name of the target job to run to process messages

setJobGroup

public void setJobGroup(String jobGroup)

Sets the group of the target job to run to process messages

Parameters:

jobGroup - Sets the group of the target job to run to process messages

setMessageService

public void setMessageService(MessageService messageService)

Sets the MessageService

Parameters:

messageService - the MessageService

setMessageDeliveryService

public void setMessageDeliveryService(MessageDeliveryService messageDeliveryService)

Sets the MessageDeliveryService

Parameters:

messageDeliveryService - the MessageDeliveryService

setSynchronous

public void setSynchronous(boolean sync)

Sets whether to perform the processing synchronously

Parameters:

sync - whether to perform the processing synchronously

setRecipientPreferenceService

public void setRecipientPreferenceService(RecipientPreferenceService prefs)

Sets the RecipientPreferencesService

Parameters:

prefs - the RecipientPreferenceService

deliver

public Long deliver(MessageDTO message)
             throws MessageDeliveryException

Description copied from interface: MessagingService

Delivers a message

Specified by:

deliver in interface MessagingService

Parameters:

message - message to deliver

Returns:

identifier for the message

Throws:

MessageDeliveryException - if unable to deliver message.

See Also:

org.kuali.rice.kcb.service.MessagingService#deliver(org.kuali.rice.kcb.dto.MessageDTO)

remove

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

Description copied from interface: MessagingService

Removes a specific message and all deliveries

Specified by:

remove in interface MessagingService

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.

See Also:

org.kuali.rice.kcb.service.MessagingService#remove(long, java.lang.String, java.lang.String)

removeByOriginId

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

Description copied from interface: MessagingService

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

Specified by:

removeByOriginId in interface MessagingService

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.

See Also:

org.kuali.rice.kcb.service.MessagingService#removeByOriginId(java.lang.String, java.lang.String, java.lang.String)