org.firebirdsql.gds
Interface ServiceParameterBuffer


public interface ServiceParameterBuffer

Instance of this interface represents a Service Parameter Buffer from the Firebird API documentation and specifies the attributes for the Services API connection.


Field Summary
static int COMMAND_LINE
           
static int CONNECT_TIMEOUT
           
static int CURRENT_VERSION
           
static int DBNAME
           
static int DUMMY_PACKET_INTERVAL
           
static int OPTIONS
           
static int PASSWORD
           
static int PASSWORD_ENC
           
static int SQL_ROLE_NAME
           
static int SYS_USER_NAME
           
static int SYS_USER_NAME_ENC
           
static int USER_NAME
           
static int VERBOSE
           
static int VERSION
           
static int VERSION1
           
 
Method Summary
 void addArgument(int argumentType)
          Set a void (valueless) parameter on this ServiceParameterBuffer.
 void addArgument(int argumentType, byte[] data)
          Set an byte[] paramter on this ServiceParameterBuffer.
 void addArgument(int argumentType, int value)
          Set an int paramter on this ServiceParameterBuffer.
 void addArgument(int argumentType, java.lang.String value)
          Set a String parameter on this ServiceParameterBuffer.
 int getArgumentAsInt(int argumentType)
          Get argument as int.
 java.lang.String getArgumentAsString(int argumentType)
          Get argument as string.
 boolean hasArgument(int argumentType)
          Check if this parameter buffer has specified argument.
 void removeArgument(int argumentType)
          Remove specified argument.
 

Field Detail

VERSION

static final int VERSION
See Also:
Constant Field Values

VERSION1

static final int VERSION1
See Also:
Constant Field Values

CURRENT_VERSION

static final int CURRENT_VERSION
See Also:
Constant Field Values

USER_NAME

static final int USER_NAME
See Also:
Constant Field Values

SYS_USER_NAME

static final int SYS_USER_NAME
See Also:
Constant Field Values

SYS_USER_NAME_ENC

static final int SYS_USER_NAME_ENC
See Also:
Constant Field Values

PASSWORD

static final int PASSWORD
See Also:
Constant Field Values

PASSWORD_ENC

static final int PASSWORD_ENC
See Also:
Constant Field Values

COMMAND_LINE

static final int COMMAND_LINE
See Also:
Constant Field Values

DBNAME

static final int DBNAME
See Also:
Constant Field Values

VERBOSE

static final int VERBOSE
See Also:
Constant Field Values

OPTIONS

static final int OPTIONS
See Also:
Constant Field Values

CONNECT_TIMEOUT

static final int CONNECT_TIMEOUT
See Also:
Constant Field Values

DUMMY_PACKET_INTERVAL

static final int DUMMY_PACKET_INTERVAL
See Also:
Constant Field Values

SQL_ROLE_NAME

static final int SQL_ROLE_NAME
See Also:
Constant Field Values
Method Detail

addArgument

void addArgument(int argumentType)
Set a void (valueless) parameter on this ServiceParameterBuffer.

Parameters:
argumentType - The parameter to be set, one of the isc_spb_* constants from ISCConstants

addArgument

void addArgument(int argumentType,
                 java.lang.String value)
Set a String parameter on this ServiceParameterBuffer.

Parameters:
argumentType - The parameter to be set, one of the isc_spb_* constants from ISCConstants
value - The value to set for the given parameter type

addArgument

void addArgument(int argumentType,
                 int value)
Set an int paramter on this ServiceParameterBuffer.

Parameters:
argumentType - The parameter to be set, one of the isc_spb_* constants from ISCConstants
value - The value to set for the given parameter type

addArgument

void addArgument(int argumentType,
                 byte[] data)
Set an byte[] paramter on this ServiceParameterBuffer.

Parameters:
argumentType - The parameter to be set, one of the isc_spb_* constants from ISCConstants
data - The value to set for the given parameter type

removeArgument

void removeArgument(int argumentType)
Remove specified argument.

Parameters:
argumentType - type of argument to remove.

getArgumentAsString

java.lang.String getArgumentAsString(int argumentType)
Get argument as string.

Parameters:
argumentType - type of argument to find.
Returns:
argument as string or null if nothing found.

getArgumentAsInt

int getArgumentAsInt(int argumentType)
Get argument as int.

Parameters:
argumentType - type of argument to find.
Returns:
argument as string or 0 if nothing found.

hasArgument

boolean hasArgument(int argumentType)
Check if this parameter buffer has specified argument.

Parameters:
argumentType - type of argument to find.
Returns:
true if this buffer contains specified argument.


Copyright © 2001-2019 Jaybird (Firebird JDBC/JCA) team. All rights reserved.