org.instrumentmiddleware.cima.plugin
Interface ICIMAPlugin

All Superinterfaces:

IPlugin

All Known Implementing Classes:

AbstractMultiPollerParcelProducer, AbstractPlugin, AbstractProducer, AbstractSinglePollerParcelProducer, ExampleOperationPlugin, OnDataSinglePollerParcelProducer, RegularIntervalMultiPollerParcelProducer, RegularIntervalSinglePollerParcelProducer

public interface ICIMAPlugin
extends IPlugin

This interface provides the internal plugin method routing

Author:

andrew

Method Summary

org.instrumentmiddleware.cima.parcel.ResponseType

internalProcessParcel(org.instrumentmiddleware.cima.parcel.BodyType body, java.util.Calendar creationTime, org.instrumentmiddleware.cima.parcel.ParcelTypeEnum.Enum type, ISession session, org.instrumentmiddleware.cima.parcel.ResponseType response) Process a parcel.

Methods inherited from interface org.instrumentmiddleware.cima.plugin.IPlugin

doSubscribe, getId, getInformation, getSequenceNumber, processParcel, setStartOnLoad, start, startOnLoad, stop

Method Detail

internalProcessParcel

org.instrumentmiddleware.cima.parcel.ResponseType internalProcessParcel(org.instrumentmiddleware.cima.parcel.BodyType body,
                                                                        java.util.Calendar creationTime,
                                                                        org.instrumentmiddleware.cima.parcel.ParcelTypeEnum.Enum type,
                                                                        ISession session,
                                                                        org.instrumentmiddleware.cima.parcel.ResponseType response)
                                                                        throws PluginException

Process a parcel. This method is very generic and allows CIMA to let the plugin handle any parcel that is relevant for the plugin. The parcel returned is the response to the request and may be validated before returning to the requester.

Parameters:

request - the request parcel

Throws:

PluginException - if there is a problem while processing the parcel