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_NO_GARBAGE_COLLECT
           
static int BACKUP_NON_TRANSPORTABLE
           
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_LICENSE_MASK
           
static int INFO_GET_LICENSED_USERS
           
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_USER_NAME
           
static int SECURITY_USERID
          Parameters for ACTION_ADD_USER, ACTION_DELETE_USER, ACTION_MODIFY_USER, and ACTION_DISPLAY_USER service calls.
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, byte value)
          Set a byte parameter on this ServiceRequestBuffer.
 void addArgument(int argumentType, int value)
          Set an int parameter on this ServiceRequestBuffer.
 void addArgument(int argumentType, java.lang.String value)
          Set a String parameter on this ServiceRequestBuffer.
 

Field Detail

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

ACTION_RESTORE

public static final int ACTION_RESTORE

ACTION_REPAIR

public static final int ACTION_REPAIR

ACTION_ADD_USER

public static final int ACTION_ADD_USER

ACTION_DELETE_USER

public static final int ACTION_DELETE_USER

ACTION_MODIFY_USER

public static final int ACTION_MODIFY_USER

ACTION_DISPLAY_USER

public static final int ACTION_DISPLAY_USER

ACTION_SET_DB_PROPERTIES

public static final int ACTION_SET_DB_PROPERTIES

ACTION_ADD_LICENSE

public static final int ACTION_ADD_LICENSE

ACTION_REMOVE_LICENSE

public static final int ACTION_REMOVE_LICENSE

ACTION_DB_STATS

public static final int ACTION_DB_STATS

ACTION_GET_SERVER_LOG

public static final int ACTION_GET_SERVER_LOG

INFO_SVR_DB_INFO

public static final int INFO_SVR_DB_INFO
Constants for GDS.iscServiceQuery(...) call

INFO_GET_LICENSE

public static final int INFO_GET_LICENSE

INFO_GET_LICENSE_MASK

public static final int INFO_GET_LICENSE_MASK

INFO_GET_CONFIG

public static final int INFO_GET_CONFIG

INFO_SVC_MGR_VERSION

public static final int INFO_SVC_MGR_VERSION

INFO_SERVER_VERSION

public static final int INFO_SERVER_VERSION

INFO_IMPLEMENTATION

public static final int INFO_IMPLEMENTATION

INFO_CAPABILITIES

public static final int INFO_CAPABILITIES

INFO_USER_DB_PATH

public static final int INFO_USER_DB_PATH

INFO_GET_ENV

public static final int INFO_GET_ENV

INFO_GET_ENV_LOCK

public static final int INFO_GET_ENV_LOCK

INFO_GET_ENV_MSG

public static final int INFO_GET_ENV_MSG

INFO_GET_OUTPUT_LINE

public static final int INFO_GET_OUTPUT_LINE

INFO_GET_OUTPUT_TO_EOF

public static final int INFO_GET_OUTPUT_TO_EOF

INFO_TIMEOUT

public static final int INFO_TIMEOUT

INFO_GET_LICENSED_USERS

public static final int INFO_GET_LICENSED_USERS

INFO_RUNNING

public static final int INFO_RUNNING

INFO_GET_USERS

public static final int INFO_GET_USERS

INFO_LIMBO_TRANSACTIONS

public static final int INFO_LIMBO_TRANSACTIONS

INFO_SINGLE_TRANSACTION_ID

public static final int INFO_SINGLE_TRANSACTION_ID

INFO_MULTI_TRANSACTION_ID

public static final int INFO_MULTI_TRANSACTION_ID

INFO_TRANSACTION_HOST_SITE

public static final int INFO_TRANSACTION_HOST_SITE

INFO_TRANSACTION_REMOTE_SITE

public static final int INFO_TRANSACTION_REMOTE_SITE

INFO_TRANSACTION_DB_PATH

public static final int INFO_TRANSACTION_DB_PATH

INFO_TRANSACTION_ADVICE

public static final int INFO_TRANSACTION_ADVICE

INFO_TRANSACTION_ADVICE_COMMIT

public static final int INFO_TRANSACTION_ADVICE_COMMIT

INFO_TRANSACTION_ADVICE_ROLLBACK

public static final int INFO_TRANSACTION_ADVICE_ROLLBACK

INFO_TRANSACTION_ADVICE_UNKNOWN

public static final int INFO_TRANSACTION_ADVICE_UNKNOWN

INFO_TRANSACTION_STATE

public static final int INFO_TRANSACTION_STATE

INFO_TRANSACTION_STATE_COMMIT

public static final int INFO_TRANSACTION_STATE_COMMIT

INFO_TRANSACTION_STATE_ROLLBACK

public static final int INFO_TRANSACTION_STATE_ROLLBACK

INFO_TRANSACTION_STATE_LIMBO

public static final int INFO_TRANSACTION_STATE_LIMBO

INFO_TRANSACTION_STATE_UNKNOWN

public static final int INFO_TRANSACTION_STATE_UNKNOWN

INFO_FLAG_END

public static final int INFO_FLAG_END

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.

SECURITY_GROUPID

public static final int SECURITY_GROUPID

SECURITY_USER_NAME

public static final int SECURITY_USER_NAME

SECURITY_PASSWORD

public static final int SECURITY_PASSWORD

SECURITY_GROUPNAME

public static final int SECURITY_GROUPNAME

SECURITY_FIRST_NAME

public static final int SECURITY_FIRST_NAME

SECURITY_MIDDLE_NAME

public static final int SECURITY_MIDDLE_NAME

SECURITY_LAST_NAME

public static final int SECURITY_LAST_NAME

LICENSE_KEY

public static final int LICENSE_KEY
Parameters for ACTION_ADD_LICENSE and ACTION_REMOVE_LICENSE calls.

LICENSE_ID

public static final int LICENSE_ID

LICENSE_DESCRIPTION

public static final int LICENSE_DESCRIPTION

BACKUP_DB_NAME

public static final int BACKUP_DB_NAME
Parameters for ACTION_BACKUP call.

BACKUP_FILE

public static final int BACKUP_FILE

BACKUP_LENGTH

public static final int BACKUP_LENGTH

BACKUP_FACTOR

public static final int BACKUP_FACTOR

BACKUP_OPTIONS

public static final int BACKUP_OPTIONS

BACKUP_IGNORE_CHECKSUMS

public static final int BACKUP_IGNORE_CHECKSUMS

BACKUP_IGNORE_LIMBO

public static final int BACKUP_IGNORE_LIMBO

BACKUP_METADATA_ONLY

public static final int BACKUP_METADATA_ONLY

BACKUP_NO_GARBAGE_COLLECT

public static final int BACKUP_NO_GARBAGE_COLLECT

BACKUP_OLD_DESCRIPTIONS

public static final int BACKUP_OLD_DESCRIPTIONS

BACKUP_NON_TRANSPORTABLE

public static final int BACKUP_NON_TRANSPORTABLE

BACKUP_CONVERT

public static final int BACKUP_CONVERT

BACKUP_EXPAND

public static final int BACKUP_EXPAND

RESTORE_DB_NAME

public static final int RESTORE_DB_NAME
Parameters for ACTION_RESTORE call.

RESTORE_BACKUP_PATH

public static final int RESTORE_BACKUP_PATH

RESTORE_LENGTH

public static final int RESTORE_LENGTH

RESTORE_BUFFERS

public static final int RESTORE_BUFFERS

RESTORE_PAGE_SIZE

public static final int RESTORE_PAGE_SIZE

RESTORE_ACCESS_MODE

public static final int RESTORE_ACCESS_MODE

RESTORE_ACCESS_MODE_READONLY

public static final int RESTORE_ACCESS_MODE_READONLY

RESTORE_ACCESS_MODE_READWRITE

public static final int RESTORE_ACCESS_MODE_READWRITE

RESTORE_OPTIONS

public static final int RESTORE_OPTIONS

RESTORE_DEACTIVATE_IDX

public static final int RESTORE_DEACTIVATE_IDX

RESTORE_NO_SHADOW

public static final int RESTORE_NO_SHADOW

RESTORE_NO_VALIDITY

public static final int RESTORE_NO_VALIDITY

RESTORE_ONE_AT_A_TIME

public static final int RESTORE_ONE_AT_A_TIME

RESTORE_OVERWRITE

public static final int RESTORE_OVERWRITE

RESTORE_CREATE

public static final int RESTORE_CREATE

RESTORE_USE_ALL_SPACE

public static final int RESTORE_USE_ALL_SPACE

PROPS_DB_NAME

public static final int PROPS_DB_NAME
Parameters for setting database properties.

PROPS_BUFFERS

public static final int PROPS_BUFFERS

PROPS_SWEEP_INTERVAL

public static final int PROPS_SWEEP_INTERVAL

PROPS_SHUTDOWN_DB

public static final int PROPS_SHUTDOWN_DB

PROPS_DENY_NEW_TRANSACTIONS

public static final int PROPS_DENY_NEW_TRANSACTIONS

PROPS_DENY_NEW_ATTACHMENTS

public static final int PROPS_DENY_NEW_ATTACHMENTS

PROPS_SET_SQL_DIALECT

public static final int PROPS_SET_SQL_DIALECT

PROPS_RESERVE_SPACE

public static final int PROPS_RESERVE_SPACE

PROPS_RESERVE_USE_ALL_SPACE

public static final int PROPS_RESERVE_USE_ALL_SPACE

PROPS_RESERVE_VERSIONS

public static final int PROPS_RESERVE_VERSIONS

PROPS_WRITE_MODE

public static final int PROPS_WRITE_MODE

PROPS_WRITE_MODE_ASYNC

public static final int PROPS_WRITE_MODE_ASYNC

PROPS_WRITE_MODE_SYNC

public static final int PROPS_WRITE_MODE_SYNC

PROPS_ACCESS_MODE

public static final int PROPS_ACCESS_MODE

PROPS_ACCESS_MODE_READONLY

public static final int PROPS_ACCESS_MODE_READONLY

PROPS_ACCESS_MODE_READWRITE

public static final int PROPS_ACCESS_MODE_READWRITE

PROPS_OPTIONS

public static final int PROPS_OPTIONS

PROPS_ACTIVATE_SHADOW

public static final int PROPS_ACTIVATE_SHADOW

PROPS_DB_ONLINE

public static final int PROPS_DB_ONLINE

REPAIR_DB_NAME

public static final int REPAIR_DB_NAME
Parameters for database repair.

REPAIR_COMMIT_TRANSACTIONS

public static final int REPAIR_COMMIT_TRANSACTIONS

REPAIR_ROLLBACK_TRANSACTIONS

public static final int REPAIR_ROLLBACK_TRANSACTIONS

REPAIR_RECOVER_TWO_PHASE

public static final int REPAIR_RECOVER_TWO_PHASE

REPAIR_TRANSACTION_ID

public static final int REPAIR_TRANSACTION_ID

REPAIR_OPTIONS

public static final int REPAIR_OPTIONS

REPAIR_VALIDATE_DB

public static final int REPAIR_VALIDATE_DB

REPAIR_SWEEP_DB

public static final int REPAIR_SWEEP_DB

REPAIR_MEND_DB

public static final int REPAIR_MEND_DB

REPAIR_LIST_LIMBO_TRANSACTIONS

public static final int REPAIR_LIST_LIMBO_TRANSACTIONS

REPAIR_CHECK_DB

public static final int REPAIR_CHECK_DB

REPAIR_IGNORE_CHECKSUM

public static final int REPAIR_IGNORE_CHECKSUM

REPAIR_KILL_SHADOWS

public static final int REPAIR_KILL_SHADOWS

REPAIR_FULL

public static final int REPAIR_FULL

STATS_DB_NAME

public static final int STATS_DB_NAME
Parameters for database statistics.

STATS_OPTIONS

public static final int STATS_OPTIONS

STATS_DATA_PAGES

public static final int STATS_DATA_PAGES

STATS_DB_LOG

public static final int STATS_DB_LOG

STATS_HEADER_PAGES

public static final int STATS_HEADER_PAGES

STATS_INDEX_PAGES

public static final int STATS_INDEX_PAGES

STATS_SYSTEM_RELATIONS

public static final int STATS_SYSTEM_RELATIONS

STATS_RECORD_VERSIONS

public static final int STATS_RECORD_VERSIONS

STATS_TABLE

public static final int STATS_TABLE

STATS_NOCREATION

public static final int STATS_NOCREATION
Method Detail

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,
                        java.lang.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,
                        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

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


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