org.geomajas.service.pipeline

Class PipelineHook

java.lang.Object

org.geomajas.service.pipeline.PipelineHook

All Implemented Interfaces:

PipelineStep

@Api(allMethods=true)
public class PipelineHook
extends Object
implements PipelineStep

Special pipeline step which is used fo weaving a base pipeline and extensions steps.

Since:

1.7.0

Author:

Joachim Van der Auwera

Constructor Summary

Constructors

Constructor and Description
PipelineHook()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(PipelineContext context, Object response) Execute this step in the pipeline.
String	getId() Get the id for the hook.
void	setId(String id) Set the id for the hook.

Methods inherited from class java.lang.Object

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

Constructor Detail

PipelineHook

public PipelineHook()

Method Detail

setId

public void setId(String id)

Set the id for the hook. This is used for identify the position to include extensions.

Parameters:

id - pipeline hook id

getId

public String getId()

Get the id for the hook. This is used for identify the position to include extensions.

Specified by:

getId in interface PipelineStep

Returns:

pipeline hook id

execute

public final void execute(PipelineContext context,
           Object response)
                   throws GeomajasException

Execute this step in the pipeline.

This is a no-op as the extension occurs while getting the pipeline, not during execution.

Specified by:

execute in interface PipelineStep

Parameters:

context - contains a map of objects which are used as shared memory between the pipeline steps

response - response object for the pipeline service

Throws:

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