org.apache.synapse
Interface Processor

All Known Implementing Classes:
AbstractProcessor

public interface Processor

Processors are the main extension mechanism for Synapse.

A Processor together with the XML ProcessorConfigurator extends both the synapse.xml and the actual processing power of Synapse.

Some of the processors are "builtin" and those are defined in the ProcessorConfiguratorFinder

Other processors can be registered using the JAR Service Provider model:
http://java.sun.com/j2se/1.3/docs/guide/jar/jar.html#Service%20Provider

The processor then deals with a message. It returns false if no further processing is desired. It can have a name (or null)

Processors can either devolve processing to other processors (e.g. a rule, stage, etc) or deal with the message itself (e.g. mediator)


Method Summary
 java.lang.String getName()
          the name of the instance of this processor
 boolean process(SynapseEnvironment se, SynapseMessage sm)
          This method is used to process a message.
 void setName(java.lang.String name)
          set the name of the instance of the processor
 

Method Detail

process

public boolean process(SynapseEnvironment se,
                       SynapseMessage sm)
This method is used to process a message. A response of true indicates continue processing. A response of false indicates to stop processing.


getName

public java.lang.String getName()
the name of the instance of this processor


setName

public void setName(java.lang.String name)
set the name of the instance of the processor