- All Superinterfaces:
- All Known Subinterfaces:
- InboundEndpoint, OutboundEndpoint
- All Known Implementing Classes:
- AbstractEndpoint, DefaultInboundEndpoint, DefaultOutboundEndpoint, DynamicURIInboundEndpoint, DynamicURIOutboundEndpoint
public interface ImmutableEndpoint
- extends Serializable
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.
static final String INITIAL_STATE_STARTED
- See Also:
- Constant Field Values
static final String INITIAL_STATE_STOPPED
- See Also:
- Constant Field Values
- 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.
- smtp -> firstname.lastname@example.org
- jms -> shipping.orders.topic
- sms -> +447910010010
- the endpointUri on which the endpoint sends or receives data
- Decides the encoding to be used for events received by this endpoint
- the encoding set on the endpoint or null if no codin has been
- 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.
- the endpoint associated with the endpoint
- The name is the identifier for the endpoint
- the endpoint name
- 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.
- the transformers to use when receiving or sending data
- The transformers used when a response is returned from invoking this endpoint.
If an endpoint has no response transformers an empty list is returned.
- the transformer to use when receiving the response data
- Returns any properties set on this endpoint
- a map of properties for this endpoint
Object getProperty(Object key)
- Retrieves a property set on the endpoint
key - the name of the property
- the property value or null if it does not exist
- 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
- the protocol name
- 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.
- Returns the transaction configuration for this endpoint
- the transaction configuration for this endpoint or null if the
endpoint is not transactional
- The filter to apply to incoming messages. Only applies when the endpoint
endpointUri is a receiver
- the Filter to use or null if one is not set
- If a filter is configured on this endpoint, this property will determine if
message that are not excepted by the filter are deleted
- true if message should be deleted, false otherwise
- Returns an EndpointSecurityFilter for this endpoint. If one is not set,
there will be no authentication on events sent via this endpoint
- EndpointSecurityFilter responsible for authenticating message flow
via this endpoint.
- See Also:
- Determines if requests originating from this endpoint should be synchronous
i.e. execute in a single thread and possibly return an result. This property
is only used when the endpoint is of type 'receiver'
- whether requests on this endpoint should execute in a single thread.
This property is only used when the endpoint is of type 'receiver'
- The timeout value for waiting for a response from a remote invocation or back channel. Mule will only wait
for a response is the
isSynchronous() flag is set to true.
- the timeout in milliseconds
- Sets the state the endpoint will be loaded in. The States are 'stopped' and
- the endpoint starting state
- 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
- the Policy factory to use when retrying a connection or dispatching an event
- 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.
Copyright © 2003-2009 MuleSource, Inc.. All Rights Reserved.