org.geomajas.service.pipeline

Interface PipelineInterceptor<RESPONSE>

Type Parameters:

RESPONSE - type of response object for the pipeline

All Known Implementing Classes:

AbstractPipelineInterceptor, SkipStepPipelineInterceptor

@Api(allMethods=true)
public interface PipelineInterceptor<RESPONSE>

A pipeline interceptor allows to perform some action before and after a consecutive series of pipeline steps. It also allows to optionally skip those steps and/or the after action by letting the before action returning different execution modes. Do not implement this class, extend AbstractPipelineInterceptor instead.

Since:

1.9.0

Author:

Jan De Moerloose

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PipelineInterceptor.ExecutionMode Execution mode.

Method Summary

Methods

Modifier and Type	Method and Description
void	afterSteps(PipelineContext context, RESPONSE response) Perform some action before the steps are executed.
PipelineInterceptor.ExecutionMode	beforeSteps(PipelineContext context, RESPONSE response) Perform some action before the steps are executed.
String	getFromStepId() The id of the first step to intercept.
String	getId() Get the id for the interceptor.
String	getToStepId() The id of the last step to intercept.

Method Detail

getId

String getId()

Get the id for the interceptor. This can be used to identify the interceptor step in the pipeline.

Returns:

interceptor id

getFromStepId

String getFromStepId()

The id of the first step to intercept.

When this is not set, this pipeline will be intercepted from the beginning.

Returns:

pipeline step id

getToStepId

String getToStepId()

The id of the last step to intercept.

When this is not set, this pipeline will be intercepted till the end.

Returns:

pipeline step id

beforeSteps

PipelineInterceptor.ExecutionMode beforeSteps(PipelineContext context,
                                            RESPONSE response)
                                              throws GeomajasException

Perform some action before the steps are executed.

Parameters:

context - pipeline context

response - pipeline response

Returns:

the execution mode

Throws:

GeomajasException - any exception which may have been thrown during the execution

afterSteps

void afterSteps(PipelineContext context,
              RESPONSE response)
                throws GeomajasException

Perform some action before the steps are executed.

Parameters:

context - pipeline context

response - pipeline response

Throws:

GeomajasException - any exception which may have been thrown during the execution