org.jboss.soa.esb.actions.routing.email
Class EmailRouter

java.lang.Object
  org.jboss.soa.esb.actions.AbstractActionLifecycle
      org.jboss.soa.esb.actions.AbstractActionPipelineProcessor
          org.jboss.soa.esb.actions.routing.AbstractRouter
              org.jboss.soa.esb.actions.routing.email.EmailRouter

All Implemented Interfaces:

ActionLifecycle, ActionPipelineProcessor

public class EmailRouter
extends AbstractRouter

EmailRouter routes the ESB message payload to a configured email account.

Like all router processing will terminate after this action has been processed. Example configuration:

<action name="send-email" class="org.jboss.soa.esb.actions.routing.email.EmailRouter">
    <property name="host" value="localhost" />
    <property name="port" value="25" />
    <property name="username" value="danbev" />
    <property name="password" value="password" />
    <property name="from" value="jbossesb" />
    <property name="sendTo" value="danbev" />
    <property name="subject" value="quickstart routing" />
    <property name="unwrap" value="true" />
 </action>
 

For details about the properties listed above please see Emailers javadoc.

Since:

4.6

Author:

Daniel Bevenius

Field Summary

Fields inherited from class org.jboss.soa.esb.actions.routing.AbstractRouter

payloadProxy, unwrap

Fields inherited from interface org.jboss.soa.esb.actions.ActionPipelineProcessor

PROCESS_EXCEPTION_METHOD, PROCESS_METHOD, PROCESS_SUCCESS_METHOD

Constructor Summary

EmailRouter(ConfigTree config)

Method Summary

Message	process(Message message) Perform the action processing on the specified message.
void	route(java.lang.Object object) Route the message or message payload.

Methods inherited from class org.jboss.soa.esb.actions.routing.AbstractRouter

getPayloadProxy

Methods inherited from class org.jboss.soa.esb.actions.AbstractActionPipelineProcessor

processException, processSuccess

Methods inherited from class org.jboss.soa.esb.actions.AbstractActionLifecycle

destroy, initialise

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jboss.soa.esb.actions.ActionLifecycle

destroy, initialise

Constructor Detail

EmailRouter

public EmailRouter(ConfigTree config)
            throws ConfigurationException

Throws:

ConfigurationException

Method Detail

process

public Message process(Message message)
                throws ActionProcessingException

Description copied from interface: ActionPipelineProcessor

Perform the action processing on the specified message. This method is invoked for each message passing throught the pipeline.

Specified by:

process in interface ActionPipelineProcessor

Overrides:

process in class AbstractRouter

Parameters:

message - The current message being processed.

Returns:

The message to be passed to the next stage of the pipeline.

Throws:

ActionProcessingException - for errors during processing.

route

public void route(java.lang.Object object)
           throws ActionProcessingException

Description copied from class: AbstractRouter

Route the message or message payload.

If the message is to be unwrapped, it will have been unwrapped at this stage.

Specified by:

route in class AbstractRouter

Parameters:

object - The object to route.

Throws:

ActionProcessingException - Exception during routing operation.