org.mule.runtime.api.connection

Interface ConnectionProvider<Connection>

Type Parameters:

Connection - the generic type of the connections to be handled

public interface ConnectionProvider<Connection>

Handles connections of the generic Connection type, which are created from a configuration object of the generic type Config.

Providers centralize the logic and parametrization to provision and release connection, while remaining abstracted from the concerns of actually manage those connections.

Implementations are expected to be reusable and thread-safe.

It is valid for implementations to implement any of the lifecycle interfaces or to request external dependencies through any of the JSR-330 annotations. However, implementations are not propagate lifecycle or to perform dependency injection into the generated connections. The runtime will do that automatically at the proper time.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
Connection	connect() Creates a new connection.
void	disconnect(Connection connection) Disposes the given connection, freeing all its allocated resources
ConnectionHandlingStrategy<Connection>	getHandlingStrategy(ConnectionHandlingStrategyFactory<Connection> handlingStrategyFactory) Specifies the ConnectionHandlingStrategy that should be use to manage the connections generated through the connect() method.
ConnectionValidationResult	validate(Connection connection) Validates the given Connection.

Method Detail

connect

Connection connect()
            throws ConnectionException

Creates a new connection.

The returned connection is expected to be ready to use

Returns:

a ready to use Connection

Throws:

ConnectionException

disconnect

void disconnect(Connection connection)

Disposes the given connection, freeing all its allocated resources

Parameters:

connection - a non null Connection.

validate

ConnectionValidationResult validate(Connection connection)

Validates the given Connection. In invalid connection case, the ConnectionValidationResult should also return a valid message ConnectionValidationResult.getMessage(), exception ConnectionValidationResult.getException() and code ConnectionValidationResult.getCode()

Parameters:

connection - a non null Connection.

Returns:

a ConnectionValidationResult indicating if the connection is valid or not.

getHandlingStrategy

ConnectionHandlingStrategy<Connection> getHandlingStrategy(ConnectionHandlingStrategyFactory<Connection> handlingStrategyFactory)

Specifies the ConnectionHandlingStrategy that should be use to manage the connections generated through the connect() method.

Implementations MUST return instances created through the provided handlingStrategyFactory. Those instances are not to be wrapped, decorated, or by any other means tampered with.

This method must also function correctly without dependencies or preconditions. That means that although it is valid for this provider to have lifecycle or external dependencies injected, this particular method must behave correctly on every possible state.

Parameters:

handlingStrategyFactory - the ConnectionHandlingStrategyFactory to be used to generate the response value

Returns:

a not null ConnectionHandlingStrategy