org.geomajas.service.pipeline

Class AbstractPipelineInterceptor<T>

java.lang.Object

org.geomajas.service.pipeline.AbstractPipelineInterceptor<T>

Type Parameters:

T -

All Implemented Interfaces:

PipelineInterceptor<T>

Direct Known Subclasses:

SkipStepPipelineInterceptor

@Api
public class AbstractPipelineInterceptor<T>
extends Object
implements PipelineInterceptor<T>

Interceptor that unconditionally skips one or more steps.

Since:

1.9.0

Author:

Jan De Moerloose

Nested Class Summary

Nested classes/interfaces inherited from interface org.geomajas.service.pipeline.PipelineInterceptor

PipelineInterceptor.ExecutionMode

Constructor Summary

Constructors

Constructor and Description
AbstractPipelineInterceptor()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterSteps(PipelineContext context, T response) Perform some action before the steps are executed.
PipelineInterceptor.ExecutionMode	beforeSteps(PipelineContext context, T 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.
void	setFromStepId(String fromStepId) Set id of first step to intercept.
void	setId(String id) Set the id for this interceptor.
void	setStepId(String stepId) Shortcut notation for setting the same from and to step id.
void	setToStepId(String toStepId) Set id of last step to intercept.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPipelineInterceptor

public AbstractPipelineInterceptor()

Method Detail

getId

public String getId()

Description copied from interface: PipelineInterceptor

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

Specified by:

getId in interface PipelineInterceptor<T>

Returns:

interceptor id

setId

public void setId(String id)

Set the id for this interceptor.

Parameters:

id - id

getFromStepId

public String getFromStepId()

Description copied from interface: PipelineInterceptor

The id of the first step to intercept.

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

Specified by:

getFromStepId in interface PipelineInterceptor<T>

Returns:

pipeline step id

setFromStepId

@Api
public void setFromStepId(String fromStepId)

Set id of first step to intercept.

Parameters:

fromStepId - from step id

Since:

1.9.0

getToStepId

public String getToStepId()

Description copied from interface: PipelineInterceptor

The id of the last step to intercept.

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

Specified by:

getToStepId in interface PipelineInterceptor<T>

Returns:

pipeline step id

setToStepId

@Api
public void setToStepId(String toStepId)

Set id of last step to intercept.

Parameters:

toStepId - to step id

Since:

1.9.0

setStepId

@Api
public void setStepId(String stepId)

Shortcut notation for setting the same from and to step id.

Parameters:

stepId - step id

Since:

1.9.0

beforeSteps

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

Description copied from interface: PipelineInterceptor

Perform some action before the steps are executed.

Specified by:

beforeSteps in interface PipelineInterceptor<T>

Parameters:

context - pipeline context

response - pipeline response

Returns:

the execution mode

Throws:

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

afterSteps

public void afterSteps(PipelineContext context,
              T response)
                throws GeomajasException

Description copied from interface: PipelineInterceptor

Perform some action before the steps are executed.

Specified by:

afterSteps in interface PipelineInterceptor<T>

Parameters:

context - pipeline context

response - pipeline response

Throws:

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