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 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 GSTAT_ATTACH
           
static int INTERP
           
static int JOURNAL
           
static int LC_CTYPE
           
static int LC_MESSAGES
           
static int LICENSE
           
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 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 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
See Also:
Constant Field Values

ALLOCATION

public static final int ALLOCATION
See Also:
Constant Field Values

JOURNAL

public static final int JOURNAL
See Also:
Constant Field Values

PAGE_SIZE

public static final int PAGE_SIZE
See Also:
Constant Field Values

NUM_BUFFERS

public static final int NUM_BUFFERS
See Also:
Constant Field Values

BUFFER_LENGTH

public static final int BUFFER_LENGTH
See Also:
Constant Field Values

DEBUG

public static final int DEBUG
See Also:
Constant Field Values

GARBAGE_COLLECT

public static final int GARBAGE_COLLECT
See Also:
Constant Field Values

VERIFY

public static final int VERIFY
See Also:
Constant Field Values

SWEEP

public static final int SWEEP
See Also:
Constant Field Values

ENABLE_JOURNAL

public static final int ENABLE_JOURNAL
See Also:
Constant Field Values

DISABLE_JOURNAL

public static final int DISABLE_JOURNAL
See Also:
Constant Field Values

DBKEY_SCOPE

public static final int DBKEY_SCOPE
See Also:
Constant Field Values

NUMBER_OF_USERS

public static final int NUMBER_OF_USERS
See Also:
Constant Field Values

TRACE

public static final int TRACE
See Also:
Constant Field Values

NO_GARBAGE_COLLECT

public static final int NO_GARBAGE_COLLECT
See Also:
Constant Field Values

DAMAGED

public static final int DAMAGED
See Also:
Constant Field Values

LICENSE

public static final int LICENSE
See Also:
Constant Field Values

SYS_USER_NAME

public static final int SYS_USER_NAME
See Also:
Constant Field Values

ENCRYPT_KEY

public static final int ENCRYPT_KEY
See Also:
Constant Field Values

ACTIVATE_SHADOW

public static final int ACTIVATE_SHADOW
See Also:
Constant Field Values

SWEEP_INTERVAL

public static final int SWEEP_INTERVAL
See Also:
Constant Field Values

DELETE_SHADOW

public static final int DELETE_SHADOW
See Also:
Constant Field Values

FORCE_WRITE

public static final int FORCE_WRITE
See Also:
Constant Field Values

BEGIN_LOG

public static final int BEGIN_LOG
See Also:
Constant Field Values

QUIT_LOG

public static final int QUIT_LOG
See Also:
Constant Field Values

NO_RESERVE

public static final int NO_RESERVE
See Also:
Constant Field Values

USER_NAME

public static final int USER_NAME
See Also:
Constant Field Values

USER

public static final int USER
See Also:
Constant Field Values

PASSWORD

public static final int PASSWORD
See Also:
Constant Field Values

PASSWORD_ENC

public static final int PASSWORD_ENC
See Also:
Constant Field Values

SYS_USER_NAME_ENC

public static final int SYS_USER_NAME_ENC
See Also:
Constant Field Values

INTERP

public static final int INTERP
See Also:
Constant Field Values

ONLINE_DUMP

public static final int ONLINE_DUMP
See Also:
Constant Field Values

OLD_FILE_SIZE

public static final int OLD_FILE_SIZE
See Also:
Constant Field Values

OLD_NUM_FILES

public static final int OLD_NUM_FILES
See Also:
Constant Field Values

OLD_FILE

public static final int OLD_FILE
See Also:
Constant Field Values

OLD_START_PAGE

public static final int OLD_START_PAGE
See Also:
Constant Field Values

OLD_START_SEQNO

public static final int OLD_START_SEQNO
See Also:
Constant Field Values

OLD_START_FILE

public static final int OLD_START_FILE
See Also:
Constant Field Values

DROP_WALFILE

public static final int DROP_WALFILE
See Also:
Constant Field Values

OLD_DUMP_ID

public static final int OLD_DUMP_ID
See Also:
Constant Field Values

WAL_BACKUP_DIR

public static final int WAL_BACKUP_DIR
See Also:
Constant Field Values

WAL_CHKPTLEN

public static final int WAL_CHKPTLEN
See Also:
Constant Field Values

WAL_NUMBUFS

public static final int WAL_NUMBUFS
See Also:
Constant Field Values

WAL_BUFSIZE

public static final int WAL_BUFSIZE
See Also:
Constant Field Values

WAL_GRP_CMT_WAIT

public static final int WAL_GRP_CMT_WAIT
See Also:
Constant Field Values

LC_MESSAGES

public static final int LC_MESSAGES
See Also:
Constant Field Values

LC_CTYPE

public static final int LC_CTYPE
See Also:
Constant Field Values

CACHE_MANAGER

public static final int CACHE_MANAGER
See Also:
Constant Field Values

SHUTDOWN

public static final int SHUTDOWN
See Also:
Constant Field Values

ONLINE

public static final int ONLINE
See Also:
Constant Field Values

SHUTDOWN_DELAY

public static final int SHUTDOWN_DELAY
See Also:
Constant Field Values

RESERVED

public static final int RESERVED
See Also:
Constant Field Values

OVERWRITE

public static final int OVERWRITE
See Also:
Constant Field Values

SEC_ATTACH

public static final int SEC_ATTACH
See Also:
Constant Field Values

DISABLE_WAL

public static final int DISABLE_WAL
See Also:
Constant Field Values

CONNECT_TIMEOUT

public static final int CONNECT_TIMEOUT
See Also:
Constant Field Values

DUMMY_PACKET_INTERVAL

public static final int DUMMY_PACKET_INTERVAL
See Also:
Constant Field Values

GBAK_ATTACH

public static final int GBAK_ATTACH
See Also:
Constant Field Values

SQL_ROLE_NAME

public static final int SQL_ROLE_NAME
See Also:
Constant Field Values

SET_PAGE_BUFFERS

public static final int SET_PAGE_BUFFERS
See Also:
Constant Field Values

WORKING_DIRECTORY

public static final int WORKING_DIRECTORY
See Also:
Constant Field Values

SQL_DIALECT

public static final int SQL_DIALECT
See Also:
Constant Field Values

SET_DB_READONLY

public static final int SET_DB_READONLY
See Also:
Constant Field Values

SET_DB_SQL_DIALECT

public static final int SET_DB_SQL_DIALECT
See Also:
Constant Field Values

GFIX_ATTACH

public static final int GFIX_ATTACH
See Also:
Constant Field Values

GSTAT_ATTACH

public static final int GSTAT_ATTACH
See Also:
Constant Field Values

SET_DB_CHARSET

public static final int SET_DB_CHARSET
See Also:
Constant Field Values
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.