DynamicURIInboundEndpoint (Mule ESB 3.7.0 API)

java.lang.Object
- org.mule.endpoint.DynamicURIInboundEndpoint

All Implemented Interfaces:

Serializable, FlowConstructAware, ImmutableEndpoint, InboundEndpoint, Startable, Stoppable, NamedObject, MessageSource, MessageRequesting
```
public class DynamicURIInboundEndpoint
extends Object
implements InboundEndpoint
```
Allow's EndpointURI to be set and changed dynamically by wrapping up an immutable endpoint instance.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected InboundEndpoint endpoint
- Fields inherited from interface org.mule.api.endpoint.ImmutableEndpoint
  INITIAL_STATE_STARTED, INITIAL_STATE_STOPPED
- Fields inherited from interface org.mule.api.transport.MessageRequesting
  REQUEST_NO_WAIT, REQUEST_WAIT_INDEFINITELY
- Fields inherited from interface org.mule.api.lifecycle.Startable
  PHASE_NAME
- Fields inherited from interface org.mule.api.lifecycle.Stoppable
  PHASE_NAME

Fields
Modifier and Type	Field and Description
`protected InboundEndpoint`	`endpoint`

Constructor Summary

Constructors
Constructor and Description
`DynamicURIInboundEndpoint(InboundEndpoint endpoint)`
`DynamicURIInboundEndpoint(InboundEndpoint endpoint, EndpointURI dynamicEndpointURI)`

Method Summary

Methods
Modifier and Type	Method and Description
`AbstractRedeliveryPolicy`	`createDefaultRedeliveryPolicy(int maxRedelivery)`
`boolean`	`equals(Object obj)`
`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.
`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()`
`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()`
`MuleMessage`	`request(long timeout)` Make a specific request to the underlying transport
`void`	`setEndpointURI(EndpointURI dynamicEndpointURI)`
`void`	`setFlowConstruct(FlowConstruct flowConstruct)`
`void`	`setListener(MessageProcessor listener)` Set the MessageProcessor listener on a message source which will be invoked when a message is received or generated.
`void`	`start()`
`void`	`stop()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - endpoint
```
protected InboundEndpoint endpoint
```
- Constructor Detail
  - DynamicURIInboundEndpoint
```
public DynamicURIInboundEndpoint(InboundEndpoint endpoint)
```
  - DynamicURIInboundEndpoint
```
public DynamicURIInboundEndpoint(InboundEndpoint endpoint,
                         EndpointURI dynamicEndpointURI)
```
- Method Detail
  - 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.
    - smtp -> admin@mycompany.com
    - jms -> shipping.orders.topic
    - sms -> +447910010010
    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
  - 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
  - setEndpointURI
```
public void setEndpointURI(EndpointURI dynamicEndpointURI)
```
  - 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
  - getRedeliveryPolicy
```
public AbstractRedeliveryPolicy getRedeliveryPolicy()
```
    Description copied from interface: ImmutableEndpoint
    
    Return the endpoint's redelivery policy, if any
    
    Specified by:
    
    getRedeliveryPolicy in interface ImmutableEndpoint
  - 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
  - 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
  - request
```
public MuleMessage request(long timeout)
                    throws Exception
```
    Description copied from interface: MessageRequesting
    
    Make a specific request to the underlying transport
    
    Specified by:
    
    request in interface MessageRequesting
    
    Parameters:
    timeout - the maximum time the operation should block before returning. The call should return immediately if there is data available. If no data becomes available before the timeout elapses, null will be returned
    
    Returns:
    the result of the request wrapped in a MuleMessage object. Null will be returned if no data was avaialable
    
    Throws:
    
    Exception - if the call to the underlying protocal causes an exception
  - 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
  - createDefaultRedeliveryPolicy
```
public AbstractRedeliveryPolicy createDefaultRedeliveryPolicy(int maxRedelivery)
```
    Specified by:
    
    createDefaultRedeliveryPolicy in interface InboundEndpoint
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - start
```
public void start()
           throws MuleException
```
    Specified by:
    
    start in interface Startable
    
    Throws:
    
    MuleException
  - stop
```
public void stop()
          throws MuleException
```
    Specified by:
    
    stop in interface Stoppable
    
    Throws:
    
    MuleException
  - setFlowConstruct
```
public void setFlowConstruct(FlowConstruct flowConstruct)
```
    Specified by:
    
    setFlowConstruct in interface FlowConstructAware
  - setListener
```
public void setListener(MessageProcessor listener)
```
    Description copied from interface: MessageSource
    
    Set the MessageProcessor listener on a message source which will be invoked when a message is received or generated.
    
    Specified by:
    
    setListener in interface MessageSource

Class DynamicURIInboundEndpoint

Field Summary

Fields inherited from interface org.mule.api.endpoint.ImmutableEndpoint

Fields inherited from interface org.mule.api.transport.MessageRequesting

Fields inherited from interface org.mule.api.lifecycle.Startable

Fields inherited from interface org.mule.api.lifecycle.Stoppable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

endpoint

Constructor Detail

DynamicURIInboundEndpoint

DynamicURIInboundEndpoint

Method Detail

getEndpointURI

getAddress

setEndpointURI

getRetryPolicyTemplate

getRedeliveryPolicy

getConnector

getEncoding

getMimeType

getFilter

getInitialState

getMuleContext

getName

getProperties

getProperty

getProtocol

getResponseTimeout

getResponseTransformers

getMessageProcessorsFactory

getMessageProcessors

getResponseMessageProcessors

getSecurityFilter

getTransactionConfig

getTransformers

isDeleteUnacceptedMessages

isReadOnly

getExchangePattern

request

getEndpointBuilderName

isProtocolSupported

isDisableTransportTransformer

createDefaultRedeliveryPolicy

hashCode

equals

start

stop

setFlowConstruct

setListener