org.apache.synapse.message.processors

Interface MessageProcessor

All Superinterfaces:

ManagedLifecycle, Nameable, SynapseArtifact

All Known Implementing Classes:

AbstractMessageProcessor, ResequencingProcessor, SamplingProcessor, ScheduledMessageForwardingProcessor, ScheduledMessageProcessor

public interface MessageProcessor
extends ManagedLifecycle, Nameable, SynapseArtifact

All Synapse Message Processors must implement MessageProcessor interface Message processors will process the Message using a Message Store. Message processing logic and process will depend on the concrete implementation of the MessageStore

Method Summary

Modifier and Type	Method and Description
String	getFileName() get the file name that the message processor is configured
String	getMessageStoreName() Get message store name associated with the Message processor
Map<String,Object>	getParameters() Get the Message processor Parameters
boolean	isStarted() Returns weather a Message processor is started or not
void	setFileName(String filename) Set the name of the file that the Message Processor is configured
void	setMessageStoreName(String messageStore) Set the Message Store name that backs the Message processor
void	setParameters(Map<String,Object> parameters) Set the Message processor parameters that will be used by the specific implementation
void	start() Start Message Processor
void	stop() Stop MessageProcessor

Methods inherited from interface org.apache.synapse.ManagedLifecycle

destroy, init

Methods inherited from interface org.apache.synapse.Nameable

getName, setName

Methods inherited from interface org.apache.synapse.SynapseArtifact

getDescription, setDescription

Method Detail

start

void start()

Start Message Processor

stop

void stop()

Stop MessageProcessor

setMessageStoreName

void setMessageStoreName(String messageStore)

Set the Message Store name that backs the Message processor

Parameters:

messageStore - name the underlying MessageStore instance

getMessageStoreName

String getMessageStoreName()

Get message store name associated with the Message processor

Returns:

message store name associated with message processor

setParameters

void setParameters(Map<String,Object> parameters)

Set the Message processor parameters that will be used by the specific implementation

Parameters:

parameters -

getParameters

Map<String,Object> getParameters()

Get the Message processor Parameters

Returns:

isStarted

boolean isStarted()

Returns weather a Message processor is started or not

Returns:

setFileName

void setFileName(String filename)

Set the name of the file that the Message Processor is configured

Parameters:

filename - Name of the file where this artifact is defined

getFileName

String getFileName()

get the file name that the message processor is configured

Returns:

Name of the file where this artifact is defined