org.qbroker.persister

Interface MessagePersister

All Known Implementing Classes:

AWSRequester, DocumentPersister, EventPersister, FilePersister, JDBCPersister, JMSPersister, JMSPublisher, JMXPersister, JobPersister, LogPersister, MessageEvaluator, MessageTerminator, MonitorPersister, PacketPersister, Persister, PersisterPool, ReceiverPool, RedisPersister, RMQPersister, ServerPersister, StreamPersister

public interface MessagePersister

MessagePersister is an interface that picks up JMS Messages from an XQueue as the input and persists or delivers them to their destinations. The XQueue will be used as the output by instances of either MessageNodes or MessageReceivers.

MessagePersister is used as the output node in a Message Flow. It supports various types destinations, like JMSDestination, logfile, database, serial port, TCP socket, web server, ftp server, ssh server, smtp server, shell script, etc. Its job is to deliver the messages.

For the transaction support of MessagePersister, it is up to the implementations. If the implementation supports the transactions, the property of XAMode should be used to control the transactions. If XAMode is set to zero, the Auto Commit should be enabled on the delivery. Otherwise, the transaction should be implemented as Batch Commit. In case the input XQueue is EXTERNAL_XA enabled, each delivered message has to be acknowledged explicitly.

At any given time, MessagePersister is on one of the following 8 different states:
PSTR_READY connected and ready to work
PSTR_RUNNING running normally
PSTR_RETRYING trying to reconnect and get back to work
PSTR_PAUSE pausing for a bit while still connected
PSTR_STANDBY standby for a bit longer while still connected
PSTR_DISABLED disabled temporarily with all connections closed
PSTR_STOPPED completed the job and closed all connections
PSTR_CLOSED closed all connections and ready to destroy object

Author:

yannanlu@yahoo.com

Field Summary

Fields

Modifier and Type	Field and Description
static int	PSTR_CLOSED
static int	PSTR_DISABLED
static int	PSTR_PAUSE
static int	PSTR_READY
static int	PSTR_RETRYING
static int	PSTR_RUNNING
static int	PSTR_STANDBY
static int	PSTR_STOPPED

Method Summary

Modifier and Type	Method and Description
void	close() closes all opened resources
int	getCapacity() returns the capacity of the InLink
java.lang.String	getLinkName() returns the name of the InLink
java.lang.String	getName() returns the name of the persister
java.lang.String	getOperation() returns the string of the operation
int	getStatus() returns the status of the persister
int	getXAMode() returns the transaction mode of the persister
void	persist(XQueue in, int sleepTime) gets all the JMS messages from the XQueue and delivers them to their destinations.
void	setStatus(int status) sets the status of the persister

Field Detail

PSTR_READY

static final int PSTR_READY

See Also:

Constant Field Values

PSTR_RUNNING

static final int PSTR_RUNNING

See Also:

Constant Field Values

PSTR_RETRYING

static final int PSTR_RETRYING

See Also:

Constant Field Values

PSTR_PAUSE

static final int PSTR_PAUSE

See Also:

Constant Field Values

PSTR_STANDBY

static final int PSTR_STANDBY

See Also:

Constant Field Values

PSTR_DISABLED

static final int PSTR_DISABLED

See Also:

Constant Field Values

PSTR_STOPPED

static final int PSTR_STOPPED

See Also:

Constant Field Values

PSTR_CLOSED

static final int PSTR_CLOSED

See Also:

Constant Field Values

Method Detail

persist

void persist(XQueue in,
             int sleepTime)

gets all the JMS messages from the XQueue and delivers them to their destinations. In case of failure, it should keep retry with the sleepTime in milliseconds.

getOperation

java.lang.String getOperation()

returns the string of the operation

getName

java.lang.String getName()

returns the name of the persister

getLinkName

java.lang.String getLinkName()

returns the name of the InLink

getStatus

int getStatus()

returns the status of the persister

getCapacity

int getCapacity()

returns the capacity of the InLink

getXAMode

int getXAMode()

returns the transaction mode of the persister

setStatus

void setStatus(int status)

sets the status of the persister

close

void close()

closes all opened resources