com.github.wuic.xml

Class XmlContextBuilderConfigurator

java.lang.Object

com.github.wuic.util.PollingScheduler<ContextBuilderConfigurator>

com.github.wuic.context.ContextBuilderConfigurator

com.github.wuic.xml.XmlContextBuilderConfigurator

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

FileXmlContextBuilderConfigurator, ReaderXmlContextBuilderConfigurator

public abstract class XmlContextBuilderConfigurator
extends ContextBuilderConfigurator

This configurator implements XML supports for WUIC. It abstracts the way the XML is read and unmarshal with JAXB.

Since:

0.4.0

Version:

1.2

Author:

Guillaume DROUET

Nested Class Summary

Nested classes/interfaces inherited from class com.github.wuic.util.PollingScheduler

PollingScheduler.Polling

Constructor Summary

Constructors

Constructor and Description
XmlContextBuilderConfigurator(Boolean multiple, ProcessContext pc) Creates a new instance.
XmlContextBuilderConfigurator(ProcessContext processContext) Builds a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
static void	configureHeap(ContextBuilder ctxBuilder, XmlHeapBean heap) Configures the heap described in the given bean.
static void	configureTemplates(XmlWuicBean xml, ContextBuilder ctxBuilder) Configures the given builder with the template in the specified bean.
static void	configureWorkflow(XmlWuicBean xml, ContextBuilder ctxBuilder) Configures the given builder with the specified bean.
ProcessContext	getProcessContext() Gets the process context associated to the tag while configuring.
int	internalConfigure(ContextBuilder ctxBuilder) Configures the given context internally.
protected abstract XmlWuicBean	unmarshal(Unmarshaller unmarshaller) Unmashal the XmlWuicBean with the given unmarhalled.

Methods inherited from class com.github.wuic.context.ContextBuilderConfigurator

configure, getTag, run, setMultipleConfigurations

Methods inherited from class com.github.wuic.util.PollingScheduler

getLastUpdateTimestampFor, getNutObservers, getPollingInterval, observe, setPollingInterval

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlContextBuilderConfigurator

public XmlContextBuilderConfigurator(ProcessContext processContext)
                              throws JAXBException

Builds a new instance.

Parameters:

processContext - the process context

Throws:

JAXBException - if an context can't be initialized

XmlContextBuilderConfigurator

public XmlContextBuilderConfigurator(Boolean multiple,
                             ProcessContext pc)
                              throws JAXBException

Creates a new instance.

Parameters:

pc - the process context

multiple - true if multiple configurations with the same tag could be executed, false otherwise

Throws:

JAXBException - if an context can't be initialized

Method Detail

configureHeap

public static void configureHeap(ContextBuilder ctxBuilder,
                 XmlHeapBean heap)
                          throws IOException

Configures the heap described in the given bean.

Parameters:

ctxBuilder - the builder to configure

heap - the configuration bean

Throws:

IOException - if any I/O error occurs

configureTemplates

public static void configureTemplates(XmlWuicBean xml,
                      ContextBuilder ctxBuilder)
                               throws WorkflowTemplateNotFoundException,
                                      IOException

Configures the given builder with the template in the specified bean.

An IllegalArgumentException is thrown if the workflow is badly defined.

Parameters:

xml - the bean

ctxBuilder - the builder

Throws:

WorkflowTemplateNotFoundException - if a workflow-template-id reference a non existing template

IOException - if any I/O error occurs

configureWorkflow

public static void configureWorkflow(XmlWuicBean xml,
                     ContextBuilder ctxBuilder)
                              throws WorkflowTemplateNotFoundException,
                                     IOException

Configures the given builder with the specified bean.

An IllegalArgumentException is thrown if the workflow is badly defined.

Parameters:

xml - the bean

ctxBuilder - the builder

Throws:

WorkflowTemplateNotFoundException - if a workflow-template-id reference a non existing template

IOException - if any I/O error occurs

getProcessContext

public ProcessContext getProcessContext()

Gets the process context associated to the tag while configuring.

Specified by:

getProcessContext in class ContextBuilderConfigurator

Returns:

the process context

internalConfigure

public int internalConfigure(ContextBuilder ctxBuilder)

Configures the given context internally. This method is called just after the ContextBuilder has been tagged with the value returned by ContextBuilderConfigurator.getTag() method. Once the execution of this method is terminated, the tag is released.

To activate polling on this configurator, this method should returns a positive integer representing the polling interval in seconds.

Specified by:

internalConfigure in class ContextBuilderConfigurator

Parameters:

ctxBuilder - the builder

unmarshal

protected abstract XmlWuicBean unmarshal(Unmarshaller unmarshaller)
                                  throws JAXBException

Unmashal the XmlWuicBean with the given unmarhalled.

Parameters:

unmarshaller - the unmarshaller

Returns:

the unmarshalled bean

Throws:

JAXBException - if the XML can't be read