com.github.wuic.context

Class ContextBuilderConfigurator

java.lang.Object

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

com.github.wuic.context.ContextBuilderConfigurator

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

HtmlParserFilter, XmlContextBuilderConfigurator

public abstract class ContextBuilderConfigurator
extends PollingScheduler<ContextBuilderConfigurator>

A configurator configures ContextBuilder. It's is called by a WUIC bootstrap in charge of Context creation using a ContextBuilder.

This class is abstract and should be extended to configure in a specific way the ContextBuilder.

Since:

0.4.0

Version:

1.1

Author:

Guillaume DROUET

Nested Class Summary

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

PollingScheduler.Polling

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ContextBuilderConfigurator() Builds a new instance.
protected	ContextBuilderConfigurator(Boolean multiple) Builds a configurator with a flag indicating to configure or not anything if a configuration with its tag has been done before.

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(ContextBuilder ctxBuilder) Configures the given context.
abstract ProcessContext	getProcessContext() Gets the process context associated to the tag while configuring.
abstract String	getTag() Gets the tag to use to identify the set of settings defined when configure(ContextBuilder) is called.
abstract int	internalConfigure(ContextBuilder ctxBuilder) Configures the given context internally.
void	run()
void	setMultipleConfigurations(Boolean flag) Sets the flag allowing or not multiple configurations.

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

ContextBuilderConfigurator

protected ContextBuilderConfigurator()

Builds a new instance.

ContextBuilderConfigurator

protected ContextBuilderConfigurator(Boolean multiple)

Builds a configurator with a flag indicating to configure or not anything if a configuration with its tag has been done before.

Parameters:

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

Method Detail

setMultipleConfigurations

public void setMultipleConfigurations(Boolean flag)

Sets the flag allowing or not multiple configurations.

Parameters:

flag - the new value

run

public void run()

configure

public void configure(ContextBuilder ctxBuilder)
               throws IOException

Configures the given context. It tags all the settings with the value returned by the getTag() method.

All settings associated to each configurator tag are cleared before (re)configuration.

Parameters:

ctxBuilder - the builder

Throws:

IOException - if I/O error occurs when start polling

internalConfigure

public abstract 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 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.

Parameters:

ctxBuilder - the builder

getTag

public abstract String getTag()

Gets the tag to use to identify the set of settings defined when configure(ContextBuilder) is called.

Returns:

the tag

getProcessContext

public abstract ProcessContext getProcessContext()

Gets the process context associated to the tag while configuring.

Returns:

the process context