org.mule.api.endpoint
Interface ImmutableEndpoint

All Superinterfaces:

NamedObject, Serializable

All Known Subinterfaces:

InboundEndpoint, OutboundEndpoint

All Known Implementing Classes:

AbstractEndpoint, CallOutboundEndpoint, CallRequestEndpoint, DefaultInboundEndpoint, DefaultOutboundEndpoint, DynamicOutboundEndpoint, DynamicRequestEndpoint, DynamicRequestEndpoint.NullInboundEndpoint, DynamicURIInboundEndpoint, DynamicURIOutboundEndpoint

public interface ImmutableEndpoint
extends Serializable, NamedObject

ImmutableEndpoint describes a Message endpoint where data is sent or received. An Enpoint is an Resource address (EndpointUri), with associated transformation, transaction and filtering rules.

Field Summary

static String	INITIAL_STATE_STARTED
static String	INITIAL_STATE_STOPPED

Method Summary

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()
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() Deprecated. use getResponseMessageProcessors() instead
RetryPolicyTemplate	getRetryPolicyTemplate() The retry policy on the endpoint configures how retries are handled.
EndpointSecurityFilter	getSecurityFilter() Deprecated.
TransactionConfig	getTransactionConfig() Returns the transaction configuration for this endpoint
List<Transformer>	getTransformers() Deprecated. use getMessageProcessors() instead
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()

Methods inherited from interface org.mule.api.NamedObject

getName

Field Detail

INITIAL_STATE_STARTED

static final String INITIAL_STATE_STARTED

See Also:

Constant Field Values

INITIAL_STATE_STOPPED

static final String INITIAL_STATE_STOPPED

See Also:

Constant Field Values

Method Detail

getEndpointURI

EndpointURI getEndpointURI()

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.

Returns:

the endpointUri on which the endpoint sends or receives data

getAddress

String getAddress()

This returns the address of the endpoint. When this contains a template, it may not be a URI

Returns:

the address on which the endpoint sends or receives data

getEncoding

String getEncoding()

Decides the encoding to be used for events received by this endpoint

Returns:

the encoding set on the endpoint or null if no codin has been specified

getConnector

Connector getConnector()

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.

Returns:

the endpoint associated with the endpoint

getTransformers

@Deprecated
List<Transformer> getTransformers()

Deprecated. use getMessageProcessors() instead

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.

Returns:

the transformers to use when receiving or sending data

getResponseTransformers

@Deprecated
List<Transformer> getResponseTransformers()

Deprecated. use getResponseMessageProcessors() instead

The transformers used when a response is returned from invoking this endpoint. If an endpoint has no response transformers an empty list is returned.

Returns:

the transformer to use when receiving the response data

getProperties

Map getProperties()

Returns any properties set on this endpoint

Returns:

a map of properties for this endpoint

getProperty

Object getProperty(Object key)

Retrieves a property set on the endpoint

Parameters:

key - the name of the property

Returns:

the property value or null if it does not exist

getProtocol

String getProtocol()

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

Returns:

the protocol name

isReadOnly

boolean isReadOnly()

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.

getTransactionConfig

TransactionConfig getTransactionConfig()

Returns the transaction configuration for this endpoint

Returns:

the transaction configuration for this endpoint or null if the endpoint is not transactional

getFilter

Filter getFilter()

The filter to apply to incoming messages. Only applies when the endpoint endpointUri is a receiver

Returns:

the Filter to use or null if one is not set

isDeleteUnacceptedMessages

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

Returns:

true if message should be deleted, false otherwise

getSecurityFilter

@Deprecated
EndpointSecurityFilter getSecurityFilter()

Deprecated.

Returns an EndpointSecurityFilter for this endpoint. If one is not set, there will be no authentication on events sent via this endpoint

Returns:

EndpointSecurityFilter responsible for authenticating message flow via this endpoint.

See Also:

EndpointSecurityFilter

getMessageProcessorsFactory

EndpointMessageProcessorChainFactory getMessageProcessorsFactory()

getMessageProcessors

List<MessageProcessor> getMessageProcessors()

getResponseMessageProcessors

List<MessageProcessor> getResponseMessageProcessors()

getExchangePattern

MessageExchangePattern getExchangePattern()

getResponseTimeout

int getResponseTimeout()

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.

Returns:

the timeout in milliseconds

getInitialState

String getInitialState()

Sets the state the endpoint will be loaded in. The States are 'stopped' and 'started' (default)

Returns:

the endpoint starting state

getMuleContext

MuleContext getMuleContext()

getRetryPolicyTemplate

RetryPolicyTemplate getRetryPolicyTemplate()

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

Returns:

the Policy factory to use when retrying a connection or dispatching an event

getEndpointBuilderName

String getEndpointBuilderName()

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.

isProtocolSupported

boolean isProtocolSupported(String protocol)

getMimeType

String getMimeType()

Return the mime type defined for the endpoint, if any

getRedeliveryPolicy

AbstractRedeliveryPolicy getRedeliveryPolicy()

Return the endpoint's redelivery policy, if any

isDisableTransportTransformer

boolean isDisableTransportTransformer()