io.r2dbc.mssql.message.tds

Class ProtocolException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.r2dbc.spi.R2dbcException

io.r2dbc.spi.R2dbcNonTransientException

io.r2dbc.spi.R2dbcNonTransientResourceException

io.r2dbc.mssql.message.tds.ProtocolException

All Implemented Interfaces:

Serializable

public final class ProtocolException
extends R2dbcNonTransientResourceException

Exception indicating unsupported or invalid protocol states. This exception is thrown in cases where e.g. the clients receives an invalid length, unexpected protocol frame or cannot decode a particular protocol frame. If a ProtocolException is thrown, then the underlying transport connection is closed.

Author:

Mark Paluch

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DRIVER_ERROR_FROM_DATABASE
static int	DRIVER_ERROR_INTERMITTENT_TLS_FAILED
static int	DRIVER_ERROR_INVALID_TDS
static int	DRIVER_ERROR_IO_FAILED
static int	DRIVER_ERROR_NONE
static int	DRIVER_ERROR_SSL_FAILED
static int	DRIVER_ERROR_UNSUPPORTED_CONFIG
static int	ERROR_QUERY_TIMEOUT
static int	ERROR_SOCKET_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
ProtocolException(String reason) Creates a new exception.
ProtocolException(String reason, int driverErrorCode) Creates a new exception.
ProtocolException(String reason, Throwable cause) Creates a new exception.
ProtocolException(String reason, Throwable cause, int driverErrorCode) Creates a new exception.

Method Summary

Modifier and Type	Method and Description
static ProtocolException	invalidTds(String reason) Create a new ProtocolException for invalid TDS.
static ProtocolException	unsupported(String reason) Create a new ProtocolException for an unsupported configuration.
static ProtocolException	unsupported(Throwable cause) Create a new ProtocolException for an unsupported configuration.

Methods inherited from class io.r2dbc.spi.R2dbcException

getErrorCode, getSql, getSqlState, toString

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Field Detail

DRIVER_ERROR_NONE

public static final int DRIVER_ERROR_NONE

See Also:

Constant Field Values

DRIVER_ERROR_FROM_DATABASE

public static final int DRIVER_ERROR_FROM_DATABASE

See Also:

Constant Field Values

DRIVER_ERROR_IO_FAILED

public static final int DRIVER_ERROR_IO_FAILED

See Also:

Constant Field Values

DRIVER_ERROR_INVALID_TDS

public static final int DRIVER_ERROR_INVALID_TDS

See Also:

Constant Field Values

DRIVER_ERROR_SSL_FAILED

public static final int DRIVER_ERROR_SSL_FAILED

See Also:

Constant Field Values

DRIVER_ERROR_UNSUPPORTED_CONFIG

public static final int DRIVER_ERROR_UNSUPPORTED_CONFIG

See Also:

Constant Field Values

DRIVER_ERROR_INTERMITTENT_TLS_FAILED

public static final int DRIVER_ERROR_INTERMITTENT_TLS_FAILED

See Also:

Constant Field Values

ERROR_SOCKET_TIMEOUT

public static final int ERROR_SOCKET_TIMEOUT

See Also:

Constant Field Values

ERROR_QUERY_TIMEOUT

public static final int ERROR_QUERY_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

ProtocolException

public ProtocolException(@Nullable
                         String reason)

Creates a new exception.

Parameters:

reason - the reason for the error. Set as the exception's message and retrieved with Throwable.getMessage().

ProtocolException

public ProtocolException(@Nullable
                         String reason,
                         int driverErrorCode)

Creates a new exception.

Parameters:

reason - the reason for the error. Set as the exception's message and retrieved with Throwable.getMessage().

driverErrorCode - the driver error code.

ProtocolException

public ProtocolException(@Nullable
                         String reason,
                         @Nullable
                         Throwable cause)

Creates a new exception.

Parameters:

reason - the reason for the error. Set as the exception's message and retrieved with Throwable.getMessage().

cause - the cause.

ProtocolException

public ProtocolException(@Nullable
                         String reason,
                         @Nullable
                         Throwable cause,
                         int driverErrorCode)

Creates a new exception.

Parameters:

reason - the reason for the error. Set as the exception's message and retrieved with Throwable.getMessage().

cause - the cause.

driverErrorCode - the driver error code.

Method Detail

invalidTds

public static ProtocolException invalidTds(String reason)

Create a new ProtocolException for invalid TDS.

Parameters:

reason - the reason for the error. Set as the exception's message and retrieved with Throwable.getMessage().

Returns:

the ProtocolException.

unsupported

public static ProtocolException unsupported(String reason)

Create a new ProtocolException for an unsupported configuration.

Parameters:

reason - the reason for the error. Set as the exception's message and retrieved with Throwable.getMessage().

Returns:

the ProtocolException.

unsupported

public static ProtocolException unsupported(Throwable cause)

Create a new ProtocolException for an unsupported configuration.

Parameters:

cause - the cause.

Returns:

the ProtocolException.