Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Public Firebird Java API.
   *
   * Redistribution and use in source and binary forms, with or without 
   * modification, are permitted provided that the following conditions are met:
   *    1. Redistributions of source code must retain the above copyright notice, 
   *       this list of conditions and the following disclaimer.
   *    2. Redistributions in binary form must reproduce the above copyright 
   *       notice, this list of conditions and the following disclaimer in the 
  *       documentation and/or other materials provided with the distribution. 
  *    3. The name of the author may not be used to endorse or promote products 
  *       derived from this software without specific prior written permission.
  * 
  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 
  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 
  * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 
  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 
  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 
  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 package org.firebirdsql.gds;

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

    
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
 
     
     // Backup/restore actions
     int ACTION_BACKUP                   = .;
     int ACTION_RESTORE                  = .;
     
     // Database repair actions
     int ACTION_REPAIR                   = .;
     
     // User management actions
     int ACTION_ADD_USER                 = .;
     int ACTION_DELETE_USER              = .;
     int ACTION_MODIFY_USER              = .;
     int ACTION_DISPLAY_USER             = .;
     
     // Changing database properties actions
     
     // License management actions
     int ACTION_ADD_LICENSE              = .;
     
     // Database and server information
     int ACTION_DB_STATS                 = .;
     int ACTION_GET_SERVER_LOG           = .;
    
    
    
    
Constants for GDS.iscServiceQuery(...) call
 
     int INFO_SVR_DB_INFO                = .;
     int INFO_GET_LICENSE                = .;
     int INFO_GET_CONFIG                 = .;
     int INFO_SVC_MGR_VERSION            = .;
     int INFO_SERVER_VERSION             = .;
     int INFO_IMPLEMENTATION             = .;
     int INFO_CAPABILITIES               = .;
     int INFO_USER_DB_PATH               = .;
     int INFO_GET_ENV                    = .;
     int INFO_GET_ENV_LOCK               = .;
     int INFO_GET_ENV_MSG                = .;
     int INFO_GET_OUTPUT_LINE            = .;
     int INFO_GET_OUTPUT_TO_EOF          = .;
     int INFO_TIMEOUT                    = .;
     int INFO_RUNNING                    = .;
     int INFO_GET_USERS                  = .;
 
     // Information about the limbo transactions
     
    
    // Server recommendation for transaction outcome resolution
    
    // Information about transaction state
    int INFO_TRANSACTION_STATE          = .;
    
    int INFO_FLAG_END                   = .;
    
    
Parameters for ACTION_ADD_USER, ACTION_DELETE_USER, ACTION_MODIFY_USER, and ACTION_DISPLAY_USER service calls.
    int SECURITY_USERID                 = .;
    int SECURITY_GROUPID                = .;
    int SECURITY_USER_NAME              = .;
    int SECURITY_PASSWORD               = .;
    int SECURITY_GROUPNAME              = .;
    int SECURITY_FIRST_NAME             = .;
    int SECURITY_MIDDLE_NAME            = .;
    int SECURITY_LAST_NAME              = .;
    
    
    
    
Parameters for ACTION_ADD_LICENSE and ACTION_REMOVE_LICENSE calls.
    int LICENSE_KEY                     = .;
    int LICENSE_ID                      = .;
    int LICENSE_DESCRIPTION             = .;
    
    
    
    
Parameters for ACTION_BACKUP call.
    int BACKUP_DB_NAME                  = .;
    int BACKUP_FILE                     = .;
    int BACKUP_LENGTH                   = .;
    int BACKUP_FACTOR                   = .;
    // Backup operation options, each constant is a bit in a bit mask.
    int BACKUP_OPTIONS                  = .;
    
    // Each constant below represents a bit in a bit mask.
    int BACKUP_IGNORE_LIMBO             = .;
    int BACKUP_METADATA_ONLY            = .;
    int BACKUP_CONVERT                  = .;
    int BACKUP_EXPAND                   = .;
    
    
    
    
Parameters for ACTION_RESTORE call.
    int RESTORE_DB_NAME                 = .;
    int RESTORE_BACKUP_PATH             = .;
    int RESTORE_LENGTH                  = .;
    int RESTORE_BUFFERS                 = .;
    int RESTORE_PAGE_SIZE               = .;
    
    // Access mode for a restored database, read-write or read-only.
    int RESTORE_ACCESS_MODE             = .;
    
    // Restore operation options
    int RESTORE_OPTIONS                 = .;
    
    // Each constant below represents a bit in a bit mask.
    int RESTORE_NO_SHADOW               = .;
    int RESTORE_NO_VALIDITY             = .;
    int RESTORE_OVERWRITE               = .;
    int RESTORE_CREATE                  = .;
    int RESTORE_USE_ALL_SPACE           = .;
    
    
    
    
Parameters for setting database properties.
    int PROPS_DB_NAME                   = .;
    int PROPS_BUFFERS                   = .;
    int PROPS_SWEEP_INTERVAL            = .;
    int PROPS_SHUTDOWN_DB               = .;
    
    // Reserving 20% space on each page for future record version
    int PROPS_RESERVE_SPACE             = .;
    int PROPS_RESERVE_VERSIONS          = .;
    
    // Write mode for the database pages sync or async (forced writes)
    int PROPS_WRITE_MODE                = .;
    int PROPS_WRITE_MODE_ASYNC          = .;
    int PROPS_WRITE_MODE_SYNC           = .;
    
    // Database access mode: read-write or read-only
    int PROPS_ACCESS_MODE               = .;
    
    // Database property options
    int PROPS_OPTIONS                   = .;
    
    // Each constant below represents a bit in a bit mask
    int PROPS_ACTIVATE_SHADOW           = .;
    int PROPS_DB_ONLINE                 = .;
    
    

    
Parameters for database repair.
    int REPAIR_DB_NAME                  = .;
    int REPAIR_TRANSACTION_ID           = .;
    
    // Database repair options
    int REPAIR_OPTIONS                  = .;
    
    // Each constant below represents a bit in a bit mask.
    int REPAIR_VALIDATE_DB              = .;
    int REPAIR_SWEEP_DB                 = .;
    int REPAIR_MEND_DB                  = .;
    int REPAIR_CHECK_DB                 = .;
    int REPAIR_KILL_SHADOWS             = .;
    int REPAIR_FULL                     = .;

    
    
    
Parameters for database statistics.
    int STATS_DB_NAME                   = .;
    
    // Database statistics options.
    int STATS_OPTIONS                   = .;
    
    // Each constant below represents a bit in a bit mask.
    int STATS_DATA_PAGES                = .;
    int STATS_DB_LOG                    = .;
    int STATS_HEADER_PAGES              = .;
    int STATS_INDEX_PAGES               = .;
    int STATS_TABLE                     = .;
    int STATS_NOCREATION                = .;
    
    
    
Set a void (valueless) parameter on this ServiceRequestBuffer.

Parameters:
argumentType The parameter to be set
    public void addArgument(int argumentType);

    
Set a String parameter on this ServiceRequestBuffer.

Parameters:
argumentType The parameter to be set
value The value to set for the given parameter
    public void addArgument(int argumentTypeString value);

    
Set an int parameter on this ServiceRequestBuffer.

Parameters:
argumentType The parameter to be set
value The value to set for the given parameter
    public void addArgument(int argumentTypeint 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
    public void addArgument(int argumentTypebyte value);
New to GrepCode? Check out our FAQ X