Class MUXPool

java.lang.Object

org.jpos.q2.QBeanSupport

org.jpos.q2.iso.MUXPool

All Implemented Interfaces:

Configurable, ISOSource, MUX, MUXPoolMBean, QBean, QBeanSupportMBean, QPersist

public class MUXPool
extends QBeanSupport
implements MUX, MUXPoolMBean

Pool of MUX instances that selects a delegate per request based on the configured strategy (one of PRIMARY_SECONDARY, ROUND_ROBIN, ROUND_ROBIN_WITH_OVERRIDE, or SPLIT_BY_DIVISOR).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MUXPool.StrategyHandler	A class implementing this interface can be added to a MUXPool to override the classical built-in strategies. It could be added to a MUXPool like this:

Field Summary

Fields

Modifier and Type	Field	Description
static final int	PRIMARY_SECONDARY	Strategy: try MUXes in order, falling through to the next when unusable.
static final int	ROUND_ROBIN	Strategy: round-robin selection across the registered MUXes.
static final int	ROUND_ROBIN_WITH_OVERRIDE	Strategy: round-robin selection with per-MTI override routing.
static final int	SPLIT_BY_DIVISOR	Strategy: hash-by-divisor selection driven by a configured field value.

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
MUXPool()	Default constructor; no instance state to initialise.

Method Summary

Modifier and Type	Method	Description
protected String	defaultRealm()	Returns the default realm for this bean; subclasses may override.
protected MUX	firstAvailableMUX(long maxWait)	Returns the first usable MUX, scanning from index 0 and waiting up to maxWait.
String[]	getMuxNames()	Returns the names of the MUXes in this pool.
int	getStrategy()	Returns the configured selection strategy.
MUXPool.StrategyHandler	getStrategyHandler()	Returns the configured custom strategy handler, if any.
protected void	initHandler(org.jdom2.Element e)	Instantiates a custom MUXPool.StrategyHandler from an XML configuration element.
void	initService()	Called during the init lifecycle phase; subclasses may override.
boolean	isConnected()	Indicates whether this source is currently connected and able to send messages.
protected MUX	nextAvailableMUX(int mnumber, long maxWait)	Returns the next usable MUX starting from mnumber, waiting up to maxWait.
ISOMsg	request(ISOMsg m, long timeout)	Sends a message to remote host and wait for response
void	request(ISOMsg m, long timeout, ISOResponseListener r, Object handBack)	Sends a message to remote host in async way
void	send(ISOMsg m)	sends (or hands back) an ISOMsg
void	stopService()	Called during the stop lifecycle phase; subclasses may override.

Methods inherited from class QBeanSupport

addAttr, close, createElement, destroy, destroyService, 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, startService, 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 void	destroyService()	Called during the destroy lifecycle phase; subclasses may override.
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
protected void	startService()	Called during the start lifecycle phase; subclasses may override.
void	stop()	stop the service

Methods inherited from class Object

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

Field Details

PRIMARY_SECONDARY

public static final int PRIMARY_SECONDARY

Strategy: try MUXes in order, falling through to the next when unusable.

See Also:

• Constant Field Values

ROUND_ROBIN

public static final int ROUND_ROBIN

Strategy: round-robin selection across the registered MUXes.

See Also:

• Constant Field Values

ROUND_ROBIN_WITH_OVERRIDE

public static final int ROUND_ROBIN_WITH_OVERRIDE

Strategy: round-robin selection with per-MTI override routing.

See Also:

• Constant Field Values

SPLIT_BY_DIVISOR

public static final int SPLIT_BY_DIVISOR

Strategy: hash-by-divisor selection driven by a configured field value.

See Also:

• Constant Field Values

Constructor Details

MUXPool

public MUXPool()

Default constructor; no instance state to initialise.

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

stopService

public void stopService()

Description copied from class: QBeanSupport

Called during the stop lifecycle phase; subclasses may override.

Overrides:

stopService in class QBeanSupport

initHandler

protected void initHandler(org.jdom2.Element e)
                    throws ConfigurationException

Instantiates a custom MUXPool.StrategyHandler from an XML configuration element.

Parameters:

e - <strategy-handler> element, or null to leave the handler unset

Throws:

ConfigurationException - if the handler cannot be instantiated

request

public ISOMsg request(ISOMsg m,
 long timeout)
               throws ISOException

Description copied from interface: MUX

Sends a message to remote host and wait for response

Specified by:

request in interface MUX

Parameters:

m - message to send

timeout - time to wait for a message

Returns:

received message or null

Throws:

ISOException - on pack/unpack error

request

public void request(ISOMsg m,
 long timeout,
 ISOResponseListener r,
 Object handBack)
             throws ISOException

Description copied from interface: MUX

Sends a message to remote host in async way

Specified by:

request in interface MUX

Parameters:

m - message to send

timeout - time to wait for the response

r - reference to response listener

handBack - optional handback to be given to reponse listener

Throws:

ISOException - on pack/unpack error

send

public void send(ISOMsg m)
          throws ISOException,
IOException

Description copied from interface: ISOSource

sends (or hands back) an ISOMsg

Specified by:

send in interface ISOSource

Parameters:

m - the Message to be sent

Throws:

ISOException - on ISO packing failure

IOException - on I/O failure

firstAvailableMUX

protected MUX firstAvailableMUX(long maxWait)

Returns the first usable MUX, scanning from index 0 and waiting up to maxWait.

Parameters:

maxWait - wall-clock deadline in milliseconds since epoch

Returns:

a usable MUX, or null if none became available before the deadline

nextAvailableMUX

protected MUX nextAvailableMUX(int mnumber,
 long maxWait)

Returns the next usable MUX starting from mnumber, waiting up to maxWait.

Parameters:

mnumber - starting index (round-robin counter)

maxWait - wall-clock deadline in milliseconds since epoch

Returns:

a usable MUX, or null if none became available before the deadline

getMuxNames

public String[] getMuxNames()

Description copied from interface: MUXPoolMBean

Returns the names of the MUXes in this pool.

Specified by:

getMuxNames in interface MUXPoolMBean

Returns:

MUX names

getStrategy

public int getStrategy()

Description copied from interface: MUXPoolMBean

Returns the configured selection strategy.

Specified by:

getStrategy in interface MUXPoolMBean

Returns:

strategy code (see MUXPool strategy constants)

getStrategyHandler

public MUXPool.StrategyHandler getStrategyHandler()

Returns the configured custom strategy handler, if any.

Returns:

the MUXPool.StrategyHandler, or null when not configured

isConnected

public boolean isConnected()

Description copied from interface: ISOSource

Indicates whether this source is currently connected and able to send messages.

Specified by:

isConnected in interface ISOSource

Returns:

true if source is connected and usable