org.firebirdsql.gds

Interface ServiceRequestBuffer

public interface ServiceRequestBuffer

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

Field Summary

static int
ACTION_ADD_LICENSE
static int
ACTION_ADD_USER
static int
ACTION_BACKUP
Operations that can be called via Services API.
static int
ACTION_DB_STATS
static int
ACTION_DELETE_USER
static int
ACTION_DISPLAY_USER
static int
ACTION_GET_SERVER_LOG
static int
ACTION_MODIFY_USER
static int
ACTION_REMOVE_LICENSE
static int
ACTION_REPAIR
static int
ACTION_RESTORE
static int
ACTION_SET_DB_PROPERTIES
static int
BACKUP_CONVERT
static int
BACKUP_DB_NAME
Parameters for ACTION_BACKUP call.
static int
BACKUP_EXPAND
static int
BACKUP_FACTOR
static int
BACKUP_FILE
static int
BACKUP_IGNORE_CHECKSUMS
static int
BACKUP_IGNORE_LIMBO
static int
BACKUP_LENGTH
static int
BACKUP_METADATA_ONLY
static int
BACKUP_NON_TRANSPORTABLE
static int
BACKUP_NO_GARBAGE_COLLECT
static int
BACKUP_OLD_DESCRIPTIONS
static int
BACKUP_OPTIONS
static int
INFO_CAPABILITIES
static int
INFO_FLAG_END
static int
INFO_GET_CONFIG
static int
INFO_GET_ENV
static int
INFO_GET_ENV_LOCK
static int
INFO_GET_ENV_MSG
static int
INFO_GET_LICENSE
static int
INFO_GET_LICENSED_USERS
static int
INFO_GET_LICENSE_MASK
static int
INFO_GET_OUTPUT_LINE
static int
INFO_GET_OUTPUT_TO_EOF
static int
INFO_GET_USERS
static int
INFO_IMPLEMENTATION
static int
INFO_LIMBO_TRANSACTIONS
static int
INFO_MULTI_TRANSACTION_ID
static int
INFO_RUNNING
static int
INFO_SERVER_VERSION
static int
INFO_SINGLE_TRANSACTION_ID
static int
INFO_SVC_MGR_VERSION
static int
INFO_SVR_DB_INFO
Constants for GDS.iscServiceQuery(...) call
static int
INFO_TIMEOUT
static int
INFO_TRANSACTION_ADVICE
static int
INFO_TRANSACTION_ADVICE_COMMIT
static int
INFO_TRANSACTION_ADVICE_ROLLBACK
static int
INFO_TRANSACTION_ADVICE_UNKNOWN
static int
INFO_TRANSACTION_DB_PATH
static int
INFO_TRANSACTION_HOST_SITE
static int
INFO_TRANSACTION_REMOTE_SITE
static int
INFO_TRANSACTION_STATE
static int
INFO_TRANSACTION_STATE_COMMIT
static int
INFO_TRANSACTION_STATE_LIMBO
static int
INFO_TRANSACTION_STATE_ROLLBACK
static int
INFO_TRANSACTION_STATE_UNKNOWN
static int
INFO_USER_DB_PATH
static int
LICENSE_DESCRIPTION
static int
LICENSE_ID
static int
LICENSE_KEY
Parameters for ACTION_ADD_LICENSE and ACTION_REMOVE_LICENSE calls.
static int
PROPS_ACCESS_MODE
static int
PROPS_ACCESS_MODE_READONLY
static int
PROPS_ACCESS_MODE_READWRITE
static int
PROPS_ACTIVATE_SHADOW
static int
PROPS_BUFFERS
static int
PROPS_DB_NAME
Parameters for setting database properties.
static int
PROPS_DB_ONLINE
static int
PROPS_DENY_NEW_ATTACHMENTS
static int
PROPS_DENY_NEW_TRANSACTIONS
static int
PROPS_OPTIONS
static int
PROPS_RESERVE_SPACE
static int
PROPS_RESERVE_USE_ALL_SPACE
static int
PROPS_RESERVE_VERSIONS
static int
PROPS_SET_SQL_DIALECT
static int
PROPS_SHUTDOWN_DB
static int
PROPS_SWEEP_INTERVAL
static int
PROPS_WRITE_MODE
static int
PROPS_WRITE_MODE_ASYNC
static int
PROPS_WRITE_MODE_SYNC
static int
REPAIR_CHECK_DB
static int
REPAIR_COMMIT_TRANSACTIONS
static int
REPAIR_DB_NAME
Parameters for database repair.
static int
REPAIR_FULL
static int
REPAIR_IGNORE_CHECKSUM
static int
REPAIR_KILL_SHADOWS
static int
REPAIR_LIST_LIMBO_TRANSACTIONS
static int
REPAIR_MEND_DB
static int
REPAIR_OPTIONS
static int
REPAIR_RECOVER_TWO_PHASE
static int
REPAIR_ROLLBACK_TRANSACTIONS
static int
REPAIR_SWEEP_DB
static int
REPAIR_TRANSACTION_ID
static int
REPAIR_VALIDATE_DB
static int
RESTORE_ACCESS_MODE
static int
RESTORE_ACCESS_MODE_READONLY
static int
RESTORE_ACCESS_MODE_READWRITE
static int
RESTORE_BACKUP_PATH
static int
RESTORE_BUFFERS
static int
RESTORE_CREATE
static int
RESTORE_DB_NAME
Parameters for ACTION_RESTORE call.
static int
RESTORE_DEACTIVATE_IDX
static int
RESTORE_LENGTH
static int
RESTORE_NO_SHADOW
static int
RESTORE_NO_VALIDITY
static int
RESTORE_ONE_AT_A_TIME
static int
RESTORE_OPTIONS
static int
RESTORE_OVERWRITE
static int
RESTORE_PAGE_SIZE
static int
RESTORE_USE_ALL_SPACE
static int
SECURITY_FIRST_NAME
static int
SECURITY_GROUPID
static int
SECURITY_GROUPNAME
static int
SECURITY_LAST_NAME
static int
SECURITY_MIDDLE_NAME
static int
SECURITY_PASSWORD
static int
SECURITY_USERID
Parameters for ACTION_ADD_USER, ACTION_DELETE_USER, ACTION_MODIFY_USER, and ACTION_DISPLAY_USER service calls.
static int
SECURITY_USER_NAME
static int
STATS_DATA_PAGES
static int
STATS_DB_LOG
static int
STATS_DB_NAME
Parameters for database statistics.
static int
STATS_HEADER_PAGES
static int
STATS_INDEX_PAGES
static int
STATS_NOCREATION
static int
STATS_OPTIONS
static int
STATS_RECORD_VERSIONS
static int
STATS_SYSTEM_RELATIONS
static int
STATS_TABLE

Method Summary

void
addArgument(int argumentType)
Set a void (valueless) parameter on this ServiceRequestBuffer.
void
addArgument(int argumentType, String value)
Set a String parameter on this ServiceRequestBuffer.
void
addArgument(int argumentType, byte value)
Set a byte parameter on this ServiceRequestBuffer.
void
addArgument(int argumentType, int value)
Set an int parameter on this ServiceRequestBuffer.

Field Details

ACTION_ADD_LICENSE

public static final int ACTION_ADD_LICENSE
Field Value:
9

ACTION_ADD_USER

public static final int ACTION_ADD_USER
Field Value:
4

ACTION_BACKUP

public static final int ACTION_BACKUP
Operations that can be called via Services API. There are following groups of operations: - backup/restore - database repair - user management - changing the database properties - license management - database and server information
Field Value:
1

ACTION_DB_STATS

public static final int ACTION_DB_STATS
Field Value:
11

ACTION_DELETE_USER

public static final int ACTION_DELETE_USER
Field Value:
5

ACTION_DISPLAY_USER

public static final int ACTION_DISPLAY_USER
Field Value:
7

ACTION_GET_SERVER_LOG

public static final int ACTION_GET_SERVER_LOG
Field Value:
12

ACTION_MODIFY_USER

public static final int ACTION_MODIFY_USER
Field Value:
6

ACTION_REMOVE_LICENSE

public static final int ACTION_REMOVE_LICENSE
Field Value:
10

ACTION_REPAIR

public static final int ACTION_REPAIR
Field Value:
3

ACTION_RESTORE

public static final int ACTION_RESTORE
Field Value:
2

ACTION_SET_DB_PROPERTIES

public static final int ACTION_SET_DB_PROPERTIES
Field Value:
8

BACKUP_CONVERT

public static final int BACKUP_CONVERT
Field Value:
64

BACKUP_DB_NAME

public static final int BACKUP_DB_NAME
Parameters for ACTION_BACKUP call.
Field Value:
106

BACKUP_EXPAND

public static final int BACKUP_EXPAND
Field Value:
128

BACKUP_FACTOR

public static final int BACKUP_FACTOR
Field Value:
6

BACKUP_FILE

public static final int BACKUP_FILE
Field Value:
5

BACKUP_IGNORE_CHECKSUMS

public static final int BACKUP_IGNORE_CHECKSUMS
Field Value:
1

BACKUP_IGNORE_LIMBO

public static final int BACKUP_IGNORE_LIMBO
Field Value:
2

BACKUP_LENGTH

public static final int BACKUP_LENGTH
Field Value:
7

BACKUP_METADATA_ONLY

public static final int BACKUP_METADATA_ONLY
Field Value:
4

BACKUP_NON_TRANSPORTABLE

public static final int BACKUP_NON_TRANSPORTABLE
Field Value:
32

BACKUP_NO_GARBAGE_COLLECT

public static final int BACKUP_NO_GARBAGE_COLLECT
Field Value:
8

BACKUP_OLD_DESCRIPTIONS

public static final int BACKUP_OLD_DESCRIPTIONS
Field Value:
16

BACKUP_OPTIONS

public static final int BACKUP_OPTIONS
Field Value:
108

INFO_CAPABILITIES

public static final int INFO_CAPABILITIES
Field Value:
57

INFO_FLAG_END

public static final int INFO_FLAG_END
Field Value:
127

INFO_GET_CONFIG

public static final int INFO_GET_CONFIG
Field Value:
53

INFO_GET_ENV

public static final int INFO_GET_ENV
Field Value:
59

INFO_GET_ENV_LOCK

public static final int INFO_GET_ENV_LOCK
Field Value:
60

INFO_GET_ENV_MSG

public static final int INFO_GET_ENV_MSG
Field Value:
61

INFO_GET_LICENSE

public static final int INFO_GET_LICENSE
Field Value:
51

INFO_GET_LICENSED_USERS

public static final int INFO_GET_LICENSED_USERS
Field Value:
65

INFO_GET_LICENSE_MASK

public static final int INFO_GET_LICENSE_MASK
Field Value:
52

INFO_GET_OUTPUT_LINE

public static final int INFO_GET_OUTPUT_LINE
Field Value:
62

INFO_GET_OUTPUT_TO_EOF

public static final int INFO_GET_OUTPUT_TO_EOF
Field Value:
63

INFO_GET_USERS

public static final int INFO_GET_USERS
Field Value:
68

INFO_IMPLEMENTATION

public static final int INFO_IMPLEMENTATION
Field Value:
56

INFO_LIMBO_TRANSACTIONS

public static final int INFO_LIMBO_TRANSACTIONS
Field Value:
66

INFO_MULTI_TRANSACTION_ID

public static final int INFO_MULTI_TRANSACTION_ID
Field Value:
20

INFO_RUNNING

public static final int INFO_RUNNING
Field Value:
67

INFO_SERVER_VERSION

public static final int INFO_SERVER_VERSION
Field Value:
55

INFO_SINGLE_TRANSACTION_ID

public static final int INFO_SINGLE_TRANSACTION_ID
Field Value:
19

INFO_SVC_MGR_VERSION

public static final int INFO_SVC_MGR_VERSION
Field Value:
54

INFO_SVR_DB_INFO

public static final int INFO_SVR_DB_INFO
Constants for GDS.iscServiceQuery(...) call
Field Value:
50

INFO_TIMEOUT

public static final int INFO_TIMEOUT
Field Value:
64

INFO_TRANSACTION_ADVICE

public static final int INFO_TRANSACTION_ADVICE
Field Value:
29

INFO_TRANSACTION_ADVICE_COMMIT

public static final int INFO_TRANSACTION_ADVICE_COMMIT
Field Value:
30

INFO_TRANSACTION_ADVICE_ROLLBACK

public static final int INFO_TRANSACTION_ADVICE_ROLLBACK
Field Value:
31

INFO_TRANSACTION_ADVICE_UNKNOWN

public static final int INFO_TRANSACTION_ADVICE_UNKNOWN
Field Value:
33

INFO_TRANSACTION_DB_PATH

public static final int INFO_TRANSACTION_DB_PATH
Field Value:
28

INFO_TRANSACTION_HOST_SITE

public static final int INFO_TRANSACTION_HOST_SITE
Field Value:
26

INFO_TRANSACTION_REMOTE_SITE

public static final int INFO_TRANSACTION_REMOTE_SITE
Field Value:
27

INFO_TRANSACTION_STATE

public static final int INFO_TRANSACTION_STATE
Field Value:
21

INFO_TRANSACTION_STATE_COMMIT

public static final int INFO_TRANSACTION_STATE_COMMIT
Field Value:
23

INFO_TRANSACTION_STATE_LIMBO

public static final int INFO_TRANSACTION_STATE_LIMBO
Field Value:
22

INFO_TRANSACTION_STATE_ROLLBACK

public static final int INFO_TRANSACTION_STATE_ROLLBACK
Field Value:
24

INFO_TRANSACTION_STATE_UNKNOWN

public static final int INFO_TRANSACTION_STATE_UNKNOWN
Field Value:
25

INFO_USER_DB_PATH

public static final int INFO_USER_DB_PATH
Field Value:
58

LICENSE_DESCRIPTION

public static final int LICENSE_DESCRIPTION
Field Value:
7

LICENSE_ID

public static final int LICENSE_ID
Field Value:
6

LICENSE_KEY

public static final int LICENSE_KEY
Parameters for ACTION_ADD_LICENSE and ACTION_REMOVE_LICENSE calls.
Field Value:
5

PROPS_ACCESS_MODE

public static final int PROPS_ACCESS_MODE
Field Value:
13

PROPS_ACCESS_MODE_READONLY

public static final int PROPS_ACCESS_MODE_READONLY
Field Value:
39

PROPS_ACCESS_MODE_READWRITE

public static final int PROPS_ACCESS_MODE_READWRITE
Field Value:
40

PROPS_ACTIVATE_SHADOW

public static final int PROPS_ACTIVATE_SHADOW
Field Value:
256

PROPS_BUFFERS

public static final int PROPS_BUFFERS
Field Value:
5

PROPS_DB_NAME

public static final int PROPS_DB_NAME
Parameters for setting database properties.
Field Value:
106

PROPS_DB_ONLINE

public static final int PROPS_DB_ONLINE
Field Value:
512

PROPS_DENY_NEW_ATTACHMENTS

public static final int PROPS_DENY_NEW_ATTACHMENTS
Field Value:
9

PROPS_DENY_NEW_TRANSACTIONS

public static final int PROPS_DENY_NEW_TRANSACTIONS
Field Value:
10

PROPS_OPTIONS

public static final int PROPS_OPTIONS
Field Value:
108

PROPS_RESERVE_SPACE

public static final int PROPS_RESERVE_SPACE
Field Value:
11

PROPS_RESERVE_USE_ALL_SPACE

public static final int PROPS_RESERVE_USE_ALL_SPACE
Field Value:
35

PROPS_RESERVE_VERSIONS

public static final int PROPS_RESERVE_VERSIONS
Field Value:
36

PROPS_SET_SQL_DIALECT

public static final int PROPS_SET_SQL_DIALECT
Field Value:
14

PROPS_SHUTDOWN_DB

public static final int PROPS_SHUTDOWN_DB
Field Value:
7

PROPS_SWEEP_INTERVAL

public static final int PROPS_SWEEP_INTERVAL
Field Value:
6

PROPS_WRITE_MODE

public static final int PROPS_WRITE_MODE
Field Value:
12

PROPS_WRITE_MODE_ASYNC

public static final int PROPS_WRITE_MODE_ASYNC
Field Value:
37

PROPS_WRITE_MODE_SYNC

public static final int PROPS_WRITE_MODE_SYNC
Field Value:
38

REPAIR_CHECK_DB

public static final int REPAIR_CHECK_DB
Field Value:
16

REPAIR_COMMIT_TRANSACTIONS

public static final int REPAIR_COMMIT_TRANSACTIONS
Field Value:
15

REPAIR_DB_NAME

public static final int REPAIR_DB_NAME
Parameters for database repair.
Field Value:
106

REPAIR_FULL

public static final int REPAIR_FULL
Field Value:
128

REPAIR_IGNORE_CHECKSUM

public static final int REPAIR_IGNORE_CHECKSUM
Field Value:
32

REPAIR_KILL_SHADOWS

public static final int REPAIR_KILL_SHADOWS
Field Value:
64

REPAIR_LIST_LIMBO_TRANSACTIONS

public static final int REPAIR_LIST_LIMBO_TRANSACTIONS
Field Value:
8

REPAIR_MEND_DB

public static final int REPAIR_MEND_DB
Field Value:
4

REPAIR_OPTIONS

public static final int REPAIR_OPTIONS
Field Value:
108

REPAIR_RECOVER_TWO_PHASE

public static final int REPAIR_RECOVER_TWO_PHASE
Field Value:
17

REPAIR_ROLLBACK_TRANSACTIONS

public static final int REPAIR_ROLLBACK_TRANSACTIONS
Field Value:
34

REPAIR_SWEEP_DB

public static final int REPAIR_SWEEP_DB
Field Value:
2

REPAIR_TRANSACTION_ID

public static final int REPAIR_TRANSACTION_ID
Field Value:
18

REPAIR_VALIDATE_DB

public static final int REPAIR_VALIDATE_DB
Field Value:
1

RESTORE_ACCESS_MODE

public static final int RESTORE_ACCESS_MODE
Field Value:
12

RESTORE_ACCESS_MODE_READONLY

public static final int RESTORE_ACCESS_MODE_READONLY
Field Value:
39

RESTORE_ACCESS_MODE_READWRITE

public static final int RESTORE_ACCESS_MODE_READWRITE
Field Value:
40

RESTORE_BACKUP_PATH

public static final int RESTORE_BACKUP_PATH
Field Value:
5

RESTORE_BUFFERS

public static final int RESTORE_BUFFERS
Field Value:
9

RESTORE_CREATE

public static final int RESTORE_CREATE
Field Value:
8192

RESTORE_DB_NAME

public static final int RESTORE_DB_NAME
Parameters for ACTION_RESTORE call.
Field Value:
106

RESTORE_DEACTIVATE_IDX

public static final int RESTORE_DEACTIVATE_IDX
Field Value:
256

RESTORE_LENGTH

public static final int RESTORE_LENGTH
Field Value:
11

RESTORE_NO_SHADOW

public static final int RESTORE_NO_SHADOW
Field Value:
512

RESTORE_NO_VALIDITY

public static final int RESTORE_NO_VALIDITY
Field Value:
1024

RESTORE_ONE_AT_A_TIME

public static final int RESTORE_ONE_AT_A_TIME
Field Value:
2048

RESTORE_OPTIONS

public static final int RESTORE_OPTIONS
Field Value:
108

RESTORE_OVERWRITE

public static final int RESTORE_OVERWRITE
Field Value:
4096

RESTORE_PAGE_SIZE

public static final int RESTORE_PAGE_SIZE
Field Value:
10

RESTORE_USE_ALL_SPACE

public static final int RESTORE_USE_ALL_SPACE
Field Value:
16384

SECURITY_FIRST_NAME

public static final int SECURITY_FIRST_NAME
Field Value:
10

SECURITY_GROUPID

public static final int SECURITY_GROUPID
Field Value:
6

SECURITY_GROUPNAME

public static final int SECURITY_GROUPNAME
Field Value:
9

SECURITY_LAST_NAME

public static final int SECURITY_LAST_NAME
Field Value:
12

SECURITY_MIDDLE_NAME

public static final int SECURITY_MIDDLE_NAME
Field Value:
11

SECURITY_PASSWORD

public static final int SECURITY_PASSWORD
Field Value:
8

SECURITY_USERID

public static final int SECURITY_USERID
Parameters for ACTION_ADD_USER, ACTION_DELETE_USER, ACTION_MODIFY_USER, and ACTION_DISPLAY_USER service calls.
Field Value:
5

SECURITY_USER_NAME

public static final int SECURITY_USER_NAME
Field Value:
7

STATS_DATA_PAGES

public static final int STATS_DATA_PAGES
Field Value:
1

STATS_DB_LOG

public static final int STATS_DB_LOG
Field Value:
2

STATS_DB_NAME

public static final int STATS_DB_NAME
Parameters for database statistics.
Field Value:
106

STATS_HEADER_PAGES

public static final int STATS_HEADER_PAGES
Field Value:
4

STATS_INDEX_PAGES

public static final int STATS_INDEX_PAGES
Field Value:
8

STATS_NOCREATION

public static final int STATS_NOCREATION
Field Value:
128

STATS_OPTIONS

public static final int STATS_OPTIONS
Field Value:
108

STATS_RECORD_VERSIONS

public static final int STATS_RECORD_VERSIONS
Field Value:
32

STATS_SYSTEM_RELATIONS

public static final int STATS_SYSTEM_RELATIONS
Field Value:
16

STATS_TABLE

public static final int STATS_TABLE
Field Value:
64

Method Details

addArgument

public void addArgument(int argumentType)
Set a void (valueless) parameter on this ServiceRequestBuffer.
Parameters:
argumentType - The parameter to be set

addArgument

public void addArgument(int argumentType,
                        String value)
Set a String parameter on this ServiceRequestBuffer.
Parameters:
argumentType - The parameter to be set
value - The value to set for the given parameter

addArgument

public void addArgument(int argumentType,
                        byte value)
Set a byte parameter on this ServiceRequestBuffer.
Parameters:
argumentType - The parameter to be set
value - The value to the set for the given parameter

addArgument

public void addArgument(int argumentType,
                        int value)
Set an int parameter on this ServiceRequestBuffer.
Parameters:
argumentType - The parameter to be set
value - The value to set for the given parameter

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