org.openmrs.notification.impl

Class MessageServiceImpl

java.lang.Object

org.openmrs.notification.impl.MessageServiceImpl

All Implemented Interfaces:

MessageService

@Transactional
public class MessageServiceImpl
extends Object
implements MessageService

Constructor Summary

Constructors

Constructor and Description
MessageServiceImpl() Public constructor Required for use with spring's method injection.

Method Summary

Modifier and Type	Method and Description
Message	createMessage(String subject, String content) Create a message object with the given parts.
Message	createMessage(String sender, String subject, String content) Create a message object with the given parts.
Message	createMessage(String recipients, String sender, String subject, String content) Create a message object with the given parts.
Message	createMessage(String recipients, String sender, String subject, String content, String attachment, String attachmentContentType, String attachmentFileName)
List	getAllTemplates() Get all templates in the database.
MessagePreparator	getMessagePreparator()
MessageSender	getMessageSender()
Template	getTemplate(Integer id) Get template by identifier.
List	getTemplatesByName(String name) Get templates by name.
Message	prepareMessage(String templateName, Map data) Prepare a message based on a template and data used for variable substitution within template.
Message	prepareMessage(Template template) Prepare a message given the template.
void	sendMessage(Message message) Send the message.
void	sendMessage(Message message, Collection<User> users) Send message to a collection of recipients.
void	sendMessage(Message message, Integer recipientId) Send a message to a user that is identified by the given identifier.
void	sendMessage(Message message, Role role) Sends a message to a group of users identifier by their role.
void	sendMessage(Message message, String roleName) Send a message to a group of users identified by their role.
void	sendMessage(Message message, User user) Send message to a single user.
void	sendMessage(String recipients, String sender, String subject, String content) Send a message using the given parameters.
void	setMessagePreparator(MessagePreparator messagePreparator) Set the message preparator.
void	setMessageSender(MessageSender messageSender) Set the message sender.
void	setTemplateDAO(TemplateDAO dao)

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageServiceImpl

public MessageServiceImpl()

Public constructor Required for use with spring's method injection. Be careful because this class requires a DAO Context in order to work properly. Please set the DAO context

Method Detail

setTemplateDAO

public void setTemplateDAO(TemplateDAO dao)

setMessagePreparator

public void setMessagePreparator(MessagePreparator messagePreparator)

Set the message preparator.

Specified by:

setMessagePreparator in interface MessageService

Parameters:

messagePreparator -

getMessagePreparator

public MessagePreparator getMessagePreparator()

Specified by:

getMessagePreparator in interface MessageService

setMessageSender

public void setMessageSender(MessageSender messageSender)

Set the message sender.

Specified by:

setMessageSender in interface MessageService

Parameters:

messageSender -

getMessageSender

public MessageSender getMessageSender()

Specified by:

getMessageSender in interface MessageService

sendMessage

public void sendMessage(Message message)
                 throws MessageException

Send the message. All send calls go through this method.

Specified by:

sendMessage in interface MessageService

Parameters:

message - the Message to be sent

Throws:

MessageException - Should send message

See Also:

MessageService.sendMessage(org.openmrs.notification.Message)

createMessage

public Message createMessage(String recipients,
                             String sender,
                             String subject,
                             String content)
                      throws MessageException

Create a message object with the given parts.

Specified by:

createMessage in interface MessageService

Parameters:

recipients - the recipients of the message

sender - the send of the message

subject - the subject of the message

content - the content or body of the message

Returns:

Message the message that was created

Throws:

MessageException - Should create message

createMessage

public Message createMessage(String sender,
                             String subject,
                             String content)
                      throws MessageException

Create a message object with the given parts.

Specified by:

createMessage in interface MessageService

Parameters:

sender - the send of the message

subject - the subject of the message

content - the content or body of the message

Throws:

MessageException

createMessage

public Message createMessage(String subject,
                             String content)
                      throws MessageException

Create a message object with the given parts.

Specified by:

createMessage in interface MessageService

Parameters:

subject - the subject of the message

content - the content or body of the message

Throws:

MessageException

createMessage

public Message createMessage(String recipients,
                             String sender,
                             String subject,
                             String content,
                             String attachment,
                             String attachmentContentType,
                             String attachmentFileName)
                      throws MessageException

Specified by:

createMessage in interface MessageService

Throws:

MessageException

See Also:

MessageService.createMessage(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

sendMessage

public void sendMessage(String recipients,
                        String sender,
                        String subject,
                        String content)
                 throws MessageException

Send a message using the given parameters. This is a convenience method so that the client does not need to create its own Message object.

Specified by:

sendMessage in interface MessageService

Throws:

MessageException

sendMessage

public void sendMessage(Message message,
                        Integer recipientId)
                 throws MessageException

Send a message to a user that is identified by the given identifier.

Specified by:

sendMessage in interface MessageService

Parameters:

message - Message to be sent

recipientId - Integer identifier of user (recipient)

Throws:

MessageException

sendMessage

public void sendMessage(Message message,
                        User user)
                 throws MessageException

Send message to a single user.

Specified by:

sendMessage in interface MessageService

Parameters:

message - the Message to be sent

user - the recipient of the message

Throws:

MessageException

sendMessage

public void sendMessage(Message message,
                        Collection<User> users)
                 throws MessageException

Send message to a collection of recipients.

Specified by:

sendMessage in interface MessageService

Throws:

MessageException

sendMessage

public void sendMessage(Message message,
                        String roleName)
                 throws MessageException

Send a message to a group of users identified by their role.

Specified by:

sendMessage in interface MessageService

Throws:

MessageException

sendMessage

public void sendMessage(Message message,
                        Role role)
                 throws MessageException

Sends a message to a group of users identifier by their role.

Specified by:

sendMessage in interface MessageService

Throws:

MessageException

prepareMessage

public Message prepareMessage(Template template)
                       throws MessageException

Prepare a message given the template. The template should be populated with all necessary data including the variable name-value pairs

Specified by:

prepareMessage in interface MessageService

Parameters:

template - the given Template

Returns:

the prepared Message

Throws:

MessageException

prepareMessage

@Transactional(readOnly=true)
public Message prepareMessage(String templateName,
                                                            Map data)
                                                     throws MessageException

Prepare a message based on a template and data used for variable substitution within template.

Specified by:

prepareMessage in interface MessageService

Parameters:

templateName - name of the template to be used

data - mapping used for variable substitution within template

Returns:

the prepared Message

Throws:

MessageException

getAllTemplates

@Transactional(readOnly=true)
public List getAllTemplates()
                                                   throws MessageException

Get all templates in the database.

Specified by:

getAllTemplates in interface MessageService

Returns:

list of Templates

Throws:

MessageException

getTemplate

@Transactional(readOnly=true)
public Template getTemplate(Integer id)
                                                   throws MessageException

Get template by identifier.

Specified by:

getTemplate in interface MessageService

Parameters:

id - template identifier

Returns:

Template

Throws:

MessageException

getTemplatesByName

@Transactional(readOnly=true)
public List getTemplatesByName(String name)
                                                      throws MessageException

Get templates by name.

Specified by:

getTemplatesByName in interface MessageService

Parameters:

name - the name of the template

Returns:

list of Templates

Throws:

MessageException