|
| |
|
| org.mule.api.endpoint.ImmutableEndpoint
All known Subclasses: org.mule.endpoint.AbstractEndpoint,
| ImmutableEndpoint | | public interface ImmutableEndpoint extends Serializable(Code) | | 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.
|
| INITIAL_STATE_STARTED | | final public static String INITIAL_STATE_STARTED(Code) | | |
| INITIAL_STATE_STOPPED | | final public static String INITIAL_STATE_STOPPED(Code) | | |
| getConnectionStrategy | | ConnectionStrategy getConnectionStrategy()(Code) | | Returns the connection strategy this endpoint should use when connecting to the underlying resource
the connection strategy this endpoint should use when connecting to the underlying resource |
| getConnector | | Connector getConnector()(Code) | | 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 |
| getEncoding | | String getEncoding()(Code) | | Decides the encoding to be used for events received by this endpoint
the encoding set on the endpoint or null if no codin has beenspecified |
| getEndpointURI | | EndpointURI getEndpointURI()(Code) | | 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.
the endpointUri on which the endpoint sends or receives data |
| getFilter | | Filter getFilter()(Code) | | 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 |
| getInitialState | | String getInitialState()(Code) | | Sets the state the endpoint will be loaded in. The States are 'stopped' and
'started' (default)
the endpoint starting state |
| getName | | String getName()(Code) | | The name is the identifier for the endpoint
the endpoint name |
| getProperties | | Map getProperties()(Code) | | Returns any properties set on this endpoint
a map of properties for this endpoint |
| getProperty | | Object getProperty(Object key)(Code) | | Retrieves a property set on the endpoint
Parameters:
key - the name of the property the property value or null if it does not exist |
| getProtocol | | String getProtocol()(Code) | | 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 |
| getRemoteSyncTimeout | | int getRemoteSyncTimeout()(Code) | | The timeout value for remoteSync invocations
the timeout in milliseconds |
| getResponseTransformers | | List getResponseTransformers()(Code) | | 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 |
| getSecurityFilter | | EndpointSecurityFilter getSecurityFilter()(Code) | | 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 flowvia this endpoint.
See Also: EndpointSecurityFilter |
| getTransactionConfig | | TransactionConfig getTransactionConfig()(Code) | | Returns the transaction configuration for this endpoint
the transaction configuration for this endpoint or null if theendpoint is not transactional |
| getTransformers | | List getTransformers()(Code) | | Transformers are responsible for transforming data when it is received or
sent by the UMO (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 UMO 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 |
| isDeleteUnacceptedMessages | | boolean isDeleteUnacceptedMessages()(Code) | | 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 |
| isReadOnly | | boolean isReadOnly()(Code) | | true if this endpoint is read-only and none of it's properties canchange. Global endpoints should be read-only so that unexpectedbehaviour is avoided. |
| isRemoteSync | | boolean isRemoteSync()(Code) | | For certain providers that support the notion of a backchannel such as sockets
(outputStream) or Jms (ReplyTo) Mule can automatically wait for a response
from a backchannel when dispatching over these protocols. This is different
for synchronous as synchronous behavior only applies to in
|
| isSynchronous | | boolean isSynchronous()(Code) | | 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' |
|
|
|