org.mule.runtime.core.internal.connection

Class DefaultConnectionManager

java.lang.Object

org.mule.runtime.core.internal.connection.DefaultConnectionManager

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Disposable, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Lifecycle, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable, ConnectionManager, ConnectionManagerAdapter

public final class DefaultConnectionManager
extends Object
implements ConnectionManagerAdapter, org.mule.runtime.api.lifecycle.Lifecycle

Implementation of ConnectionManager which manages connections opened on a specific application.

Since:

4.0

Field Summary

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Stoppable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Disposable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
DefaultConnectionManager(MuleContext muleContext) Creates a new instance

Method Summary

Modifier and Type	Method and Description
<C> void	bind(Object owner, org.mule.runtime.api.connection.ConnectionProvider<C> connectionProvider) Binds the given config and connectionProvider so that the latter is used each time that the config is supplied as an argument of the ConnectionManager.getConnection(Object) method.
void	dispose()
<C> org.mule.runtime.api.connection.ConnectionHandler<C>	getConnection(Object config) Obtains a ConnectionHandler for a config which was previously bound through the ConnectionManager.bind(Object, ConnectionProvider) method.
org.mule.runtime.api.config.PoolingProfile	getDefaultPoolingProfile() When no PoolingProfile is specified by the user the ConnectionManagerAdapter will provide the default one to configure the pool of connections
RetryPolicyTemplate	getDefaultRetryPolicyTemplate() When no RetryPolicyTemplate is specified by the user the ConnectionManagerAdapter will provide the default one to create the required RetryPolicys instances.
<C> RetryPolicyTemplate	getRetryTemplateFor(org.mule.runtime.api.connection.ConnectionProvider<C> connectionProvider) Returns the RetryPolicyTemplate that should be applied to the given connectionProvider
boolean	hasBinding(Object config)
void	initialise()
void	start()
void	stop() Breaks all bindings and closes all connections
org.mule.runtime.api.connection.ConnectionValidationResult	testConnectivity(org.mule.runtime.extension.api.runtime.ConfigurationInstance configurationInstance) Tests connectivity for the given configurationInstance.
<C> org.mule.runtime.api.connection.ConnectionValidationResult	testConnectivity(org.mule.runtime.api.connection.ConnectionProvider<C> connectionProvider) Tests connectivity of the given connectionProvider.
void	unbind(Object config) Breaks the binding that was previously produced by invoking ConnectionManager.bind(Object, ConnectionProvider) with the given config on this instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultConnectionManager

@Inject
public DefaultConnectionManager(MuleContext muleContext)

Creates a new instance

Parameters:

muleContext - the MuleContext of the owned application

Method Detail

bind

public <C> void bind(Object owner,
                     org.mule.runtime.api.connection.ConnectionProvider<C> connectionProvider)

Binds the given config and connectionProvider so that the latter is used each time that the config is supplied as an argument of the ConnectionManager.getConnection(Object) method.

If a binding already exists for the config then this one replaces the previous one. All connections produced by the previous binding are closed.

Specified by:

bind in interface ConnectionManager

Type Parameters:

C - the generic type of the connections to be produced

Parameters:

owner - the config that acts as the binding key

connectionProvider - the ConnectionProvider that produces the connections

Throws:

IllegalStateException - if invoked while the muleContext is stopped or stopping

getRetryTemplateFor

public <C> RetryPolicyTemplate getRetryTemplateFor(org.mule.runtime.api.connection.ConnectionProvider<C> connectionProvider)

Returns the RetryPolicyTemplate that should be applied to the given connectionProvider

Specified by:

getRetryTemplateFor in interface ConnectionManagerAdapter

Type Parameters:

C - the generic type of the connection returned by the provider

Parameters:

connectionProvider - a ConnectionProvider

Returns:

a RetryPolicyTemplate

testConnectivity

public <C> org.mule.runtime.api.connection.ConnectionValidationResult testConnectivity(org.mule.runtime.api.connection.ConnectionProvider<C> connectionProvider)

Tests connectivity of the given connectionProvider.

The connectionProvider is expected to be fully initialised and functional. However, it is not required for it to have been registered through the ConnectionManager.bind(Object, ConnectionProvider) method.

Specified by:

testConnectivity in interface ConnectionManager

Type Parameters:

C - the generic type of the connections produced by the connectionProvider

Parameters:

connectionProvider - a ConnectionProvider

Returns:

a ConnectionValidationResult

testConnectivity

public org.mule.runtime.api.connection.ConnectionValidationResult testConnectivity(org.mule.runtime.extension.api.runtime.ConfigurationInstance configurationInstance)
                                                                            throws IllegalArgumentException

Tests connectivity for the given configurationInstance.

The connectionProvider is expected to be fully initialised and functional. It is not required for the config wrapped by the configurationInstance to have been registered through the ConnectionManager.bind(Object, ConnectionProvider) method. However, if it has been, then the test will be performed using the resources allocated by such registration.

Specified by:

testConnectivity in interface ConnectionManager

Parameters:

configurationInstance - a ConfigurationInstance

Returns:

a ConnectionValidationResult

Throws:

IllegalArgumentException - if the configurationInstance doesn't have an associated ConnectionProvider

hasBinding

public boolean hasBinding(Object config)

Specified by:

hasBinding in interface ConnectionManager

Parameters:

config - the config that acts as the binding key

Returns:

whether the config is currently bound to a ConnectionProvider

unbind

public void unbind(Object config)

Breaks the binding that was previously produced by invoking ConnectionManager.bind(Object, ConnectionProvider) with the given config on this instance.

All connections produced as a result of the broken binding are closed once they're released. Once all connections created with the previous ConnectionProvider are closed, the stop and dispose lifecycle phases are applied over the provider if necessary.

If no such binding exists no action is taken.

Specified by:

unbind in interface ConnectionManager

Parameters:

config - a config for which a binding is presumed to exists

getConnection

public <C> org.mule.runtime.api.connection.ConnectionHandler<C> getConnection(Object config)
                                                                       throws org.mule.runtime.api.connection.ConnectionException

Obtains a ConnectionHandler for a config which was previously bound through the ConnectionManager.bind(Object, ConnectionProvider) method.

This method does not guarantee if the returned connections are always different, reused, pooled, etc. That depends on the implementation of this interface and the implementation of the bounded ConnectionProvider.

Once the requester has finished using the obtained connection, it is MANDATORY for it to invoke the ConnectionHandler.release() method on it.

Specified by:

getConnection in interface ConnectionManager

Type Parameters:

C - the generic type of the returned connection

Parameters:

config - a config for which a binding has been established through ConnectionManager.bind(Object, ConnectionProvider)

Returns:

a ConnectionHandler wrapping the produced connection

Throws:

org.mule.runtime.api.connection.ConnectionException - if the conection could not be established or if no such binding exists for the config

stop

public void stop()
          throws org.mule.runtime.api.exception.MuleException

Breaks all bindings and closes all connections

Specified by:

stop in interface org.mule.runtime.api.lifecycle.Stoppable

Throws:

org.mule.runtime.api.exception.MuleException - in case of error.

dispose

public void dispose()

Specified by:

dispose in interface org.mule.runtime.api.lifecycle.Disposable

initialise

public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

start

public void start()
           throws org.mule.runtime.api.exception.MuleException

Specified by:

start in interface org.mule.runtime.api.lifecycle.Startable

Throws:

org.mule.runtime.api.exception.MuleException

getDefaultRetryPolicyTemplate

public RetryPolicyTemplate getDefaultRetryPolicyTemplate()

When no RetryPolicyTemplate is specified by the user the ConnectionManagerAdapter will provide the default one to create the required RetryPolicys instances.

Specified by:

getDefaultRetryPolicyTemplate in interface ConnectionManagerAdapter

Returns:

a RetryPolicyTemplate

getDefaultPoolingProfile

public org.mule.runtime.api.config.PoolingProfile getDefaultPoolingProfile()

When no PoolingProfile is specified by the user the ConnectionManagerAdapter will provide the default one to configure the pool of connections

Specified by:

getDefaultPoolingProfile in interface ConnectionManagerAdapter

Returns:

a PoolingProfile