Package org.objectweb.joram.client.connector

Class InboundConsumer

java.lang.Object

org.objectweb.joram.client.connector.InboundConsumer

All Implemented Interfaces:

ServerSessionPool, InboundConsumerMBean

public class InboundConsumer
extends Object
implements ServerSessionPool, InboundConsumerMBean

An InboundConsumer instance is responsible for consuming messages from a given JORAM destination and through a given JORAM connection.

Field Summary

Fields

Modifier and Type	Field	Description
private int	ackMode
private boolean	closeDurSub	for closing durable subscription
private XAConnection	cnx	The provided connection to the underlying JORAM server.
private ConnectionConsumer	cnxConsumer	Wrapped ConnectionConsumer instance.
private static boolean	DEBUG
(package private) MessageEndpointFactory	endpointFactory	Application's endpoints factory.
private static Logger	logger
private int	maxWorks	Maximum number of Work instances to be submitted (0 for infinite).
private Vector<ServerSession>	pool	Pool of server sessions.
private int	serverSessions	Number of created server sessions.
private String	subName	The durable subscription name, if provided.
private boolean	transacted	true if message consumption occurs in a transaction.
private WorkManager	workManager	Application server's WorkManager instance.

Constructor Summary

Constructors

Constructor	Description
InboundConsumer(WorkManager workManager, MessageEndpointFactory endpointFactory, XAConnection cnx, Destination dest, String selector, boolean durable, String subName, boolean transacted, int maxWorks, int maxMessages, int ackMode, boolean closeDurSub)	Constructs an InboundConsumer instance.

Method Summary

Modifier and Type	Method	Description
(package private) void	close()	Closes the consumer.
String	getAckMode()	the session mode.
boolean	getCloseDurSub()	for closing durable subscription
String	getJMXBeanName(XAConnection cnx)
int	getMaxWorks()	Maximum number of Work instances to be submitted (0 for infinite).
int	getPoolSize()	Size of the pool of server sessions.
ServerSession	getServerSession()	Provides a new InboundSession instance for processing incoming messages.
int	getServerSessions()	Number of created server sessions.
String[]	getSessions()
String	getSubName()	The durable subscription name, if provided.
boolean	getTransacted()	true if message consumption occurs in a transaction.
private InboundSession	newSession()
String	registerMBean()
(package private) void	releaseSession(InboundSession session)	Releases an InboundSession instance.
void	unregisterMBean()

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final Logger logger

DEBUG

private static final boolean DEBUG

workManager

private WorkManager workManager

Application server's WorkManager instance.

endpointFactory

MessageEndpointFactory endpointFactory

Application's endpoints factory.

cnx

private XAConnection cnx

The provided connection to the underlying JORAM server.

subName

private String subName

The durable subscription name, if provided.

transacted

private boolean transacted

true if message consumption occurs in a transaction.

maxWorks

private int maxWorks

Maximum number of Work instances to be submitted (0 for infinite).

ackMode

private int ackMode

closeDurSub

private boolean closeDurSub

for closing durable subscription

cnxConsumer

private ConnectionConsumer cnxConsumer

Wrapped ConnectionConsumer instance.

serverSessions

private int serverSessions

Number of created server sessions.

pool

private Vector<ServerSession> pool

Pool of server sessions.

Constructor Detail

InboundConsumer

public InboundConsumer(WorkManager workManager,
                       MessageEndpointFactory endpointFactory,
                       XAConnection cnx,
                       Destination dest,
                       String selector,
                       boolean durable,
                       String subName,
                       boolean transacted,
                       int maxWorks,
                       int maxMessages,
                       int ackMode,
                       boolean closeDurSub)
                throws ResourceException

Constructs an InboundConsumer instance.

Parameters:

workManager - Application server's WorkManager instance.

endpointFactory - Application's endpoints factory.

cnx - Connection to the JORAM server.

dest - Destination to get messages from.

selector - Selector for filtering messages.

durable - true for durably subscribing.

subName - Durable subscription name.

transacted - true if deliveries will occur in a XA transaction.

maxWorks - Max number of Work instances to be submitted.

Throws:

NotSupportedException - If the activation parameters are invalid.

SecurityException - If the target destination is not readable.

CommException - If the connection with the JORAM server is lost.

ResourceException - Generic exception.

Method Detail

getJMXBeanName

public String getJMXBeanName(XAConnection cnx)

registerMBean

public String registerMBean()

unregisterMBean

public void unregisterMBean()

getServerSession

public ServerSession getServerSession()
                               throws JMSException

Provides a new InboundSession instance for processing incoming messages.

Specified by:

getServerSession in interface ServerSessionPool

Throws:

JMSException - Never thrown.

newSession

private InboundSession newSession()

releaseSession

void releaseSession(InboundSession session)

Releases an InboundSession instance.

close

void close()

Closes the consumer.

getSubName

public String getSubName()

Description copied from interface: InboundConsumerMBean

The durable subscription name, if provided.

Specified by:

getSubName in interface InboundConsumerMBean

getTransacted

public boolean getTransacted()

Description copied from interface: InboundConsumerMBean

true if message consumption occurs in a transaction.

Specified by:

getTransacted in interface InboundConsumerMBean

getMaxWorks

public int getMaxWorks()

Description copied from interface: InboundConsumerMBean

Maximum number of Work instances to be submitted (0 for infinite).

Specified by:

getMaxWorks in interface InboundConsumerMBean

getAckMode

public String getAckMode()

Description copied from interface: InboundConsumerMBean

the session mode.

Specified by:

getAckMode in interface InboundConsumerMBean

getCloseDurSub

public boolean getCloseDurSub()

Description copied from interface: InboundConsumerMBean

for closing durable subscription

Specified by:

getCloseDurSub in interface InboundConsumerMBean

getServerSessions

public int getServerSessions()

Description copied from interface: InboundConsumerMBean

Number of created server sessions.

Specified by:

getServerSessions in interface InboundConsumerMBean

getPoolSize

public int getPoolSize()

Description copied from interface: InboundConsumerMBean

Size of the pool of server sessions.

Specified by:

getPoolSize in interface InboundConsumerMBean

getSessions

public String[] getSessions()

Specified by:

getSessions in interface InboundConsumerMBean