com.github.wuic.context

Interface ContextInterceptor

All Known Implementing Classes:

ContextInterceptorAdapter

public interface ContextInterceptor

Represents an interceptor that is called just before and just after a workflow is processed. This gives a last chance to modify input and output of several services.

For instance, an interceptor could intercept an EngineRequestBuilder the Context is going to use and the list of nuts it returns when the job is done.

Since:

0.5.0

Version:

1.0

Author:

Guillaume DROUET

Method Summary

Methods

Modifier and Type	Method and Description
Workflow	afterGetWorkflow(String id, Workflow workflow) Called just after a workflow has been retrieved.
ConvertibleNut	afterProcess(ConvertibleNut nut, String path) Called just after the workflow has been executed to retrieve one path.
List<ConvertibleNut>	afterProcess(List<ConvertibleNut> nuts) Called just after the workflow has been executed.
String	beforeGetWorkflow(String workflowId) Called just before if going to be retrieved with a specified ID.
EngineRequestBuilder	beforeProcess(EngineRequestBuilder request) Called just before the workflow is executed.
EngineRequestBuilder	beforeProcess(EngineRequestBuilder request, String path) Called just before the workflow is executed to retrieve one path.

Method Detail

beforeGetWorkflow

String beforeGetWorkflow(String workflowId)

Called just before if going to be retrieved with a specified ID.

Parameters:

workflowId - the retrieved workflow ID

Returns:

the workflow ID to actually retrieve

afterGetWorkflow

Workflow afterGetWorkflow(String id,
                        Workflow workflow)

Called just after a workflow has been retrieved.

Parameters:

id - the workflow ID

workflow - the retrieved workflow

Returns:

the workflow to return

beforeProcess

EngineRequestBuilder beforeProcess(EngineRequestBuilder request)

Called just before the workflow is executed.

Parameters:

request - the request builder

Returns:

the request to use

beforeProcess

EngineRequestBuilder beforeProcess(EngineRequestBuilder request,
                                 String path)

Called just before the workflow is executed to retrieve one path.

Parameters:

request - the request builder

path - the path

Returns:

the request to use

afterProcess

List<ConvertibleNut> afterProcess(List<ConvertibleNut> nuts)

Called just after the workflow has been executed.

Parameters:

nuts - the nuts

Returns:

the nuts the Context should return or give to the next interceptor

afterProcess

ConvertibleNut afterProcess(ConvertibleNut nut,
                          String path)

Called just after the workflow has been executed to retrieve one path.

Parameters:

nut - the nut

path - the path

Returns:

the nut the Context should return or give to the next interceptor