com.github.wuic

Class WuicFacadeBuilder.ContextBuilderFacade

java.lang.Object

java.util.Observable

com.github.wuic.context.ContextBuilder

com.github.wuic.WuicFacadeBuilder.ContextBuilderFacade

Enclosing class:

WuicFacadeBuilder

public final class WuicFacadeBuilder.ContextBuilderFacade
extends ContextBuilder

This class gives a chance to directly define settings for the final ContextBuilder of the built WuicFacade.

Since:

0.5.1

Version:

1.0

Author:

Guillaume DROUET

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	WuicFacadeBuilder.ContextBuilderFacade.ContextEngineBuilderFacade Exposes WuicFacadeBuilder.ContextBuilderFacade when WuicFacadeBuilder.ContextBuilderFacade.ContextEngineBuilderFacade.toContext() is called.
class	WuicFacadeBuilder.ContextBuilderFacade.ContextNutDaoBuilderFacade Exposes WuicFacadeBuilder.ContextBuilderFacade when WuicFacadeBuilder.ContextBuilderFacade.ContextNutDaoBuilderFacade.toContext() is called.
class	WuicFacadeBuilder.ContextBuilderFacade.ContextNutFilterBuilderFacade Exposes WuicFacadeBuilder.ContextBuilderFacade when WuicFacadeBuilder.ContextBuilderFacade.ContextNutFilterBuilderFacade.toContext() is called.

Nested classes/interfaces inherited from class com.github.wuic.context.ContextBuilder

ContextBuilder.ContextEngineBuilder, ContextBuilder.ContextGenericBuilder, ContextBuilder.ContextNutDaoBuilder, ContextBuilder.ContextNutFilterBuilder

Constructor Summary

Constructors

Constructor and Description
WuicFacadeBuilder.ContextBuilderFacade()

Method Summary

Methods

Modifier and Type	Method and Description
WuicFacadeBuilder.ContextBuilderFacade	clearTag(Object tag) Clears all configurations associated to the given tag.
WuicFacadeBuilder.ContextBuilderFacade	configureDefault() Configures for each type provided by the engine builder factory and nut dao builder factory a default instance identified with an id starting by ContextBuilder.BUILDER_ID_PREFIX and followed by the type name itself.
WuicFacadeBuilder.ContextBuilderFacade.ContextEngineBuilderFacade	contextEngineBuilder(Class<?> type) Returns a new context default engine builder.
WuicFacadeBuilder.ContextBuilderFacade.ContextEngineBuilderFacade	contextEngineBuilder(String id, String type) Returns a new context engine builder.
WuicFacadeBuilder.ContextBuilderFacade.ContextNutDaoBuilderFacade	contextNutDaoBuilder(Class<?> type) Returns a new default context DAO builder.
WuicFacadeBuilder.ContextBuilderFacade.ContextNutDaoBuilderFacade	contextNutDaoBuilder(String id, String type) Returns a new context DAO builder.
WuicFacadeBuilder.ContextBuilderFacade.ContextNutFilterBuilderFacade	contextNutFilterBuilder(String id, String type) Returns a new context filter builder.
WuicFacadeBuilder.ContextBuilderFacade	heap(boolean disposable, String id, String ndbId, String[] heapIds, String[] path, HeapListener... listeners) Defines a new heap in this context.
WuicFacadeBuilder.ContextBuilderFacade	heap(String id, String ndbId, String[] path, HeapListener... listeners) Creates a new heap as specified by ContextBuilder.heap(boolean, String, String, String[], String[], HeapListener...)
WuicFacadeBuilder.ContextBuilderFacade	interceptor(ContextInterceptor interceptor) Adds a ContextInterceptor to the builder.
WuicFacadeBuilder.ContextBuilderFacade	mergeSettings(ContextBuilder other) Merges all the settings of the given ContextBuilder to the current setting of this object.
WuicFacadeBuilder.ContextBuilderFacade	processContext(ProcessContext processContext) Sets the process context for the setting associated to the current tag.
WuicFacadeBuilder.ContextBuilderFacade	releaseTag() Releases the current tag of this context.
WuicFacadeBuilder.ContextBuilderFacade	tag(Object tag) Decorates the current builder with a new builder associated to a specified tag.
WuicFacadeBuilder.ContextBuilderFacade	template(String id, String[] ebIds, String... daos) Builds a new template with no exclusion and default engine usages.
WuicFacadeBuilder.ContextBuilderFacade	template(String id, String[] ebIds, String[] ebIdsExclusion, Boolean includeDefaultEngines, String... ndbIds) Creates a new workflow template.
WuicFacadeBuilder	toFacade() Backs to the facade builder API.
WuicFacadeBuilder.ContextBuilderFacade	workflow(String identifier, Boolean forEachHeap, String heapIdPattern, String workflowTemplateId) Creates a new workflow.

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

build, cloneContextNutDaoBuilder, contextEngineBuilder, contextNutDaoBuilder, contextNutFilterBuilder, disposableHeap, engineBuilder, getDefaultBuilderId, getDefaultBuilderId, getDefaultBuilderId, getFilters, newNutDaoBuilder, nutFilter

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

WuicFacadeBuilder.ContextBuilderFacade

public WuicFacadeBuilder.ContextBuilderFacade()

Method Detail

toFacade

public WuicFacadeBuilder toFacade()

Backs to the facade builder API.

Returns:

the enclosing class

configureDefault

public WuicFacadeBuilder.ContextBuilderFacade configureDefault()
                                                        throws IOException

Configures for each type provided by the engine builder factory and nut dao builder factory a default instance identified with an id starting by ContextBuilder.BUILDER_ID_PREFIX and followed by the type name itself.

Overrides:

configureDefault in class ContextBuilder

Returns:

the current builder

Throws:

IOException - if configuration fails

tag

public WuicFacadeBuilder.ContextBuilderFacade tag(Object tag)

Decorates the current builder with a new builder associated to a specified tag. Tagging the context allows to isolate a set of configurations that could be erased by calling ContextBuilder.clearTag(Object). This way, this feature is convenient when you need to poll the configurations to reload it.

All configurations will be associated to the tag until the ContextBuilder.releaseTag() method is called. If tag is currently set, then it is released when this method is called with a new tag.

Overrides:

tag in class ContextBuilder

Parameters:

tag - an arbitrary object which represents the current tag

Returns:

the current builder which will associates all configurations to the tag

See Also:

ContextBuilder.clearTag(Object), ContextBuilder.releaseTag()

clearTag

public WuicFacadeBuilder.ContextBuilderFacade clearTag(Object tag)

Clears all configurations associated to the given tag.

Overrides:

clearTag in class ContextBuilder

Parameters:

tag - the tag

Returns:

this ContextBuilder

releaseTag

public WuicFacadeBuilder.ContextBuilderFacade releaseTag()

Releases the current tag of this context. When the configurations associated to a tag are finished, it could be released by calling this method to not tag next configurations.

Overrides:

releaseTag in class ContextBuilder

Returns:

this current builder without tag

processContext

public WuicFacadeBuilder.ContextBuilderFacade processContext(ProcessContext processContext)

Sets the process context for the setting associated to the current tag.

Overrides:

processContext in class ContextBuilder

Parameters:

processContext - the ProcessContext

Returns:

this builder

contextNutDaoBuilder

public WuicFacadeBuilder.ContextBuilderFacade.ContextNutDaoBuilderFacade contextNutDaoBuilder(String id,
                                                                                     String type)

Returns a new context DAO builder.

Overrides:

contextNutDaoBuilder in class ContextBuilder

Parameters:

id - the final builder's ID, default ID if null

type - the final builder's type

Returns:

the specific context builder

contextNutDaoBuilder

public WuicFacadeBuilder.ContextBuilderFacade.ContextNutDaoBuilderFacade contextNutDaoBuilder(Class<?> type)

Returns a new default context DAO builder.

Overrides:

contextNutDaoBuilder in class ContextBuilder

Parameters:

type - the component to build

Returns:

the specific context builder

contextNutFilterBuilder

public WuicFacadeBuilder.ContextBuilderFacade.ContextNutFilterBuilderFacade contextNutFilterBuilder(String id,
                                                                                           String type)

Returns a new context filter builder.

Overrides:

contextNutFilterBuilder in class ContextBuilder

Parameters:

id - the final builder's ID

type - the final builder's type

Returns:

the specific context builder

contextEngineBuilder

public WuicFacadeBuilder.ContextBuilderFacade.ContextEngineBuilderFacade contextEngineBuilder(String id,
                                                                                     String type)

Returns a new context engine builder.

Overrides:

contextEngineBuilder in class ContextBuilder

Parameters:

id - the final builder's ID

type - the final builder's type

Returns:

the specific context builder

contextEngineBuilder

public WuicFacadeBuilder.ContextBuilderFacade.ContextEngineBuilderFacade contextEngineBuilder(Class<?> type)

Returns a new context default engine builder.

Overrides:

contextEngineBuilder in class ContextBuilder

Parameters:

type - the component to build

Returns:

the specific context builder

interceptor

public WuicFacadeBuilder.ContextBuilderFacade interceptor(ContextInterceptor interceptor)

Adds a ContextInterceptor to the builder.

Overrides:

interceptor in class ContextBuilder

Parameters:

interceptor - the interceptor

Returns:

this ContextBuilder

heap

public WuicFacadeBuilder.ContextBuilderFacade heap(String id,
                                          String ndbId,
                                          String[] path,
                                          HeapListener... listeners)
                                            throws IOException

Creates a new heap as specified by ContextBuilder.heap(boolean, String, String, String[], String[], HeapListener...) without any composition and which is not disposable.

Overrides:

heap in class ContextBuilder

Parameters:

id - the heap ID

ndbId - the NutDao builder the heap is based on

path - the path

listeners - some listeners for this heap

Returns:

this ContextBuilder

Throws:

IOException - if the HEAP could not be created

heap

public WuicFacadeBuilder.ContextBuilderFacade heap(boolean disposable,
                                          String id,
                                          String ndbId,
                                          String[] heapIds,
                                          String[] path,
                                          HeapListener... listeners)
                                            throws IOException

Defines a new heap in this context. A heap is always identified by an ID and is associated to NutDao builder to use to convert paths into Nut. A list of paths needs also to be specified to know which underlying nuts compose the heap.

The heap could be composed in part or totally of other heaps.

If the ObjectBuilder ID is not known, a IllegalArgumentException will be thrown.

Overrides:

heap in class ContextBuilder

Parameters:

disposable - if the heap is disposable or not (see NutDaoListener.isDisposable()

id - the heap ID

ndbId - the NutDao builder the heap is based on, default is used if null

heapIds - the heaps composition

path - the path

listeners - some listeners for this heap

Returns:

this ContextBuilder

Throws:

IOException - if the HEAP could not be created

template

public WuicFacadeBuilder.ContextBuilderFacade template(String id,
                                              String[] ebIds,
                                              String... daos)
                                                throws IOException

Builds a new template with no exclusion and default engine usages.

Overrides:

template in class ContextBuilder

Parameters:

id - the template's id

ebIds - the set of Engine builder to use

daos - the DAO

Returns:

this ContextBuilder

Throws:

IOException - if an I/O error occurs

See Also:

ContextBuilder.template(String, String[], String[], Boolean, String...)

template

public WuicFacadeBuilder.ContextBuilderFacade template(String id,
                                              String[] ebIds,
                                              String[] ebIdsExclusion,
                                              Boolean includeDefaultEngines,
                                              String... ndbIds)
                                                throws IOException

Creates a new workflow template.

The template consists to chain a set of engines produced by the specified Engine builders. There is a chain for each possible NutType. A chain that processes a particular NutType of Nut is composed of engines ordered by type. All engines specified in parameter as array are simply organized following those two criteria to create the chains. Moreover, default engines could be injected in the chain to perform common operations to be done on nuts. If an Engine builder is specified in a chain while it is injected by default, then the configuration of the given builder will overrides the default one.

A set of NutDao builder could be specified to store processed nuts. When the client will retrieve the nuts, it will access it through a proxy URI configured in the protocol. This URI corresponds to a server in front of the location where nuts have been stored. For that reason the NutDao must support NutDao.save(com.github.wuic.nut.Nut) operation.

If the context builder should include engines by default, then a set of default engine to be excluded could be specified.

An IllegalStateException will be thrown if the context is not correctly configured. Bad settings are :

• Unknown ObjectBuilder ID
• A NutDao does not supports NutDao.save(com.github.wuic.nut.Nut) method

Overrides:

template in class ContextBuilder

Parameters:

id - the template's id

ebIds - the set of Engine builder to use

ebIdsExclusion - some default builder to be excluded in the chain

includeDefaultEngines - include or not default engines

ndbIds - the set of NutDao builder where to eventually upload processed nuts

Returns:

this ContextBuilder

Throws:

IOException - if an I/O error occurs

workflow

public WuicFacadeBuilder.ContextBuilderFacade workflow(String identifier,
                                              Boolean forEachHeap,
                                              String heapIdPattern,
                                              String workflowTemplateId)
                                                throws IOException,
                                                       WorkflowTemplateNotFoundException

Creates a new workflow. Any nut processing will be done through an existing workflow.

A workflow is based on a WorkflowTemplate with a specified ID.

The heap to be used is represented by a regex. The forEachHeap parameter indicates if only one workflow should be created having as heap a composition of all heaps matching the pattern. If the parameter is false, then a workflow is created for each matching NutsHeap. In this case, the workflow ID will be the concatenation if the given identifier and the heap's ID.

An IllegalStateException will be thrown if the context is not correctly configured. Bad settings are :

• Unknown NutsHeap ID

Overrides:

workflow in class ContextBuilder

Parameters:

identifier - the identifier used to build the workflow ID, is the prefix if create one for each heap

forEachHeap - true if a dedicated workflow must be created for each matching heap, false for a composition

heapIdPattern - the regex matching the heap IDs that needs to be processed

workflowTemplateId - a template ID to initialize the workflow

Returns:

this ContextBuilder

Throws:

IOException - if an I/O error occurs

WorkflowTemplateNotFoundException - if the specified template ID does not exists

mergeSettings

public WuicFacadeBuilder.ContextBuilderFacade mergeSettings(ContextBuilder other)

Merges all the settings of the given ContextBuilder to the current setting of this object.

Overrides:

mergeSettings in class ContextBuilder

Parameters:

other - the object to merge

Returns:

this