Contact Us 1-800-596-4880
  1. Homepage
  2. Mule Runtime (3.9)
  3. Reference
  4. Transports Reference
  5. Connecting Using Transports

  6. Configuring a Transport

Configuring a Transport

You can configure a transport in the following ways:

  • Define a connector configuration using the <connector> element in the Mule XML configuration file.

  • Set transport properties on endpoints to customize the transport behavior for a single endpoint instance.

  • Use an endpoint URI that defines the scheme and connection information for the transport, such as tcp://localhost:12345. See Mule Endpoint URIs for more information. The URI consists of the protocol followed by transport-specific information, and then zero or more parameters to set as properties on the connector.

This page describes the common properties for all transports. The actual configuration parameters for each transport type are described separately for each transport. To see the details of a specific transport, see Transports Reference.

Common Connector Properties

All connectors require that you set the name attribute to a unique name for that connector. Additionally, they all include the following common properties.

Property Description Default Required

default-connector-exception-strategy

The exception strategy to use when errors occur in the connector.

No

receiver-threading-profile

The threading properties and WorkManager to use when receiving events from the connector.

The default receiver threading profile set on the Mule Configuration

Yes

dispatcher-threading-profile

The threading properties and WorkManager to use when dispatching events from the connector.

The default dispatcher threading profile set on the Mule Configuration.

Yes

connection-strategy

Desupported as of Mule 2.0. Use retry policies instead.

No

service-overrides

A map of service configuration values that can be used to override the default configuration for this transport.

No

createMultipleTransactedReceivers

Only used for inbound endpoints with a configured transaction. Creates multiple concurrent receivers, that extend TransactedPollingMessageReceiver, for this connector. Inbound endpoints support having multiple receivers that pull messages concurrently, providing better throughput.

false

No

numberOfConcurrentTransactedReceivers

If createMultipleTransactedReceivers is set to true, defines the number of concurrent receivers that is launched.
For example, consider a VM transport configured with numberOfConcurrentTransactedReceivers set to 3. This endpoint launches three processes that concurrently consume messages from the queue and send them to the flow.

No

dynamicNotification

Whether to enable dynamic notification.

false

No

validateConnections

Causes Mule to validate connections before use. Note that this is only a configuration hint; transport implementations may or may not make an extra effort to validate the connection.

true

No

Setting Spring Properties on Connectors

You can also set a Spring property on a connector. This is especially useful if you are using a custom connector.

For example, you can set a Spring property to define the maximum time a socket will be left open on a TCP or HTTP connector, regardless of what happens with the client or data transfer from the client. To do this, include a Spring property to define a value for the keepAliveTimeout property, as shown:

xmlns:spring="http://www.springframework.org/schema/beans"
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-current.xsd

...

  <http:connector name="httpConnector">
        <spring:property name="keepAliveTimeout" value="5000" />
  </http:connector>

Note that this keepAliveTimeout example is only relevant for the TCP and HTTP connectors and may not work with other connectors.

See Using Mule with Spring for information on setting Spring properties.

Retry Policies

Retry policies are used to configure how a connector behaves when its connection fails. For complete information, see Configuring Reconnection Strategies.

Creating Your Own Transport

For information on creating a custom transport for Mule, see Creating Transports.

Detailed Configuration Information

Receiver Threading Profile

The threading profile to use when a connector receives messages.

Attributes of <receiver-threading-profile…​>

Name Type Required Default Description

maxThreadsActive

integer

no

The maximum number of threads to use.

maxThreadsIdle

integer

no

The maximum number of idle or inactive threads that can be in the pool before they are destroyed.

threadTTL

integer

no

Determines how long an inactive thread is kept in the pool before being discarded.

poolExhaustedAction

WAIT, DISCARD, DISCARD_OLDEST, ABORT, RUN

no

When the maximum pool size or queue size is bounded, this value determines how to handle incoming tasks.

Possible values are:

  • WAIT - Wait until a thread becomes available; don’t use this value if the minimum number of threads is zero, in which case a thread may never become available.

  • DISCARD - Throw away the current request and return.

  • DISCARD_OLDEST - Throw away the oldest request and return.

  • ABORT - Throw a RuntimeException.

  • RUN - The default; the thread making the execute request runs the task itself, which helps guard against lockup.

threadWaitTimeout

integer

no

How long to wait in milliseconds when the pool exhausted action is WAIT. If the value is negative, it will wait indefinitely.

maxBufferSize

integer

no

Determines how many requests are queued when the pool is at maximum usage capacity and the pool exhausted action is WAIT. The buffer is used as an overflow.

doThreading

boolean

no

true

Whether threading should be used (default is true).

Dispatcher Threading Profile

The threading profile to use when a connector dispatches messages.

Attributes of <dispatcher-threading-profile…​>

Name Type Required Default Description

maxThreadsActive

integer

no

The maximum number of threads to use.

maxThreadsIdle

integer

no

The maximum number of idle or inactive threads that can be in the pool before they are destroyed.

threadTTL

integer

no

Determines how long an inactive thread is kept in the pool before being discarded.

poolExhaustedAction

WAIT, DISCARD, DISCARD_OLDEST, ABORT, RUN

no

When the maximum pool size or queue size is bounded, this value determines how to handle incoming tasks.

Possible values are:

  • WAIT - Wait until a thread becomes available; don’t use this value if the minimum number of threads is zero, in which case a thread may never become available.

  • DISCARD - Throw away the current request and return.

  • DISCARD_OLDEST - Throw away the oldest request and return.

  • ABORT - Throw a RuntimeException.

  • RUN - The default; the thread making the execute request runs the task itself, which helps guard against lockup.

threadWaitTimeout

integer

no

How long to wait in milliseconds when the pool exhausted action is WAIT. If the value is negative, it will wait indefinitely.

maxBufferSize

integer

no

Determines how many requests are queued when the pool is at maximum usage capacity and the pool exhausted action is WAIT. The buffer is used as an overflow.

doThreading

boolean

no

true

Whether threading should be used (default is true).

Service Overrides

Service overrides allow the connector to be further configured/customized by allowing parts of the transport implementation to be overridden, for example, the message receiver or dispatcher implementation, or the message adaptor that is used.

Attributes of <service-overrides…​>

Name Type Required Default Description

messageReceiver

string

no

transactedMessageReceiver

string

no

xaTransactedMessageReceiver

string

no

dispatcherFactory

string

no

inboundTransformer

string

no

outboundTransformer

string

no

responseTransformer

string

no

endpointBuilder

string

no

messageFactory

string

no

serviceFinder

string

no

sessionHandler

string

no

inboundExchangePatterns

string

no

outboundExchangePatterns

string

no