org.mule.endpoint
Class DynamicOutboundEndpoint

java.lang.Object
  extended by org.mule.endpoint.DynamicOutboundEndpoint
All Implemented Interfaces:
Serializable, ImmutableEndpoint, OutboundEndpoint, NamedObject, MessageProcessor

public class DynamicOutboundEndpoint
extends Object
implements OutboundEndpoint

An Outbound endpoint who's URI is a template used to created new non dynamic endpoints based on the current message. This allows for the destination of a message to change based on the contents of the message. Note that this endpoint ONLY substitutes the URI, but other config elements such as the transformers, filters, etc do not change. You cannot change an endpoint scheme dynamically so you can't switch between HTTP and JMS for example using the same dynamic endpoint.

See Also:
Serialized Form

Field Summary
static String DYNAMIC_URI_PLACEHOLDER
           
protected  Log logger
           
protected  String uriTemplate
          The URI template used to construct the actual URI to send the message to.
 
Fields inherited from interface org.mule.api.endpoint.ImmutableEndpoint
INITIAL_STATE_STARTED, INITIAL_STATE_STOPPED
 
Constructor Summary
DynamicOutboundEndpoint(EndpointBuilder builder, String uriTemplate)
           
 
Method Summary
 boolean equals(Object o)
           
 String getAddress()
          This returns the address of the endpoint.
 Connector getConnector()
          The endpoint that will be used to send the message on.
 String getEncoding()
          Decides the encoding to be used for events received by this endpoint
 String getEndpointBuilderName()
          The name of the endpoint builder used to create this endpoint.
 EndpointURI getEndpointURI()
          This specifess the communication endpointUri.
protected  EndpointURI getEndpointURIForMessage(MuleEvent event)
           
 MessageExchangePattern getExchangePattern()
           
 Filter getFilter()
          The filter to apply to incoming messages.
 String getInitialState()
          Sets the state the endpoint will be loaded in.
 List<MessageProcessor> getMessageProcessors()
           
 EndpointMessageProcessorChainFactory getMessageProcessorsFactory()
           
 String getMimeType()
          Return the mime type defined for the endpoint, if any
 MuleContext getMuleContext()
           
 String getName()
          Gets the name of the object
 Map getProperties()
          Returns any properties set on this endpoint
 Object getProperty(Object key)
          Retrieves a property set on the endpoint
 String getProtocol()
          The transport protocol name that the message endpoint communicates over.
 AbstractRedeliveryPolicy getRedeliveryPolicy()
          Return the endpoint's redelivery policy, if any
 List<MessageProcessor> getResponseMessageProcessors()
           
 List<String> getResponseProperties()
           
 int getResponseTimeout()
          The timeout value for waiting for a response from a remote invocation or back channel.
 List<Transformer> getResponseTransformers()
          The transformers used when a response is returned from invoking this endpoint.
 RetryPolicyTemplate getRetryPolicyTemplate()
          The retry policy on the endpoint configures how retries are handled.
 EndpointSecurityFilter getSecurityFilter()
          Returns an EndpointSecurityFilter for this endpoint.
 TransactionConfig getTransactionConfig()
          Returns the transaction configuration for this endpoint
 List<Transformer> getTransformers()
          Transformers are responsible for transforming data when it is received or sent by the component (depending on whether this endpoint is a receiver or not).
 int hashCode()
           
 boolean isDeleteUnacceptedMessages()
          If a filter is configured on this endpoint, this property will determine if message that are not excepted by the filter are deleted
 boolean isDisableTransportTransformer()
           
 boolean isProtocolSupported(String protocol)
           
 boolean isReadOnly()
           
protected  String parseURIString(String uri, MuleMessage message)
           
 MuleEvent process(MuleEvent event)
          Invokes the MessageProcessor.
protected  void validateUriTemplate(String uri)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DYNAMIC_URI_PLACEHOLDER

public static final String DYNAMIC_URI_PLACEHOLDER
See Also:
Constant Field Values

logger

protected final transient Log logger

uriTemplate

protected String uriTemplate
The URI template used to construct the actual URI to send the message to.

Constructor Detail

DynamicOutboundEndpoint

public DynamicOutboundEndpoint(EndpointBuilder builder,
                               String uriTemplate)
                        throws MalformedEndpointException
Throws:
MalformedEndpointException
Method Detail

validateUriTemplate

protected void validateUriTemplate(String uri)
                            throws MalformedEndpointException
Throws:
MalformedEndpointException

getEndpointURIForMessage

protected EndpointURI getEndpointURIForMessage(MuleEvent event)
                                        throws DispatchException
Throws:
DispatchException

parseURIString

protected String parseURIString(String uri,
                                MuleMessage message)

process

public MuleEvent process(MuleEvent event)
                  throws MuleException
Description copied from interface: MessageProcessor
Invokes the MessageProcessor.

Specified by:
process in interface MessageProcessor
Parameters:
event - MuleEvent to be processed
Returns:
optional response MuleEvent
Throws:
MuleException

equals

public boolean equals(Object o)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

getConnector

public Connector getConnector()
Description copied from interface: ImmutableEndpoint
The endpoint that will be used to send the message on. It is important that the endpointUri and the connection correlate i.e. if your endpointUri is a jms queue your connection must be a JMS endpoint.

Specified by:
getConnector in interface ImmutableEndpoint
Returns:
the endpoint associated with the endpoint

getEndpointURI

public EndpointURI getEndpointURI()
Description copied from interface: ImmutableEndpoint
This specifess the communication endpointUri. This will have a different format depending on the transport protocol being used i.e.

if an endpointUri is not specifed it will be assumed that it will be determined at run-time by the calling application. The endpointUri can be aliteral endpointUri such as an email address or it can be a logical name for an endpointUri as long as it is declared in a message-endpointUri block. When the message-provider is created the endpointUri is first lookup in the endpointUri registry and if nothing is returned the endpointUri value itself is used.

Specified by:
getEndpointURI in interface ImmutableEndpoint
Returns:
the endpointUri on which the endpoint sends or receives data

getRedeliveryPolicy

public AbstractRedeliveryPolicy getRedeliveryPolicy()
Description copied from interface: ImmutableEndpoint
Return the endpoint's redelivery policy, if any

Specified by:
getRedeliveryPolicy in interface ImmutableEndpoint

getAddress

public String getAddress()
Description copied from interface: ImmutableEndpoint
This returns the address of the endpoint. When this contains a template, it may not be a URI

Specified by:
getAddress in interface ImmutableEndpoint
Returns:
the address on which the endpoint sends or receives data

getRetryPolicyTemplate

public RetryPolicyTemplate getRetryPolicyTemplate()
Description copied from interface: ImmutableEndpoint
The retry policy on the endpoint configures how retries are handled. The behaviour is slightly different for inbound and outbound endpoints. For inbound endpoints the Retry Policy determines how the connection to the underlying transport will be managed if the connection is lost. For outbound endpoints, the Retry Policy will attempt to retry dispatching, sending and receiving an event

Specified by:
getRetryPolicyTemplate in interface ImmutableEndpoint
Returns:
the Policy factory to use when retrying a connection or dispatching an event

getEncoding

public String getEncoding()
Description copied from interface: ImmutableEndpoint
Decides the encoding to be used for events received by this endpoint

Specified by:
getEncoding in interface ImmutableEndpoint
Returns:
the encoding set on the endpoint or null if no codin has been specified

getMimeType

public String getMimeType()
Description copied from interface: ImmutableEndpoint
Return the mime type defined for the endpoint, if any

Specified by:
getMimeType in interface ImmutableEndpoint

getFilter

public Filter getFilter()
Description copied from interface: ImmutableEndpoint
The filter to apply to incoming messages. Only applies when the endpoint endpointUri is a receiver

Specified by:
getFilter in interface ImmutableEndpoint
Returns:
the Filter to use or null if one is not set

getInitialState

public String getInitialState()
Description copied from interface: ImmutableEndpoint
Sets the state the endpoint will be loaded in. The States are 'stopped' and 'started' (default)

Specified by:
getInitialState in interface ImmutableEndpoint
Returns:
the endpoint starting state

getMuleContext

public MuleContext getMuleContext()
Specified by:
getMuleContext in interface ImmutableEndpoint

getName

public String getName()
Description copied from interface: NamedObject
Gets the name of the object

Specified by:
getName in interface NamedObject
Returns:
the name of the object

getProperties

public Map getProperties()
Description copied from interface: ImmutableEndpoint
Returns any properties set on this endpoint

Specified by:
getProperties in interface ImmutableEndpoint
Returns:
a map of properties for this endpoint

getProperty

public Object getProperty(Object key)
Description copied from interface: ImmutableEndpoint
Retrieves a property set on the endpoint

Specified by:
getProperty in interface ImmutableEndpoint
Parameters:
key - the name of the property
Returns:
the property value or null if it does not exist

getProtocol

public String getProtocol()
Description copied from interface: ImmutableEndpoint
The transport protocol name that the message endpoint communicates over. i.e. jms, sms, smtp etc. The protocol must match that of the associated endpoint

Specified by:
getProtocol in interface ImmutableEndpoint
Returns:
the protocol name

getResponseTimeout

public int getResponseTimeout()
Description copied from interface: ImmutableEndpoint
The timeout value for waiting for a response from a remote invocation or back channel. Mule will only wait for a response if the endpoint's message exchange pattern requires a response.

Specified by:
getResponseTimeout in interface ImmutableEndpoint
Returns:
the timeout in milliseconds

getResponseTransformers

public List<Transformer> getResponseTransformers()
Description copied from interface: ImmutableEndpoint
The transformers used when a response is returned from invoking this endpoint. If an endpoint has no response transformers an empty list is returned.

Specified by:
getResponseTransformers in interface ImmutableEndpoint
Returns:
the transformer to use when receiving the response data

getMessageProcessorsFactory

public EndpointMessageProcessorChainFactory getMessageProcessorsFactory()
Specified by:
getMessageProcessorsFactory in interface ImmutableEndpoint

getMessageProcessors

public List<MessageProcessor> getMessageProcessors()
Specified by:
getMessageProcessors in interface ImmutableEndpoint

getResponseMessageProcessors

public List<MessageProcessor> getResponseMessageProcessors()
Specified by:
getResponseMessageProcessors in interface ImmutableEndpoint

getSecurityFilter

public EndpointSecurityFilter getSecurityFilter()
Description copied from interface: ImmutableEndpoint
Returns an EndpointSecurityFilter for this endpoint. If one is not set, there will be no authentication on events sent via this endpoint

Specified by:
getSecurityFilter in interface ImmutableEndpoint
Returns:
EndpointSecurityFilter responsible for authenticating message flow via this endpoint.
See Also:
EndpointSecurityFilter

getTransactionConfig

public TransactionConfig getTransactionConfig()
Description copied from interface: ImmutableEndpoint
Returns the transaction configuration for this endpoint

Specified by:
getTransactionConfig in interface ImmutableEndpoint
Returns:
the transaction configuration for this endpoint or null if the endpoint is not transactional

getTransformers

public List<Transformer> getTransformers()
Description copied from interface: ImmutableEndpoint
Transformers are responsible for transforming data when it is received or sent by the component (depending on whether this endpoint is a receiver or not). A tranformation for an inbound event can be forced by the user by calling the inbound event.getTransformedMessage(). A tranformation for an outbound event is called or when the Service dispatchEvent() or sendEvent() methods are called. If an endpoint has no transformers an empty list is returned.

Specified by:
getTransformers in interface ImmutableEndpoint
Returns:
the transformers to use when receiving or sending data

isDeleteUnacceptedMessages

public boolean isDeleteUnacceptedMessages()
Description copied from interface: ImmutableEndpoint
If a filter is configured on this endpoint, this property will determine if message that are not excepted by the filter are deleted

Specified by:
isDeleteUnacceptedMessages in interface ImmutableEndpoint
Returns:
true if message should be deleted, false otherwise

isReadOnly

public boolean isReadOnly()
Specified by:
isReadOnly in interface ImmutableEndpoint
Returns:
true if this endpoint is read-only and none of it's properties can change. Global endpoints should be read-only so that unexpected behaviour is avoided.

getExchangePattern

public MessageExchangePattern getExchangePattern()
Specified by:
getExchangePattern in interface ImmutableEndpoint

getResponseProperties

public List<String> getResponseProperties()
Specified by:
getResponseProperties in interface OutboundEndpoint
Returns:
a list of properties which should be carried over from the request message to the response message in the case of a synchronous call.

getEndpointBuilderName

public String getEndpointBuilderName()
Description copied from interface: ImmutableEndpoint
The name of the endpoint builder used to create this endpoint. May be used to an endpoints builder for example to recreate endpoints for deserialized events.

Specified by:
getEndpointBuilderName in interface ImmutableEndpoint

isProtocolSupported

public boolean isProtocolSupported(String protocol)
Specified by:
isProtocolSupported in interface ImmutableEndpoint

isDisableTransportTransformer

public boolean isDisableTransportTransformer()
Specified by:
isDisableTransportTransformer in interface ImmutableEndpoint


Copyright © 2003-2014 MuleSoft, Inc.. All Rights Reserved.