Package org.exoplatform.commons.api.notification.service

Interface QueueMessage

public interface QueueMessage

Field Summary

Fields

Modifier and Type	Field	Description
static String	MESSAGE_ADDED_IN_QUEUE
static String	MESSAGE_DELETED_FROM_QUEUE
static String	MESSAGE_SENT_FROM_QUEUE

Method Summary

Modifier and Type	Method	Description
void	enable(boolean enabled)	Enable/Disable sending mail message
boolean	put(MessageInfo message)	Puts the message into the queue
void	removeAll()	Removes all queue elements
void	send()	Peek the message from queue and send
boolean	sendMessage(MessageInfo message)	Sends mail instantly without passing by queue (use directly the mail service).

Field Detail

MESSAGE_ADDED_IN_QUEUE

static final String MESSAGE_ADDED_IN_QUEUE

See Also:

Constant Field Values

MESSAGE_DELETED_FROM_QUEUE

static final String MESSAGE_DELETED_FROM_QUEUE

See Also:

Constant Field Values

MESSAGE_SENT_FROM_QUEUE

static final String MESSAGE_SENT_FROM_QUEUE

See Also:

Constant Field Values

Method Detail

put

boolean put(MessageInfo message)
     throws Exception

Puts the message into the queue

Parameters:

message -

Returns:

Throws:

Exception

send

void send()
   throws Exception

Peek the message from queue and send

Throws:

Exception

sendMessage

boolean sendMessage(MessageInfo message)
             throws Exception

Sends mail instantly without passing by queue (use directly the mail service). If sending mail is suspended (by Mail Counter MBean), the message will not be sent, thus it will be suspended.

Parameters:

message - the message to be sent

Returns:

true if the message is sent or mail service is off

Throws:

Exception

removeAll

void removeAll()
        throws Exception

Removes all queue elements

Throws:

Exception

enable

void enable(boolean enabled)

Enable/Disable sending mail message

Parameters:

enabled - true to enable and false to disable