com.atlassian.sal.spi

Interface HostConnectionAccessor

All Known Implementing Classes:

SpringHostConnectionAccessor

public interface HostConnectionAccessor

Interface allowing SAL to execute a callback with a Connection, in the context of a transaction. Host must export this. Host must implement this; may use com.atlassian.sal.spring.connection.SpringHostConnectionAccessor

Since:

3.0

Method Summary

Modifier and Type	Method and Description
<A> A	execute(boolean readOnly, boolean newTransaction, ConnectionCallback<A> callback) Execute a callback which is supplied a Connection, within a transaction.
io.atlassian.fugue.Option<String>	getSchemaName() Returns the configured schema name (if any), for connections provided during execute(boolean, boolean, ConnectionCallback)

Method Detail

execute

<A> A execute(boolean readOnly,
              boolean newTransaction,
              @Nonnull
              ConnectionCallback<A> callback)

Execute a callback which is supplied a Connection, within a transaction. It is up to the caller as to whether it attempts to participate in an existing transaction. This is explicitly explained in TransactionalExecutor. In the case of the callback returning normally:

• If it is a new connection/transaction that the implementation started then the transaction must be committed, or
• In the case of an existing transaction, the implementation will do nothing and wait for the larger transaction to be committed

In the case of the callback throwing a RuntimeException:

• The implementation will mark the transaction as "rollback only" and rethrow the error

The host must ensure that the Connection provided to the ConnectionCallback has autoCommit=false. The following methods are guaranteed not to be called on connection: Connection.setAutoCommit(boolean) Connection.commit() Connection.close() Connection.rollback() Connection.setReadOnly(boolean) Connection.abort(java.util.concurrent.Executor) Connection.setCatalog(String) Connection.setSchema(String) Connection.setTransactionIsolation(int) Connection.setNetworkTimeout(java.util.concurrent.Executor, int)

Parameters:

readOnly - connection should be read only

newTransaction - attempt to create a new transaction even if there is already a "current" transaction

callback - mandatory

Returns:

return value of callback

getSchemaName

@Nonnull
io.atlassian.fugue.Option<String> getSchemaName()

Returns the configured schema name (if any), for connections provided during execute(boolean, boolean, ConnectionCallback)

Returns:

schema name, if there is one