org.datanucleus.store.connection

Interface ConnectionFactory

All Known Implementing Classes:

AbstractConnectionFactory

public interface ConnectionFactory

Factory for connections to the datastore. To be implemented by all StoreManagers.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATANUCLEUS_CONNECTION_RESOURCE_TYPE User-visible configuration property name
static String	DATANUCLEUS_CONNECTION2_RESOURCE_TYPE User-visible configuration property name
static String	RESOURCE_TYPE_OPTION Internal property name used on ConnectionFactory instances, range of Values: JTA | RESOURCE_LOCAL

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Release any resources that have been allocated.
ManagedConnection	createManagedConnection(ExecutionContext ec, Map transactionOptions) Create the ManagedConnection.
ManagedConnection	getConnection(ExecutionContext ec, Transaction transaction, Map options) Obtain a connection from the Factory.

Field Detail

DATANUCLEUS_CONNECTION_RESOURCE_TYPE

static final String DATANUCLEUS_CONNECTION_RESOURCE_TYPE

User-visible configuration property name

See Also:

Constant Field Values

DATANUCLEUS_CONNECTION2_RESOURCE_TYPE

static final String DATANUCLEUS_CONNECTION2_RESOURCE_TYPE

User-visible configuration property name

See Also:

Constant Field Values

RESOURCE_TYPE_OPTION

static final String RESOURCE_TYPE_OPTION

Internal property name used on ConnectionFactory instances, range of Values: JTA | RESOURCE_LOCAL

See Also:

DATANUCLEUS_CONNECTION_RESOURCE_TYPE, DATANUCLEUS_CONNECTION2_RESOURCE_TYPE, Constant Field Values

Method Detail

getConnection

ManagedConnection getConnection(ExecutionContext ec,
                              Transaction transaction,
                              Map options)

Obtain a connection from the Factory. The connection will be enlisted within the transaction associated to the ExecutionContext if enlist set to true.

Parameters:

ec - ExecutionContext that the connection is bound to during its lifecycle (or null)

options - Any options for then creating the connection

Returns:

the ManagedConnection

createManagedConnection

ManagedConnection createManagedConnection(ExecutionContext ec,
                                        Map transactionOptions)

Create the ManagedConnection. Only used by ConnectionManager so do not call this.

Parameters:

ec - ExecutionContext that the connection is bound to during its lifecycle (if any)

transactionOptions - the Transaction options this connection will be enlisted to, null if non existent

Returns:

The ManagedConnection.

close

void close()

Release any resources that have been allocated.