Class ChannelAdaptor

java.lang.Object

org.jpos.q2.QBeanSupport

org.jpos.q2.iso.ChannelAdaptor

All Implemented Interfaces:

Configurable, ExceptionHandlerConfigAware, Channel, ChannelAdaptorMBean, QBean, QBeanSupportMBean, QPersist, Loggeable

Direct Known Subclasses:

MultiSessionChannelAdaptor

public class ChannelAdaptor
extends QBeanSupport
implements ChannelAdaptorMBean, Channel, Loggeable, ExceptionHandlerConfigAware

A Q2 adaptor that wraps an ISOChannel for use within the Q2 container.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ChannelAdaptor.Receiver	Background thread that reads incoming messages from the channel.
class	ChannelAdaptor.Sender	Background thread that forwards outgoing messages to the channel.

Field Summary

Fields

Modifier and Type	Field	Description
protected Space	sp	The space used for inter-process message passing.

Fields inherited from class QBeanSupport

cfg, log, scheduledThreadPoolExecutor

Modifier and Type	Field	Description
protected Configuration	cfg	Configuration applied to this bean by the container.
protected Log	log	Logger associated with this bean.
protected ScheduledThreadPoolExecutor	scheduledThreadPoolExecutor	Lazily-allocated scheduler shared with subclasses; see QBeanSupport.getScheduledThreadPoolExecutor().

Fields inherited from interface QBean

DESTROYED, FAILED, STARTED, STARTING, stateString, STOPPED, STOPPING

Modifier and Type	Field	Description
static final int	DESTROYED	QBean has been destroyed.
static final int	FAILED	QBean has failed.
static final int	STARTED	QBean is running.
static final int	STARTING	QBean is in the process of starting.
static final String[]	stateString	Human-readable names for each QBean state, indexed by state constant.
static final int	STOPPED	QBean is stopped.
static final int	STOPPING	QBean is in the process of stopping.

Constructor Summary

Constructors

Constructor	Description
ChannelAdaptor()	Default constructor.

Method Summary

Modifier and Type	Method	Description
protected void	addFilters(FilteredChannel channel, org.jdom2.Element e, QFactory fact)	Registers filters defined in the configuration element with the channel.
protected void	append(StringBuilder sb, String name, int value)	Appends a name=value counter entry to the string builder.
protected void	checkConnection()	Waits until the reconnect token clears, then attempts to reconnect.
protected String	defaultRealm()	Returns the default realm for this bean; subclasses may override.
void	destroyService()	Called during the destroy lifecycle phase; subclasses may override.
protected void	disconnect()	Disconnects the channel and releases associated resources.
void	dump(PrintStream p, String indent)	Dumps a human-readable representation of this object to the print stream.
int	getConnectsCounter()	Returns the number of successful connections since last reset.
String	getCountersAsString()	Returns all counters as a human-readable string.
String	getHost()	Returns the remote host name or address.
long	getIdleTimeInMillis()	Returns the idle time since the last transaction.
String	getInQueue()	Returns the incoming space queue name.
long	getLastTxnTimestampInMillis()	Returns the timestamp of the last transaction.
String	getOutQueue()	Returns the outgoing space queue name.
int	getPort()	Returns the remote port number.
long	getReconnectDelay()	Returns the reconnect delay.
int	getRXCounter()	Returns the received message count.
String	getSocketFactory()	Returns the socket factory class name.
int	getTXCounter()	Returns the transmitted message count.
protected Space	grabSpace(org.jdom2.Element e)	Returns the Space referenced by the given element, or the default space if null.
protected ISOChannel	initChannel()	Initialises and returns the ISOChannel from the current configuration.
void	initService()	Called during the init lifecycle phase; subclasses may override.
protected void	initSpaceAndQueues()	Initialises the Space and in/out queues used by this adaptor.
boolean	isConnected()	Returns true if the channel is currently connected.
ISOChannel	newChannel(org.jdom2.Element e, QFactory f)	Parses a <channel> element, returning an ISOChannel.
ISOChannel	newChannel(org.jdom2.Element e, QFactory f, String fallbackRealm)	Parses a <channel> element, using the provided fallback realm when none is configured.
ISOMsg	receive()	Receive message
ISOMsg	receive(long timeout)	Receive message
void	resetCounters()	Resets all message counters to zero.
void	send(ISOMsg m)	Queue a message to be transmitted by this adaptor
void	send(ISOMsg m, long timeout)	Queue a message to be transmitted by this adaptor
void	setHost(String host)	Sets the remote host name or address.
void	setInQueue(String in)	Sets the incoming space queue name.
void	setOutQueue(String out)	Sets the outgoing space queue name.
void	setPort(int port)	Sets the remote port number.
void	setReconnectDelay(long delay)	Sets the reconnect delay.
void	setSocketFactory(String sFac)	Sets the socket factory class name.
void	startService()	Called during the start lifecycle phase; subclasses may override.
void	stopService()	Called during the stop lifecycle phase; subclasses may override.

Methods inherited from class QBeanSupport

addAttr, close, createElement, destroy, getAttrs, getAttrs, getConfiguration, getDump, getFactory, getLoader, getLoaderURLS, getLog, getLogger, getName, getPersist, getProperties, getProperty, getRealm, getScheduledThreadPoolExecutor, getServer, getState, getStateAsString, init, isModified, running, setAttr, setConfiguration, setLogger, setModified, setName, setPersist, setProperty, setRealm, setServer, setState, start, stop

Modifier and Type	Method	Description
protected void	addAttr(org.jdom2.Element e, String name, Object obj, String type)	Appends an <attr> child element with name/type/value to e.
protected void	close(Closeable... closeables)	Closes a sequence of Closeable resources, logging any failures as a warning.
protected org.jdom2.Element	createElement(String name, Class mbeanClass)	Builds a JDOM Element reflecting the bean's persistent attributes, driven by the JavaBean introspection of mbeanClass.
void	destroy()	destroy the service
protected Iterator	getAttrs()	Iterates over top-level <attr> children of the persisted element.
protected Iterator	getAttrs(String parent)	Iterates over <attr> children nested under the given parent element name.
Configuration	getConfiguration()	Returns the configuration applied to this bean.
String	getDump()	Returns a textual dump of this bean's state.
QFactory	getFactory()	Returns the QFactory associated with the hosting Q2 server.
QClassLoader	getLoader()	Returns the QClassLoader for this bean.
URL[]	getLoaderURLS()	Returns the URLs registered with the class loader.
Log	getLog()	Returns the Log used by this bean.
String	getLogger()	Returns the logger name.
String	getName()	Returns the bean name.
org.jdom2.Element	getPersist()	Returns the persistent configuration element for this QBean.
protected Iterator	getProperties(String parent)	Iterates over <property> children nested under the given parent element name.
protected String	getProperty(Iterator props, String name)	Returns the value of the named property from an iterator of <property> elements.
String	getRealm()	Returns the logging realm.
protected ScheduledThreadPoolExecutor	getScheduledThreadPoolExecutor()	Lazily creates and returns a ScheduledThreadPoolExecutor for use by subclasses.
Q2	getServer()	Returns the Q2 server instance.
int	getState()	Returns the current state of this QBean.
String	getStateAsString()	Returns the current state as a human-readable string.
void	init()	init the service
boolean	isModified()	Returns true if this QBean's configuration has been modified since last save.
boolean	running()	Indicates whether this bean is currently starting or running.
protected void	setAttr(Iterator attrs, String name, Object obj)	Updates the value of the named attribute within an iterator of <attr> elements.
void	setConfiguration(Configuration cfg)	Configures this object with the supplied Configuration.
void	setLogger(String loggerName)	Sets the logger by name.
void	setModified(boolean modified)	Marks this bean's persistent state as modified or in sync.
void	setName(String name)	Sets the bean name.
void	setPersist(org.jdom2.Element persist)	Sets the persistent configuration element.
protected void	setProperty(Iterator props, String name, String value)	Updates the value attribute of the named property within an iterator of <property> elements.
void	setRealm(String realm)	Sets the logging realm.
void	setServer(Q2 server)	Sets the Q2 server instance for this QBean.
void	setState(int state)	Sets the lifecycle state of this bean.
void	start()	start the service
void	stop()	stop the service

Methods inherited from class Object

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

Methods inherited from interface ExceptionHandlerConfigAware

addExceptionHandlers

Modifier and Type	Method	Description
default void	addExceptionHandlers(ExceptionHandlerAware receiver, org.jdom2.Element elem, QFactory fact)	Parses exception-handler child elements from elem and registers them with receiver.

Methods inherited from interface Loggeable

dump

Modifier and Type	Method	Description
default void	dump(PrintStream p, String indent, LogRenderer.Type type)	Dumps a representation of this object using the specified renderer type.

Field Details

sp

protected Space sp

The space used for inter-process message passing.

Constructor Details

ChannelAdaptor

public ChannelAdaptor()

Default constructor.

Method Details

defaultRealm

protected String defaultRealm()

Description copied from class: QBeanSupport

Returns the default realm for this bean; subclasses may override.

Overrides:

defaultRealm in class QBeanSupport

Returns:

default realm string, or null

initService

public void initService()
                 throws ConfigurationException

Description copied from class: QBeanSupport

Called during the init lifecycle phase; subclasses may override.

Overrides:

initService in class QBeanSupport

Throws:

ConfigurationException

startService

public void startService()

Description copied from class: QBeanSupport

Called during the start lifecycle phase; subclasses may override.

Overrides:

startService in class QBeanSupport

stopService

public void stopService()

Description copied from class: QBeanSupport

Called during the stop lifecycle phase; subclasses may override.

Overrides:

stopService in class QBeanSupport

destroyService

public void destroyService()

Description copied from class: QBeanSupport

Called during the destroy lifecycle phase; subclasses may override.

Overrides:

destroyService in class QBeanSupport

setReconnectDelay

public void setReconnectDelay(long delay)

Description copied from interface: ChannelAdaptorMBean

Sets the reconnect delay.

Specified by:

setReconnectDelay in interface ChannelAdaptorMBean

Parameters:

delay - reconnect delay in milliseconds

getReconnectDelay

public long getReconnectDelay()

Description copied from interface: ChannelAdaptorMBean

Returns the reconnect delay.

Specified by:

getReconnectDelay in interface ChannelAdaptorMBean

Returns:

reconnect delay in milliseconds

setInQueue

public void setInQueue(String in)

Description copied from interface: ChannelAdaptorMBean

Sets the incoming space queue name.

Specified by:

setInQueue in interface ChannelAdaptorMBean

Parameters:

in - name of the incoming space queue

getInQueue

public String getInQueue()

Description copied from interface: ChannelAdaptorMBean

Returns the incoming space queue name.

Specified by:

getInQueue in interface ChannelAdaptorMBean

Returns:

name of the incoming space queue

setOutQueue

public void setOutQueue(String out)

Description copied from interface: ChannelAdaptorMBean

Sets the outgoing space queue name.

Specified by:

setOutQueue in interface ChannelAdaptorMBean

Parameters:

out - name of the outgoing space queue

send

public void send(ISOMsg m)

Queue a message to be transmitted by this adaptor

Specified by:

send in interface Channel

Parameters:

m - message to send

send

public void send(ISOMsg m,
 long timeout)

Queue a message to be transmitted by this adaptor

Parameters:

m - message to send

timeout - timeout in millis

receive

public ISOMsg receive()

Receive message

Specified by:

receive in interface Channel

Returns:

received message

receive

public ISOMsg receive(long timeout)

Receive message

Specified by:

receive in interface Channel

Parameters:

timeout - time to wait for an incoming message

Returns:

received message or null on timeout

isConnected

public boolean isConnected()

Description copied from interface: ChannelAdaptorMBean

Returns true if the channel is currently connected.

Specified by:

isConnected in interface ChannelAdaptorMBean

Returns:

true if channel is connected

getOutQueue

public String getOutQueue()

Description copied from interface: ChannelAdaptorMBean

Returns the outgoing space queue name.

Specified by:

getOutQueue in interface ChannelAdaptorMBean

Returns:

name of the outgoing space queue

newChannel

public ISOChannel newChannel(org.jdom2.Element e,
 QFactory f)
                      throws ConfigurationException

Parses a <channel> element, returning an ISOChannel.

Parameters:

e - the configuration element

f - the QFactory

Returns:

a configured ISOChannel

Throws:

ConfigurationException - on configuration error

newChannel

public ISOChannel newChannel(org.jdom2.Element e,
 QFactory f,
 String fallbackRealm)
                      throws ConfigurationException

Parses a <channel> element, using the provided fallback realm when none is configured.

Parameters:

e - the configuration element

f - the QFactory

fallbackRealm - realm to use if none is configured

Returns:

a configured ISOChannel

Throws:

ConfigurationException - on configuration error

addFilters

protected void addFilters(FilteredChannel channel,
 org.jdom2.Element e,
 QFactory fact)
                   throws ConfigurationException

Registers filters defined in the configuration element with the channel.

Parameters:

channel - the channel to configure

e - the configuration element

fact - the QFactory

Throws:

ConfigurationException - on error

initChannel

protected ISOChannel initChannel()
                          throws ConfigurationException

Initialises and returns the ISOChannel from the current configuration.

Returns:

the initialised channel

Throws:

ConfigurationException - on error

initSpaceAndQueues

protected void initSpaceAndQueues()
                           throws ConfigurationException

Initialises the Space and in/out queues used by this adaptor.

Throws:

ConfigurationException - on error

checkConnection

protected void checkConnection()

Waits until the reconnect token clears, then attempts to reconnect.

disconnect

protected void disconnect()

Disconnects the channel and releases associated resources.

setHost

public void setHost(String host)

Description copied from interface: ChannelAdaptorMBean

Sets the remote host name or address.

Specified by:

setHost in interface ChannelAdaptorMBean

Parameters:

host - remote host

getHost

public String getHost()

Description copied from interface: ChannelAdaptorMBean

Returns the remote host name or address.

Specified by:

getHost in interface ChannelAdaptorMBean

Returns:

remote host

setPort

public void setPort(int port)

Description copied from interface: ChannelAdaptorMBean

Sets the remote port number.

Specified by:

setPort in interface ChannelAdaptorMBean

Parameters:

port - remote port

getPort

public int getPort()

Description copied from interface: ChannelAdaptorMBean

Returns the remote port number.

Specified by:

getPort in interface ChannelAdaptorMBean

Returns:

remote port

setSocketFactory

public void setSocketFactory(String sFac)

Description copied from interface: ChannelAdaptorMBean

Sets the socket factory class name.

Specified by:

setSocketFactory in interface ChannelAdaptorMBean

Parameters:

sFac - socket factory class name

resetCounters

public void resetCounters()

Description copied from interface: ChannelAdaptorMBean

Resets all message counters to zero.

Specified by:

resetCounters in interface ChannelAdaptorMBean

getCountersAsString

public String getCountersAsString()

Description copied from interface: ChannelAdaptorMBean

Returns all counters as a human-readable string.

Specified by:

getCountersAsString in interface ChannelAdaptorMBean

Returns:

counters string

getTXCounter

public int getTXCounter()

Description copied from interface: ChannelAdaptorMBean

Returns the transmitted message count.

Specified by:

getTXCounter in interface ChannelAdaptorMBean

Returns:

TX count

getRXCounter

public int getRXCounter()

Description copied from interface: ChannelAdaptorMBean

Returns the received message count.

Specified by:

getRXCounter in interface ChannelAdaptorMBean

Returns:

RX count

getConnectsCounter

public int getConnectsCounter()

Description copied from interface: ChannelAdaptorMBean

Returns the number of successful connections since last reset.

Specified by:

getConnectsCounter in interface ChannelAdaptorMBean

Returns:

connect count

getLastTxnTimestampInMillis

public long getLastTxnTimestampInMillis()

Description copied from interface: ChannelAdaptorMBean

Returns the timestamp of the last transaction.

Specified by:

getLastTxnTimestampInMillis in interface ChannelAdaptorMBean

Returns:

timestamp in milliseconds

getIdleTimeInMillis

public long getIdleTimeInMillis()

Description copied from interface: ChannelAdaptorMBean

Returns the idle time since the last transaction.

Specified by:

getIdleTimeInMillis in interface ChannelAdaptorMBean

Returns:

idle time in milliseconds

getSocketFactory

public String getSocketFactory()

Description copied from interface: ChannelAdaptorMBean

Returns the socket factory class name.

Specified by:

getSocketFactory in interface ChannelAdaptorMBean

Returns:

socket factory class name

dump

public void dump(PrintStream p,
 String indent)

Description copied from interface: Loggeable

Dumps a human-readable representation of this object to the print stream.

Specified by:

dump in interface Loggeable

Parameters:

p - the output stream

indent - indentation prefix

grabSpace

protected Space grabSpace(org.jdom2.Element e)

Returns the Space referenced by the given element, or the default space if null.

Parameters:

e - the element whose text names the space

Returns:

the resolved Space

append

protected void append(StringBuilder sb,
 String name,
 int value)

Appends a name=value counter entry to the string builder.

Parameters:

sb - the builder to append to

name - the counter name

value - the counter value