io.r2dbc.mssql.message.token

Class RpcRequest.Builder

java.lang.Object

io.r2dbc.mssql.message.token.RpcRequest.Builder

Enclosing class:

RpcRequest

public static final class RpcRequest.Builder
extends Object

Builder for RpcRequest.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
RpcRequest	build() Build a RpcRequest.
RpcRequest.Builder	withNamedParameter(io.r2dbc.mssql.codec.RpcDirection direction, String name, Collation collation, String value) Add a String parameter to this RPC call.
RpcRequest.Builder	withNamedParameter(io.r2dbc.mssql.codec.RpcDirection direction, String name, io.r2dbc.mssql.codec.Encoded value) Add an Encoded parameter to this RPC call.
RpcRequest.Builder	withNamedParameter(io.r2dbc.mssql.codec.RpcDirection direction, String name, Integer value) Add a Integer parameter to this RPC call.
RpcRequest.Builder	withOptionFlags(RpcRequest.OptionFlags optionFlags) Configure the RpcRequest.OptionFlags.
RpcRequest.Builder	withParameter(io.r2dbc.mssql.codec.RpcDirection direction, Collation collation, String value) Add a String parameter to this RPC call.
RpcRequest.Builder	withParameter(io.r2dbc.mssql.codec.RpcDirection direction, io.r2dbc.mssql.codec.Encoded value) Add an Encoded parameter to this RPC call.
RpcRequest.Builder	withParameter(io.r2dbc.mssql.codec.RpcDirection direction, Integer value) Add a Integer parameter to this RPC call.
RpcRequest.Builder	withProcId(int id) Configure a procedureId to call a pre-defined stored procedure.
RpcRequest.Builder	withProcName(String procName) Configure a procedure name.
RpcRequest.Builder	withTransactionDescriptor(io.r2dbc.mssql.message.TransactionDescriptor transactionDescriptor) Configure a TransactionDescriptor.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

withProcName

public RpcRequest.Builder withProcName(String procName)

Configure a procedure name.

Parameters:

procName - the name of the stored procedure to call.

Returns:

this RpcRequest.Builder.

withProcId

public RpcRequest.Builder withProcId(int id)

Configure a procedureId to call a pre-defined stored procedure.

Parameters:

id - the stored procedure Id. See RpcRequest.Sp_Cursor and other Sp_ constants.

Returns:

this RpcRequest.Builder.

withParameter

public RpcRequest.Builder withParameter(io.r2dbc.mssql.codec.RpcDirection direction,
                                        Collation collation,
                                        @Nullable
                                        String value)

Add a String parameter to this RPC call.

Parameters:

direction - RPC parameter direction (in/out).

collation - parameter encoding.

value - the parameter value, can be null.

Returns:

this RpcRequest.Builder.

Throws:

IllegalArgumentException - when RpcDirection or Collation is null.

withParameter

public RpcRequest.Builder withParameter(io.r2dbc.mssql.codec.RpcDirection direction,
                                        @Nullable
                                        Integer value)

Add a Integer parameter to this RPC call.

Parameters:

direction - RPC parameter direction (in/out).

value - the parameter value, can be null.

Returns:

this RpcRequest.Builder.

Throws:

IllegalArgumentException - when RpcDirection is null.

withParameter

public RpcRequest.Builder withParameter(io.r2dbc.mssql.codec.RpcDirection direction,
                                        io.r2dbc.mssql.codec.Encoded value)

Add an Encoded parameter to this RPC call.

Parameters:

direction - RPC parameter direction (in/out).

value - the parameter value.

Returns:

this RpcRequest.Builder.

Throws:

IllegalArgumentException - when RpcDirection or Encoded is null.

withNamedParameter

public RpcRequest.Builder withNamedParameter(io.r2dbc.mssql.codec.RpcDirection direction,
                                             String name,
                                             Collation collation,
                                             @Nullable
                                             String value)

Add a String parameter to this RPC call.

Parameters:

direction - RPC parameter direction (in/out).

name - the parameter name

collation - parameter encoding.

value - the parameter value, can be null.

Returns:

this RpcRequest.Builder.

Throws:

IllegalArgumentException - when RpcDirection, name or Collation is null.

withNamedParameter

public RpcRequest.Builder withNamedParameter(io.r2dbc.mssql.codec.RpcDirection direction,
                                             String name,
                                             @Nullable
                                             Integer value)

Add a Integer parameter to this RPC call.

Parameters:

direction - RPC parameter direction (in/out).

name - the parameter name

value - the parameter value, can be null.

Returns:

this RpcRequest.Builder.

Throws:

IllegalArgumentException - when RpcDirection or name is null.

withNamedParameter

public RpcRequest.Builder withNamedParameter(io.r2dbc.mssql.codec.RpcDirection direction,
                                             String name,
                                             io.r2dbc.mssql.codec.Encoded value)

Add an Encoded parameter to this RPC call.

Parameters:

direction - RPC parameter direction (in/out).

name - the parameter name

value - the parameter value.

Returns:

this RpcRequest.Builder.

Throws:

IllegalArgumentException - when RpcDirection, name, or Encoded is null.

withTransactionDescriptor

public RpcRequest.Builder withTransactionDescriptor(io.r2dbc.mssql.message.TransactionDescriptor transactionDescriptor)

Configure a TransactionDescriptor.

Parameters:

transactionDescriptor - the transaction descriptor.

Returns:

this RpcRequest.Builder.

Throws:

IllegalArgumentException - when TransactionDescriptor is null.

withOptionFlags

public RpcRequest.Builder withOptionFlags(RpcRequest.OptionFlags optionFlags)

Configure the RpcRequest.OptionFlags.

Parameters:

optionFlags - the option flags to use.

Returns:

this RpcRequest.Builder.

Throws:

IllegalArgumentException - when RpcRequest.OptionFlags is null.

build

public RpcRequest build()

Build a RpcRequest.

Returns:

a new RpcRequest.

Throws:

IllegalStateException - when TransactionDescriptor or procedure name/id are not configured.