Module org.mule.sdk.api

Package org.mule.sdk.api.connectivity

Interface ConnectionProvider<C>

Type Parameters:

C - the generic type of the connections to be handled

All Known Subinterfaces:

CachedConnectionProvider<C>, PoolingConnectionProvider<C>

@MinMuleVersion("4.5")
public interface ConnectionProvider<C>

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	Description
C	connect()	Creates a new connection.
void	disconnect(C connection)	Disposes the given connection, freeing all its allocated resources
ConnectionValidationResult	validate(C connection)	Validates the given ConnectionProvider.

Method Details

connect

C connect()
   throws org.mule.runtime.api.connection.ConnectionException

Creates a new connection.

The returned connection is expected to be ready to use

Returns:

a ready to use Connection

Throws:

org.mule.runtime.api.connection.ConnectionException

disconnect

void disconnect(C connection)

Disposes the given connection, freeing all its allocated resources

Parameters:

connection - a non null Connection.

validate

ConnectionValidationResult validate(C connection)

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

Parameters:

connection - a non null ConnectionProvider.

Returns:

a ConnectionValidationResult indicating if the connection is valid or not.