com.beasys.commerce.foundation.pipeline
Interface PipelineComponentExtended

All Known Implementing Classes:

CommercePipelineComponentExtended

public interface PipelineComponentExtended

Server side business logic lives in pipeline components. They usually represent small pieces of business logic. Pipeline components can be combined into a larger unit of work called a pipeline.

The PipelineComponents typically read the information from PipelineSession, process the information and then update the PipelineSession with updated/additional information. The PipelineComponents should return the processed PipelineSession.

If the execution of any PipelineComponent is not successful depending on how critical its execution was, it can either throw a PipelineFatalException or a PipelineNonFatalException. If PipelineFatalException is thrown, then the entire pipeline in which this component is participating is considered a failure. If a PipelineNonFatalException is thrown, then the execution of other components in this pipeline is continued.

Note: this interface makes PipelineComponent interface obsolete. New PC implementations should implement this interface, and also any PC that will operate in an environment where concurrent requests on the same HTTP Session can occur (such as sites that use HTML frames).

See Also:

PipelineSessionExtended, PipelineSession, PipelineFatalException, PipelineNonFatalException, RemoteException

Method Summary

PipelineSessionExtended

process(PipelineSessionExtended pipelineSession, int requestId) The process method which processes the PipelineSession and returns the processed PipelineSession.

Method Detail

process

public PipelineSessionExtended process(PipelineSessionExtended pipelineSession,
                                       int requestId)
                                throws PipelineFatalException,
                                       PipelineNonFatalException,
                                       java.rmi.RemoteException

The process method which processes the PipelineSession and returns the processed PipelineSession.

Note: This method is not allowed to return null. Returning null will cause the pipeline in which this component is participating to terminate abnormally.

Parameters:

pipelineSession - PipelineSessionExtended object

requestId - unique identifier of originating request

Returns:

PipelineSessionExtended the processed PipelineSessionExtended object

Throws:

PipelineFatalException - indicates that the component failed to execute and the pipeline has to be terminated.

PipelineNonFatalException - indicates that the component failed to execute. But the failure is not critical to the pipeline as a whole and hence the pipeline execution has to be continued.

RemoteException - on Remote error.