Class QXmlConfig

java.lang.Object

org.jpos.q2.QBeanSupport

org.jpos.q2.qbean.QXmlConfig

All Implemented Interfaces:

Configurable, XmlConfigurable, QBean, QBeanSupportMBean, QPersist

public class QXmlConfig
extends QBeanSupport
implements XmlConfigurable

QBean that registers its raw XML configuration element under NameRegistrar so other beans can look it up at runtime.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XML_PREFIX	Prefix used when registering the configuration element in NameRegistrar.

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

Method Summary

Modifier and Type	Method	Description
protected void	destroyService()	Called during the destroy lifecycle phase; subclasses may override.
static org.jdom2.Element	getConfiguration(String name)	Looks up the configuration element registered under name.
static org.jdom2.Element	getConfiguration(String name, long timeout)	Looks up the configuration element registered under name, waiting up to timeout.
void	setConfiguration(org.jdom2.Element e)	Configures this object from an XML element.

Methods inherited from class QBeanSupport

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

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.
protected String	defaultRealm()	Returns the default realm for this bean; subclasses may override.
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
protected void	initService()	Called during the init lifecycle phase; subclasses may override.
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
protected void	stopService()	Called during the stop lifecycle phase; subclasses may override.

Methods inherited from class Object

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

Field Details

XML_PREFIX

public static final String XML_PREFIX

Prefix used when registering the configuration element in NameRegistrar.

See Also:

• Constant Field Values

Constructor Details

QXmlConfig

public QXmlConfig()

Default constructor; no instance state to initialise.

Method Details

destroyService

protected void destroyService()

Description copied from class: QBeanSupport

Called during the destroy lifecycle phase; subclasses may override.

Overrides:

destroyService in class QBeanSupport

setConfiguration

public void setConfiguration(org.jdom2.Element e)

Description copied from interface: XmlConfigurable

Configures this object from an XML element.

Specified by:

setConfiguration in interface XmlConfigurable

Parameters:

e - Configuration element

getConfiguration

public static org.jdom2.Element getConfiguration(String name)
                                          throws NameRegistrar.NotFoundException

Looks up the configuration element registered under name.

Parameters:

name - configuration name (without the XML_PREFIX prefix)

Returns:

the registered configuration element

Throws:

NameRegistrar.NotFoundException - if no configuration is registered under that name

getConfiguration

public static org.jdom2.Element getConfiguration(String name,
 long timeout)

Looks up the configuration element registered under name, waiting up to timeout.

Parameters:

name - configuration name

timeout - in millis

Returns:

Configuration Element or null