Interface ConnectionMgr


public interface ConnectionMgr
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
     
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final boolean
     
    static final long
     
    static final long
     
    static final Logger
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
     
    void
    authenticateBBj(byte[] p_auth)
     
    void
    changeDir(String p_dir, boolean p_useRemote)
    Change current directory.
    void
    changeDir(String p_dir, boolean p_useRemote, String p_user, String p_password)
    Change current directory.
    boolean
    Try to checkout a license using the license connection if one is not already checked out.
    void
    chmod(String p_filename, int p_permissions, boolean p_useRemote)
     
    void
    chmod(String p_filename, int p_permissions, boolean p_useRemote, String p_user, String p_password)
     
    void
    Clear any cache that might exist.
    void
    Clear the FCBCACHE.
    default void
    convert(String p_filename, boolean p_recoverable, boolean p_overwrite, boolean p_useRemote, String p_filePassword)
    Convert (upgrade) file to latest file format.
    default void
    convert(String p_filename, boolean p_recoverable, boolean p_overwrite, boolean p_useRemote, String p_filePassword, long p_timeout)
    Convert (upgrade) file to latest file format.
    default void
    convert(String p_filename, boolean p_recoverable, boolean p_overwrite, boolean p_useRemote, String p_user, String p_password, String p_filePassword)
    Convert (upgrade) file to latest file format.
    default void
    convert(String p_filename, boolean p_recoverable, boolean p_overwrite, boolean p_useRemote, String p_user, String p_password, String p_filePassword, long p_timeout)
    Convert (upgrade) file to latest file format.
    default void
    convert(String p_filename, boolean p_recoverable, boolean p_overwrite, boolean p_useRemote, String p_user, String p_password, String p_filePassword, long p_timeout, String p_modes)
    Convert (upgrade) file to latest file format.
    void
    convert(String p_filename, boolean p_recoverable, boolean p_overwrite, boolean p_useRemote, String p_user, String p_password, String p_filePassword, long p_timeout, String p_modes, String p_tmpDir)
    Convert (upgrade) file to latest file format.
     
    void
    createDirectFile(String p_filename, byte p_keySize, long p_records, int p_recordSize, boolean p_useRemote)
    Create a DIRECT or SORT file.
    void
    createDirectFile(String p_filename, byte p_keySize, long p_records, int p_recordSize, boolean p_useRemote, String p_mode)
    Create a DIRECT or SORT file.
    void
    createDirectFile(String p_filename, byte p_keySize, long p_records, int p_recordSize, boolean p_useRemote, String p_user, String p_password, int p_umask)
    Create a DIRECT or SORT file.
    void
    createDirectFile(String p_filename, byte p_keySize, long p_records, int p_recordSize, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode)
    Create a DIRECT or SORT file.
    void
    createFile(byte[] p_fid, boolean p_useRemote)
    Create a file generically from a FID.
    void
    createFile(byte[] p_fid, boolean p_useRemote, String p_user, String p_password, int p_umask)
    Create a file generically from a FID.
    void
    createFile(byte[] p_fid, byte[] p_fin, boolean p_useRemote)
    Create a file generically from a FID.
    void
    createFile(byte[] p_fid, byte[] p_fin, boolean p_useRemote, String p_user, String p_password, int p_umask)
    Create a file generically from a FID.
    void
    createFile(byte[] p_fid, int p_fidlen, boolean p_useRemote)
    Create a file generically from a FID.
    void
    createFile(byte[] p_fid, int p_fidlen, boolean p_useRemote, String p_mode)
    Create a file generically from a FID.
    void
    createFile(byte[] p_fid, int p_fidlen, boolean p_useRemote, String p_user, String p_password, int p_umask)
    Create a file generically from a FID.
    void
    createFile(byte[] p_fid, int p_fidlen, byte[] p_fin, int p_finlen, boolean p_useRemote)
    Create a file generically from a FID.
    void
    createFile(byte[] p_fid, int p_fidlen, byte[] p_fin, int p_finlen, boolean p_useRemote, String p_mode)
    Create a file generically from a FID.
    void
    createFile(byte[] p_fid, int p_fidlen, byte[] p_fin, int p_finlen, boolean p_useRemote, String p_user, String p_password, int p_umask)
    Create a file generically from a FID.
    void
    createFile(byte[] p_fid, int p_fidlen, byte[] p_fin, int p_finlen, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode)
    Create a file generically from a FID.
    void
    createFile(byte[] p_fid, int p_fidOffset, int p_fidlen, byte[] p_fin, int p_finOffset, int p_finlen, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode)
    Create a file generically from a FID.
    default void
    createFile(io.netty.buffer.ByteBuf p_fid, io.netty.buffer.ByteBuf p_fin, boolean p_useRemote, String p_mode)
    Create a file generically from a FID.
    default void
    createFile(ByteBuffer p_fid, ByteBuffer p_fin, boolean p_useRemote, String p_mode)
    Create a file generically from a FID.
    void
    createIndexedFile(String p_filename, long p_records, int p_recordSize, boolean p_useRemote)
    Create an INDEXED file.
    void
    createIndexedFile(String p_filename, long p_records, int p_recordSize, boolean p_useRemote, String p_mode)
    Create an INDEXED file.
    void
    createIndexedFile(String p_filename, long p_records, int p_recordSize, boolean p_useRemote, String p_user, String p_password, int p_umask)
    Create an INDEXED file.
    void
    createIndexedFile(String p_filename, long p_records, int p_recordSize, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode)
    Create an INDEXED file.
    void
    createMKeyedFile(String p_filename, byte p_keySize, long p_records, int p_recordSize, boolean p_64bit, boolean p_tagged, boolean p_useRemote)
    Create a single keyed MKEYED file.
    void
    createMKeyedFile(String p_filename, byte p_keySize, long p_records, int p_recordSize, boolean p_64bit, boolean p_tagged, boolean p_useRemote, String p_mode)
    Create a single keyed MKEYED file.
    void
    createMKeyedFile(String p_filename, byte p_keySize, long p_records, int p_recordSize, boolean p_64bit, boolean p_tagged, boolean p_useRemote, String p_user, String p_password, int p_umask)
    Create a single keyed MKEYED file.
    void
    createMKeyedFile(String p_filename, byte p_keySize, long p_records, int p_recordSize, boolean p_64bit, boolean p_tagged, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode)
    Create a single keyed MKEYED file.
    void
    createMKeyedFile(String p_filename, List p_keys, long p_records, int p_recordSize, boolean p_64bit, boolean p_tagged, boolean p_useRemote)
    Create a multi keyed MKEYED file.
    void
    createMKeyedFile(String p_filename, List p_keys, long p_records, int p_recordSize, boolean p_64bit, boolean p_tagged, boolean p_useRemote, String p_mode)
    Create a multi keyed MKEYED file.
    void
    createMKeyedFile(String p_filename, List p_keys, long p_records, int p_recordSize, boolean p_64bit, boolean p_tagged, boolean p_useRemote, String p_user, String p_password, int p_umask)
    Create a multi keyed MKEYED file.
    void
    createMKeyedFile(String p_filename, List p_keys, long p_records, int p_recordSize, boolean p_64bit, boolean p_tagged, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode)
    Create a multi keyed MKEYED file.
    void
    createSerialFile(String p_filename, long p_records, int p_recordSize, boolean p_useRemote)
    Create a SERIAL file.
    void
    createSerialFile(String p_filename, long p_records, int p_recordSize, boolean p_useRemote, String p_mode)
    Create a SERIAL file.
    void
    createSerialFile(String p_filename, long p_records, int p_recordSize, boolean p_useRemote, String p_user, String p_password, int p_umask)
    Create a SERIAL file.
    void
    createSerialFile(String p_filename, long p_records, int p_recordSize, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode)
    Create a SERIAL file.
    void
    createStringFile(String p_filename, boolean p_useRemote)
    Create a STRING file.
    void
    createStringFile(String p_filename, boolean p_useRemote, String p_mode)
    Create a STRING file.
    void
    createStringFile(String p_filename, boolean p_useRemote, String p_user, String p_password, int p_umask)
    Create a STRING file.
    void
    createStringFile(String p_filename, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode)
    Create a STRING file.
    void
    createTextSearchFile(String p_filename, String p_template, String p_idField, boolean p_useRemote, String p_mode)
    Create a text search file/directory.
    void
    createTextSearchFile(String p_filename, String p_template, String p_idField, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode)
    Create a text search file/directory.
    void
    createVKeyedFile(String p_filename, int p_keySize, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, String p_mode)
    Create a single keyed VKEYED file.
    void
    createVKeyedFile(String p_filename, int p_keySize, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode)
    Create a single keyed VKEYED file.
    void
    createVKeyedFile(String p_filename, List p_keys, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, String p_mode)
    Create a multi keyed VKEYED file.
    void
    createVKeyedFile(String p_filename, List p_keys, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode)
    Create a multi keyed VKEYED file.
    void
    createXFile(byte[] p_xfid, boolean p_useRemote)
    Create a file generically from an XFID.
    void
    createXFile(byte[] p_xfid, boolean p_useRemote, String p_mode)
    Create a file generically from an XFID.
    void
    createXFile(byte[] p_xfid, boolean p_useRemote, String p_user, String p_password, int p_umask)
    Create a file generically from an XFID.
    void
    createXFile(byte[] p_xfid, byte[] p_xfin, boolean p_useRemote)
    Create a file generically from an XFID.
    void
    createXFile(byte[] p_xfid, byte[] p_xfin, boolean p_useRemote, String p_mode)
    Create a file generically from an XFID.
    void
    createXFile(byte[] p_xfid, byte[] p_xfin, boolean p_useRemote, String p_user, String p_password, int p_umask)
    Create a file generically from an XFID.
    void
    createXFile(byte[] p_xfid, byte[] p_xfin, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode)
    Create a file generically from an XFID.
    void
    createXFile(byte[] p_xfid, int p_xfidoffset, int p_xfidlen, byte[] p_xfin, int p_xfinoffset, int p_xfinlength, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode)
    Create a file generically from an XFID.
    default void
    createXFile(io.netty.buffer.ByteBuf p_xfid, io.netty.buffer.ByteBuf p_xfin, boolean p_useRemote, String p_mode)
    Create a file generically from an XFID.
    default void
    createXFile(ByteBuffer p_xfid, ByteBuffer p_xfin, boolean p_useRemote, String p_mode)
    Create a file generically from an XFID.
    void
    createXKeyedFile(String p_filename, int p_keySize, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote)
    Create a single keyed XKEYED file.
    void
    createXKeyedFile(String p_filename, int p_keySize, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, String p_mode)
    Create a single keyed XKEYED file.
    void
    createXKeyedFile(String p_filename, int p_keySize, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, String p_user, String p_password, int p_umask)
    Create a single keyed XKEYED file.
    void
    createXKeyedFile(String p_filename, int p_keySize, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode)
    Create a single keyed XKEYED file.
    void
    createXKeyedFile(String p_filename, List p_keys, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote)
    Create a multi keyed XKEYED file.
    void
    createXKeyedFile(String p_filename, List p_keys, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, String p_mode)
    Create a multi keyed XKEYED file.
    void
    createXKeyedFile(String p_filename, List p_keys, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, String p_user, String p_password, int p_umask)
    Create a multi keyed XKEYED file.
    void
    createXKeyedFile(String p_filename, List p_keys, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode)
    Create a multi keyed XKEYED file.
    void
    enableFcbCache(boolean p_enable)
    Enable or disable FCBCACHE.
    void
    Ensure that the session license is actually checked out, used with no-fee licenses in case you want to switch to a fee license.
    void
    erase(String p_filename, boolean p_useRemote)
    Erase a file.
    void
    erase(String p_filename, boolean p_useRemote, long p_timeout)
    Erase a file.
    void
    erase(String p_filename, boolean p_useRemote, long p_timeout, String p_user, String p_password)
    Erase a file.
    void
    erase(String p_filename, boolean p_useRemote, String p_user, String p_password)
    Erase a file.
    boolean
    exists(String p_filename, boolean p_useRemote)
    Does the named file exist?
    boolean
    exists(String p_filename, boolean p_useRemote, String p_user, String p_password)
    Does the named file exist?
    boolean
    Is the FCBCACHE enabled?
     
    int
    Get license available count.
     
    Get the connection id.
    Get the console for this ConnectionMgr.
    long
    Get the default open timeout.
    int
    Get the default filesystem server port.
    Get current directory.
    getDir(String p_user, String p_password)
    Get current directory.
    void
    obtaind DVKLicense.
    boolean
    Get whether we have an enterprise license.
    int
    Get license expiration date.
    boolean
    Get whether we have an fully functional license (as opposed to Runtime).
    Get the host for this ConnectionMgr.
    long
     
    getLicense(String p_feature, String p_version)
    Get a user specified license.
    Get license error message.
     
    Get local initialized user.
    int
    Get a machine unique id.
    Get the default password for this ConnectionMgr.
    int
    getPermissions(String p_filename, boolean p_useRemote)
     
    int
    getPermissions(String p_filename, boolean p_useRemote, String p_user, String p_password)
     
    int
    Get SAM Expiration date.
    void
    obtaind SAMLicense.
    boolean
    Get whether or not the prefix scan should check all roots.
    Get serial number from license connection.
    boolean
    Get whether we have an SQL Read/Write license.
    getTempFilename(String p_prefix, String p_suffix)
    Get a temporary local filename.
    getTempFilename(String p_prefix, String p_suffix, String p_directory)
    Get a temporary local filename.
    getTempFilename(String p_prefix, String p_suffix, String p_user, String p_password)
    Get a temporary local filename.
    getTempFilename(String p_prefix, String p_suffix, String p_directory, String p_user, String p_password)
    Get a temporary local filename.
    int
    Get the default UMASK.
    Get the default user name for this ConnectionMgr.
    int
    Get license user count.
    boolean
     
    boolean
    Get whether license information is available to the user.
    void
    Initialize the local (license) connection -- making sure that the license is checked out and license information is available.
    void
    initLocalConnection(com.basis.user.security.Token p_token)
    Initialize the local (license) connection -- making sure that the license is checked out and license information is available.
    void
    initLocalConnection(String p_user, String p_password)
    Initialize the local (license) connection -- making sure that the license is checked out and license information is available.
    boolean
    isFileLocal(String p_filename, boolean p_useRemote)
     
    boolean
    isLocal(InetAddress p_address, int p_port)
     
    boolean
    Is the license per connection?
    boolean
    isReadable(String p_filename, boolean p_useRemote)
    Is the named file readable?
    boolean
    isReadable(String p_filename, boolean p_useRemote, String p_user, String p_password)
    Is the named file readable?
    boolean
    Is SAM available?
    boolean
    isWritable(String p_filename, boolean p_useRemote)
    Is the named file writable?
    boolean
    isWritable(String p_filename, boolean p_useRemote, String p_user, String p_password)
    Is the named file writable?
    void
    mkdir(String p_filename, boolean p_useRemote)
    Create a directory.
    void
    mkdir(String p_filename, boolean p_useRemote, String p_user, String p_password, int p_umask)
    Create a directory.
    default FilePosition
    open(String p_filename, boolean p_readOnly, boolean p_useRemote)
    Open a file normally (per the file type).
    default FilePosition
    open(String p_filename, boolean p_readOnly, boolean p_useRemote, boolean p_advisoryLocking)
    Open a file normally (per the file type).
    default FilePosition
    open(String p_filename, boolean p_readOnly, int p_mode, boolean p_useRemote, String p_user, String p_password, List p_path, boolean p_advisoryLocking, int p_umask, String p_filePassword)
    Open a file normally (per the file type).
    open(String p_filename, boolean p_readOnly, int p_mode, boolean p_useRemote, String p_user, String p_password, List p_path, boolean p_advisoryLocking, int p_umask, String p_filePassword, long p_timeout)
    Open a file normally (per the file type).
    default FilePosition
    open(String p_filename, boolean p_readOnly, int p_mode, boolean p_useRemote, List p_path, boolean p_advisoryLocking, int p_umask)
    Open a file normally (per the file type).
    default FilePosition
    open(String p_filename, boolean p_readOnly, int p_mode, boolean p_useRemote, List p_path, boolean p_advisoryLocking, int p_umask, long p_timeout)
    Open a file normally (per the file type).
    default FilePosition
    open(String p_filename, boolean p_readOnly, int p_mode, boolean p_useRemote, List p_path, boolean p_advisoryLocking, int p_umask, String p_filePassword)
    Open a file normally (per the file type).
    default FilePosition
    open(String p_filename, boolean p_readOnly, int p_mode, boolean p_useRemote, List p_path, boolean p_advisoryLocking, int p_umask, String p_filePassword, long p_timeout)
    Open a file normally (per the file type).
    default FilePosition
    open(String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote)
    Open a file either as STRING or INDEXED.
    default FilePosition
    open(String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, boolean p_advisoryLocking)
    Open a file either as STRING or INDEXED.
    default FilePosition
    open(String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, boolean p_advisoryLocking, int p_umask)
    Open a file either as STRING or INDEXED.
    default FilePosition
    open(String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, String p_user, String p_password)
    Open a file either as STRING or INDEXED.
    default FilePosition
    open(String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, String p_user, String p_password, boolean p_advisoryLocking)
    Open a file either as STRING or INDEXED.
    default FilePosition
    open(String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, String p_user, String p_password, boolean p_advisoryLocking, int p_umask)
    Open a file either as STRING or INDEXED.
    default FilePosition
    open(String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, String p_user, String p_password, List p_path)
    Open a file either as STRING or INDEXED.
    default FilePosition
    open(String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, String p_user, String p_password, List p_path, boolean p_advisoryLocking)
    Open a file either as STRING or INDEXED.
    open(String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, String p_user, String p_password, List p_path, boolean p_advisoryLocking, int p_umask)
    Open a file either as STRING or INDEXED.
    default FilePosition
    open(String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, List p_path)
    Open a file either as STRING or INDEXED.
    default FilePosition
    open(String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, List p_path, boolean p_advisoryLocking)
    Open a file either as STRING or INDEXED.
    default FilePosition
    open(String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, List p_path, boolean p_advisoryLocking, int p_umask)
    Open a file either as STRING or INDEXED.
    default FilePosition
    open(String p_filename, boolean p_readOnly, int p_recordSize, String p_modes, boolean p_useRemote, boolean p_advisoryLocking, int p_umask)
    Open a file either as STRING or INDEXED.
    default FilePosition
    open(String p_filename, boolean p_readOnly, int p_recordSize, String p_modes, boolean p_useRemote, boolean p_advisoryLocking, int p_umask, long p_timeout)
    Open a file either as STRING or INDEXED.
    default FilePosition
    open(String p_filename, boolean p_readOnly, int p_recordSize, String p_modes, boolean p_useRemote, String p_user, String p_password, List p_path, boolean p_advisoryLocking, int p_umask)
    Open a file either as STRING or INDEXED.
    open(String p_filename, boolean p_readOnly, int p_recordSize, String p_modes, boolean p_useRemote, String p_user, String p_password, List p_path, boolean p_advisoryLocking, int p_umask, long p_timeout)
    Open a file either as STRING or INDEXED.
    default FilePosition
    open(String p_filename, boolean p_readOnly, int p_recordSize, String p_modes, boolean p_useRemote, List p_path, boolean p_advisoryLocking)
    Open a file either as STRING or INDEXED.
    default FilePosition
    open(String p_filename, boolean p_readOnly, int p_recordSize, String p_modes, boolean p_useRemote, List p_path, boolean p_advisoryLocking, int p_umask)
    Open a file either as STRING or INDEXED.
    default FilePosition
    open(String p_filename, boolean p_readOnly, int p_recordSize, String p_modes, boolean p_useRemote, List p_path, boolean p_advisoryLocking, int p_umask, long p_timeout)
    Open a file either as STRING or INDEXED.
    default FilePosition
    open(String p_filename, boolean p_readOnly, int p_recordSize, String p_modes, boolean p_useRemote, List p_path, boolean p_advisoryLocking, long p_timeout)
    Open a file either as STRING or INDEXED.
    default FilePosition
    open(String p_filename, boolean p_readOnly, String p_encryptPassword, boolean p_useRemote)
    Open a file normally (per the file type).
    default FilePosition
    open(String p_filename, boolean p_readOnly, String p_encryptPassword, boolean p_useRemote, boolean p_advisoryLocking)
     
    default FilePosition
    open(String p_filename, boolean p_readOnly, String p_modes, boolean p_useRemote, String p_user, String p_password, List p_path, boolean p_advisoryLocking, int p_umask, String p_filePassword)
    Open a file normally (per the file type).
    open(String p_filename, boolean p_readOnly, String p_modes, boolean p_useRemote, String p_user, String p_password, List p_path, boolean p_advisoryLocking, int p_umask, String p_filePassword, long p_timeout)
    Open a file normally (per the file type).
    default FilePosition
    open(String p_filename, boolean p_readOnly, String p_modes, boolean p_useRemote, List p_path, boolean p_advisoryLocking, int p_umask, String p_filePassword)
    Open a file normally (per the file type).
    default FilePosition
    open(String p_filename, boolean p_readOnly, String p_modes, boolean p_useRemote, List p_path, boolean p_advisoryLocking, int p_umask, String p_filePassword, long p_timeout)
    Open a file normally (per the file type).
    openSelect(String p_filename, String p_fieldList, String p_template, String p_where, String p_sortby, long p_limit, String p_mode, boolean p_useRemote, String p_user, String p_password, List p_path, boolean p_advisoryLocking, String p_filePassword)
    Open a file using SELECT.
    openSelect(String p_filename, String p_fieldList, String p_template, String p_where, String p_sortby, long p_limit, String p_mode, boolean p_useRemote, String p_user, String p_password, List p_path, boolean p_advisoryLocking, String p_filePassword, long p_timeout)
    Open a file using SELECT.
    openSelect(String p_filename, String p_fieldList, String p_template, String p_where, String p_sortby, long p_limit, String p_mode, boolean p_useRemote, List p_path, boolean p_advisoryLocking, String p_filePassword)
    Open a file using SELECT.
    openSelect(String p_filename, String p_fieldList, String p_template, String p_where, String p_sortby, long p_limit, String p_mode, boolean p_useRemote, List p_path, boolean p_advisoryLocking, String p_filePassword, long p_timeout)
    Open a file using SELECT.
    recover(String p_filename, boolean p_overwrite, boolean p_useRemote)
    Recover a recoverable file.
    recover(String p_filename, boolean p_overwrite, boolean p_useRemote, String p_filePassword)
    Recover a recoverable file.
    recover(String p_filename, boolean p_overwrite, boolean p_useRemote, String p_filePassword, long p_timeout)
    Recover a recoverable file.
    recover(String p_filename, boolean p_overwrite, boolean p_useRemote, String p_user, String p_password)
    Recover a recoverable file.
    recover(String p_filename, boolean p_overwrite, boolean p_useRemote, String p_user, String p_password, long p_timeout)
    Recover a recoverable file.
    recover(String p_filename, boolean p_overwrite, boolean p_useRemote, String p_user, String p_password, String p_filePassword)
    Recover a recoverable file.
    recover(String p_filename, boolean p_overwrite, boolean p_useRemote, String p_user, String p_password, String p_filePassword, long p_timeout)
    Recover a recoverable file.
    recover(String p_filename, boolean p_overwrite, boolean p_useRemote, String p_user, String p_password, String p_filePassword, long p_timeout, String p_modes)
    Recover a recoverable file.
    recover(String p_filename, boolean p_overwrite, boolean p_useRemote, String p_user, String p_password, String p_filePassword, long p_timeout, String p_modes, String p_tmpDir)
    Recover a recoverable file.
    void
     
    void
    rename(String p_fromFilename, String p_toFilename, boolean p_useRemote)
    Rename a file.
    void
    rename(String p_fromFilename, String p_toFilename, boolean p_useRemote, String p_user, String p_password)
    Rename a file.
    void
    rmdir(String p_filename, boolean p_useRemote)
    Remove a directory.
    void
    rmdir(String p_filename, boolean p_useRemote, long p_timeout)
    Remove a directory.
    void
    rmdir(String p_filename, boolean p_useRemote, long p_timeout, String p_user, String p_password)
    Remove a directory.
    void
    rmdir(String p_filename, boolean p_useRemote, String p_user, String p_password)
    Remove a directory.
    void
    setConnectionID(String p_connectionID)
    Set the connection id.
    void
    setConsole(String p_console)
     
    void
    setDefaultOpenTimeout(long p_timeout)
    Set the default open timeout.
    void
    setDisksyn(Map p_disksyn)
    Set disksyn map.
    void
    setEnforceEnterprise(boolean p_enforceEnterprise)
    Set whether the ConnectionMgr should enforce the enterprise license.
    void
     
    void
    Set the NagProcess that will be used to process the nag message for licensing.
    void
    setPassword(String p_password)
     
    void
    setPerConnection(boolean p_perConnection)
    Set per connection license
    void
    Set the prefix list used for opening files from a String path.
    void
    setPrefixes(String p_path, char p_separator)
    Set the prefix list used for opening files from a String path given a separator character.
    void
    setPrefixes(List p_prefixes)
    Set the prefix list used for opening files.
    void
    setScanAllRoots(boolean p_scan)
    Set whether or not the prefix scan should check all roots.
    void
    setUmask(int p_umask)
     
    void
    setUser(String p_user)
    Set the default user name for this ConnectionMgr.
    boolean
     
    void
     
    void
    Call to update the license.
    void
    Verify a license connection...
    boolean
     
  • Field Details

  • Method Details

    • addClearListener

      void addClearListener(ConnectionMgr.ClearListener p_listener)
    • removeClearListener

      void removeClearListener(ConnectionMgr.ClearListener p_listener)
    • getClearListeners

      List<ConnectionMgr.ClearListener> getClearListeners()
    • getLastUsed

      long getLastUsed()
    • updateLastUsed

      void updateLastUsed()
    • getDefaultOpenTimeout

      long getDefaultOpenTimeout()
      Get the default open timeout.
      Returns:
      Default open timeout in milliseconds.
    • setDefaultOpenTimeout

      void setDefaultOpenTimeout(long p_timeout)
      Set the default open timeout.
      Parameters:
      p_timeout - Default timeout for open in milliseconds,
    • getDefaultServerPort

      int getDefaultServerPort()
      Get the default filesystem server port.
      Returns:
      Default port that a filesystem server should be found on.
    • setUser

      void setUser(String p_user)
      Set the default user name for this ConnectionMgr.
      Parameters:
      p_user - Default user name for server connections from this ConnectionMgr.
    • setPassword

      void setPassword(String p_password)
    • setUmask

      void setUmask(int p_umask)
    • authenticateBBj

      void authenticateBBj(byte[] p_auth)
    • setConsole

      void setConsole(String p_console)
    • setPerConnection

      void setPerConnection(boolean p_perConnection)
      Set per connection license
      Parameters:
      p_perConnection -
    • setHost

      void setHost(InetAddress p_host)
    • setNagProcess

      void setNagProcess(NagProcess p_process)
      Set the NagProcess that will be used to process the nag message for licensing.
      Parameters:
      p_process - NagProcess instance that should be used to process nag messages.
    • getUser

      String getUser()
      Get the default user name for this ConnectionMgr.
      Returns:
      Default user name for the server connections from this ConnectionMgr.
    • getPassword

      String getPassword()
      Get the default password for this ConnectionMgr.
      Returns:
      Default password for the server connections from this ConnectionMgr.
    • getUmask

      int getUmask()
      Get the default UMASK.
      Returns:
      the default umask.
    • getConsole

      String getConsole()
      Get the console for this ConnectionMgr.
      Returns:
      Console for the server connections from this ConnectionMgr.
    • isPerConnection

      boolean isPerConnection()
      Is the license per connection?
      Returns:
      true if the license is per connection
    • getHost

      InetAddress getHost()
      Get the host for this ConnectionMgr. This value is ignored by the client side interface.
      Returns:
      Host used for licensing.
    • setScanAllRoots

      void setScanAllRoots(boolean p_scan)
      Set whether or not the prefix scan should check all roots.
    • getScanAllRoots

      boolean getScanAllRoots()
      Get whether or not the prefix scan should check all roots.
    • setPrefixes

      void setPrefixes(List p_prefixes)
      Set the prefix list used for opening files.
      Parameters:
      p_prefixes - List of strings to use as file name prefixes.
    • setPrefixes

      void setPrefixes(String p_path)
      Set the prefix list used for opening files from a String path.
      Parameters:
      p_path - String path of file name prefixes separated by the File.pathSeparatorChar.
    • setPrefixes

      void setPrefixes(String p_path, char p_separator)
      Set the prefix list used for opening files from a String path given a separator character.
      Parameters:
      p_path - String path of file name prefixes separated by the provided separator character.
      p_separator - Separator character to use in splitting the provided String path.
    • setDisksyn

      void setDisksyn(Map p_disksyn)
      Set disksyn map.
    • enableFcbCache

      void enableFcbCache(boolean p_enable)
      Enable or disable FCBCACHE.
      Parameters:
      p_enable - true if the FCBCACHE should be enabled.
    • fcbCacheEnabled

      boolean fcbCacheEnabled()
      Is the FCBCACHE enabled?
      Returns:
      true if the FCBCACHE is enabled.
    • clearFcbCache

      void clearFcbCache()
      Clear the FCBCACHE.
    • setConnectionID

      void setConnectionID(String p_connectionID)
      Set the connection id.
    • getConnectionID

      String getConnectionID()
      Get the connection id.
    • clear

      void clear()
      Clear any cache that might exist. This will ensure that there will be no cached connections still in existence and that the license connection is closed.
    • getLocalUser

      String getLocalUser()
      Get local initialized user.
      Returns:
      Local initialized user
    • initLocalConnection

      void initLocalConnection() throws FilesystemException
      Initialize the local (license) connection -- making sure that the license is checked out and license information is available. Functions will not work until this method has been called.
      Throws:
      FilesystemException - if there is a problem establishing a connection to the license (local) server.
    • initLocalConnection

      void initLocalConnection(String p_user, String p_password) throws FilesystemException
      Initialize the local (license) connection -- making sure that the license is checked out and license information is available. Functions will not work until this method has been called.
      Parameters:
      p_user - User name for the license connection.
      p_password - Password for the license connection.
      Throws:
      FilesystemException - if there is a problem establishing a connection to the license (local) server.
    • initLocalConnection

      void initLocalConnection(com.basis.user.security.Token p_token) throws FilesystemException
      Initialize the local (license) connection -- making sure that the license is checked out and license information is available. Functions will not work until this method has been called.
      Parameters:
      p_token - Auth token for the license connection.
      Throws:
      FilesystemException - if there is a problem establishing a connection to the license (local) server.
    • getLicenseVersion

      String getLicenseVersion() throws FilesystemException
      Throws:
      FilesystemException
    • getActualLicenseVersion

      String getActualLicenseVersion() throws FilesystemException
      Throws:
      FilesystemException
    • haveLicenseConnection

      boolean haveLicenseConnection()
      Get whether license information is available to the user.
      Returns:
      true if initLocalConnection has been called and license information is available to the user.
    • verifyLicenseConnection

      void verifyLicenseConnection() throws FilesystemException
      Verify a license connection...
      Throws:
      FilesystemException
    • checkoutLicense

      boolean checkoutLicense() throws FilesystemException
      Try to checkout a license using the license connection if one is not already checked out.
      Returns:
      true if a license is checked out.
      Throws:
      FilesystemException
    • ensureCheckout

      void ensureCheckout() throws FilesystemException
      Ensure that the session license is actually checked out, used with no-fee licenses in case you want to switch to a fee license.
      Throws:
      FilesystemException
    • getSerialNumber

      String getSerialNumber()
      Get serial number from license connection.
      Returns:
      Serial number or null if there is no license connection.
    • getLicenseMessage

      String getLicenseMessage() throws FilesystemException
      Get license error message.
      Returns:
      License error or null if no error.
      Throws:
      FilesystemException - TODO
    • shouldNag

      boolean shouldNag()
    • getEnterprise

      boolean getEnterprise()
      Get whether we have an enterprise license.
      Returns:
      true if the license is enterprise.
    • viewEnterprise

      boolean viewEnterprise()
    • setEnforceEnterprise

      void setEnforceEnterprise(boolean p_enforceEnterprise)
      Set whether the ConnectionMgr should enforce the enterprise license. The entails not allowing any file access to remote data servers if the license is not enterprise.
      Parameters:
      p_enforceEnterprise - true if enterprise licensing should be enforced.
    • getFullyFunctional

      boolean getFullyFunctional()
      Get whether we have an fully functional license (as opposed to Runtime).
      Returns:
      true if the license is fully functional.
    • getSQLReadWrite

      boolean getSQLReadWrite()
      Get whether we have an SQL Read/Write license.
      Returns:
      true if the license is SQL Read/Write.
    • getMachineUniqueId

      int getMachineUniqueId()
      Get a machine unique id.
      Returns:
      machine unique id.
    • getUserCount

      int getUserCount()
      Get license user count.
      Returns:
      license user count.
    • getAvailableCount

      int getAvailableCount()
      Get license available count.
      Returns:
      license available count.
    • getExpirationDate

      int getExpirationDate()
      Get license expiration date.
      Returns:
      license expiration as a Julian date.
    • isSAMAvailable

      boolean isSAMAvailable()
      Is SAM available?
      Returns:
      true if SAM is available
    • getSAMExpirationDate

      int getSAMExpirationDate()
      Get SAM Expiration date.
      Returns:
      SAM expiration date (0 if no SAM is available)
    • getLicense

      License getLicense(String p_feature, String p_version) throws FilesystemException
      Get a user specified license. This call will attempt to check out a user specified license and, if successful, return a License object to interact with it.
      Parameters:
      p_feature - Feature name.
      p_version - Version for the license.
      Returns:
      Checked out License instance.
      Throws:
      FilesystemException - if there is a problem talking to the license server or checking out the user specified license.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, boolean p_useRemote) throws FilesystemException
      Open a file normally (per the file type).
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_useRemote - true if a dataserver can be used.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, String p_encryptPassword, boolean p_useRemote) throws FilesystemException
      Open a file normally (per the file type).
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_encryptPassword - password for encrypted secure file.
      p_useRemote - true if a dataserver can be used.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, String p_encryptPassword, boolean p_useRemote, boolean p_advisoryLocking) throws FilesystemException
      Throws:
      FilesystemException
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, boolean p_useRemote, boolean p_advisoryLocking) throws FilesystemException
      Open a file normally (per the file type).
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_useRemote - true if a dataserver can be used.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, int p_mode, boolean p_useRemote, List p_path, boolean p_advisoryLocking, int p_umask) throws FilesystemException
      Open a file normally (per the file type).
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_mode - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_path - List of strings to use as a file path.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      p_umask - UMASK to use if the file is to be created.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, int p_mode, boolean p_useRemote, List p_path, boolean p_advisoryLocking, int p_umask, long p_timeout) throws FilesystemException
      Open a file normally (per the file type).
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_mode - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_path - List of strings to use as a file path.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      p_umask - UMASK to use if the file is to be created.
      p_timeout - Open timeout.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, int p_mode, boolean p_useRemote, List p_path, boolean p_advisoryLocking, int p_umask, String p_filePassword) throws FilesystemException
      Open a file normally (per the file type).
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_mode - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_path - List of strings to use as a file path.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      p_umask - UMASK to use if the file is to be created.
      p_filePassword - Password for secure file.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, int p_mode, boolean p_useRemote, List p_path, boolean p_advisoryLocking, int p_umask, String p_filePassword, long p_timeout) throws FilesystemException
      Open a file normally (per the file type).
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_mode - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_path - List of strings to use as a file path.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      p_umask - UMASK to use if the file is to be created.
      p_filePassword - Password for secure file.
      p_timeout - Open timeout.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, String p_modes, boolean p_useRemote, List p_path, boolean p_advisoryLocking, int p_umask, String p_filePassword) throws FilesystemException
      Open a file normally (per the file type).
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_modes - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_path - List of strings to use as a file path.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      p_umask - UMASK to use if the file is to be created.
      p_filePassword - Password for secure file.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, String p_modes, boolean p_useRemote, List p_path, boolean p_advisoryLocking, int p_umask, String p_filePassword, long p_timeout) throws FilesystemException
      Open a file normally (per the file type).
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_modes - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_path - List of strings to use as a file path.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      p_umask - UMASK to use if the file is to be created.
      p_filePassword - Password for secure file.
      p_timeout - Open timeout.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, int p_mode, boolean p_useRemote, String p_user, String p_password, List p_path, boolean p_advisoryLocking, int p_umask, String p_filePassword) throws FilesystemException
      Open a file normally (per the file type).
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_mode - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_path - List of strings to use as a file path.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      p_umask - UMASK to use if the file is to be created.
      p_filePassword - Password for secure file.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      FilePosition open(String p_filename, boolean p_readOnly, int p_mode, boolean p_useRemote, String p_user, String p_password, List p_path, boolean p_advisoryLocking, int p_umask, String p_filePassword, long p_timeout) throws FilesystemException
      Open a file normally (per the file type).
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_mode - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_path - List of strings to use as a file path.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      p_umask - UMASK to use if the file is to be created.
      p_filePassword - Password for secure file.
      p_timeout - Open timeout.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, String p_modes, boolean p_useRemote, String p_user, String p_password, List p_path, boolean p_advisoryLocking, int p_umask, String p_filePassword) throws FilesystemException
      Open a file normally (per the file type).
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_modes - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_path - List of strings to use as a file path.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      p_umask - UMASK to use if the file is to be created.
      p_filePassword - Password for secure file.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      FilePosition open(String p_filename, boolean p_readOnly, String p_modes, boolean p_useRemote, String p_user, String p_password, List p_path, boolean p_advisoryLocking, int p_umask, String p_filePassword, long p_timeout) throws FilesystemException
      Open a file normally (per the file type).
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_modes - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_path - List of strings to use as a file path.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      p_umask - UMASK to use if the file is to be created.
      p_filePassword - Password for secure file.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote) throws FilesystemException
      Open a file either as STRING or INDEXED.
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_recordSize - Open the file as an INDEXED file using this as the record size. If this is negative, open the file as a STRING file.
      p_useRemote - true if a dataserver can be used.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, boolean p_advisoryLocking) throws FilesystemException
      Open a file either as STRING or INDEXED.
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_recordSize - Open the file as an INDEXED file using this as the record size. If this is negative, open the file as a STRING file.
      p_mode - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, boolean p_advisoryLocking, int p_umask) throws FilesystemException
      Open a file either as STRING or INDEXED.
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_recordSize - Open the file as an INDEXED file using this as the record size. If this is negative, open the file as a STRING file.
      p_mode - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      p_umask - UMASK to use if the file is to be created.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, int p_recordSize, String p_modes, boolean p_useRemote, boolean p_advisoryLocking, int p_umask) throws FilesystemException
      Open a file either as STRING or INDEXED.
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_recordSize - Open the file as an INDEXED file using this as the record size. If this is negative, open the file as a STRING file.
      p_modes - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      p_umask - UMASK to use if the file is to be created.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, int p_recordSize, String p_modes, boolean p_useRemote, boolean p_advisoryLocking, int p_umask, long p_timeout) throws FilesystemException
      Open a file either as STRING or INDEXED.
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_recordSize - Open the file as an INDEXED file using this as the record size. If this is negative, open the file as a STRING file.
      p_modes - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      p_umask - UMASK to use if the file is to be created.
      p_timeout - Open timeout.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, List p_path) throws FilesystemException
      Open a file either as STRING or INDEXED.
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_recordSize - Open the file as an INDEXED file using this as the record size. If this is negative, open the file as a STRING file.
      p_mode - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_path - List of strings to use as a file path.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, List p_path, boolean p_advisoryLocking) throws FilesystemException
      Open a file either as STRING or INDEXED.
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_recordSize - Open the file as an INDEXED file using this as the record size. If this is negative, open the file as a STRING file.
      p_mode - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_path - List of strings to use as a file path.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, int p_recordSize, String p_modes, boolean p_useRemote, List p_path, boolean p_advisoryLocking) throws FilesystemException
      Open a file either as STRING or INDEXED.
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_recordSize - Open the file as an INDEXED file using this as the record size. If this is negative, open the file as a STRING file.
      p_modes - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_path - List of strings to use as a file path.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, int p_recordSize, String p_modes, boolean p_useRemote, List p_path, boolean p_advisoryLocking, long p_timeout) throws FilesystemException
      Open a file either as STRING or INDEXED.
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_recordSize - Open the file as an INDEXED file using this as the record size. If this is negative, open the file as a STRING file.
      p_modes - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_path - List of strings to use as a file path.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      p_timeout - Open timeout.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, List p_path, boolean p_advisoryLocking, int p_umask) throws FilesystemException
      Open a file either as STRING or INDEXED.
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_recordSize - Open the file as an INDEXED file using this as the record size. If this is negative, open the file as a STRING file.
      p_mode - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_path - List of strings to use as a file path.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      p_umask - UMASK to use if the file is to be created.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, int p_recordSize, String p_modes, boolean p_useRemote, List p_path, boolean p_advisoryLocking, int p_umask) throws FilesystemException
      Open a file either as STRING or INDEXED.
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_recordSize - Open the file as an INDEXED file using this as the record size. If this is negative, open the file as a STRING file.
      p_modes - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_path - List of strings to use as a file path.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      p_umask - UMASK to use if the file is to be created.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, int p_recordSize, String p_modes, boolean p_useRemote, List p_path, boolean p_advisoryLocking, int p_umask, long p_timeout) throws FilesystemException
      Open a file either as STRING or INDEXED.
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_recordSize - Open the file as an INDEXED file using this as the record size. If this is negative, open the file as a STRING file.
      p_modes - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_path - List of strings to use as a file path.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      p_umask - UMASK to use if the file is to be created.
      p_timeout - Open timeout.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, String p_user, String p_password) throws FilesystemException
      Open a file either as STRING or INDEXED.
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_recordSize - Open the file as an INDEXED file using this as the record size. If this is negative, open the file as a STRING file.
      p_mode - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, String p_user, String p_password, boolean p_advisoryLocking) throws FilesystemException
      Open a file either as STRING or INDEXED.
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_recordSize - Open the file as an INDEXED file using this as the record size. If this is negative, open the file as a STRING file.
      p_mode - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, String p_user, String p_password, boolean p_advisoryLocking, int p_umask) throws FilesystemException
      Open a file either as STRING or INDEXED.
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_recordSize - Open the file as an INDEXED file using this as the record size. If this is negative, open the file as a STRING file.
      p_mode - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      p_umask - UMASK to use if the file is to be created.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, String p_user, String p_password, List p_path) throws FilesystemException
      Open a file either as STRING or INDEXED.
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_recordSize - Open the file as an INDEXED file using this as the record size. If this is negative, open the file as a STRING file.
      p_mode - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_path - List of strings to use as a file path.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, String p_user, String p_password, List p_path, boolean p_advisoryLocking) throws FilesystemException
      Open a file either as STRING or INDEXED.
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_recordSize - Open the file as an INDEXED file using this as the record size. If this is negative, open the file as a STRING file.
      p_mode - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_path - List of strings to use as a file path.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      FilePosition open(String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, String p_user, String p_password, List p_path, boolean p_advisoryLocking, int p_umask) throws FilesystemException
      Open a file either as STRING or INDEXED.
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_recordSize - Open the file as an INDEXED file using this as the record size. If this is negative, open the file as a STRING file.
      p_mode - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_path - List of strings to use as a file path.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      p_umask - UMASK to use if the file is to be created.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      default FilePosition open(String p_filename, boolean p_readOnly, int p_recordSize, String p_modes, boolean p_useRemote, String p_user, String p_password, List p_path, boolean p_advisoryLocking, int p_umask) throws FilesystemException
      Open a file either as STRING or INDEXED.
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_recordSize - Open the file as an INDEXED file using this as the record size. If this is negative, open the file as a STRING file.
      p_modes - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_path - List of strings to use as a file path.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      p_umask - UMASK to use if the file is to be created.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • open

      FilePosition open(String p_filename, boolean p_readOnly, int p_recordSize, String p_modes, boolean p_useRemote, String p_user, String p_password, List p_path, boolean p_advisoryLocking, int p_umask, long p_timeout) throws FilesystemException
      Open a file either as STRING or INDEXED.
      Parameters:
      p_filename - File to open.
      p_readOnly - true if the file should be opened read only.
      p_recordSize - Open the file as an INDEXED file using this as the record size. If this is negative, open the file as a STRING file.
      p_modes - Modes for file open.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_path - List of strings to use as a file path.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      p_umask - UMASK to use if the file is to be created.
      p_timeout - Open timeout.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • openSelect

      FilePosition openSelect(String p_filename, String p_fieldList, String p_template, String p_where, String p_sortby, long p_limit, String p_mode, boolean p_useRemote, List p_path, boolean p_advisoryLocking, String p_filePassword) throws FilesystemException
      Open a file using SELECT. This impliments the functionality of the BBj SELECT verb using the SQL Engine of the BASIS DBMS.
      Parameters:
      p_filename - File to open.
      p_template - Template for file records. This template decribes the data format of the file for the query.
      p_where - Where clause for the SQL SELECT.
      p_sortby - Sort clause for the SQL ORDER BY.
      p_limit - Limit on number of records to return.
      p_mode - Modes for SELECT.
      p_useRemote - true if a dataserver can be used.
      p_path - List of strings to use as a file path.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      p_filePassword - Password for secure file.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • openSelect

      FilePosition openSelect(String p_filename, String p_fieldList, String p_template, String p_where, String p_sortby, long p_limit, String p_mode, boolean p_useRemote, List p_path, boolean p_advisoryLocking, String p_filePassword, long p_timeout) throws FilesystemException
      Open a file using SELECT. This impliments the functionality of the BBj SELECT verb using the SQL Engine of the BASIS DBMS.
      Parameters:
      p_filename - File to open.
      p_template - Template for file records. This template decribes the data format of the file for the query.
      p_where - Where clause for the SQL SELECT.
      p_sortby - Sort clause for the SQL ORDER BY.
      p_limit - Limit on number of records to return.
      p_mode - Modes for SELECT.
      p_useRemote - true if a dataserver can be used.
      p_path - List of strings to use as a file path.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      p_filePassword - Password for secure file.
      p_timeout - Open timeout.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • openSelect

      FilePosition openSelect(String p_filename, String p_fieldList, String p_template, String p_where, String p_sortby, long p_limit, String p_mode, boolean p_useRemote, String p_user, String p_password, List p_path, boolean p_advisoryLocking, String p_filePassword) throws FilesystemException
      Open a file using SELECT. This impliments the functionality of the BBj SELECT verb using the SQL Engine of the BASIS DBMS.
      Parameters:
      p_filename - File to open.
      p_template - Template for file records. This template decribes the data format of the file for the query.
      p_where - Where clause for the SQL SELECT.
      p_sortby - Sort clause for the SQL ORDER BY.
      p_limit - Limit on number of records to return.
      p_mode - Modes for SELECT.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_path - List of strings to use as a file path.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      p_filePassword - Password for secure file.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • openSelect

      FilePosition openSelect(String p_filename, String p_fieldList, String p_template, String p_where, String p_sortby, long p_limit, String p_mode, boolean p_useRemote, String p_user, String p_password, List p_path, boolean p_advisoryLocking, String p_filePassword, long p_timeout) throws FilesystemException
      Open a file using SELECT. This impliments the functionality of the BBj SELECT verb using the SQL Engine of the BASIS DBMS.
      Parameters:
      p_filename - File to open.
      p_template - Template for file records. This template decribes the data format of the file for the query.
      p_where - Where clause for the SQL SELECT.
      p_sortby - Sort clause for the SQL ORDER BY.
      p_limit - Limit on number of records to return.
      p_mode - Modes for SELECT.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_path - List of strings to use as a file path.
      p_advisoryLocking - true if the file should be opened using advisory locking.
      p_filePassword - Password for secure file.
      p_timeout - Open timeout.
      Returns:
      FilePosition opened.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createFile

      void createFile(byte[] p_fid, boolean p_useRemote) throws FilesystemException
      Create a file generically from a FID.
      Parameters:
      p_fid - FID byte array as returned by the getFID method of FilePosition.
      p_useRemote - true if a dataserver can be used.
      Throws:
      FilesystemException - If a filesystem problem occurs.
      See Also:
    • createFile

      void createFile(byte[] p_fid, int p_fidlen, boolean p_useRemote) throws FilesystemException
      Create a file generically from a FID.
      Parameters:
      p_fid - FID byte array as returned by the getFID method of FilePosition.
      p_useRemote - true if a dataserver can be used.
      Throws:
      FilesystemException - If a filesystem problem occurs.
      See Also:
    • createFile

      void createFile(byte[] p_fid, int p_fidlen, boolean p_useRemote, String p_mode) throws FilesystemException
      Create a file generically from a FID.
      Parameters:
      p_fid - FID byte array as returned by the getFID method of FilePosition.
      p_useRemote - true if a dataserver can be used.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
      See Also:
    • createFile

      void createFile(byte[] p_fid, boolean p_useRemote, String p_user, String p_password, int p_umask) throws FilesystemException
      Create a file generically from a FID.
      Parameters:
      p_fid - FID byte array as returned by the getFID method of FilePosition.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      Throws:
      FilesystemException - If a filesystem problem occurs.
      See Also:
    • createFile

      void createFile(byte[] p_fid, int p_fidlen, boolean p_useRemote, String p_user, String p_password, int p_umask) throws FilesystemException
      Create a file generically from a FID.
      Parameters:
      p_fid - FID byte array as returned by the getFID method of FilePosition.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      Throws:
      FilesystemException - If a filesystem problem occurs.
      See Also:
    • createFile

      void createFile(byte[] p_fid, byte[] p_fin, boolean p_useRemote) throws FilesystemException
      Create a file generically from a FID.
      Parameters:
      p_fid - FID byte array as returned by the getFID method of FilePosition.
      p_fin - FIN byte array as returned by the getFIN method of FilePosition. The is can be used in the creation of MKEYED and XKEYED files.
      p_useRemote - true if a dataserver can be used.
      Throws:
      FilesystemException - If a filesystem problem occurs.
      See Also:
    • createFile

      void createFile(byte[] p_fid, int p_fidlen, byte[] p_fin, int p_finlen, boolean p_useRemote) throws FilesystemException
      Create a file generically from a FID.
      Parameters:
      p_fid - FID byte array as returned by the getFID method of FilePosition.
      p_fin - FIN byte array as returned by the getFIN method of FilePosition. The is can be used in the creation of MKEYED and XKEYED files.
      p_useRemote - true if a dataserver can be used.
      Throws:
      FilesystemException - If a filesystem problem occurs.
      See Also:
    • createFile

      void createFile(byte[] p_fid, int p_fidlen, byte[] p_fin, int p_finlen, boolean p_useRemote, String p_mode) throws FilesystemException
      Create a file generically from a FID.
      Parameters:
      p_fid - FID byte array as returned by the getFID method of FilePosition.
      p_fin - FIN byte array as returned by the getFIN method of FilePosition. The is can be used in the creation of MKEYED and XKEYED files.
      p_useRemote - true if a dataserver can be used.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
      See Also:
    • createFile

      default void createFile(ByteBuffer p_fid, ByteBuffer p_fin, boolean p_useRemote, String p_mode) throws FilesystemException
      Create a file generically from a FID.
      Parameters:
      p_fid - FID byte array as returned by the getFID method of FilePosition.
      p_fin - FIN byte array as returned by the getFIN method of FilePosition. The is can be used in the creation of MKEYED and XKEYED files.
      p_useRemote - true if a dataserver can be used.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
      See Also:
    • createFile

      default void createFile(io.netty.buffer.ByteBuf p_fid, io.netty.buffer.ByteBuf p_fin, boolean p_useRemote, String p_mode) throws FilesystemException
      Create a file generically from a FID.
      Parameters:
      p_fid - FID byte array as returned by the getFID method of FilePosition.
      p_fin - FIN byte array as returned by the getFIN method of FilePosition. The is can be used in the creation of MKEYED and XKEYED files.
      p_useRemote - true if a dataserver can be used.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
      See Also:
    • createFile

      void createFile(byte[] p_fid, byte[] p_fin, boolean p_useRemote, String p_user, String p_password, int p_umask) throws FilesystemException
      Create a file generically from a FID.
      Parameters:
      p_fid - FID byte array as returned by the getFID method of FilePosition.
      p_fin - FIN byte array as returned by the getFIN method of FilePosition. The is can be used in the creation of MKEYED and XKEYED files.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      Throws:
      FilesystemException - If a filesystem problem occurs.
      See Also:
    • createFile

      void createFile(byte[] p_fid, int p_fidlen, byte[] p_fin, int p_finlen, boolean p_useRemote, String p_user, String p_password, int p_umask) throws FilesystemException
      Create a file generically from a FID.
      Parameters:
      p_fid - FID byte array as returned by the getFID method of FilePosition.
      p_fin - FIN byte array as returned by the getFIN method of FilePosition. The is can be used in the creation of MKEYED and XKEYED files.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      Throws:
      FilesystemException - If a filesystem problem occurs.
      See Also:
    • createFile

      void createFile(byte[] p_fid, int p_fidlen, byte[] p_fin, int p_finlen, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode) throws FilesystemException
      Create a file generically from a FID.
      Parameters:
      p_fid - FID byte array as returned by the getFID method of FilePosition.
      p_fin - FIN byte array as returned by the getFIN method of FilePosition. The is can be used in the creation of MKEYED and XKEYED files.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
      See Also:
    • createFile

      void createFile(byte[] p_fid, int p_fidOffset, int p_fidlen, byte[] p_fin, int p_finOffset, int p_finlen, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode) throws FilesystemException
      Create a file generically from a FID.
      Parameters:
      p_fid - FID byte array as returned by the getFID method of FilePosition.
      p_fin - FIN byte array as returned by the getFIN method of FilePosition. The is can be used in the creation of MKEYED and XKEYED files.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
      See Also:
    • createXFile

      void createXFile(byte[] p_xfid, boolean p_useRemote) throws FilesystemException
      Create a file generically from an XFID.
      Parameters:
      p_xfid - XFID byte array as returned by the getXFID method of FilePosition.
      p_useRemote - true if a dataserver can be used.
      Throws:
      FilesystemException - If a filesystem problem occurs.
      See Also:
    • createXFile

      void createXFile(byte[] p_xfid, boolean p_useRemote, String p_mode) throws FilesystemException
      Create a file generically from an XFID.
      Parameters:
      p_xfid - XFID byte array as returned by the getXFID method of FilePosition.
      p_useRemote - true if a dataserver can be used.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
      See Also:
    • createXFile

      void createXFile(byte[] p_xfid, boolean p_useRemote, String p_user, String p_password, int p_umask) throws FilesystemException
      Create a file generically from an XFID.
      Parameters:
      p_xfid - XFID byte array as returned by the getXFID method of FilePosition.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      Throws:
      FilesystemException - If a filesystem problem occurs.
      See Also:
    • createXFile

      void createXFile(byte[] p_xfid, byte[] p_xfin, boolean p_useRemote) throws FilesystemException
      Create a file generically from an XFID.
      Parameters:
      p_xfid - XFID byte array as returned by the getXFID method of FilePosition.
      p_xfin - XFIN byte array as returned by the getXFIN method of FilePosition. The is can be used in the creation of MKEYED and XKEYED files.
      p_useRemote - true if a dataserver can be used.
      Throws:
      FilesystemException - If a filesystem problem occurs.
      See Also:
    • createXFile

      void createXFile(byte[] p_xfid, byte[] p_xfin, boolean p_useRemote, String p_mode) throws FilesystemException
      Create a file generically from an XFID.
      Parameters:
      p_xfid - XFID byte array as returned by the getXFID method of FilePosition.
      p_xfin - XFIN byte array as returned by the getXFIN method of FilePosition. The is can be used in the creation of MKEYED and XKEYED files.
      p_useRemote - true if a dataserver can be used.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
      See Also:
    • createXFile

      default void createXFile(ByteBuffer p_xfid, ByteBuffer p_xfin, boolean p_useRemote, String p_mode) throws FilesystemException
      Create a file generically from an XFID.
      Parameters:
      p_xfid - XFID byte array as returned by the getXFID method of FilePosition.
      p_xfin - XFIN byte array as returned by the getXFIN method of FilePosition. The is can be used in the creation of MKEYED and XKEYED files.
      p_useRemote - true if a dataserver can be used.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
      See Also:
    • createXFile

      default void createXFile(io.netty.buffer.ByteBuf p_xfid, io.netty.buffer.ByteBuf p_xfin, boolean p_useRemote, String p_mode) throws FilesystemException
      Create a file generically from an XFID.
      Parameters:
      p_xfid - XFID byte array as returned by the getXFID method of FilePosition.
      p_xfin - XFIN byte array as returned by the getXFIN method of FilePosition. The is can be used in the creation of MKEYED and XKEYED files.
      p_useRemote - true if a dataserver can be used.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
      See Also:
    • createXFile

      void createXFile(byte[] p_xfid, byte[] p_xfin, boolean p_useRemote, String p_user, String p_password, int p_umask) throws FilesystemException
      Create a file generically from an XFID.
      Parameters:
      p_xfid - XFID byte array as returned by the getXFID method of FilePosition.
      p_xfin - XFIN byte array as returned by the getXFIN method of FilePosition. The is can be used in the creation of MKEYED and XKEYED files.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      Throws:
      FilesystemException - If a filesystem problem occurs.
      See Also:
    • createXFile

      void createXFile(byte[] p_xfid, byte[] p_xfin, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode) throws FilesystemException
      Create a file generically from an XFID.
      Parameters:
      p_xfid - XFID byte array as returned by the getXFID method of FilePosition.
      p_xfin - XFIN byte array as returned by the getXFIN method of FilePosition. The is can be used in the creation of MKEYED and XKEYED files.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
      See Also:
    • createXFile

      void createXFile(byte[] p_xfid, int p_xfidoffset, int p_xfidlen, byte[] p_xfin, int p_xfinoffset, int p_xfinlength, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode) throws FilesystemException
      Create a file generically from an XFID.
      Parameters:
      p_xfid - XFID byte array as returned by the getXFID method of FilePosition.
      p_xfin - XFIN byte array as returned by the getXFIN method of FilePosition. The is can be used in the creation of MKEYED and XKEYED files.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
      See Also:
    • createStringFile

      void createStringFile(String p_filename, boolean p_useRemote) throws FilesystemException
      Create a STRING file.
      Parameters:
      p_filename - File to create.
      p_useRemote - true if a dataserver can be used.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createStringFile

      void createStringFile(String p_filename, boolean p_useRemote, String p_mode) throws FilesystemException
      Create a STRING file.
      Parameters:
      p_filename - File to create.
      p_useRemote - true if a dataserver can be used.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createStringFile

      void createStringFile(String p_filename, boolean p_useRemote, String p_user, String p_password, int p_umask) throws FilesystemException
      Create a STRING file.
      Parameters:
      p_filename - File to create.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createStringFile

      void createStringFile(String p_filename, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode) throws FilesystemException
      Create a STRING file.
      Parameters:
      p_filename - File to create.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createSerialFile

      void createSerialFile(String p_filename, long p_records, int p_recordSize, boolean p_useRemote) throws FilesystemException
      Create a SERIAL file.
      Parameters:
      p_filename - File to create.
      p_records - Number of records -- this is just recorded, not used.
      p_recordSize - Size of a record -- this is just recorded, not used.
      p_useRemote - true if a dataserver can be used.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createSerialFile

      void createSerialFile(String p_filename, long p_records, int p_recordSize, boolean p_useRemote, String p_mode) throws FilesystemException
      Create a SERIAL file.
      Parameters:
      p_filename - File to create.
      p_records - Number of records -- this is just recorded, not used.
      p_recordSize - Size of a record -- this is just recorded, not used.
      p_useRemote - true if a dataserver can be used.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createSerialFile

      void createSerialFile(String p_filename, long p_records, int p_recordSize, boolean p_useRemote, String p_user, String p_password, int p_umask) throws FilesystemException
      Create a SERIAL file.
      Parameters:
      p_filename - File to create.
      p_records - Number of records -- this is just recorded, not used.
      p_recordSize - Size of a record -- this is just recorded, not used.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createSerialFile

      void createSerialFile(String p_filename, long p_records, int p_recordSize, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode) throws FilesystemException
      Create a SERIAL file.
      Parameters:
      p_filename - File to create.
      p_records - Number of records -- this is just recorded, not used.
      p_recordSize - Size of a record -- this is just recorded, not used.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createIndexedFile

      void createIndexedFile(String p_filename, long p_records, int p_recordSize, boolean p_useRemote) throws FilesystemException
      Create an INDEXED file.
      Parameters:
      p_filename - File to create.
      p_records - Number of records -- must be greater than 0.
      p_recordSize - Size of a record -- this is a number between 1 and 32767 inclusive.
      p_useRemote - true if a dataserver can be used.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createIndexedFile

      void createIndexedFile(String p_filename, long p_records, int p_recordSize, boolean p_useRemote, String p_mode) throws FilesystemException
      Create an INDEXED file.
      Parameters:
      p_filename - File to create.
      p_records - Number of records -- must be greater than 0.
      p_recordSize - Size of a record -- this is a number between 1 and 32767 inclusive.
      p_useRemote - true if a dataserver can be used.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createIndexedFile

      void createIndexedFile(String p_filename, long p_records, int p_recordSize, boolean p_useRemote, String p_user, String p_password, int p_umask) throws FilesystemException
      Create an INDEXED file.
      Parameters:
      p_filename - File to create.
      p_records - Number of records -- must be greater than 0.
      p_recordSize - Size of a record -- this is a number between 1 and 32767 inclusive.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createIndexedFile

      void createIndexedFile(String p_filename, long p_records, int p_recordSize, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode) throws FilesystemException
      Create an INDEXED file.
      Parameters:
      p_filename - File to create.
      p_records - Number of records -- must be greater than 0.
      p_recordSize - Size of a record -- this is a number between 1 and 32767 inclusive.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createDirectFile

      void createDirectFile(String p_filename, byte p_keySize, long p_records, int p_recordSize, boolean p_useRemote) throws FilesystemException
      Create a DIRECT or SORT file. A SORT file is just a DIRECT file with a record size of 0.
      Parameters:
      p_filename - File to create.
      p_keySize - Size of a key -- this is a number between 1 and 64 inclusive.
      p_records - Number of records -- must be greater than 0.
      p_recordSize - Size of a record -- this is a number between 0 and 32767 inclusive.
      p_useRemote - true if a dataserver can be used.
      Throws:
      FilesystemException - If an filesystem exception occurs.
    • createDirectFile

      void createDirectFile(String p_filename, byte p_keySize, long p_records, int p_recordSize, boolean p_useRemote, String p_mode) throws FilesystemException
      Create a DIRECT or SORT file. A SORT file is just a DIRECT file with a record size of 0.
      Parameters:
      p_filename - File to create.
      p_keySize - Size of a key -- this is a number between 1 and 64 inclusive.
      p_records - Number of records -- must be greater than 0.
      p_recordSize - Size of a record -- this is a number between 0 and 32767 inclusive.
      p_useRemote - true if a dataserver can be used.
      p_mode - Mode string.
      Throws:
      FilesystemException - If an filesystem exception occurs.
    • createDirectFile

      void createDirectFile(String p_filename, byte p_keySize, long p_records, int p_recordSize, boolean p_useRemote, String p_user, String p_password, int p_umask) throws FilesystemException
      Create a DIRECT or SORT file. A SORT file is just a DIRECT file with a record size of 0.
      Parameters:
      p_filename - File to create.
      p_keySize - Size of a key -- this is a number between 1 and 64 inclusive.
      p_records - Number of records -- must be greater than 0.
      p_recordSize - Size of a record -- this is a number between 0 and 32767 inclusive.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      Throws:
      FilesystemException - If an filesystem exception occurs.
    • createDirectFile

      void createDirectFile(String p_filename, byte p_keySize, long p_records, int p_recordSize, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode) throws FilesystemException
      Create a DIRECT or SORT file. A SORT file is just a DIRECT file with a record size of 0.
      Parameters:
      p_filename - File to create.
      p_keySize - Size of a key -- this is a number between 1 and 64 inclusive.
      p_records - Number of records -- must be greater than 0.
      p_recordSize - Size of a record -- this is a number between 0 and 32767 inclusive.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      p_mode - Mode string.
      Throws:
      FilesystemException - If an filesystem exception occurs.
    • createMKeyedFile

      void createMKeyedFile(String p_filename, byte p_keySize, long p_records, int p_recordSize, boolean p_64bit, boolean p_tagged, boolean p_useRemote) throws FilesystemException
      Create a single keyed MKEYED file.
      Parameters:
      p_filename - File to create.
      p_keySize - Size of a key -- this is a number between 1 and 120 inclusive.
      p_records - Number of records -- if this number is 0 the file will be dynamically allocated.
      p_recordSize - Size of a record -- this is a number between 0 and 32767 inclusive.
      p_64bit - true if the file should be 64 bit (large file).
      p_tagged - true if the file should have tagged records (highly recoverable).
      p_useRemote - true if a dataserver can be used.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createMKeyedFile

      void createMKeyedFile(String p_filename, byte p_keySize, long p_records, int p_recordSize, boolean p_64bit, boolean p_tagged, boolean p_useRemote, String p_mode) throws FilesystemException
      Create a single keyed MKEYED file.
      Parameters:
      p_filename - File to create.
      p_keySize - Size of a key -- this is a number between 1 and 120 inclusive.
      p_records - Number of records -- if this number is 0 the file will be dynamically allocated.
      p_recordSize - Size of a record -- this is a number between 0 and 32767 inclusive.
      p_64bit - true if the file should be 64 bit (large file).
      p_tagged - true if the file should have tagged records (highly recoverable).
      p_useRemote - true if a dataserver can be used.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createMKeyedFile

      void createMKeyedFile(String p_filename, byte p_keySize, long p_records, int p_recordSize, boolean p_64bit, boolean p_tagged, boolean p_useRemote, String p_user, String p_password, int p_umask) throws FilesystemException
      Create a single keyed MKEYED file.
      Parameters:
      p_filename - File to create.
      p_keySize - Size of a key -- this is a number between 1 and 120 inclusive.
      p_records - Number of records -- if this number is 0 the file will be dynamically allocated.
      p_recordSize - Size of a record -- this is a number between 0 and 32767 inclusive.
      p_64bit - true if the file should be 64 bit (large file).
      p_tagged - true if the file should have tagged records (highly recoverable).
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createMKeyedFile

      void createMKeyedFile(String p_filename, byte p_keySize, long p_records, int p_recordSize, boolean p_64bit, boolean p_tagged, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode) throws FilesystemException
      Create a single keyed MKEYED file.
      Parameters:
      p_filename - File to create.
      p_keySize - Size of a key -- this is a number between 1 and 120 inclusive.
      p_records - Number of records -- if this number is 0 the file will be dynamically allocated.
      p_recordSize - Size of a record -- this is a number between 0 and 32767 inclusive.
      p_64bit - true if the file should be 64 bit (large file).
      p_tagged - true if the file should have tagged records (highly recoverable).
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createMKeyedFile

      void createMKeyedFile(String p_filename, List p_keys, long p_records, int p_recordSize, boolean p_64bit, boolean p_tagged, boolean p_useRemote) throws FilesystemException
      Create a multi keyed MKEYED file.
      Parameters:
      p_filename - File to create.
      p_keys - List of KeyDescription objects -- There must be a maximum of 16 keys with up to 48 segments total.
      p_records - Number of records -- if this number is 0 the file will be dynamically allocated.
      p_recordSize - Size of a record -- this is a number between 0 and 32767 inclusive.
      p_64bit - true if the file should be 64 bit (large file).
      p_tagged - true if the file should have tagged records (highly recoverable).
      p_useRemote - true if a dataserver can be used.
      Throws:
      FilesystemException - If a filesystem problem occurs.
      See Also:
    • createMKeyedFile

      void createMKeyedFile(String p_filename, List p_keys, long p_records, int p_recordSize, boolean p_64bit, boolean p_tagged, boolean p_useRemote, String p_mode) throws FilesystemException
      Create a multi keyed MKEYED file.
      Parameters:
      p_filename - File to create.
      p_keys - List of KeyDescription objects -- There must be a maximum of 16 keys with up to 48 segments total.
      p_records - Number of records -- if this number is 0 the file will be dynamically allocated.
      p_recordSize - Size of a record -- this is a number between 0 and 32767 inclusive.
      p_64bit - true if the file should be 64 bit (large file).
      p_tagged - true if the file should have tagged records (highly recoverable).
      p_useRemote - true if a dataserver can be used.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
      See Also:
    • createMKeyedFile

      void createMKeyedFile(String p_filename, List p_keys, long p_records, int p_recordSize, boolean p_64bit, boolean p_tagged, boolean p_useRemote, String p_user, String p_password, int p_umask) throws FilesystemException
      Create a multi keyed MKEYED file.
      Parameters:
      p_filename - File to create.
      p_keys - List of KeyDescription objects -- There must be a maximum of 16 keys with up to 48 segments total.
      p_records - Number of records -- if this number is 0 the file will be dynamically allocated.
      p_recordSize - Size of a record -- this is a number between 0 and 32767 inclusive.
      p_64bit - true if the file should be 64 bit (large file).
      p_tagged - true if the file should have tagged records (highly recoverable).
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      Throws:
      FilesystemException - If a filesystem problem occurs.
      See Also:
    • createMKeyedFile

      void createMKeyedFile(String p_filename, List p_keys, long p_records, int p_recordSize, boolean p_64bit, boolean p_tagged, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode) throws FilesystemException
      Create a multi keyed MKEYED file.
      Parameters:
      p_filename - File to create.
      p_keys - List of KeyDescription objects -- There must be a maximum of 16 keys with up to 48 segments total.
      p_records - Number of records -- if this number is 0 the file will be dynamically allocated.
      p_recordSize - Size of a record -- this is a number between 0 and 32767 inclusive.
      p_64bit - true if the file should be 64 bit (large file).
      p_tagged - true if the file should have tagged records (highly recoverable).
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
      See Also:
    • createXKeyedFile

      void createXKeyedFile(String p_filename, int p_keySize, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote) throws FilesystemException
      Create a single keyed XKEYED file.
      Parameters:
      p_filename - File to create.
      p_keySize - Size of a key -- must be greater than 1.
      p_records - Number of records -- if this number is 0 the file will be dynamically allocated.
      p_recordSize - Size of a record -- must be greater than or equal to 0.
      p_tagged - true if the file should have tagged records (highly recoverable).
      p_useRemote - true if a dataserver can be used.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createXKeyedFile

      void createXKeyedFile(String p_filename, int p_keySize, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, String p_mode) throws FilesystemException
      Create a single keyed XKEYED file.
      Parameters:
      p_filename - File to create.
      p_keySize - Size of a key -- must be greater than 1.
      p_records - Number of records -- if this number is 0 the file will be dynamically allocated.
      p_recordSize - Size of a record -- must be greater than or equal to 0.
      p_tagged - true if the file should have tagged records (highly recoverable).
      p_useRemote - true if a dataserver can be used.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createXKeyedFile

      void createXKeyedFile(String p_filename, int p_keySize, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, String p_user, String p_password, int p_umask) throws FilesystemException
      Create a single keyed XKEYED file.
      Parameters:
      p_filename - File to create.
      p_keySize - Size of a key -- must be greater than 1.
      p_records - Number of records -- if this number is 0 the file will be dynamically allocated.
      p_recordSize - Size of a record -- must be greater than or equal to 0.
      p_tagged - true if the file should have tagged records (highly recoverable).
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createXKeyedFile

      void createXKeyedFile(String p_filename, int p_keySize, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode) throws FilesystemException
      Create a single keyed XKEYED file.
      Parameters:
      p_filename - File to create.
      p_keySize - Size of a key -- must be greater than 1.
      p_records - Number of records -- if this number is 0 the file will be dynamically allocated.
      p_recordSize - Size of a record -- must be greater than or equal to 0.
      p_tagged - true if the file should have tagged records (highly recoverable).
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createXKeyedFile

      void createXKeyedFile(String p_filename, List p_keys, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote) throws FilesystemException
      Create a multi keyed XKEYED file.
      Parameters:
      p_filename - File to create.
      p_keys - List of KeyDescription objects.
      p_records - Number of records -- if this number is 0 the file will be dynamically allocated.
      p_recordSize - Size of a record -- must be greater than or equal to 0.
      p_tagged - true if the file should have tagged records (highly recoverable).
      p_useRemote - true if a dataserver can be used.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createXKeyedFile

      void createXKeyedFile(String p_filename, List p_keys, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, String p_mode) throws FilesystemException
      Create a multi keyed XKEYED file.
      Parameters:
      p_filename - File to create.
      p_keys - List of KeyDescription objects.
      p_records - Number of records -- if this number is 0 the file will be dynamically allocated.
      p_recordSize - Size of a record -- must be greater than or equal to 0.
      p_tagged - true if the file should have tagged records (highly recoverable).
      p_useRemote - true if a dataserver can be used.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createXKeyedFile

      void createXKeyedFile(String p_filename, List p_keys, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, String p_user, String p_password, int p_umask) throws FilesystemException
      Create a multi keyed XKEYED file.
      Parameters:
      p_filename - File to create.
      p_keys - List of KeyDescription objects.
      p_records - Number of records -- if this number is 0 the file will be dynamically allocated.
      p_recordSize - Size of a record -- must be greater than or equal to 0.
      p_tagged - true if the file should have tagged records (highly recoverable).
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createXKeyedFile

      void createXKeyedFile(String p_filename, List p_keys, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode) throws FilesystemException
      Create a multi keyed XKEYED file.
      Parameters:
      p_filename - File to create.
      p_keys - List of KeyDescription objects.
      p_records - Number of records -- if this number is 0 the file will be dynamically allocated.
      p_recordSize - Size of a record -- must be greater than or equal to 0.
      p_tagged - true if the file should have tagged records (highly recoverable).
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createVKeyedFile

      void createVKeyedFile(String p_filename, int p_keySize, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, String p_mode) throws FilesystemException
      Create a single keyed VKEYED file.
      Parameters:
      p_filename - File to create.
      p_keySize - Size of a key -- must be greater than 1.
      p_records - Number of records -- if this number is 0 the file will be dynamically allocated.
      p_recordSize - Size of a record -- must be greater than or equal to 0.
      p_tagged - true if the file should have tagged records (highly recoverable).
      p_useRemote - true if a dataserver can be used.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createVKeyedFile

      void createVKeyedFile(String p_filename, int p_keySize, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode) throws FilesystemException
      Create a single keyed VKEYED file.
      Parameters:
      p_filename - File to create.
      p_keySize - Size of a key -- must be greater than 1.
      p_records - Number of records -- if this number is 0 the file will be dynamically allocated.
      p_recordSize - Size of a record -- must be greater than or equal to 0.
      p_tagged - true if the file should have tagged records (highly recoverable).
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createVKeyedFile

      void createVKeyedFile(String p_filename, List p_keys, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, String p_mode) throws FilesystemException
      Create a multi keyed VKEYED file.
      Parameters:
      p_filename - File to create.
      p_keys - List of KeyDescription objects.
      p_records - Number of records -- if this number is 0 the file will be dynamically allocated.
      p_recordSize - Size of a record -- must be greater than or equal to 0.
      p_tagged - true if the file should have tagged records (highly recoverable).
      p_useRemote - true if a dataserver can be used.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createVKeyedFile

      void createVKeyedFile(String p_filename, List p_keys, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode) throws FilesystemException
      Create a multi keyed VKEYED file.
      Parameters:
      p_filename - File to create.
      p_keys - List of KeyDescription objects.
      p_records - Number of records -- if this number is 0 the file will be dynamically allocated.
      p_recordSize - Size of a record -- must be greater than or equal to 0.
      p_tagged - true if the file should have tagged records (highly recoverable).
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      p_mode - Mode string.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • createTextSearchFile

      void createTextSearchFile(String p_filename, String p_template, String p_idField, boolean p_useRemote, String p_mode) throws FilesystemException
      Create a text search file/directory.
      Parameters:
      p_filename -
      p_template -
      p_idField -
      p_useRemote -
      p_mode -
      Throws:
      FilesystemException
    • createTextSearchFile

      void createTextSearchFile(String p_filename, String p_template, String p_idField, boolean p_useRemote, String p_user, String p_password, int p_umask, String p_mode) throws FilesystemException
      Create a text search file/directory.
      Parameters:
      p_filename -
      p_template -
      p_idField -
      p_useRemote -
      p_user -
      p_password -
      p_umask -
      p_mode -
      Throws:
      FilesystemException
    • erase

      void erase(String p_filename, boolean p_useRemote) throws FilesystemException
      Erase a file.
      Parameters:
      p_filename - File to erase.
      p_useRemote - true if a dataserver can be used.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • erase

      void erase(String p_filename, boolean p_useRemote, long p_timeout) throws FilesystemException
      Erase a file.
      Parameters:
      p_filename - File to erase.
      p_useRemote - true if a dataserver can be used.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • erase

      void erase(String p_filename, boolean p_useRemote, String p_user, String p_password) throws FilesystemException
      Erase a file.
      Parameters:
      p_filename - File to erase.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • erase

      void erase(String p_filename, boolean p_useRemote, long p_timeout, String p_user, String p_password) throws FilesystemException
      Erase a file.
      Parameters:
      p_filename - File to erase.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • mkdir

      void mkdir(String p_filename, boolean p_useRemote) throws FilesystemException
      Create a directory.
      Parameters:
      p_filename - Directory to create.
      p_useRemote - true if a dataserver can be used.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • mkdir

      void mkdir(String p_filename, boolean p_useRemote, String p_user, String p_password, int p_umask) throws FilesystemException
      Create a directory.
      Parameters:
      p_filename - Directory to create.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_umask - UMASK for creation permissions.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • rmdir

      void rmdir(String p_filename, boolean p_useRemote) throws FilesystemException
      Remove a directory.
      Parameters:
      p_filename - Directory to remove.
      p_useRemote - true if a dataserver can be used.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • rmdir

      void rmdir(String p_filename, boolean p_useRemote, long p_timeout) throws FilesystemException
      Remove a directory.
      Parameters:
      p_filename - Directory to remove.
      p_useRemote - true if a dataserver can be used.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • rmdir

      void rmdir(String p_filename, boolean p_useRemote, String p_user, String p_password) throws FilesystemException
      Remove a directory.
      Parameters:
      p_filename - Directory to remove.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • rmdir

      void rmdir(String p_filename, boolean p_useRemote, long p_timeout, String p_user, String p_password) throws FilesystemException
      Remove a directory.
      Parameters:
      p_filename - Directory to remove.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • rename

      void rename(String p_fromFilename, String p_toFilename, boolean p_useRemote) throws FilesystemException
      Rename a file. Files cannot be renamed across servers.
      Parameters:
      p_fromFilename - File to rename.
      p_toFilename - New name for the file.
      p_useRemote - true if a dataserver can be used.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • rename

      void rename(String p_fromFilename, String p_toFilename, boolean p_useRemote, String p_user, String p_password) throws FilesystemException
      Rename a file. Files cannot be renamed across servers.
      Parameters:
      p_fromFilename - File to rename.
      p_toFilename - New name for the file.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • changeDir

      void changeDir(String p_dir, boolean p_useRemote) throws FilesystemException
      Change current directory.
      Parameters:
      p_dir - Directory to make current.
      p_useRemote - true if a dataserver can be used.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • changeDir

      void changeDir(String p_dir, boolean p_useRemote, String p_user, String p_password) throws FilesystemException
      Change current directory.
      Parameters:
      p_dir - Directory to make current.
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • getDir

      String getDir() throws FilesystemException
      Get current directory.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • getDir

      String getDir(String p_user, String p_password) throws FilesystemException
      Get current directory.
      Parameters:
      p_user - User name for server connection.
      p_password - Password for server connection.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • getTempFilename

      String getTempFilename(String p_prefix, String p_suffix) throws FilesystemException
      Get a temporary local filename.
      Parameters:
      p_prefix - File prefix.
      p_suffix - File suffix.
      Returns:
      Temporary filename.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • getTempFilename

      String getTempFilename(String p_prefix, String p_suffix, String p_user, String p_password) throws FilesystemException
      Get a temporary local filename.
      Parameters:
      p_prefix - File prefix.
      p_suffix - File suffix.
      p_user - User name for server connection.
      p_password - Password for server connection.
      Returns:
      Temporary filename.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • getTempFilename

      String getTempFilename(String p_prefix, String p_suffix, String p_directory) throws FilesystemException
      Get a temporary local filename.
      Parameters:
      p_prefix - File prefix.
      p_suffix - File suffix.
      p_directory - Directory for temporary file.
      Returns:
      Temporary filename.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • getTempFilename

      String getTempFilename(String p_prefix, String p_suffix, String p_directory, String p_user, String p_password) throws FilesystemException
      Get a temporary local filename.
      Parameters:
      p_prefix - File prefix.
      p_suffix - File suffix.
      p_directory - Directory for temporary file.
      p_user - User name for server connection.
      p_password - Password for server connection.
      Returns:
      Temporary filename.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • convert

      default void convert(String p_filename, boolean p_recoverable, boolean p_overwrite, boolean p_useRemote, String p_filePassword) throws FilesystemException
      Convert (upgrade) file to latest file format. If the file is already in the latest format the function will return without changing the file.
      Parameters:
      p_filename - File to convert.
      p_recoverable - true if the file should be made recoverable if possible.
      p_overwrite - Should old ".bak" files be overwritten?
      p_useRemote - true if a dataserver can be used.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • convert

      default void convert(String p_filename, boolean p_recoverable, boolean p_overwrite, boolean p_useRemote, String p_filePassword, long p_timeout) throws FilesystemException
      Convert (upgrade) file to latest file format. If the file is already in the latest format the function will return without changing the file.
      Parameters:
      p_filename - File to convert.
      p_recoverable - true if the file should be made recoverable if possible.
      p_overwrite - Should old ".bak" files be overwritten?
      p_useRemote - true if a dataserver can be used.
      p_timeout - Open timeout.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • convert

      default void convert(String p_filename, boolean p_recoverable, boolean p_overwrite, boolean p_useRemote, String p_user, String p_password, String p_filePassword) throws FilesystemException
      Convert (upgrade) file to latest file format. If the file is already in the latest format the function will return without changing the file.
      Parameters:
      p_filename - File to convert.
      p_recoverable - true if the file should be made recoverable if possible.
      p_overwrite - Should old ".bak" files be overwritten?
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • convert

      default void convert(String p_filename, boolean p_recoverable, boolean p_overwrite, boolean p_useRemote, String p_user, String p_password, String p_filePassword, long p_timeout) throws FilesystemException
      Convert (upgrade) file to latest file format. If the file is already in the latest format the function will return without changing the file.
      Parameters:
      p_filename - File to convert.
      p_recoverable - true if the file should be made recoverable if possible.
      p_overwrite - Should old ".bak" files be overwritten?
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_timeout - Open timeout.
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • convert

      default void convert(String p_filename, boolean p_recoverable, boolean p_overwrite, boolean p_useRemote, String p_user, String p_password, String p_filePassword, long p_timeout, String p_modes) throws FilesystemException
      Convert (upgrade) file to latest file format. If the file is already in the latest format the function will return without changing the file.
      Parameters:
      p_filename - File to convert.
      p_recoverable - true if the file should be made recoverable if possible.
      p_overwrite - Should old ".bak" files be overwritten?
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_timeout - Open timeout.
      p_modes - File open/create modes
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • convert

      void convert(String p_filename, boolean p_recoverable, boolean p_overwrite, boolean p_useRemote, String p_user, String p_password, String p_filePassword, long p_timeout, String p_modes, String p_tmpDir) throws FilesystemException
      Convert (upgrade) file to latest file format. If the file is already in the latest format the function will return without changing the file.
      Parameters:
      p_filename - File to convert.
      p_recoverable - true if the file should be made recoverable if possible.
      p_overwrite - Should old ".bak" files be overwritten?
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_timeout - Open timeout.
      p_modes - File open/create modes
      p_tmpDir - temporary directory to use (or null)
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • recover

      default RecoverStatus recover(String p_filename, boolean p_overwrite, boolean p_useRemote) throws FilesystemException
      Recover a recoverable file. An exception will be thrown if the file is not recoverable.
      Parameters:
      p_filename - File to recover.
      p_overwrite - Should old ".bak" files be overwritten?
      p_useRemote - true if a dataserver can be used.
      Returns:
      Status information about the recovery
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • recover

      default RecoverStatus recover(String p_filename, boolean p_overwrite, boolean p_useRemote, String p_filePassword) throws FilesystemException
      Recover a recoverable file. An exception will be thrown if the file is not recoverable.
      Parameters:
      p_filename - File to recover.
      p_overwrite - Should old ".bak" files be overwritten?
      p_useRemote - true if a dataserver can be used.
      p_filePassword - Password for secure file.
      Returns:
      Status information about the recovery
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • recover

      default RecoverStatus recover(String p_filename, boolean p_overwrite, boolean p_useRemote, String p_filePassword, long p_timeout) throws FilesystemException
      Recover a recoverable file. An exception will be thrown if the file is not recoverable.
      Parameters:
      p_filename - File to recover.
      p_overwrite - Should old ".bak" files be overwritten?
      p_useRemote - true if a dataserver can be used.
      p_filePassword - Password for secure file.
      p_timeout - Open timeout.
      Returns:
      Status information about the recovery
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • recover

      default RecoverStatus recover(String p_filename, boolean p_overwrite, boolean p_useRemote, String p_user, String p_password) throws FilesystemException
      Recover a recoverable file. An exception will be thrown if the file is not recoverable.
      Parameters:
      p_filename - File to recover.
      p_overwrite - Should old ".bak" files be overwritten?
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      Returns:
      Status information about the recovery
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • recover

      default RecoverStatus recover(String p_filename, boolean p_overwrite, boolean p_useRemote, String p_user, String p_password, long p_timeout) throws FilesystemException
      Recover a recoverable file. An exception will be thrown if the file is not recoverable.
      Parameters:
      p_filename - File to recover.
      p_overwrite - Should old ".bak" files be overwritten?
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_timeout - Open timeout.
      Returns:
      Status information about the recovery
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • recover

      default RecoverStatus recover(String p_filename, boolean p_overwrite, boolean p_useRemote, String p_user, String p_password, String p_filePassword) throws FilesystemException
      Recover a recoverable file. An exception will be thrown if the file is not recoverable.
      Parameters:
      p_filename - File to recover.
      p_overwrite - Should old ".bak" files be overwritten?
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_filePassword - Password for secure file.
      Returns:
      Status information about the recovery
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • recover

      default RecoverStatus recover(String p_filename, boolean p_overwrite, boolean p_useRemote, String p_user, String p_password, String p_filePassword, long p_timeout) throws FilesystemException
      Recover a recoverable file. An exception will be thrown if the file is not recoverable.
      Parameters:
      p_filename - File to recover.
      p_overwrite - Should old ".bak" files be overwritten?
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_filePassword - Password for secure file.
      p_timeout - Open timeout.
      Returns:
      Status information about the recovery
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • recover

      default RecoverStatus recover(String p_filename, boolean p_overwrite, boolean p_useRemote, String p_user, String p_password, String p_filePassword, long p_timeout, String p_modes) throws FilesystemException
      Recover a recoverable file. An exception will be thrown if the file is not recoverable.
      Parameters:
      p_filename - File to recover.
      p_overwrite - Should old ".bak" files be overwritten?
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_filePassword - Password for secure file.
      p_timeout - Open timeout.
      p_modes - File open/create modes
      Returns:
      Status information about the recovery
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • recover

      RecoverStatus recover(String p_filename, boolean p_overwrite, boolean p_useRemote, String p_user, String p_password, String p_filePassword, long p_timeout, String p_modes, String p_tmpDir) throws FilesystemException
      Recover a recoverable file. An exception will be thrown if the file is not recoverable.
      Parameters:
      p_filename - File to recover.
      p_overwrite - Should old ".bak" files be overwritten?
      p_useRemote - true if a dataserver can be used.
      p_user - User name for server connection.
      p_password - Password for server connection.
      p_filePassword - Password for secure file.
      p_timeout - Open timeout.
      p_modes - File open/create modes
      p_tmpDir - Temporary directory (or null)
      Returns:
      Status information about the recovery
      Throws:
      FilesystemException - If a filesystem problem occurs.
    • getPermissions

      int getPermissions(String p_filename, boolean p_useRemote) throws FilesystemException
      Throws:
      FilesystemException
    • getPermissions

      int getPermissions(String p_filename, boolean p_useRemote, String p_user, String p_password) throws FilesystemException
      Throws:
      FilesystemException
    • chmod

      void chmod(String p_filename, int p_permissions, boolean p_useRemote) throws FilesystemException
      Throws:
      FilesystemException
    • chmod

      void chmod(String p_filename, int p_permissions, boolean p_useRemote, String p_user, String p_password) throws FilesystemException
      Throws:
      FilesystemException
    • exists

      boolean exists(String p_filename, boolean p_useRemote) throws FilesystemException
      Does the named file exist?
      Parameters:
      p_filename - File name.
      p_useRemote - true if a dataserver can be used.
      Throws:
      FilesystemException
    • exists

      boolean exists(String p_filename, boolean p_useRemote, String p_user, String p_password) throws FilesystemException
      Does the named file exist?
      Parameters:
      p_filename - File name.
      p_useRemote - true if a dataserver can be used.
      Throws:
      FilesystemException
    • isReadable

      boolean isReadable(String p_filename, boolean p_useRemote) throws FilesystemException
      Is the named file readable?
      Parameters:
      p_filename - File name.
      p_useRemote - true if a dataserver can be used.
      Throws:
      FilesystemException
    • isReadable

      boolean isReadable(String p_filename, boolean p_useRemote, String p_user, String p_password) throws FilesystemException
      Is the named file readable?
      Parameters:
      p_filename - File name.
      p_useRemote - true if a dataserver can be used.
      Throws:
      FilesystemException
    • isWritable

      boolean isWritable(String p_filename, boolean p_useRemote) throws FilesystemException
      Is the named file writable?
      Parameters:
      p_filename - File name.
      p_useRemote - true if a dataserver can be used.
      Throws:
      FilesystemException
    • getDVKLic

      void getDVKLic() throws FilesystemException
      obtaind DVKLicense.
      Throws:
      FilesystemException - if unable to get license
    • getSAMLic

      void getSAMLic() throws FilesystemException
      obtaind SAMLicense.
      Throws:
      FilesystemException - if unable to get license
    • isWritable

      boolean isWritable(String p_filename, boolean p_useRemote, String p_user, String p_password) throws FilesystemException
      Is the named file writable?
      Parameters:
      p_filename - File name.
      p_useRemote - true if a dataserver can be used.
      Throws:
      FilesystemException
    • hasLocalProtectedAccess

      boolean hasLocalProtectedAccess()
    • isFileLocal

      boolean isFileLocal(String p_filename, boolean p_useRemote)
    • updateLicense

      void updateLicense() throws FilesystemException
      Call to update the license.
      Throws:
      FilesystemException
    • isLocal

      boolean isLocal(InetAddress p_address, int p_port)
    • createDefaultNagProcess

      NagProcess createDefaultNagProcess(NagListener p_listener)