Module com.aoapps.sql.failfast

Package com.aoapps.sql.failfast

Interface FailFastConnection

All Superinterfaces:

AutoCloseable, Connection, Wrapper, Wrapper

All Known Implementing Classes:

FailFastConnectionImpl

public interface FailFastConnection
extends Wrapper, Connection

Makes a Connection perform in a fail-fast manner. All access to the connection will fail once a Throwable has been thrown by the underlying driver, with this state only being cleared by rollback.

Author:

AO Industries, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	FailFastConnection.State	The set of possible fail-fast states.

Field Summary

Fields inherited from interface java.sql.Connection

TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE

Method Summary

Modifier and Type	Method	Description
void	abort(Executor executor)	Puts the connection into a terminal AbortedSQLException fail-fast state then calls FailFastConnectionImpl.doAbort(java.lang.Throwable, java.util.concurrent.Executor).
void	addFailFastCause(Throwable cause)	Registers a cause for the current failure.
Throwable	clearFailFast()	Clears the cause of the current fail-fast state.
void	close()	Puts the connection into a terminal ClosedSQLException fail-fast state then calls FailFastConnectionImpl.doClose(java.lang.Throwable).
Throwable	getFailFastCause()	Gets the cause of the current fail-fast state.
FailFastConnection.State	getFailFastState()	Gets the current fail-fail state.
Connection	getWrapped()	Gets the connection that is wrapped.
void	rollback()	When not in a terminal fail-fast state, will clear the fail-fast state upon a successful call to super.rollback().
void	rollback(Savepoint savepoint)	When not in a terminal fail-fast state, will clear the fail-fast state upon a successful call to super.rollback(savepoint).

Methods inherited from interface java.sql.Connection

beginRequest, clearWarnings, commit, createArrayOf, createBlob, createClob, createNClob, createSQLXML, createStatement, createStatement, createStatement, createStruct, endRequest, getAutoCommit, getCatalog, getClientInfo, getClientInfo, getHoldability, getMetaData, getNetworkTimeout, getSchema, getTransactionIsolation, getTypeMap, getWarnings, isClosed, isReadOnly, isValid, nativeSQL, prepareCall, prepareCall, prepareCall, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, releaseSavepoint, setAutoCommit, setCatalog, setClientInfo, setClientInfo, setHoldability, setNetworkTimeout, setReadOnly, setSavepoint, setSavepoint, setSchema, setShardingKey, setShardingKey, setShardingKeyIfValid, setShardingKeyIfValid, setTransactionIsolation, setTypeMap

Methods inherited from interface com.aoapps.sql.wrapper.Wrapper

isWrapperFor, unwrap

Method Details

getWrapped

Connection getWrapped()

Gets the connection that is wrapped.

Specified by:

getWrapped in interface Wrapper

addFailFastCause

void addFailFastCause(Throwable cause)

Registers a cause for the current failure. Multiple causes are merged in the following order:

1. TerminalSQLException take highest precedence, since these are non-recoverable.
2. All other Throwable are next precedence. These might be recoverable through rollback() or rollback(java.sql.Savepoint).

Higher precedence causes will suppress any existing cause of a lower precedence (new adds the current as suppressed).

Lower precedence causes will be suppressed by any existing cause of higher precedence (current adds the new as suppressed).

Causes within the same precedence are merged via Throwables.addSuppressed(java.lang.Throwable, java.lang.Throwable).

Parameters:

cause - The additional cause, ignored when null

getFailFastCause

Throwable getFailFastCause()

Gets the cause of the current fail-fast state.

This might involve creating a new exception, so getFailFastState() may be faster when the exact cause is not required.

Returns:

The cause or null when not in failure state (operating normally).

See Also:

• getFailFastState()

getFailFastState

FailFastConnection.State getFailFastState()

Gets the current fail-fail state.

Returns:

The state or FailFastConnection.State.OK when not in failure state (operating normally).

See Also:

• getFailFastCause()

clearFailFast

Throwable clearFailFast()
                 throws TerminalSQLException

Clears the cause of the current fail-fast state. This will typically be invoked automatically during one of the following successful operations:

1. Connection.rollback()
2. Connection.rollback(java.sql.Savepoint)

Returns:

The cause or null when was not in failure state (operating normally).

Throws:

TerminalSQLException - if the connection is in a terminal fail-fast state, such as closed or aborted.

See Also:

• getFailFastCause()

rollback

void rollback()
       throws TerminalSQLException,
SQLException

When not in a terminal fail-fast state, will clear the fail-fast state upon a successful call to super.rollback().

Specified by:

rollback in interface Connection

Throws:

TerminalSQLException - if already in a terminal fail-fast state

SQLException - if any other failure occurs during rollback

close

void close()
    throws SQLException

Puts the connection into a terminal ClosedSQLException fail-fast state then calls FailFastConnectionImpl.doClose(java.lang.Throwable).

When already in a terminal state (closed or aborted), is a no-op and does not call FailFastConnectionImpl.doClose(java.lang.Throwable).

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Connection

Throws:

SQLException

See Also:

• addFailFastCause(java.lang.Throwable)
• ClosedSQLException
• FailFastConnectionImpl.doClose(java.lang.Throwable)

rollback

void rollback(Savepoint savepoint)
       throws TerminalSQLException,
SQLException

When not in a terminal fail-fast state, will clear the fail-fast state upon a successful call to super.rollback(savepoint).

Specified by:

rollback in interface Connection

Throws:

FailFastSQLException - if already in a terminal fail-fast state

SQLException - if any other failure occurs during rollback

TerminalSQLException

abort

void abort(Executor executor)
    throws SQLException

Puts the connection into a terminal AbortedSQLException fail-fast state then calls FailFastConnectionImpl.doAbort(java.lang.Throwable, java.util.concurrent.Executor).

When already in a terminal state (closed or aborted), is a no-op and does not call FailFastConnectionImpl.doAbort(java.lang.Throwable, java.util.concurrent.Executor)

Specified by:

abort in interface Connection

Throws:

SQLException

See Also:

• addFailFastCause(java.lang.Throwable)
• AbortedSQLException
• FailFastConnectionImpl.doAbort(java.lang.Throwable, java.util.concurrent.Executor)