MessageReceiver

All Known Implementing Classes:

DocumentReceiver, FileReceiver, HeartbeatGenerator, JDBCReceiver, JMSReceiver, JMSSubscriber, JMXReceiver, LogReceiver, LogScissor, PacketReceiver, Receiver, RedisReceiver, RMQReceiver, ServerListener, ServerReceiver, StreamReceiver
```
public interface MessageReceiver
```
MessageReceiver is an interface that receives JMS Messages from their originations and puts them to an XQueue as the output. This XQueue will be used as the input by instances of either MessageNode or MessagePersister.

MessageReceiver can be used as the input node in a message flow. It may actively fetch or pick up the messages from a remote origination. It may also scan the local log files for messages. Or it just creates messages periodically. Alternatively, it may listen to a network socket for receiving messages passively. Therefore MessageReceiver is a source of JMS Messages.

For the transaction support of MessageReceiver, 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 Acknowledgement should be enabled. Otherwise, the transaction should be implemented as Client Acknowledgement. In the mode of Client Acknowledgement, MessageReceiver relies on extrenal resources to acknowledge the messages. Meanwhile, its output XQueue should have its EXTERNAL_XA bit set so that Client Acknowledgement will be able to propagate to all XQueues downstream.

At any given time, MessageReceiver is on one of the following 8 different states:
RCVR_READY connected and ready to work
RCVR_RUNNING running normally
RCVR_RETRYING trying to reconnect and get back to work
RCVR_PAUSE pausing for a bit while still connected
RCVR_STANDBY standby for a bit longer while still connected
RCVR_DISABLED disabled temporarily with all connections closed
RCVR_STOPPED completed the job and closed all connections
RCVR_CLOSED closed all connections and ready to destroy object

Author:

yannanlu@yahoo.com

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`RCVR_CLOSED`
`static int`	`RCVR_DISABLED`
`static int`	`RCVR_PAUSE`
`static int`	`RCVR_READY`
`static int`	`RCVR_RETRYING`
`static int`	`RCVR_RUNNING`
`static int`	`RCVR_STANDBY`
`static int`	`RCVR_STOPPED`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`close()` closes all opened resources
`int`	`getCapacity()` returns the capacity of the OutLink
`java.lang.String`	`getLinkName()` returns the name of the OutLink
`java.lang.String`	`getName()` returns the name of the receiver
`java.lang.String`	`getOperation()` returns the string of the operation
`int[]`	`getPartition()` returns the partiton array of the input XQueue for the reciever
`int`	`getStatus()` returns the status of the receiver
`int`	`getXAMode()` returns the transaction mode of the reciever
`void`	`receive(XQueue out, int sleepTime)` puts all the received JMS messages to the XQueue as the output.
`void`	`setStatus(int status)` sets the status of the receiver

- Field Detail
  - RCVR_READY
```
static final int RCVR_READY
```
    See Also:
    
    Constant Field Values
  - RCVR_RUNNING
```
static final int RCVR_RUNNING
```
    See Also:
    
    Constant Field Values
  - RCVR_RETRYING
```
static final int RCVR_RETRYING
```
    See Also:
    
    Constant Field Values
  - RCVR_PAUSE
```
static final int RCVR_PAUSE
```
    See Also:
    
    Constant Field Values
  - RCVR_STANDBY
```
static final int RCVR_STANDBY
```
    See Also:
    
    Constant Field Values
  - RCVR_DISABLED
```
static final int RCVR_DISABLED
```
    See Also:
    
    Constant Field Values
  - RCVR_STOPPED
```
static final int RCVR_STOPPED
```
    See Also:
    
    Constant Field Values
  - RCVR_CLOSED
```
static final int RCVR_CLOSED
```
    See Also:
    
    Constant Field Values
- Method Detail
  - receive
```
void receive(XQueue out,
             int sleepTime)
```
    puts all the received JMS messages to the XQueue as the output. 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 receiver
  - getLinkName
```
java.lang.String getLinkName()
```
    returns the name of the OutLink
  - getStatus
```
int getStatus()
```
    returns the status of the receiver
  - getCapacity
```
int getCapacity()
```
    returns the capacity of the OutLink
  - getXAMode
```
int getXAMode()
```
    returns the transaction mode of the reciever
  - getPartition
```
int[] getPartition()
```
    returns the partiton array of the input XQueue for the reciever
  - setStatus
```
void setStatus(int status)
```
    sets the status of the receiver
  - close
```
void close()
```
    closes all opened resources

Interface MessageReceiver

Field Summary

Method Summary

Field Detail

RCVR_READY

RCVR_RUNNING

RCVR_RETRYING

RCVR_PAUSE

RCVR_STANDBY

RCVR_DISABLED

RCVR_STOPPED

RCVR_CLOSED

Method Detail

receive

getOperation

getName

getLinkName

getStatus

getCapacity

getXAMode

getPartition

setStatus

close