com.github.wuic.context

Class Context

java.lang.Object

com.github.wuic.context.Context

All Implemented Interfaces:

Observer

public class Context
extends Object
implements Observer

The context is the core element of WUIC which allows to process nuts inside workflow.

It is built thank to a ContextBuilder and is linked to it during it life cycles to know if the context is up to date regarding configuration changes since it has been built.

Since:

0.4.0

Version:

1.2

Author:

Guillaume DROUET

Method Summary

Methods

Modifier and Type	Method and Description
Workflow	getWorkflow(String workflowId) Returns the workflow associated to the given ID.
Boolean	isUpToDate() Indicates if this context is up to date regarding the changes performed on the builder that built it.
ConvertibleNut	process(String contextPath, String wId, String path, UrlProviderFactory urlProviderFactory, ProcessContext processContext, EngineType... skip) Processes a workflow an returns the nut inside the result with a name that equals to the specified one.
List<ConvertibleNut>	process(String contextPath, String workflowId, UrlProviderFactory urlProviderFactory, ProcessContext processContext, EngineType... skip) Processes a workflow and returns the resulting nuts.
void	update(Observable o, Object arg)
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

process

public List<ConvertibleNut> process(String contextPath,
                           String workflowId,
                           UrlProviderFactory urlProviderFactory,
                           ProcessContext processContext,
                           EngineType... skip)
                             throws WuicException

Processes a workflow and returns the resulting nuts. If no workflow is associated to the given ID, then an exception will be thrown.

Parameters:

workflowId - the workflow ID

contextPath - the context path where nuts will be referenced

urlProviderFactory - the UrlProviderFactory

processContext - the process context

skip - the skipped engines

Returns:

the resulting nuts

Throws:

WuicException - if any exception related to WUIC occurs

process

public ConvertibleNut process(String contextPath,
                     String wId,
                     String path,
                     UrlProviderFactory urlProviderFactory,
                     ProcessContext processContext,
                     EngineType... skip)
                       throws WuicException,
                              IOException

Processes a workflow an returns the nut inside the result with a name that equals to the specified one.

Parameters:

skip - the skipped engine types

contextPath - the context path where nuts will be referenced

wId - the workflow ID

path - the nut name

urlProviderFactory - the URL provider

processContext - the process context

Returns:

the nut corresponding to the nut name

Throws:

WuicException - if workflow fails to be processed

IOException - if any I/O error occurs

isUpToDate

public Boolean isUpToDate()

Indicates if this context is up to date regarding the changes performed on the builder that built it.

Returns:

true if this context is up to date, false if the builder has been modified since the context has been generated

getWorkflow

public Workflow getWorkflow(String workflowId)
                     throws WorkflowNotFoundException

Returns the workflow associated to the given ID.

Parameters:

workflowId - the ID

Returns:

the workflow that corresponds to the ID

Throws:

WorkflowNotFoundException - if no workflow is associated to the ID.

update

public void update(Observable o,
          Object arg)

Specified by:

update in interface Observer

workflowIds

public Set<String> workflowIds()

Returns the workflow IDs.

Returns:

the IDs