org.firebirdsql.gds
Interface DatabaseParameterBuffer


public interface DatabaseParameterBuffer

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

Additionally it is possible to change some database properties in a permanent way, however this approach is not recommended. Please use instead management API.


Field Summary
static int ACTIVATE_SHADOW
           
static int ADDRESS_PATH
           
static int ALLOCATION
           
static int BEGIN_LOG
           
static int BUFFER_LENGTH
           
static int CACHE_MANAGER
           
static int CDD_PATHNAME
           
static int CONNECT_TIMEOUT
           
static int DAMAGED
           
static int DBKEY_SCOPE
           
static int DEBUG
           
static int DELETE_SHADOW
           
static int DISABLE_JOURNAL
           
static int DISABLE_WAL
           
static int DROP_WALFILE
           
static int DUMMY_PACKET_INTERVAL
           
static int ENABLE_JOURNAL
           
static int ENCRYPT_KEY
           
static int FORCE_WRITE
           
static int GARBAGE_COLLECT
           
static int GBAK_ATTACH
           
static int GFIX_ATTACH
           
static int GSEC_ATTACH
           
static int GSTAT_ATTACH
           
static int INTERP
           
static int JOURNAL
           
static int LC_CTYPE
           
static int LC_MESSAGES
           
static int LICENSE
           
static int NO_DB_TRIGGERS
           
static int NO_GARBAGE_COLLECT
           
static int NO_RESERVE
           
static int NUM_BUFFERS
           
static int NUMBER_OF_USERS
           
static int OLD_DUMP_ID
           
static int OLD_FILE
           
static int OLD_FILE_SIZE
           
static int OLD_NUM_FILES
           
static int OLD_START_FILE
           
static int OLD_START_PAGE
           
static int OLD_START_SEQNO
           
static int ONLINE
           
static int ONLINE_DUMP
           
static int OVERWRITE
           
static int PAGE_SIZE
           
static int PASSWORD
           
static int PASSWORD_ENC
           
static int PROCESS_ID
           
static int PROCESS_NAME
           
static int QUIT_LOG
           
static int RESERVED
           
static int SEC_ATTACH
           
static int SET_DB_CHARSET
           
static int SET_DB_READONLY
           
static int SET_DB_SQL_DIALECT
           
static int SET_PAGE_BUFFERS
           
static int SHUTDOWN
           
static int SHUTDOWN_DELAY
           
static int SQL_DIALECT
           
static int SQL_ROLE_NAME
           
static int SWEEP
           
static int SWEEP_INTERVAL
           
static int SYS_USER_NAME
           
static int SYS_USER_NAME_ENC
           
static int TRACE
           
static int TRUSTED_AUTH
           
static int USER
           
static int USER_NAME
           
static int VERIFY
           
static int WAL_BACKUP_DIR
           
static int WAL_BUFSIZE
           
static int WAL_CHKPTLEN
           
static int WAL_GRP_CMT_WAIT
           
static int WAL_NUMBUFS
           
static int WORKING_DIRECTORY
           
 
Method Summary
 void addArgument(int argumentType)
          Add argument with no parameters.
 void addArgument(int argumentType, byte[] content)
          Add array of bytes.
 void addArgument(int argumentType, int value)
          Add integer argument.
 void addArgument(int argumentType, java.lang.String value)
          Add string argument.
 DatabaseParameterBuffer deepCopy()
          Make a deep copy of this object.
 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

CDD_PATHNAME

public static final int CDD_PATHNAME

ALLOCATION

public static final int ALLOCATION

JOURNAL

public static final int JOURNAL

PAGE_SIZE

public static final int PAGE_SIZE

NUM_BUFFERS

public static final int NUM_BUFFERS

BUFFER_LENGTH

public static final int BUFFER_LENGTH

DEBUG

public static final int DEBUG

GARBAGE_COLLECT

public static final int GARBAGE_COLLECT

VERIFY

public static final int VERIFY

SWEEP

public static final int SWEEP

ENABLE_JOURNAL

public static final int ENABLE_JOURNAL

DISABLE_JOURNAL

public static final int DISABLE_JOURNAL

DBKEY_SCOPE

public static final int DBKEY_SCOPE

NUMBER_OF_USERS

public static final int NUMBER_OF_USERS

TRACE

public static final int TRACE

NO_GARBAGE_COLLECT

public static final int NO_GARBAGE_COLLECT

DAMAGED

public static final int DAMAGED

LICENSE

public static final int LICENSE

SYS_USER_NAME

public static final int SYS_USER_NAME

ENCRYPT_KEY

public static final int ENCRYPT_KEY

ACTIVATE_SHADOW

public static final int ACTIVATE_SHADOW

SWEEP_INTERVAL

public static final int SWEEP_INTERVAL

DELETE_SHADOW

public static final int DELETE_SHADOW

FORCE_WRITE

public static final int FORCE_WRITE

BEGIN_LOG

public static final int BEGIN_LOG

QUIT_LOG

public static final int QUIT_LOG

NO_RESERVE

public static final int NO_RESERVE

USER_NAME

public static final int USER_NAME

USER

public static final int USER

PASSWORD

public static final int PASSWORD

PASSWORD_ENC

public static final int PASSWORD_ENC

SYS_USER_NAME_ENC

public static final int SYS_USER_NAME_ENC

INTERP

public static final int INTERP

ONLINE_DUMP

public static final int ONLINE_DUMP

OLD_FILE_SIZE

public static final int OLD_FILE_SIZE

OLD_NUM_FILES

public static final int OLD_NUM_FILES

OLD_FILE

public static final int OLD_FILE

OLD_START_PAGE

public static final int OLD_START_PAGE

OLD_START_SEQNO

public static final int OLD_START_SEQNO

OLD_START_FILE

public static final int OLD_START_FILE

DROP_WALFILE

public static final int DROP_WALFILE

OLD_DUMP_ID

public static final int OLD_DUMP_ID

WAL_BACKUP_DIR

public static final int WAL_BACKUP_DIR

WAL_CHKPTLEN

public static final int WAL_CHKPTLEN

WAL_NUMBUFS

public static final int WAL_NUMBUFS

WAL_BUFSIZE

public static final int WAL_BUFSIZE

WAL_GRP_CMT_WAIT

public static final int WAL_GRP_CMT_WAIT

LC_MESSAGES

public static final int LC_MESSAGES

LC_CTYPE

public static final int LC_CTYPE

CACHE_MANAGER

public static final int CACHE_MANAGER

SHUTDOWN

public static final int SHUTDOWN

ONLINE

public static final int ONLINE

SHUTDOWN_DELAY

public static final int SHUTDOWN_DELAY

RESERVED

public static final int RESERVED

OVERWRITE

public static final int OVERWRITE

SEC_ATTACH

public static final int SEC_ATTACH

DISABLE_WAL

public static final int DISABLE_WAL

CONNECT_TIMEOUT

public static final int CONNECT_TIMEOUT

DUMMY_PACKET_INTERVAL

public static final int DUMMY_PACKET_INTERVAL

GBAK_ATTACH

public static final int GBAK_ATTACH

SQL_ROLE_NAME

public static final int SQL_ROLE_NAME

SET_PAGE_BUFFERS

public static final int SET_PAGE_BUFFERS

WORKING_DIRECTORY

public static final int WORKING_DIRECTORY

SQL_DIALECT

public static final int SQL_DIALECT

SET_DB_READONLY

public static final int SET_DB_READONLY

SET_DB_SQL_DIALECT

public static final int SET_DB_SQL_DIALECT

GFIX_ATTACH

public static final int GFIX_ATTACH

GSTAT_ATTACH

public static final int GSTAT_ATTACH

SET_DB_CHARSET

public static final int SET_DB_CHARSET

GSEC_ATTACH

public static final int GSEC_ATTACH

ADDRESS_PATH

public static final int ADDRESS_PATH

PROCESS_ID

public static final int PROCESS_ID

NO_DB_TRIGGERS

public static final int NO_DB_TRIGGERS

TRUSTED_AUTH

public static final int TRUSTED_AUTH

PROCESS_NAME

public static final int PROCESS_NAME
Method Detail

addArgument

public void addArgument(int argumentType)
Add argument with no parameters.
Parameters:
argumentType - type of argument.

addArgument

public void addArgument(int argumentType,
                        java.lang.String value)
Add string argument.
Parameters:
argumentType - type of argument.
value - string value to add.

addArgument

public void addArgument(int argumentType,
                        int value)
Add integer argument.
Parameters:
argumentType - type of argument.
value - integer value to add.

addArgument

public void addArgument(int argumentType,
                        byte[] content)
Add array of bytes.
Parameters:
argumentType - type of argument.
content - content of argument.

removeArgument

public void removeArgument(int argumentType)
Remove specified argument.
Parameters:
argumentType - type of argument to remove.

getArgumentAsString

public 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

public 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

public 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.

deepCopy

public DatabaseParameterBuffer deepCopy()
Make a deep copy of this object.
Returns:
deep copy of this object.


Copyright © 2001 David Jencks and other authors. All rights reserved.