io.r2dbc.mssql.message.token

Class Prelogin.Encryption

java.lang.Object

io.r2dbc.mssql.message.token.Prelogin.Token

io.r2dbc.mssql.message.token.Prelogin.Encryption

Enclosing class:

Prelogin

public static class Prelogin.Encryption
extends Prelogin.Token

Allows negotiation of the used encryption (Transport-Level Encryption via SSL) mode.

Field Summary

Fields

Modifier and Type	Field and Description
static byte	ENCRYPT_NOT_SUP Encryption not supported.
static byte	ENCRYPT_OFF Disabled encryption but enabled/required for login with credentials.
static byte	ENCRYPT_ON Encryption enabled.
static byte	ENCRYPT_REQ Encryption required.
static byte	TYPE

Constructor Summary

Constructors

Constructor and Description
Encryption(byte encryption) Create a new Prelogin.Encryption token.

Method Summary

Modifier and Type	Method and Description
static Prelogin.Encryption	decode(io.r2dbc.mssql.message.token.Prelogin.TokenDecodingState toDecode) Decode the Prelogin.Encryption token.
void	encodeStream(io.netty.buffer.ByteBuf buffer)
byte	getEncryption()
boolean	requiresConnectionSslHandshake() Returns true if a SSL handshake is required to enable SSL for the entire connection.
boolean	requiresLoginSslHandshake() Returns true if a SSL handshake is required to enable SSL for sending the Login packet only.
boolean	requiresSslHandshake() Returns true if the subsequent communication requires a SSL handshake.
String	toString()

Methods inherited from class io.r2dbc.mssql.message.token.Prelogin.Token

encodeToken

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final byte TYPE

See Also:

Constant Field Values

ENCRYPT_OFF

public static final byte ENCRYPT_OFF

Disabled encryption but enabled/required for login with credentials.

See Also:

Constant Field Values

ENCRYPT_ON

public static final byte ENCRYPT_ON

Encryption enabled.

See Also:

Constant Field Values

ENCRYPT_NOT_SUP

public static final byte ENCRYPT_NOT_SUP

Encryption not supported.

See Also:

Constant Field Values

ENCRYPT_REQ

public static final byte ENCRYPT_REQ

Encryption required.

See Also:

Constant Field Values

Constructor Detail

Encryption

public Encryption(byte encryption)

Create a new Prelogin.Encryption token.

Parameters:

encryption - encryption capability flag.

Method Detail

decode

public static Prelogin.Encryption decode(io.r2dbc.mssql.message.token.Prelogin.TokenDecodingState toDecode)

Decode the Prelogin.Encryption token.

Parameters:

toDecode - the state to decode.

Returns:

the decoded Prelogin.Encryption.

getEncryption

public byte getEncryption()

encodeStream

public void encodeStream(io.netty.buffer.ByteBuf buffer)

Specified by:

encodeStream in class Prelogin.Token

requiresSslHandshake

public boolean requiresSslHandshake()

Returns true if the subsequent communication requires a SSL handshake.

Returns:

true if the subsequent communication requires a SSL handshake.

requiresLoginSslHandshake

public boolean requiresLoginSslHandshake()

Returns true if a SSL handshake is required to enable SSL for sending the Login packet only.

Returns:

true if a SSL handshake is required to enable SSL for sending the Login packet only.

requiresConnectionSslHandshake

public boolean requiresConnectionSslHandshake()

Returns true if a SSL handshake is required to enable SSL for the entire connection.

Returns:

true if a SSL handshake is required to enable SSL for the entire connection.

toString

public String toString()

Overrides:

toString in class Object