com.github.wuic.engine

Class EngineRequestBuilder

java.lang.Object

com.github.wuic.engine.EngineRequestBuilder

public final class EngineRequestBuilder
extends Object

This class builds EngineRequest objects.

Since:

0.5.0

Version:

1.0

Author:

Guillaume DROUET

Constructor Summary

Constructors

Constructor and Description
EngineRequestBuilder(EngineRequest request) Builds a new instance with the EngineRequestBuilder wrapped inside the given request.
EngineRequestBuilder(String wId, NutsHeap h, Context ctx) Builds a new instance with mandatory workflow ID and NutsHeap.

Method Summary

Methods

Modifier and Type	Method and Description
EngineRequestBuilder	bestEffort() Enables best effort for this request.
EngineRequest	build() Builds a bew instance.
EngineRequestBuilder	chain(NutType nutType, NodeEngine nodeEngine) Sets the chains of engines for each type.
EngineRequestBuilder	chains(Map<NutType,? extends NodeEngine> c) Sets the chains of engines for each type.
EngineRequestBuilder	contextPath(String cp) Sets the context path.
EngineRequestBuilder	disableBestEffort() Disables best effort for this request.
EngineRequestBuilder	excludeFromSprite(Set<String> efs) Excludes any nut with a name in the given set from sprite computation.
NodeEngine	getChainFor(NutType nutType) Gets the chains which can treat nuts of the given NutType.
String	getContextPath() Gets the context path.
NutsHeap	getHeap() Returns the heap.
List<ConvertibleNut>	getNuts() Gets the nuts.
String	getPrefixCreatedNut() Returns the prefix created nut
ProcessContext	getProcessContext() Gets the process context.
UrlProviderFactory	getUrlProviderFactory() Gets the UrlProviderFactory.
String	getWorkflowId() Gets the workflow ID.
EngineRequestBuilder	heap(NutsHeap h) Sets the NutsHeap.
boolean	isBestEffort() Indicates if this request requires best effort.
EngineRequestBuilder	nuts(List<? extends Nut> n) Sets the nuts.
EngineRequestBuilder	prefixCreatedNut(String pcn) Sets the prefix of created nut.
EngineRequestBuilder	processContext(ProcessContext pc) Sets the process context.
boolean	shouldSkip(EngineType engineType) Indicates if an engine of the given type should skip its treatment when this request is submitted.
EngineRequestBuilder	skip(EngineType... toSkip) Sets the skipped EngineType.
EngineRequestBuilder	staticsServedByWuicServlet() Indicates that result will be served by WUIC servlet.
EngineRequestBuilder	urlProviderFactory(UrlProviderFactory upf) Sets the UrlProviderFactory.
EngineRequestBuilder	workflowId(String wId) Sets the workflow ID.
EngineRequestBuilder	workflowKey(String wk) Sets the workflow key.

Methods inherited from class java.lang.Object

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

Constructor Detail

EngineRequestBuilder

public EngineRequestBuilder(String wId,
                    NutsHeap h,
                    Context ctx)

Builds a new instance with mandatory workflow ID and NutsHeap.

Parameters:

wId - the workflow id

h - the heap

EngineRequestBuilder

public EngineRequestBuilder(EngineRequest request)

Builds a new instance with the EngineRequestBuilder wrapped inside the given request.

Parameters:

request - the request

Method Detail

disableBestEffort

public EngineRequestBuilder disableBestEffort()

Disables best effort for this request.

Returns:

this

bestEffort

public EngineRequestBuilder bestEffort()

Enables best effort for this request.

Returns:

this

nuts

public EngineRequestBuilder nuts(List<? extends Nut> n)

Sets the nuts. Each nut will be wrapped in a PipedConvertibleNut to be exposed as ConvertibleNut.

Parameters:

n - the nuts

Returns:

this

workflowKey

public EngineRequestBuilder workflowKey(String wk)

Sets the workflow key.

Parameters:

wk - the key

Returns:

this

workflowId

public EngineRequestBuilder workflowId(String wId)

Sets the workflow ID.

Parameters:

wId - the workflow ID

Returns:

this

prefixCreatedNut

public EngineRequestBuilder prefixCreatedNut(String pcn)

Sets the prefix of created nut.

Parameters:

pcn - the prefix

Returns:

this

urlProviderFactory

public EngineRequestBuilder urlProviderFactory(UrlProviderFactory upf)

Sets the UrlProviderFactory.

Parameters:

upf - the factory

Returns:

this

skip

public EngineRequestBuilder skip(EngineType... toSkip)

Sets the skipped EngineType.

Parameters:

toSkip - the skipped types

Returns:

this

contextPath

public EngineRequestBuilder contextPath(String cp)

Sets the context path.

Parameters:

cp - the context path

Returns:

this

heap

public EngineRequestBuilder heap(NutsHeap h)

Sets the NutsHeap.

Parameters:

h - the heap

Returns:

this

excludeFromSprite

public EngineRequestBuilder excludeFromSprite(Set<String> efs)

Excludes any nut with a name in the given set from sprite computation.

Parameters:

efs - the set

Returns:

this

chains

public EngineRequestBuilder chains(Map<NutType,? extends NodeEngine> c)

Sets the chains of engines for each type.

Parameters:

c - the chains

Returns:

this

chain

public EngineRequestBuilder chain(NutType nutType,
                         NodeEngine nodeEngine)

Sets the chains of engines for each type.

Parameters:

nutType - the type

nodeEngine - the chain's root

Returns:

this

processContext

public EngineRequestBuilder processContext(ProcessContext pc)

Sets the process context.

Parameters:

pc - the process context

Returns:

this

staticsServedByWuicServlet

public EngineRequestBuilder staticsServedByWuicServlet()

Indicates that result will be served by WUIC servlet.

Returns:

this

build

public EngineRequest build()

Builds a bew instance. Default state is applied here if some attributes have not been initialized.

Returns:

the built EngineRequest

getPrefixCreatedNut

public String getPrefixCreatedNut()

Returns the prefix created nut

Returns:

the created nut

getNuts

public List<ConvertibleNut> getNuts()

Gets the nuts.

Returns:

the nuts

getContextPath

public String getContextPath()

Gets the context path.

Returns:

the context path

getHeap

public NutsHeap getHeap()

Returns the heap.

Returns:

the heap

getWorkflowId

public String getWorkflowId()

Gets the workflow ID.

Returns:

the workflow ID.

getChainFor

public NodeEngine getChainFor(NutType nutType)

Gets the chains which can treat nuts of the given NutType.

Parameters:

nutType - the nut type

Returns:

the chains that can treat this nut type

shouldSkip

public boolean shouldSkip(EngineType engineType)

Indicates if an engine of the given type should skip its treatment when this request is submitted.

Parameters:

engineType - the EngineType

Returns:

true if treatment should be skipped, false otherwise.

getUrlProviderFactory

public UrlProviderFactory getUrlProviderFactory()

Gets the UrlProviderFactory.

Returns:

the factory

isBestEffort

public boolean isBestEffort()

Indicates if this request requires best effort.

Returns:

true in case of best effort, false otherwise

getProcessContext

public ProcessContext getProcessContext()

Gets the process context.

Returns:

the process context