Package org.eclipse.jetty.xml

Class XmlConfiguration.JettyXmlConfiguration

java.lang.Object

org.eclipse.jetty.xml.XmlConfiguration.JettyXmlConfiguration

All Implemented Interfaces:

ConfigurationProcessor

Enclosing class:

XmlConfiguration

private static class XmlConfiguration.JettyXmlConfiguration
extends Object
implements ConfigurationProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	XmlConfiguration.JettyXmlConfiguration.Args
private class	XmlConfiguration.JettyXmlConfiguration.AttrOrElementNode

Field Summary

Fields

Modifier and Type	Field	Description
(package private) XmlConfiguration	_configuration
(package private) XmlParser.Node	_root

Constructor Summary

Constructors

Modifier	Constructor	Description
private	JettyXmlConfiguration()

Method Summary

Modifier and Type	Method	Description
private void	appendDefaultPropertyValues(StringBuilder defValues, XmlParser.Node node)
private Object	call(Class<?> oClass, String methodName, Object obj, XmlConfiguration.JettyXmlConfiguration.Args args)
private Object	call(Object obj, XmlParser.Node node)	Calls a method.
Object	configure()
Object	configure(Object obj)
void	configure(Object obj, XmlParser.Node cfg, int i)	Recursive configuration routine.
private Object	construct(Class<?> klass, XmlConfiguration.JettyXmlConfiguration.Args args)
private static ArrayList<Object>	convertArrayToArrayList(Object array)
private static Collection<?>	convertArrayToCollection(Object array, Class<?> collectionType)
private String	defaultValue(Object obj, XmlParser.Node node)	Check children for all <Property> and <SystemProperty> and return the String representation of any declared default="value" attributes.
private Object	envObj(XmlParser.Node node)	Returns the value of an environment property.
private Object	get(Object obj, XmlParser.Node node)	Calls a getter method.
private Object	getField(Field field, Object object)
void	init(URL url, XmlParser.Node root, XmlConfiguration configuration)
void	init(Resource resource, XmlParser.Node root, XmlConfiguration configuration)	Initialize a ConfigurationProcessor from provided Resource and XML
private Object	invokeConstructor(Constructor<?> constructor, Object... args)
private Object	invokeMethod(Method method, Object obj, Object[] args)
private Object	invokeMethod(Method method, Object obj, Object[] args, boolean isUsingDefaultValue)
private static boolean	isTypeMatchingClass(String type, Class<?> classToMatch)
private Object	itemValue(Object obj, Object item)	Returns recursively the value of an element.
private Object	newArray(Object obj, XmlParser.Node node)	Creates a new array object.
private Object	newMap(Object obj, XmlParser.Node node)	Creates a new map object.
private Object	newObj(Object obj, XmlParser.Node node)	Creates a new value object.
private static Class<?>	nodeClass(XmlParser.Node node)
private Object	propertyObj(XmlParser.Node node)	Returns the value of a property.
private void	put(Object obj, XmlParser.Node node)	Calls a put method.
private Object	refObj(XmlParser.Node node)	Returns a reference object mapped to an id.
private void	set(Object obj, XmlParser.Node node)	Call a setter method.
private void	setField(Field field, Object obj, Object arg, boolean isUsingDefaultValue)
private Object	systemPropertyObj(XmlParser.Node node)	Returns the value of a system property.
private Object	value(Object obj, XmlParser.Node node)	Returns the scalar value of an element

Methods inherited from class java.lang.Object

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

Field Details

_root

XmlParser.Node _root

_configuration

XmlConfiguration _configuration

Constructor Details

JettyXmlConfiguration

private JettyXmlConfiguration()

Method Details

init

public void init(URL url,
 XmlParser.Node root,
 XmlConfiguration configuration)

Specified by:

init in interface ConfigurationProcessor

init

public void init(Resource resource,
 XmlParser.Node root,
 XmlConfiguration configuration)

Description copied from interface: ConfigurationProcessor

Initialize a ConfigurationProcessor from provided Resource and XML

Specified by:

init in interface ConfigurationProcessor

Parameters:

resource - the resource being read

root - the parsed XML root node for the resource

configuration - the configuration being used (typically for ref IDs)

configure

public Object configure(Object obj)
                 throws Exception

Specified by:

configure in interface ConfigurationProcessor

Throws:

Exception

configure

public Object configure()
                 throws Exception

Specified by:

configure in interface ConfigurationProcessor

Throws:

Exception

nodeClass

private static Class<?> nodeClass(XmlParser.Node node)
                           throws ClassNotFoundException

Throws:

ClassNotFoundException

configure

public void configure(Object obj,
 XmlParser.Node cfg,
 int i)
               throws Exception

Recursive configuration routine. This method applies the nested Set, Put, Call, etc. elements to the given object.

Parameters:

obj - the object to configure

cfg - the XML nodes of the configuration

i - the index of the XML nodes

Throws:

Exception - if the configuration fails

set

private void set(Object obj,
 XmlParser.Node node)
          throws Exception

Call a setter method.

This method makes a best effort to find a matching set method. The type of the value is used to find a suitable set method by:

1. Trying for a trivial type match
2. Looking for a native type match
3. Trying all correctly named methods for an auto conversion
4. Attempting to construct a suitable value from original value

Parameters:

obj - the enclosing object

node - the <Set> XML node

Throws:

Exception

invokeConstructor

private Object invokeConstructor(Constructor<?> constructor,
 Object... args)
                          throws IllegalAccessException,
InvocationTargetException,
InstantiationException

Throws:

IllegalAccessException

InvocationTargetException

InstantiationException

invokeMethod

private Object invokeMethod(Method method,
 Object obj,
 Object[] args)
                     throws IllegalAccessException,
InvocationTargetException

Throws:

IllegalAccessException

InvocationTargetException

invokeMethod

private Object invokeMethod(Method method,
 Object obj,
 Object[] args,
 boolean isUsingDefaultValue)
                     throws IllegalAccessException,
InvocationTargetException

Throws:

IllegalAccessException

InvocationTargetException

getField

private Object getField(Field field,
 Object object)
                 throws IllegalAccessException

Throws:

IllegalAccessException

setField

private void setField(Field field,
 Object obj,
 Object arg,
 boolean isUsingDefaultValue)
               throws IllegalAccessException

Throws:

IllegalAccessException

convertArrayToCollection

private static Collection<?> convertArrayToCollection(Object array,
 Class<?> collectionType)

Parameters:

array - the array to convert

collectionType - the desired collection type

Returns:

a collection of the desired type if the array can be converted

convertArrayToArrayList

private static ArrayList<Object> convertArrayToArrayList(Object array)

put

private void put(Object obj,
 XmlParser.Node node)
          throws Exception

Calls a put method.

Parameters:

obj - the enclosing map object

node - the <Put> XML node

Throws:

Exception

get

private Object get(Object obj,
 XmlParser.Node node)
            throws Exception

Calls a getter method.

Any object returned from the call is passed to the configure method to consume the remaining elements.

If the "class" attribute is present and its value is "class", then the class instance itself is returned.

Parameters:

obj - the enclosing object

node - the <Get> XML node

Returns:

the result of the getter invocation

Throws:

Exception

call

private Object call(Object obj,
 XmlParser.Node node)
             throws Exception

Calls a method.

A method is selected by trying all methods with matching names and number of arguments. Any object returned from the call is passed to the configure method to consume the remaining elements. Note that if this is a static call we consider only methods declared directly in the given class, i.e. we ignore any static methods in superclasses.

Parameters:

obj - the enclosing object

node - the <Call> XML node

Returns:

the result of the method invocation

Throws:

Exception

call

private Object call(Class<?> oClass,
 String methodName,
 Object obj,
 XmlConfiguration.JettyXmlConfiguration.Args args)
             throws InvocationTargetException,
NoSuchMethodException

Throws:

InvocationTargetException

NoSuchMethodException

newObj

private Object newObj(Object obj,
 XmlParser.Node node)
               throws Exception

Creates a new value object.

Parameters:

obj - the enclosing object

node - the <New> XML node

Returns:

the result of the constructor invocation

Throws:

Exception

construct

private Object construct(Class<?> klass,
 XmlConfiguration.JettyXmlConfiguration.Args args)
                  throws InvocationTargetException,
NoSuchMethodException

Throws:

InvocationTargetException

NoSuchMethodException

refObj

private Object refObj(XmlParser.Node node)
               throws Exception

Returns a reference object mapped to an id.

Parameters:

node - the <Ref> XML node

Returns:

the result of the reference invocation

Throws:

Exception

newArray

private Object newArray(Object obj,
 XmlParser.Node node)
                 throws Exception

Creates a new array object.

Parameters:

obj - the enclosing object

node - the <Array> XML node

Returns:

the newly created array

Throws:

Exception

newMap

private Object newMap(Object obj,
 XmlParser.Node node)
               throws Exception

Creates a new map object.

Parameters:

obj - the enclosing object

node - the <Map> XML node

Returns:

the newly created map

Throws:

Exception

propertyObj

private Object propertyObj(XmlParser.Node node)
                    throws Exception

Returns the value of a property.

Parameters:

node - the <Property> XML node

Returns:

the property value

Throws:

Exception

systemPropertyObj

private Object systemPropertyObj(XmlParser.Node node)
                          throws Exception

Returns the value of a system property.

Parameters:

node - the <SystemProperty> XML node

Returns:

the property value

Throws:

Exception

envObj

private Object envObj(XmlParser.Node node)
               throws Exception

Returns the value of an environment property.

Parameters:

node - the <Env> XML node

Returns:

the environment property value

Throws:

Exception

defaultValue

private String defaultValue(Object obj,
 XmlParser.Node node)
                     throws Exception

Check children for all <Property> and <SystemProperty> and return the String representation of any declared default="value" attributes.

Parameters:

obj - the enclosing obj

node - the XML node

Returns:

a String representing all <Property default="..."> and <SystemProperty default="..."> values appended together

Throws:

Exception

appendDefaultPropertyValues

private void appendDefaultPropertyValues(StringBuilder defValues,
 XmlParser.Node node)
                                  throws Exception

Throws:

Exception

value

private Object value(Object obj,
 XmlParser.Node node)
              throws Exception

Returns the scalar value of an element

.

If no value type is specified, then white space is trimmed out of the value. If it contains multiple value elements they are added as strings before being converted to any specified type.

Parameters:

obj - the enclosing object

node - the XML node

Returns:

the value of the XML node

Throws:

Exception

isTypeMatchingClass

private static boolean isTypeMatchingClass(String type,
 Class<?> classToMatch)

itemValue

private Object itemValue(Object obj,
 Object item)
                  throws Exception

Returns recursively the value of an element.

Parameters:

obj - the enclosing object

item - the initial element value

Returns:

the recursive value of the element

Throws:

Exception