com.github.wuic

Class WuicFacade

java.lang.Object

com.github.wuic.WuicFacade

public final class WuicFacade
extends Object

This class is a facade which exposes the WUIC features by simplifying them within some exposed methods.

Since:

0.1.0

Version:

1.9

Author:

Guillaume DROUET

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WuicFacade.WarmupStrategy This enumeration allows to indicate how the Context should be initialized when ContextBuilder.build() is called.

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	allowsMultipleConfigInTagSupport() Indicates to view templates if multiple configurations are allowed.
void	clearTag(String tag) Clears the given tag in the ContextBuilder.
void	configure(Boolean useDefault, ContextBuilderConfigurator... configurators) Configures the internal builder with the given configurators.
void	configure(ContextBuilderConfigurator... configurators) Configures the internal builder with the given configurators.
String	getContextPath() Returns the context path.
ObjectBuilder<NutDao>	newNutDaoBuilder(String type) Builds a new NutDao builder.
boolean	refreshContext() Refresh the context if necessary.
List<ConvertibleNut>	runWorkflow(String id, ProcessContext processContext, EngineType... skip) Gets the nuts processed by the given workflow identified by the specified ID inside a specified context.
ConvertibleNut	runWorkflow(String id, String path, ProcessContext processContext, EngineType... skip) Gets the nut with the given path processed by the given workflow identified by the specified ID.
ConvertibleNut	runWorkflow(String id, String path, UrlProviderFactory urlProviderFactory, ProcessContext processContext, EngineType... skip) Gets the nut with the given path processed by the given workflow identified by the specified ID.
List<ConvertibleNut>	runWorkflow(String id, UrlProviderFactory urlProviderFactory, ProcessContext processContext, EngineType... skip) Gets the nuts processed by the given workflow identified by the specified ID.
Set<String>	workflowIds() Returns the workflow IDs.

Methods inherited from class java.lang.Object

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

Method Detail

newNutDaoBuilder

public ObjectBuilder<NutDao> newNutDaoBuilder(String type)

Builds a new NutDao builder.

Parameters:

type - the type of DAO

Returns:

the builder

clearTag

public void clearTag(String tag)

Clears the given tag in the ContextBuilder.

Parameters:

tag - the tag to clear

configure

public void configure(Boolean useDefault,
             ContextBuilderConfigurator... configurators)
               throws WuicException

Configures the internal builder with the given configurators.

Parameters:

useDefault - injects default configuration for each known engine and DAO type or not

configurators - the configurators

Throws:

WuicException - if an I/O error occurs or context can't be built

configure

public void configure(ContextBuilderConfigurator... configurators)
               throws WuicException

Configures the internal builder with the given configurators. By default, injects default configuration for each known engine and DAO type or not

Parameters:

configurators - the configurators

Throws:

WuicException - if an I/O error occurs or context can't be built

runWorkflow

public ConvertibleNut runWorkflow(String id,
                         String path,
                         UrlProviderFactory urlProviderFactory,
                         ProcessContext processContext,
                         EngineType... skip)
                           throws WuicException

Gets the nut with the given path processed by the given workflow identified by the specified ID.

The path should be used with the name of one nut returned when invoking runWorkflow(String, UrlProviderFactory, ProcessContext, com.github.wuic.engine.EngineType...).

Parameters:

id - the workflow ID

path - the requested path, null to retrieve all paths

urlProviderFactory - the URL provider

processContext - the process context

skip - the engine types

Returns:

the processed nuts

Throws:

WuicException - if the context can't be processed

runWorkflow

public ConvertibleNut runWorkflow(String id,
                         String path,
                         ProcessContext processContext,
                         EngineType... skip)
                           throws WuicException

Gets the nut with the given path processed by the given workflow identified by the specified ID.

The path should be used with the name of nuts returned when invoking runWorkflow(String, String, UrlProviderFactory, ProcessContext, EngineType...).

Parameters:

id - the workflow ID

path - the requested path, null to retrieve all paths

processContext - the process context

skip - the engine types

Returns:

the processed nuts

Throws:

WuicException - if the context can't be processed

runWorkflow

public List<ConvertibleNut> runWorkflow(String id,
                               UrlProviderFactory urlProviderFactory,
                               ProcessContext processContext,
                               EngineType... skip)
                                 throws WuicException

Gets the nuts processed by the given workflow identified by the specified ID.

Parameters:

id - the workflow ID

urlProviderFactory - the URL provider

processContext - the process context

skip - the engine types

Returns:

the processed nuts

Throws:

WuicException - if the context can't be processed

runWorkflow

public List<ConvertibleNut> runWorkflow(String id,
                               ProcessContext processContext,
                               EngineType... skip)
                                 throws WuicException

Gets the nuts processed by the given workflow identified by the specified ID inside a specified context.

Parameters:

id - the workflow ID

skip - the engine types

processContext - the process context

Returns:

the processed nuts

Throws:

WuicException - if the context can't be processed

workflowIds

public Set<String> workflowIds()

Returns the workflow IDs.

Returns:

the IDs

refreshContext

public boolean refreshContext()
                       throws WuicException

Refresh the context if necessary.

Returns:

true if the context is re-built,false otherwise

Throws:

WuicException - context can't be built

getContextPath

public String getContextPath()

Returns the context path.

Returns:

context path

allowsMultipleConfigInTagSupport

public Boolean allowsMultipleConfigInTagSupport()

Indicates to view templates if multiple configurations are allowed.

Returns:

true if allowed, false otherwise