Package org.kuali.rice.kcb.service.impl

Class MessagingServiceImpl

java.lang.Object

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

All Implemented Interfaces:

org.kuali.rice.kcb.api.service.MessagingService

public class MessagingServiceImpl
extends Object
implements org.kuali.rice.kcb.api.service.MessagingService

MessagingService implementation

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MessagingServiceImpl.QueueProcessingJobSynchronization

Constructor Summary

Constructors

Constructor	Description
MessagingServiceImpl()

Method Summary

Modifier and Type	Method	Description
Long	deliver(org.kuali.rice.kcb.api.message.MessageDTO message)
void	remove(long messageId, String user, String cause)
Long	removeByOriginId(String originId, String user, String cause)
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 Details

MessagingServiceImpl

public MessagingServiceImpl()

Method Details

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(org.kuali.rice.kcb.api.message.MessageDTO message)
             throws org.kuali.rice.kcb.api.exception.MessageDeliveryException

Specified by:

deliver in interface org.kuali.rice.kcb.api.service.MessagingService

Throws:

org.kuali.rice.kcb.api.exception.MessageDeliveryException

remove

public void remove(long messageId,
 String user,
 String cause)
            throws org.kuali.rice.kcb.api.exception.MessageDismissalException

Specified by:

remove in interface org.kuali.rice.kcb.api.service.MessagingService

Throws:

org.kuali.rice.kcb.api.exception.MessageDismissalException

removeByOriginId

public Long removeByOriginId(String originId,
 String user,
 String cause)
                      throws org.kuali.rice.kcb.api.exception.MessageDismissalException

Specified by:

removeByOriginId in interface org.kuali.rice.kcb.api.service.MessagingService

Throws:

org.kuali.rice.kcb.api.exception.MessageDismissalException