com.atlassian.sal.spring.connection

Class SpringHostConnectionAccessor

java.lang.Object

com.atlassian.sal.spring.connection.SpringHostConnectionAccessor

All Implemented Interfaces:

HostConnectionAccessor

public class SpringHostConnectionAccessor
extends Object
implements HostConnectionAccessor

Default implementation for spring environments.

Host should instantiate and export this.

Host must implement ConnectionProvider.

Since:

3.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SpringHostConnectionAccessor.ConnectionProvider Host specific implementation.

Constructor Summary

Constructors

Constructor and Description
SpringHostConnectionAccessor(SpringHostConnectionAccessor.ConnectionProvider connectionProvider, org.springframework.transaction.PlatformTransactionManager transactionManager)

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 HostConnectionAccessor.execute(boolean, boolean, ConnectionCallback)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpringHostConnectionAccessor

public SpringHostConnectionAccessor(@Nonnull
                                    SpringHostConnectionAccessor.ConnectionProvider connectionProvider,
                                    @Nonnull
                                    org.springframework.transaction.PlatformTransactionManager transactionManager)

Method Detail

execute

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

Description copied from interface: HostConnectionAccessor

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)

Specified by:

execute in interface HostConnectionAccessor

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
public io.atlassian.fugue.Option<String> getSchemaName()

Description copied from interface: HostConnectionAccessor

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

Specified by:

getSchemaName in interface HostConnectionAccessor

Returns:

schema name, if there is one