Custom Pipeline

There are multiple categories of pipeline components. These categories are –

Pipeline Components Stages :

General Component: (Decode, Encode, Pre-assemble, Resolve Party or Validate )Take one message process message and produce zero or one message

Disassemble Component: Split message, promote custom properties

Assemble Component: Used to wrap message with head or trailer or both

Probe Component: (This is not an independent component. Any pipeline component can implement the IProbeMessage interface if it must support message probing functionality.)
Enables the component to check the beginning part of the message.

Developing General Pipeline Component

General pipeline component implements following interfaces –

a. IBaseComponent Interface
b. IComponentUI Interface
c. IComponent Interface
d. IPersistPropertyBag (Optional. Required when pipeline design time properties are to be defined)

IBaseComponent Interface:

All pipelines implement this interface. Interface provides members which can be implemented to provide information about pipeline.

IBaseComponent Interface Properties:

Description Property. Used to specify small description about pipeline component.
Description is visible on pipeline properties page at design time.

Name Property used to specify name of pipeline component. Name is visible on pipeline properties page at design time.

Version Property used to specify version (example 1.0.0.0) of pipeline component. Visible on pipeline properties page at design time.

IComponentUI Interface:All pipeline components must implement this interface. Members of this interface provide design time support.

IComponentUI Interface Properties:
Icon Property: used to provide icon associated with pipeline component.

Validate Method: This is called by pipeline designer before pipeline compilation to
verify that all configuration properties are correctly set.

IComponent Interface
This is core interface. Member of this interface is implemented for specific message processing/massaging.
IComponent Interface Properties:

Execute Method: Does specific processing/massaging in inbound message and produces output message to be forwarded to next stages of pipeline or message box.

IPersistPropertyBag

Interface provides members which can be used to save and load pipeline design time properties with property bag. This interface is implemented only when pipeline’s design time properties are to be defined.
IpersistPropertyBag Properties:

GetClassID Method: Retrieves the component's globally unique identifying value.
InitNew Method: Initializes any objects needed by the component to use the persisted properties.
Load Method: Used to load property from property bag.
Save Method: Used to save property to property bag.