io.r2dbc.mssql.message.token

Class Prelogin

java.lang.Object

io.r2dbc.mssql.message.token.Prelogin

All Implemented Interfaces:

io.r2dbc.mssql.message.ClientMessage, io.r2dbc.mssql.message.Message, TokenStream

public final class Prelogin
extends Object
implements TokenStream, io.r2dbc.mssql.message.ClientMessage

Stream structure for PRELOGIN.

Author:

Mark Paluch

See Also:

Prelogin.Token

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Prelogin.Builder Builder for Prelogin.
static class	Prelogin.Encryption Allows negotiation of the used encryption (Transport-Level Encryption via SSL) mode.
static class	Prelogin.InstanceValidation Allows validating a remote SQL server instance.
static class	Prelogin.Terminator Terminating token indicating the end of prelogin tokens.
static class	Prelogin.ThreadId Token that allows associating a client application Thread Id with the connection.
static class	Prelogin.Token Pre-Login Token.
static class	Prelogin.TraceId TraceId token that allows associating a connectionId/activityId with the connection.
static class	Prelogin.UnknownToken Token placeholder that consumes unknown tokens.
static class	Prelogin.Version Version information representing the SQL server version.

Constructor Summary

Constructors

Constructor and Description
Prelogin(List<? extends Prelogin.Token> tokens) Create a new Prelogin given List of Prelogin.Token.

Method Summary

Modifier and Type	Method and Description
static Prelogin.Builder	builder()
static Prelogin	decode(io.netty.buffer.ByteBuf buffer) Decode the Prelogin response from a ByteBuf.
TdsFragment	encode(io.netty.buffer.ByteBufAllocator allocator, int packetSize) Encode a message into a data buffer.
boolean	equals(Object o)
String	getName()
<T extends Prelogin.Token> T	getRequiredToken(Class<? extends T> tokenType) Resolve a Prelogin.Token given its type.
<T extends Prelogin.Token> Optional<T>	getToken(Class<? extends T> tokenType) Resolve a Prelogin.Token given its type.
List<? extends Prelogin.Token>	getTokens()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Prelogin

public Prelogin(List<? extends Prelogin.Token> tokens)

Create a new Prelogin given List of Prelogin.Token.

Parameters:

tokens - must not be null.

Method Detail

builder

public static Prelogin.Builder builder()

Returns:

a new builder for Prelogin.

decode

public static Prelogin decode(io.netty.buffer.ByteBuf buffer)

Decode the Prelogin response from a ByteBuf.

Parameters:

buffer - must not be null.

Returns:

the decoded Prelogin response Message.

getTokens

public List<? extends Prelogin.Token> getTokens()

Returns:

the tokens.

getToken

public <T extends Prelogin.Token> Optional<T> getToken(Class<? extends T> tokenType)

Resolve a Prelogin.Token given its type.

Type Parameters:

T - token type.

Parameters:

tokenType - the type to filter.

Returns:

Optional containing the potentially found tokenType.

getRequiredToken

public <T extends Prelogin.Token> T getRequiredToken(Class<? extends T> tokenType)

Resolve a Prelogin.Token given its type.

Type Parameters:

T - token type.

Parameters:

tokenType - the type to filter.

Returns:

the token of type tokenType.

Throws:

NoSuchElementException - if the token could not be found.

getName

public String getName()

Specified by:

getName in interface TokenStream

Returns:

symbolic name of the TokenStream.

encode

public TdsFragment encode(io.netty.buffer.ByteBufAllocator allocator,
                          int packetSize)

Description copied from interface: io.r2dbc.mssql.message.ClientMessage

Encode a message into a data buffer. Can encode either to a scalar TdsFragment or a Publisher of TdsFragment.

Specified by:

encode in interface io.r2dbc.mssql.message.ClientMessage

Parameters:

allocator - the ByteBufAllocator to use to get a data buffer to write into.

packetSize - packet size hint.

Returns:

a scalar TdsFragment or a Publisher that produces the TdsFragment containing the encoded message.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object