AbstractEndpoint (Mule ESB 2.2.1 API)
Keywords: org.mule.endpoint.AbstractEndpoint class

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.mule.endpoint
Class AbstractEndpoint

    java.lang.Object
      org.mule.endpoint.AbstractEndpoint

All Implemented Interfaces:
  Serializable, ImmutableEndpoint

Direct Known Subclasses:
  DefaultInboundEndpoint, DefaultOutboundEndpoint

    public abstract class AbstractEndpoint

extends Object
implements ImmutableEndpoint

`ImmutableMuleEndpoint` describes a Provider in the Mule Server. A endpoint is a grouping of an endpoint, an endpointUri and a transformer.

See Also:
  Serialized Form

Field Summary
`protected static Log` | `logger` logger used by this class
`protected RetryPolicyTemplate` | `retryPolicyTemplate`

Fields inherited from interface org.mule.api.endpoint.ImmutableEndpoint
`INITIAL_STATE_STARTED, INITIAL_STATE_STOPPED`

Constructor Summary
`AbstractEndpoint(Connector connector, EndpointURI endpointUri, List transformers, List responseTransformers, String name, Map properties, TransactionConfig transactionConfig, Filter filter, boolean deleteUnacceptedMessages, EndpointSecurityFilter securityFilter, boolean synchronous, int responseTimeout, String initialState, String endpointEncoding, String endpointBuilderName, MuleContext muleContext, RetryPolicyTemplate retryPolicyTemplate)`

Method Summary
`protected static boolean` | `equal(Object a, Object b)`
`boolean` | `equals(Object obj)`
`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.
`Filter` | `getFilter()` The filter to apply to incoming messages.
`String` | `getInitialState()` Sets the state the endpoint will be loaded in.
`MuleContext` | `getMuleContext()`
`String` | `getName()` The name is the identifier for the endpoint
`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.
`int` | `getResponseTimeout()` The timeout value for remoteSync invocations
`List` | `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` | `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` | `isReadOnly()`
`boolean` | `isSynchronous()` Determines if requests originating from this endpoint should be synchronous i.e.
`String` | `toString()`
`protected void` | `updateTransformerEndpoints(List transformers)`

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

Field Detail

### logger

    protected static final Log logger

  logger used by this class

### retryPolicyTemplate

    protected RetryPolicyTemplate retryPolicyTemplate

Constructor Detail

### AbstractEndpoint

    public AbstractEndpoint(Connector connector,
                            EndpointURI endpointUri,
                            List transformers,
                            List responseTransformers,
                            String name,
                            Map properties,
                            TransactionConfig transactionConfig,
                            Filter filter,
                            boolean deleteUnacceptedMessages,
                            EndpointSecurityFilter securityFilter,
                            boolean synchronous,
                            int responseTimeout,
                            String initialState,
                            String endpointEncoding,
                            String endpointBuilderName,
                            MuleContext muleContext,
                            RetryPolicyTemplate retryPolicyTemplate)

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

### 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

### 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

### getName

    public String getName()

  Description copied from interface: `ImmutableEndpoint`
  The name is the identifier for the endpoint

  Specified by:
    `getName` in interface `ImmutableEndpoint`
  Returns:
    the endpoint name

### getTransformers

    public List 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

### 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

### 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.

### toString

    public String toString()

  Overrides:
    `toString` in class `Object`

### 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

### 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

### equal

    protected static boolean equal(Object a,
                                   Object b)

### equals

    public boolean equals(Object obj)

  Overrides:
    `equals` in class `Object`

### hashCode

    public int hashCode()

  Overrides:
    `hashCode` in class `Object`

### 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

### 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

### updateTransformerEndpoints

    protected void updateTransformerEndpoints(List transformers)

### getSecurityFilter

    public EndpointSecurityFilter getSecurityFilter()

  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`

### isSynchronous

    public boolean isSynchronous()

  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'

  Specified by:
    `isSynchronous` in interface `ImmutableEndpoint`
  Returns:
    whether requests on this endpoint should execute in a single thread. This property is only used when the endpoint is of type 'receiver'

### getResponseTimeout

    public int getResponseTimeout()

  The timeout value for remoteSync invocations

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

### getInitialState

    public String getInitialState()

  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

### getResponseTransformers

    public List 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

### 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

### getMuleContext

    public MuleContext getMuleContext()

  Specified by:
    `getMuleContext` in interface `ImmutableEndpoint`

### 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

### 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`
  Returns:

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2003-2009 MuleSource, Inc.. All Rights Reserved.