Package com.storedobject.mail

Class Server

java.lang.Object

com.storedobject.job.Job

com.storedobject.job.DaemonJob

com.storedobject.job.MessageSender<Mail>

com.storedobject.mail.Server

public class Server
extends MessageSender<Mail>

Constructor Summary

Constructors

Constructor	Description
Server(Schedule schedule)

Method Summary

Modifier and Type	Method	Description
protected int	getBatchSize()	Batch size - How many messages to be read for sending in one batch?
protected String	getSelectCondition()	Additional condition to be be added when messages are read for sending.
protected int	sendMessage(Mail message)	Send a message.
protected boolean	sendMessages(List<Mail> messages)	Send a batch of messages.

Methods inherited from class com.storedobject.job.MessageSender

canSend, execute, getCreditBalance, getDeliveryCost, initialize, kick, monitorDeliveryCost, recover, shutdown, terminate

Methods inherited from class com.storedobject.job.DaemonJob

isActive

Methods inherited from class com.storedobject.job.Job

alert, clean, getDevice, getStatus, getTransactionManager, log

Methods inherited from class java.lang.Object

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

Constructor Details

Server

public Server(Schedule schedule)

Method Details

sendMessage

protected int sendMessage(Mail message)

Description copied from class: MessageSender

Send a message. The method should just send the message and should not update any status.

Specified by:

sendMessage in class MessageSender<Mail>

Parameters:

message - Message to send.

Returns:

The error code to indicate the status. 0: Successful, 1: Retry later, 2: Insufficient balance. Anything above 2 indicates an error condition that doesn't allow this message to be sent (for example, invalid mobile number in case of an SMSMessage).

getBatchSize

protected int getBatchSize()

Description copied from class: MessageSender

Batch size - How many messages to be read for sending in one batch?

Overrides:

getBatchSize in class MessageSender<Mail>

Returns:

Default is 50.

sendMessages

protected boolean sendMessages(List<Mail> messages)

Description copied from class: MessageSender

Send a batch of messages. The default implementation of this method processes each message by invoking MessageSender.sendMessage(Message) and if this is overridden, the MessageSender.sendMessage(Message) will not be invoked from elsewhere.

Note: The Status of the message should be updated adn saved within this method if overridden.

Overrides:

sendMessages in class MessageSender<Mail>

Parameters:

messages - Messages to be sent.

Returns:

True if messages are sent successfully.

getSelectCondition

protected String getSelectCondition()

Description copied from class: MessageSender

Additional condition to be be added when messages are read for sending.

Overrides:

getSelectCondition in class MessageSender<Mail>

Returns:

Default implementation returns null, so no additional selection criteria are applied.