Message Forwarding Processor

The message forwarding processor is a message processor that consumes messages in a message store and sends them to an endpoint. If the message was successfully delivered to the endpoint, the processor will delete the message from the message store. In case of a failure, it will retry after a configured interval.

Message forwarding processor parameters

In addition to the mandatory endpoint name and message store parameters, you can set the following parameters when adding a message forwarding processor:

Parameter Name	Value	Required
Processor State (`is.active`)	Activate (`true`) or Deactivate (`false`)	Yes
Forwarding Interval (`interval`)	Interval in milliseconds in which processor consumes messages	No (The default value is 1000)
Retry Interval (`client.retry.interval`)	Message retry interval in milliseconds	No (The default is value is 1000)
Non retry HTTP status codes (non.retry.status.codes)	Message Processor look at this parameter before it decides if it has to retry. If the response's HTTP status code is one of the specified status codes, it won't retry.	No
Maximum Delivery Attempts (`max.delivery.attempts`)	Maximum redelivery attempts before deactivating the processor	No
Axis2 Client Repository (`axis2.repo`)	Axis2 Client repository path. This is the location where services and modules reside.	No
Axis2 Configuration (`axis2.config`)	Axis2 Configuration to be used to send messages	No
Reply Sequence Name (`message.processor.reply.sequence`)	Name of the sequence where the message reply should be sent	No
Fault Sequence Name (`message.processor.fault.sequence`)	Name of the sequence where the fault message should be sent to in case of a SOAP fault	No
Quartz Configuration File Path (`quartz.conf`)	Quartz configuration file path. This properties file contains the Quartz configuration parameters for fine tuning the Quartz engine. More details of the configuration can be found at http://quartz-scheduler.org/documentation/quartz-2.x/configuration/ConfigMain.	No
Cron Expression (`cronExpression`)	Cron expression to be used to configure the retry pattern	No
Pinned Servers (`pinnedServers`)	A comma-separated list of server names where the message processor should be started, so that when you start the message processor on an ESB server, it is only started on that server if the server name is in this list. This is useful when you have multiple ESB instances in a cluster.	No

Message context properties to be used with the message forwarding processor

Property Name	Value	Required
`target.endpoint` (Deprecated)	Name of the Address Endpoint where the message should be delivered. This property is deprecated and is no longer required, but for backward compatibility, it does not cause errors if it is included.	No
OUT_ONLY	Set to `true` if this is an out-only message	Required for out-only scenarios
FORCE_ERROR_ON_SOAP_FAULT	Set to `true` if it is required to retry in case of SOAP fault.	NO

Samples

For samples illustrating how to use the message forwarding processor, see: