Class OneShotChannelAdaptorMK2

java.lang.Object

org.jpos.q2.QBeanSupport

org.jpos.q2.iso.OneShotChannelAdaptorMK2

All Implemented Interfaces:

Runnable, Configurable, Channel, OneShotChannelAdaptorMK2MBean, QBean, QBeanSupportMBean, QPersist

public class OneShotChannelAdaptorMK2
extends QBeanSupport
implements OneShotChannelAdaptorMK2MBean, Channel, Runnable

OneShotChannelAdaptorMK2 connects and disconnects a channel for every message exchange. It is similar to OneShotChannelAdaptor but uses a thread pool instead of opening threads statically and supports mux pooling by exposing channel readiness.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	OneShotChannelAdaptorMK2.Worker	Per-message worker that opens an ad-hoc channel, sends a request, and forwards the response.

Field Summary

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
OneShotChannelAdaptorMK2()	Default constructor.

Method Summary

Modifier and Type	Method	Description
protected String	defaultRealm()	Returns the default realm for this bean; subclasses may override.
void	destroyService()	Called during the destroy lifecycle phase; subclasses may override.
String	getHost()	Returns the configured remote host.
String	getInQueue()	Returns the inbound queue name.
String	getOutQueue()	Returns the outbound queue name.
int	getPort()	Returns the configured remote port.
String	getSocketFactory()	Returns the configured socket-factory class name.
protected void	initService()	Called during the init lifecycle phase; subclasses may override.
boolean	isConnected()	Indicates whether the adaptor's underlying channel is currently connected.
ISOMsg	receive()	Receives an ISO message from this channel.
ISOMsg	receive(long timeout)	Receives an ISO message, waiting at most timeout milliseconds.
void	run()
void	send(ISOMsg m)	Sends a message via the inbound queue with no expiration.
void	send(ISOMsg m, long timeout)	Sends a message via the inbound queue with a per-entry lease.
void	setHost(String host)	Sets the remote host.
void	setInQueue(String in)	Sets the inbound queue name.
void	setOutQueue(String out)	Sets the outbound queue name.
void	setPort(int port)	Sets the remote port.
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

Constructor Details

OneShotChannelAdaptorMK2

public OneShotChannelAdaptorMK2()

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

protected void initService()
                    throws Exception

Description copied from class: QBeanSupport

Called during the init lifecycle phase; subclasses may override.

Overrides:

initService in class QBeanSupport

Throws:

Exception - on error

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

isConnected

public boolean isConnected()

Description copied from interface: OneShotChannelAdaptorMK2MBean

Indicates whether the adaptor's underlying channel is currently connected.

Specified by:

isConnected in interface OneShotChannelAdaptorMK2MBean

Returns:

true if the channel is up

run

public void run()

Specified by:

run in interface Runnable

send

public void send(ISOMsg m)

Sends a message via the inbound queue with no expiration.

Specified by:

send in interface Channel

Parameters:

m - message to send

send

public void send(ISOMsg m,
 long timeout)

Sends a message via the inbound queue with a per-entry lease.

Parameters:

m - message to send

timeout - entry lease in milliseconds

receive

public ISOMsg receive()

Description copied from interface: Channel

Receives an ISO message from this channel.

Specified by:

receive in interface Channel

Returns:

received message

receive

public ISOMsg receive(long timeout)

Description copied from interface: Channel

Receives an ISO message, waiting at most timeout milliseconds.

Specified by:

receive in interface Channel

Parameters:

timeout - time to wait for a message

Returns:

received message or null on timeout

getInQueue

public String getInQueue()

Description copied from interface: OneShotChannelAdaptorMK2MBean

Returns the inbound queue name.

Specified by:

getInQueue in interface OneShotChannelAdaptorMK2MBean

Returns:

queue name

setInQueue

public void setInQueue(String in)

Description copied from interface: OneShotChannelAdaptorMK2MBean

Sets the inbound queue name.

Specified by:

setInQueue in interface OneShotChannelAdaptorMK2MBean

Parameters:

in - queue name

getOutQueue

public String getOutQueue()

Description copied from interface: OneShotChannelAdaptorMK2MBean

Returns the outbound queue name.

Specified by:

getOutQueue in interface OneShotChannelAdaptorMK2MBean

Returns:

queue name

setOutQueue

public void setOutQueue(String out)

Description copied from interface: OneShotChannelAdaptorMK2MBean

Sets the outbound queue name.

Specified by:

setOutQueue in interface OneShotChannelAdaptorMK2MBean

Parameters:

out - queue name

getHost

public String getHost()

Description copied from interface: OneShotChannelAdaptorMK2MBean

Returns the configured remote host.

Specified by:

getHost in interface OneShotChannelAdaptorMK2MBean

Returns:

host name or address

setHost

public void setHost(String host)

Description copied from interface: OneShotChannelAdaptorMK2MBean

Sets the remote host.

Specified by:

setHost in interface OneShotChannelAdaptorMK2MBean

Parameters:

host - host name or address

getPort

public int getPort()

Description copied from interface: OneShotChannelAdaptorMK2MBean

Returns the configured remote port.

Specified by:

getPort in interface OneShotChannelAdaptorMK2MBean

Returns:

TCP port number

setPort

public void setPort(int port)

Description copied from interface: OneShotChannelAdaptorMK2MBean

Sets the remote port.

Specified by:

setPort in interface OneShotChannelAdaptorMK2MBean

Parameters:

port - TCP port number

getSocketFactory

public String getSocketFactory()

Returns the configured socket-factory class name.

Specified by:

getSocketFactory in interface OneShotChannelAdaptorMK2MBean

Returns:

socket factory class name

setSocketFactory

public void setSocketFactory(String sFac)

Sets the socket-factory class name.

Specified by:

setSocketFactory in interface OneShotChannelAdaptorMK2MBean

Parameters:

sFac - socket factory class name