Class QServer

java.lang.Object

org.jpos.q2.QBeanSupport

org.jpos.q2.iso.QServer

All Implemented Interfaces:

Configurable, ISORequestListener, QServerMBean, QBean, QBeanSupportMBean, QPersist, SpaceListener

public class QServer
extends QBeanSupport
implements QServerMBean, SpaceListener, ISORequestListener

ISO Server wrapper.

Field Summary

Fields

Modifier and Type	Field	Description
protected LocalSpace	sp	Local space used for inbound/outbound queue routing when configured.

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
QServer()	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	getChannel()	Returns the configured channel class name.
String	getCountersAsString()	Returns aggregated counters across all active channels.
String	getCountersAsString(String isoChannelName)	Returns counters for a single named accepted channel.
String	getISOChannelNames()	Returns the names of all currently-active accepted channels, comma-separated.
ISOServer	getISOServer()	Returns the underlying ISOServer created by this bean.
int	getMaxSessions()	Returns the configured maximum number of concurrent client sessions.
String	getPackager()	Returns the configured packager class name.
int	getPort()	Returns the configured listen port.
String	getSocketFactory()	Returns the configured socket-factory class name.
void	initService()	Called during the init lifecycle phase; subclasses may override.
void	notify(Object key, Object value)	Called by Space implementation whenever an object with the given key is being placed in the Space.
boolean	process(ISOSource source, ISOMsg m)	Called when an unmatched request is received.
void	setChannel(String channel)	Sets the fully qualified channel class name instantiated for each accepted connection.
void	setMaxSessions(int maxSessions)	Sets the maximum number of concurrent client sessions accepted by the server.
void	setPackager(String packager)	Sets the fully qualified packager class name used by accepted channels.
void	setPort(int port)	Sets the TCP port the server listens on.
void	setSocketFactory(String sFactory)	Sets the fully qualified socket-factory class name used to create the server socket.
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

Field Details

sp

protected LocalSpace sp

Local space used for inbound/outbound queue routing when configured.

Constructor Details

QServer

public QServer()

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

setPort

public void setPort(int port)

Description copied from interface: QServerMBean

Sets the TCP port the server listens on.

Specified by:

setPort in interface QServerMBean

Parameters:

port - TCP port number

getPort

public int getPort()

Description copied from interface: QServerMBean

Returns the configured listen port.

Specified by:

getPort in interface QServerMBean

Returns:

TCP port number

setPackager

public void setPackager(String packager)

Description copied from interface: QServerMBean

Sets the fully qualified packager class name used by accepted channels.

Specified by:

setPackager in interface QServerMBean

Parameters:

packager - packager class name

getPackager

public String getPackager()

Description copied from interface: QServerMBean

Returns the configured packager class name.

Specified by:

getPackager in interface QServerMBean

Returns:

packager class name

setChannel

public void setChannel(String channel)

Description copied from interface: QServerMBean

Sets the fully qualified channel class name instantiated for each accepted connection.

Specified by:

setChannel in interface QServerMBean

Parameters:

channel - channel class name

getChannel

public String getChannel()

Description copied from interface: QServerMBean

Returns the configured channel class name.

Specified by:

getChannel in interface QServerMBean

Returns:

channel class name

setMaxSessions

public void setMaxSessions(int maxSessions)

Description copied from interface: QServerMBean

Sets the maximum number of concurrent client sessions accepted by the server.

Specified by:

setMaxSessions in interface QServerMBean

Parameters:

maxSessions - maximum sessions

getMaxSessions

public int getMaxSessions()

Description copied from interface: QServerMBean

Returns the configured maximum number of concurrent client sessions.

Specified by:

getMaxSessions in interface QServerMBean

Returns:

maximum sessions

setSocketFactory

public void setSocketFactory(String sFactory)

Description copied from interface: QServerMBean

Sets the fully qualified socket-factory class name used to create the server socket.

Specified by:

setSocketFactory in interface QServerMBean

Parameters:

sFactory - socket factory class name

getSocketFactory

public String getSocketFactory()

Description copied from interface: QServerMBean

Returns the configured socket-factory class name.

Specified by:

getSocketFactory in interface QServerMBean

Returns:

socket factory class name

getISOChannelNames

public String getISOChannelNames()

Description copied from interface: QServerMBean

Returns the names of all currently-active accepted channels, comma-separated.

Specified by:

getISOChannelNames in interface QServerMBean

Returns:

comma-separated active channel names

getISOServer

public ISOServer getISOServer()

Returns the underlying ISOServer created by this bean.

Returns:

the live server, or null if not yet started

getCountersAsString

public String getCountersAsString()

Description copied from interface: QServerMBean

Returns aggregated counters across all active channels.

Specified by:

getCountersAsString in interface QServerMBean

Returns:

counter snapshot suitable for diagnostics

getCountersAsString

public String getCountersAsString(String isoChannelName)

Description copied from interface: QServerMBean

Returns counters for a single named accepted channel.

Specified by:

getCountersAsString in interface QServerMBean

Parameters:

isoChannelName - accepted channel's name

Returns:

counter snapshot suitable for diagnostics, or empty if the channel is unknown

notify

public void notify(Object key,
 Object value)

Description copied from interface: SpaceListener

Called by Space implementation whenever an object with the given key is being placed in the Space.

Specified by:

notify in interface SpaceListener

Parameters:

key - Object's key

value - Object's value

process

public boolean process(ISOSource source,
 ISOMsg m)

Description copied from interface: ISORequestListener

Called when an unmatched request is received. Processes an unmatched ISO request.

Specified by:

process in interface ISORequestListener

Parameters:

source - source where you optionally can reply

m - the unmatched request

Returns:

true if request was handled by this listener