org.mule.runtime.api.connection

Interface ConnectionHandler<T>

Type Parameters:

T - the generic type of the connection being wrapped by each individual instance

public interface ConnectionHandler<T>

Represents a connection that is being managed by the runtime.

This is actually a wrapper which provides an unique API for managing connections of different types and using different policies. For example, clients of this API will use the getConnection() method to obtain the actual connection that's been managed, without independently of the connection being pooled, cached, lazy, validated, reconnected, etc.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
T	getConnection() Returns the connection that's being wrapped.
void	release() When a component requests an instance of this interface, it becomes obligated to invoke this method after it no longer requires such instance.

Method Detail

getConnection

T getConnection()
         throws ConnectionException

Returns the connection that's being wrapped. The actual implications of invoking this method depends on the implementation.

No guarantees are offered regarding how this method provisions the connection. The only commitment this method takes is that it will either provide a connection ready to be used or throw a ConnectionException

Returns:

a ready to use connection

Throws:

ConnectionException - if a valid connection could not be obtained

release

void release()

When a component requests an instance of this interface, it becomes obligated to invoke this method after it no longer requires such instance.

Just like with getConnection(), the implications of executing this method are not guaranteed. Depending on the implementation, the connection could be closed, returned to a pooled, recycled, etc. It is not to be assumed that any resources allocated by the wrapped connection will be freed after invoking this method.

The only strong piece on the contract is the user's obligation to invoke this method once it's done with the instance