org.firebirdsql.gds

Interface DatabaseParameterBuffer

Known Implementing Classes:
FBConnectionRequestInfo

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
NUMBER_OF_USERS
static int
NUM_BUFFERS
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, String value)
Add string argument.
void
addArgument(int argumentType, byte[] content)
Add array of bytes.
void
addArgument(int argumentType, int value)
Add integer argument.
DatabaseParameterBuffer
deepCopy()
Make a deep copy of this object.
int
getArgumentAsInt(int argumentType)
Get argument as int.
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 Details

ACTIVATE_SHADOW

public static final int ACTIVATE_SHADOW
Field Value:
21

ALLOCATION

public static final int ALLOCATION
Field Value:
2

BEGIN_LOG

public static final int BEGIN_LOG
Field Value:
25

BUFFER_LENGTH

public static final int BUFFER_LENGTH
Field Value:
6

CACHE_MANAGER

public static final int CACHE_MANAGER
Field Value:
49

CDD_PATHNAME

public static final int CDD_PATHNAME
Field Value:
1

CONNECT_TIMEOUT

public static final int CONNECT_TIMEOUT
Field Value:
57

DAMAGED

public static final int DAMAGED
Field Value:
17

DBKEY_SCOPE

public static final int DBKEY_SCOPE
Field Value:
13

DEBUG

public static final int DEBUG
Field Value:
7

DELETE_SHADOW

public static final int DELETE_SHADOW
Field Value:
23

DISABLE_JOURNAL

public static final int DISABLE_JOURNAL
Field Value:
12

DISABLE_WAL

public static final int DISABLE_WAL
Field Value:
56

DROP_WALFILE

public static final int DROP_WALFILE
Field Value:
40

DUMMY_PACKET_INTERVAL

public static final int DUMMY_PACKET_INTERVAL
Field Value:
58

ENABLE_JOURNAL

public static final int ENABLE_JOURNAL
Field Value:
11

ENCRYPT_KEY

public static final int ENCRYPT_KEY
Field Value:
20

FORCE_WRITE

public static final int FORCE_WRITE
Field Value:
24

GARBAGE_COLLECT

public static final int GARBAGE_COLLECT
Field Value:
8

GBAK_ATTACH

public static final int GBAK_ATTACH
Field Value:
59

GFIX_ATTACH

public static final int GFIX_ATTACH
Field Value:
66

GSTAT_ATTACH

public static final int GSTAT_ATTACH
Field Value:
67

INTERP

public static final int INTERP
Field Value:
32

JOURNAL

public static final int JOURNAL
Field Value:
3

LC_CTYPE

public static final int LC_CTYPE
Field Value:
48

LC_MESSAGES

public static final int LC_MESSAGES
Field Value:
47

LICENSE

public static final int LICENSE
Field Value:
18

NO_GARBAGE_COLLECT

public static final int NO_GARBAGE_COLLECT
Field Value:
16

NO_RESERVE

public static final int NO_RESERVE
Field Value:
27

NUMBER_OF_USERS

public static final int NUMBER_OF_USERS
Field Value:
14

NUM_BUFFERS

public static final int NUM_BUFFERS
Field Value:
5

OLD_DUMP_ID

public static final int OLD_DUMP_ID
Field Value:
41

OLD_FILE

public static final int OLD_FILE
Field Value:
36

OLD_FILE_SIZE

public static final int OLD_FILE_SIZE
Field Value:
34

OLD_NUM_FILES

public static final int OLD_NUM_FILES
Field Value:
35

OLD_START_FILE

public static final int OLD_START_FILE
Field Value:
39

OLD_START_PAGE

public static final int OLD_START_PAGE
Field Value:
37

OLD_START_SEQNO

public static final int OLD_START_SEQNO
Field Value:
38

ONLINE

public static final int ONLINE
Field Value:
51

ONLINE_DUMP

public static final int ONLINE_DUMP
Field Value:
33

OVERWRITE

public static final int OVERWRITE
Field Value:
54

PAGE_SIZE

public static final int PAGE_SIZE
Field Value:
4

PASSWORD

public static final int PASSWORD
Field Value:
29

PASSWORD_ENC

public static final int PASSWORD_ENC
Field Value:
30

QUIT_LOG

public static final int QUIT_LOG
Field Value:
26

RESERVED

public static final int RESERVED
Field Value:
53

SEC_ATTACH

public static final int SEC_ATTACH
Field Value:
55

SET_DB_CHARSET

public static final int SET_DB_CHARSET
Field Value:
68

SET_DB_READONLY

public static final int SET_DB_READONLY
Field Value:
64

SET_DB_SQL_DIALECT

public static final int SET_DB_SQL_DIALECT
Field Value:
65

SET_PAGE_BUFFERS

public static final int SET_PAGE_BUFFERS
Field Value:
61

SHUTDOWN

public static final int SHUTDOWN
Field Value:
50

SHUTDOWN_DELAY

public static final int SHUTDOWN_DELAY
Field Value:
52

SQL_DIALECT

public static final int SQL_DIALECT
Field Value:
63

SQL_ROLE_NAME

public static final int SQL_ROLE_NAME
Field Value:
60

SWEEP

public static final int SWEEP
Field Value:
10

SWEEP_INTERVAL

public static final int SWEEP_INTERVAL
Field Value:
22

SYS_USER_NAME

public static final int SYS_USER_NAME
Field Value:
19

SYS_USER_NAME_ENC

public static final int SYS_USER_NAME_ENC
Field Value:
31

TRACE

public static final int TRACE
Field Value:
15

USER

public static final int USER
Field Value:
28

USER_NAME

public static final int USER_NAME
Field Value:
28

VERIFY

public static final int VERIFY
Field Value:
9

WAL_BACKUP_DIR

public static final int WAL_BACKUP_DIR
Field Value:
42

WAL_BUFSIZE

public static final int WAL_BUFSIZE
Field Value:
45

WAL_CHKPTLEN

public static final int WAL_CHKPTLEN
Field Value:
43

WAL_GRP_CMT_WAIT

public static final int WAL_GRP_CMT_WAIT
Field Value:
46

WAL_NUMBUFS

public static final int WAL_NUMBUFS
Field Value:
44

WORKING_DIRECTORY

public static final int WORKING_DIRECTORY
Field Value:
62

Method Details

addArgument

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

addArgument

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

addArgument

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

addArgument

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

deepCopy

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

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.

getArgumentAsString

public String getArgumentAsString(int argumentType)
Get argument as string.
Parameters:
argumentType - type of argument to find.
Returns:
argument as string or null 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.

removeArgument

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

Copyright B) 2001 David Jencks and other authors. All rights reserved.