Class QFactory

java.lang.Object

org.jpos.q2.QFactory

public class QFactory
extends Object

Factory responsible for creating, configuring, and deploying QBean instances from XML deploy descriptors.

Constructor Summary

Constructors

Constructor	Description
QFactory(ObjectName loaderName, Q2 q2)	Constructs a QFactory with the given class loader object name and Q2 instance.

Method Summary

Modifier and Type	Method	Description
static void	autoconfigure(Object obj, Configuration cfg)	Automatically configures fields annotated with Config on the given object.
void	configureQBean(MBeanServer server, ObjectName objectName, org.jdom2.Element e)	Configures a QBean by applying attributes from the given XML element.
ObjectInstance	createQBean(Q2 server, org.jdom2.Element e, Object obj)	Registers and initializes a QBean MBean in the MBeanServer.
protected String	defaultRealm(String elementName)	Returns the default realm name for the given XML element name.
void	destroyQBean(Q2 server, ObjectName objectName, Object obj)	Stops, destroys, and unregisters the given QBean MBean.
static ExecutorService	executorService(boolean virtual)	Creates an ExecutorService using either virtual or platform threads.
static org.jdom2.Element	expandEnvProperties(org.jdom2.Element e)	Decorates an Element by replacing its attributes, and content Environment properties references.
AttributeList	getAttributeList(org.jdom2.Element e)	Builds a JMX AttributeList from attr child elements of the given element.
String	getAttributeName(String name)	Capitalizes the first letter of an attribute name to produce a setter/getter name.
static String	getAttributeValue(org.jdom2.Element e, String name)	Returns the value of the named attribute from the element, with environment variable substitution.
protected Collection	getCollection(Class type, org.jdom2.Element e)	Creates a collection from a definition element with the format.
Configuration	getConfiguration(org.jdom2.Element e)	Returns a Configuration built from the given XML element, with optional merge.
static String	getEagerStartAttribute(org.jdom2.Element e)	Returns the value of the eager-start attribute, defaulting to "false".
static String	getEnabledAttribute(org.jdom2.Element e)	Returns the value of the enabled attribute, defaulting to "true".
protected Object	getObject(org.jdom2.Element childElement)	Creates an object from a definition element.
Q2	getQ2()	Returns the Q2 server instance associated with this factory.
Object	instantiate(Q2 server, org.jdom2.Element e)	Instantiates the MBean class described by the given XML element.
static void	invoke(Object obj, String m, Object p)	Try to invoke a method (usually a setter) on the given object silently ignoring if method does not exist
static void	invoke(Object obj, String m, Object p, Class pc)	Try to invoke a method (usually a setter) on the given object silently ignoring if method does not exist
static boolean	isEagerStart(org.jdom2.Element e)	Returns true if the element's eager-start attribute evaluates to true.
static boolean	isEnabled(org.jdom2.Element e)	Returns true if the element's enabled attribute evaluates to true.
<T> T	newInstance(Class<T> clazz)	Instantiates the given class via the Q2 MBeanServer.
<T> T	newInstance(String clazz)	Instantiates the class with the given name via the Q2 MBeanServer.
<T> T	newInstance(org.jdom2.Element e)	Creates a new instance from the values in Element e.
void	setAttribute(MBeanServer server, ObjectName objectName, String attribute, Object value)	Sets an attribute on the given MBean, silently ignoring unknown attributes.
void	setConfiguration(Object obj, org.jdom2.Element e)	Applies configuration from the XML element to the given object.
void	setLogger(Object obj, org.jdom2.Element e)	Sets the logger and realm on the object if it implements LogSource.
void	setLogger(Object obj, org.jdom2.Element e, String fallbackRealm)	Sets the logger and realm on the object if it implements LogSource, with a fallback realm.
void	startQBean(Q2 server, ObjectName objectName)	Invokes the start method on the given QBean MBean.

Methods inherited from class Object

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

Constructor Details

QFactory

public QFactory(ObjectName loaderName,
 Q2 q2)

Constructs a QFactory with the given class loader object name and Q2 instance.

Parameters:

loaderName - the ObjectName of the QClassLoader MBean

q2 - the Q2 server instance

Method Details

instantiate

public Object instantiate(Q2 server,
 org.jdom2.Element e)
                   throws ReflectionException,
MBeanException,
InstanceNotFoundException

Instantiates the MBean class described by the given XML element.

Parameters:

server - the Q2 server instance

e - the XML element defining the class to instantiate

Returns:

the newly instantiated object

Throws:

ReflectionException - if the class cannot be instantiated via reflection

MBeanException - if the MBeanServer reports an error

InstanceNotFoundException - if the class loader MBean is not found

createQBean

public ObjectInstance createQBean(Q2 server,
 org.jdom2.Element e,
 Object obj)
                           throws MalformedObjectNameException,
InstanceAlreadyExistsException,
InstanceNotFoundException,
MBeanException,
NotCompliantMBeanException,
InvalidAttributeValueException,
ReflectionException,
ConfigurationException

Registers and initializes a QBean MBean in the MBeanServer.

Parameters:

server - the Q2 server instance

e - the XML element defining the QBean

obj - the instantiated QBean object

Returns:

the registered ObjectInstance

Throws:

MalformedObjectNameException - if the object name is malformed

InstanceAlreadyExistsException - if a bean with this name is already deployed

InstanceNotFoundException - if the class loader MBean is not found

MBeanException - if the MBeanServer reports an error

NotCompliantMBeanException - if the object is not a valid MBean

InvalidAttributeValueException - if an attribute value is invalid

ReflectionException - if a reflective operation fails

ConfigurationException - if configuration fails

getQ2

public Q2 getQ2()

Returns the Q2 server instance associated with this factory.

Returns:

the Q2 server instance

setAttribute

public void setAttribute(MBeanServer server,
 ObjectName objectName,
 String attribute,
 Object value)
                  throws InstanceNotFoundException,
MBeanException,
InvalidAttributeValueException,
ReflectionException

Sets an attribute on the given MBean, silently ignoring unknown attributes.

Parameters:

server - the MBeanServer

objectName - the ObjectName of the MBean

attribute - the attribute name

value - the attribute value

Throws:

InstanceNotFoundException - if the MBean is not found

MBeanException - if the MBeanServer reports an error

InvalidAttributeValueException - if the value is invalid

ReflectionException - if a reflective operation fails

startQBean

public void startQBean(Q2 server,
 ObjectName objectName)
                throws InstanceNotFoundException,
MBeanException,
ReflectionException

Invokes the start method on the given QBean MBean.

Parameters:

server - the Q2 server instance

objectName - the ObjectName of the QBean MBean

Throws:

InstanceNotFoundException - if the MBean is not found

MBeanException - if the MBeanServer reports an error

ReflectionException - if a reflective operation fails

destroyQBean

public void destroyQBean(Q2 server,
 ObjectName objectName,
 Object obj)
                  throws InstanceNotFoundException,
MBeanException,
ReflectionException

Stops, destroys, and unregisters the given QBean MBean.

Parameters:

server - the Q2 server instance

objectName - the ObjectName of the QBean MBean

obj - the underlying QBean object

Throws:

InstanceNotFoundException - if the MBean is not found

MBeanException - if the MBeanServer reports an error

ReflectionException - if a reflective operation fails

configureQBean

public void configureQBean(MBeanServer server,
 ObjectName objectName,
 org.jdom2.Element e)
                    throws ConfigurationException

Configures a QBean by applying attributes from the given XML element.

Parameters:

server - the MBeanServer

objectName - the ObjectName of the QBean

e - the XML element containing attr child elements

Throws:

ConfigurationException - if attribute setting fails

getAttributeList

public AttributeList getAttributeList(org.jdom2.Element e)
                               throws ConfigurationException

Builds a JMX AttributeList from attr child elements of the given element.

Parameters:

e - the XML element containing attr child elements

Returns:

list of JMX Attribute objects

Throws:

ConfigurationException - if attribute conversion fails

getObject

protected Object getObject(org.jdom2.Element childElement)
                    throws ConfigurationException

Creates an object from a definition element. The element may have an attribute called type indicating the type of the object to create, if this attribute is not present java.lang.String is assumed. int, long and boolean are converted to their wrappers.

Parameters:

childElement - Dom Element with the definition of the object.

Returns:

The created object.

Throws:

ConfigurationException - If an exception is found trying to create the object.

getCollection

protected Collection getCollection(Class type,
 org.jdom2.Element e)
                            throws ConfigurationException

Creates a collection from a definition element with the format.

    <attr type="...">
        <item type="...">...</item>
        ...
    </attr>
 

Parameters:

type - class type

e - the Element

Returns:

the object collection

Throws:

ConfigurationException - if configuration is invalid

getAttributeName

public String getAttributeName(String name)

Capitalizes the first letter of an attribute name to produce a setter/getter name.

Parameters:

name - the raw attribute name

Returns:

the capitalized attribute name

newInstance

public <T> T newInstance(String clazz)
                  throws ConfigurationException

Instantiates the class with the given name via the Q2 MBeanServer.

Type Parameters:

T - the expected return type

Parameters:

clazz - the fully-qualified class name to instantiate

Returns:

the newly instantiated object

Throws:

ConfigurationException - if instantiation fails

newInstance

public <T> T newInstance(Class<T> clazz)
                  throws ConfigurationException

Instantiates the given class via the Q2 MBeanServer.

Type Parameters:

T - the expected return type

Parameters:

clazz - the Class to instantiate

Returns:

the newly instantiated object

Throws:

ConfigurationException - if instantiation fails

newInstance

public <T> T newInstance(org.jdom2.Element e)
                  throws ConfigurationException

Creates a new instance from the values in Element e.

The method honors the enabled attribute in the given Element e, returning null immediately if enabled is computed to a true-equivalent.

It also calls setLogger(Object, Element) to set logger and realm, and setConfiguration(Object, Element) to trigger the standard [auto]configuration sequence from properties and XML.

Type Parameters:

T - expected concrete type returned to the caller

Parameters:

e - The XML config

Returns:

the new instance, or null if not enabled

Throws:

ConfigurationException - if the instance can't be created (e.g. class not found) or the configuration process itself threw the exception.

getConfiguration

public Configuration getConfiguration(org.jdom2.Element e)
                               throws ConfigurationException

Returns a Configuration built from the given XML element, with optional merge.

Parameters:

e - the XML element to build the configuration from

Returns:

the resulting Configuration

Throws:

ConfigurationException - if configuration building or merging fails

setLogger

public void setLogger(Object obj,
 org.jdom2.Element e)

Sets the logger and realm on the object if it implements LogSource.

Parameters:

obj - the object to configure

e - the XML element containing logger/realm attributes

setLogger

public void setLogger(Object obj,
 org.jdom2.Element e,
 String fallbackRealm)

Sets the logger and realm on the object if it implements LogSource, with a fallback realm.

Parameters:

obj - the object to configure

e - the XML element containing logger/realm attributes

fallbackRealm - realm to use when none is specified in the element

defaultRealm

protected String defaultRealm(String elementName)

Returns the default realm name for the given XML element name.

Parameters:

elementName - the XML element name (e.g. "channel", "server")

Returns:

the corresponding default realm string

getAttributeValue

public static String getAttributeValue(org.jdom2.Element e,
 String name)

Returns the value of the named attribute from the element, with environment variable substitution.

Parameters:

e - the XML element

name - the attribute name

Returns:

the resolved attribute value, or null if not present

setConfiguration

public void setConfiguration(Object obj,
 org.jdom2.Element e)
                      throws ConfigurationException

Applies configuration from the XML element to the given object.

Parameters:

obj - the object to configure

e - the XML element containing configuration attributes

Throws:

ConfigurationException - if configuration fails

invoke

public static void invoke(Object obj,
 String m,
 Object p)
                   throws ConfigurationException

Try to invoke a method (usually a setter) on the given object silently ignoring if method does not exist

Parameters:

obj - the object

m - method to invoke

p - parameter

Throws:

ConfigurationException - if method happens to throw an exception

invoke

public static void invoke(Object obj,
 String m,
 Object p,
 Class pc)
                   throws ConfigurationException

Try to invoke a method (usually a setter) on the given object silently ignoring if method does not exist

Parameters:

obj - the object

m - method to invoke

p - parameter

pc - parameter class

Throws:

ConfigurationException - if method happens to throw an exception

isEnabled

public static boolean isEnabled(org.jdom2.Element e)

Returns true if the element's enabled attribute evaluates to true.

Parameters:

e - the XML element

Returns:

true if enabled

isEagerStart

public static boolean isEagerStart(org.jdom2.Element e)

Returns true if the element's eager-start attribute evaluates to true.

Parameters:

e - the XML element

Returns:

true if eager start is requested

getEnabledAttribute

public static String getEnabledAttribute(org.jdom2.Element e)

Returns the value of the enabled attribute, defaulting to "true".

Parameters:

e - the XML element

Returns:

the enabled attribute value

getEagerStartAttribute

public static String getEagerStartAttribute(org.jdom2.Element e)

Returns the value of the eager-start attribute, defaulting to "false".

Parameters:

e - the XML element

Returns:

the eager-start attribute value

autoconfigure

public static void autoconfigure(Object obj,
 Configuration cfg)
                          throws IllegalAccessException

Automatically configures fields annotated with Config on the given object.

Parameters:

obj - the object to autoconfigure

cfg - the Configuration to read values from

Throws:

IllegalAccessException - if field access fails

expandEnvProperties

public static org.jdom2.Element expandEnvProperties(org.jdom2.Element e)

Decorates an Element by replacing its attributes, and content Environment properties references.

Parameters:

e - The element being decorated.

Returns:

The modified element, it is modified in place, but it is returned to ease method chaining or call composition.

executorService

public static ExecutorService executorService(boolean virtual)

Creates an ExecutorService using either virtual or platform threads.

Parameters:

virtual - true to use virtual threads, false for platform threads

Returns:

a new ExecutorService