org.geomajas.service.pipeline

Class PipelineInfo<RESPONSE>

java.lang.Object

org.geomajas.service.pipeline.PipelineInfo<RESPONSE>

Type Parameters:

RESPONSE - type of response object for the pipeline

@Api(allMethods=true)
public class PipelineInfo<RESPONSE>
extends Object

Configuration info for a pipeline service.

Since:

1.6.0

Author:

Joachim Van der Auwera

Constructor Summary

Constructors

Constructor and Description
PipelineInfo()

Method Summary

Methods

Modifier and Type	Method and Description
PipelineInfo	getDelegatePipeline() Get the delegate pipeline.
Map<String,PipelineStep<RESPONSE>>	getExtensions() Get set of steps which need to be weaved at the extension hooks.
List<PipelineInterceptor<RESPONSE>>	getInterceptors() Get the list of interceptors to be added to the pipeline.
String	getLayerId() Set the layer for which this definition should apply.
List<PipelineStep<RESPONSE>>	getPipeline() Get the list of steps which form the pipeline.
String	getPipelineName() Get the name of the pipeline for which this is an implementation.
void	setDelegatePipeline(PipelineInfo delegatePipeline) Define a delegate pipeline.
void	setExtensions(Map<String,PipelineStep<RESPONSE>> extensions) Set the set of steps which need to be weaved at the extension hooks.
void	setInterceptors(List<PipelineInterceptor<RESPONSE>> interceptors) Set the list of interceptors which need to be added to the pipeline.
void	setLayerId(String layerId) Get the layer id for which this pipeline applies.
void	setPipeline(List<PipelineStep<RESPONSE>> pipeline) Set the list of steps which form the pipeline.
void	setPipelineName(String pipelineName) Set the name of the pipeline for which steps are defined.

Methods inherited from class java.lang.Object

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

Constructor Detail

PipelineInfo

public PipelineInfo()

Method Detail

getPipelineName

public String getPipelineName()

Get the name of the pipeline for which this is an implementation.

Returns:

pipeline name

setPipelineName

public void setPipelineName(String pipelineName)

Set the name of the pipeline for which steps are defined.

Parameters:

pipelineName - pipeline name

getLayerId

public String getLayerId()

Set the layer for which this definition should apply.

When this is not set (or null), it indicates a candidate default implementation.

Returns:

layer for which this pipeline applies

setLayerId

public void setLayerId(String layerId)

Get the layer id for which this pipeline applies.

When this is not set (or null), it indicates a candidate default implementation.

Parameters:

layerId - layer for which this pipeline applies

getDelegatePipeline

public PipelineInfo getDelegatePipeline()

Get the delegate pipeline.

Either the pipeline itself should be defined or a delegate. It is not allowed to define both.

Returns:

delegate pipeline definition

setDelegatePipeline

public void setDelegatePipeline(PipelineInfo delegatePipeline)

Define a delegate pipeline.

Either the pipeline itself should be defined or a delegate. It is not allowed to define both.

Parameters:

delegatePipeline - delegate pipeline definition

getPipeline

public List<PipelineStep<RESPONSE>> getPipeline()

Get the list of steps which form the pipeline.

Either the pipeline itself should be defined or a delegate. It is not allowed to define both.

Returns:

list of pipeline steps

setPipeline

public void setPipeline(List<PipelineStep<RESPONSE>> pipeline)

Set the list of steps which form the pipeline.

Either the pipeline itself should be defined or a delegate. It is not allowed to define both.

Parameters:

pipeline - list of pipeline steps

getExtensions

public Map<String,PipelineStep<RESPONSE>> getExtensions()

Get set of steps which need to be weaved at the extension hooks.

Extensions are always added in the pipeline just after the hook (in the expanded delegate pipeline).

Returns:

map of hook name and pipeline step

Since:

1.7.0

setExtensions

public void setExtensions(Map<String,PipelineStep<RESPONSE>> extensions)

Set the set of steps which need to be weaved at the extension hooks.

Extensions are always added in the pipeline just after the hook (in the expanded delegate pipeline).

Parameters:

extensions - map of hook name and pipeline step

Since:

1.7.0

getInterceptors

public List<PipelineInterceptor<RESPONSE>> getInterceptors()

Get the list of interceptors to be added to the pipeline.

Returns:

list of interceptors

Since:

1.9.0

setInterceptors

public void setInterceptors(List<PipelineInterceptor<RESPONSE>> interceptors)

Set the list of interceptors which need to be added to the pipeline.

Parameters:

interceptors - list of interceptors

Since:

1.9.0