Package com.basis.filesystem
Interface FilePosition
- All Superinterfaces:
AutoCloseable,LegacyFilePosition
-
Method Summary
Modifier and TypeMethodDescriptionbooleanvoidclose()Close the file position.intextractAtCurrentPosition(byte[] p_buffer, int p_offset, int p_length, int p_timeout) intextractAtCurrentPosition(io.netty.buffer.ByteBuf p_buffer, int p_timeout) intextractAtCurrentPosition(ByteBuffer p_buffer, int p_timeout) intextractAtCurrentPositionWithKey(byte[] p_buffer, int p_offset, int p_length, int p_keyNumber, int p_timeout) intextractAtCurrentPositionWithKey(byte[] p_buffer, int p_offset, int p_length, String p_keyName, int p_timeout) intextractAtCurrentPositionWithKey(io.netty.buffer.ByteBuf p_buffer, int p_keyNumber, int p_timeout) intextractAtCurrentPositionWithKey(io.netty.buffer.ByteBuf p_buffer, String p_keyName, int p_timeout) intextractAtCurrentPositionWithKey(ByteBuffer p_buffer, int p_keyNumber, int p_timeout) intextractAtCurrentPositionWithKey(ByteBuffer p_buffer, String p_keyName, int p_timeout) intextractByIndex(byte[] p_buffer, int p_offset, int p_length, long p_index, int p_timeout) intextractByIndex(io.netty.buffer.ByteBuf p_buffer, long p_index, int p_timeout) intextractByIndex(ByteBuffer p_buffer, long p_index, int p_timeout) intextractByKey(byte[] p_buffer, int p_offset, int p_length, byte[] p_key, int p_koffset, int p_klength, int p_keyNumber, int p_timeout) intextractByKey(byte[] p_buffer, int p_offset, int p_length, byte[] p_key, int p_koffset, int p_klength, String p_keyName, int p_timeout) intextractByKey(io.netty.buffer.ByteBuf p_buffer, io.netty.buffer.ByteBuf p_key, int p_keyNumber, int p_timeout) intextractByKey(io.netty.buffer.ByteBuf p_buffer, io.netty.buffer.ByteBuf p_key, String p_keyName, int p_timeout) intextractByKey(ByteBuffer p_buffer, ByteBuffer p_key, int p_keyNumber, int p_timeout) intextractByKey(ByteBuffer p_buffer, ByteBuffer p_key, String p_keyName, int p_timeout) intextractFieldAtCurrentPosition(byte[] p_buffer, int p_offset, int p_length, int p_timeout) intextractFieldAtCurrentPosition(io.netty.buffer.ByteBuf p_buffer, int p_timeout) intextractFieldAtCurrentPosition(ByteBuffer p_buffer, int p_timeout) intextractFieldByIndex(byte[] p_buffer, int p_offset, int p_length, long p_index, int p_timeout) intextractFieldByIndex(io.netty.buffer.ByteBuf p_buffer, long p_index, int p_timeout) intextractFieldByIndex(ByteBuffer p_buffer, long p_index, int p_timeout) intfindByKey(byte[] p_buffer, int p_offset, int p_length, byte[] p_key, int p_koffset, int p_klength, int p_keyNumber, long p_move, int p_timeout) intfindByKey(byte[] p_buffer, int p_offset, int p_length, byte[] p_key, int p_koffset, int p_klength, String p_keyName, long p_move, int p_timeout) intfindByKey(io.netty.buffer.ByteBuf p_buffer, io.netty.buffer.ByteBuf p_key, int p_keyNumber, long p_move, int p_timeout) intfindByKey(io.netty.buffer.ByteBuf p_buffer, io.netty.buffer.ByteBuf p_key, String p_keyName, long p_move, int p_timeout) intfindByKey(ByteBuffer p_buffer, ByteBuffer p_key, int p_keyNumber, long p_move, int p_timeout) intfindByKey(ByteBuffer p_buffer, ByteBuffer p_key, String p_keyName, long p_move, int p_timeout) Get canonical file name.Get user file comment.Get the current key name (if applicable).intGet the current key number (if applicable).byte[]getFID()Base FID function used by the interpreter to get the FID byte array.byte[]Base FID function used by the interpreter to get the FID byte array.Get file name.intGet type of file.byte[]getFIN(int p_index) Base FIN function used by the interpreter to get the FIN byte array.getFINTemplate(int p_index) Get template string for base FIN function.intgetFirstKeyForCurrentPosition(byte[] p_buffer, int p_offset, int p_length, int p_timeout) intgetFirstKeyForCurrentPosition(io.netty.buffer.ByteBuf p_buffer, int p_timeout) intgetFirstKeyForCurrentPosition(ByteBuffer p_buffer, int p_timeout) getHost()Get the license host (server for client/client for server).Get the ID string.longgetIndex()Get current index -- this is not guaranteed to be useful for all file types.Get an InputStream from a STRING or PROGRAM file.intgetKeyAfterCurrentPosition(byte[] p_buffer, int p_offset, int p_length, int p_timeout) intgetKeyAfterCurrentPosition(io.netty.buffer.ByteBuf p_buffer, int p_timeout) intgetKeyAfterCurrentPosition(ByteBuffer p_buffer, int p_timeout) intgetKeyAtCurrentPosition(byte[] p_buffer, int p_offset, int p_length, int p_timeout) intgetKeyAtCurrentPosition(io.netty.buffer.ByteBuf p_buffer, int p_timeout) intgetKeyAtCurrentPosition(ByteBuffer p_buffer, int p_timeout) intgetKeyBeforeCurrentPosition(byte[] p_buffer, int p_offset, int p_length, int p_timeout) intgetKeyBeforeCurrentPosition(io.netty.buffer.ByteBuf p_buffer, int p_timeout) intgetKeyBeforeCurrentPosition(ByteBuffer p_buffer, int p_timeout) intgetKeyByIndex(long p_index, byte[] p_buffer, int p_offset, int p_length, int p_timeout) intgetKeyByIndex(long p_index, io.netty.buffer.ByteBuf p_buffer, int p_timeout) intgetKeyByIndex(long p_index, ByteBuffer p_buffer, int p_timeout) getKeyDescription(int p_keyNum) Get a KeyDescription from the file -- this only works for MKEYED and XKEYED.getKeyDescription(String p_keyName) Get a KeyDescription from the file -- this only works for MKEYED and XKEYED.Get list of KeyDescriptions from the file -- this only works for MKEYED and XKEYED.getKeyName(int p_keyNum) Get key name for a key number.String[]Get an array of key names if applicable.intgetKeyNumber(String p_keyName) Get key number for a key name.intGet logical key size (if applicable).intgetLastKeyForCurrentPosition(byte[] p_buffer, int p_offset, int p_length, int p_timeout) intgetLastKeyForCurrentPosition(io.netty.buffer.ByteBuf p_buffer, int p_timeout) intgetLastKeyForCurrentPosition(ByteBuffer p_buffer, int p_timeout) longGet date and time of last file modification.longGet length of the file -- not valid for all file types.intMaximum number of bytes in any key.intMaximum number of bytes that a user is able to read from the file in a single read.longGet maximum number of records (if applicable).Get options.Get an OutputStream from a STRING or PROGRAM file.longGet the number of records actually in the file.intGet record size (if applicable).intgetSpecificKeyAtCurrentPosition(byte[] p_buffer, int p_offset, int p_length, int p_keyNumber, int p_timeout) intgetSpecificKeyAtCurrentPosition(byte[] p_buffer, int p_offset, int p_length, String p_keyName, int p_timeout) intgetSpecificKeyAtCurrentPosition(io.netty.buffer.ByteBuf p_buffer, int p_keyNumber, int p_timeout) intgetSpecificKeyAtCurrentPosition(io.netty.buffer.ByteBuf p_buffer, String p_keyName, int p_timeout) intgetSpecificKeyAtCurrentPosition(ByteBuffer p_buffer, int p_keyNumber, int p_timeout) intgetSpecificKeyAtCurrentPosition(ByteBuffer p_buffer, String p_keyName, int p_timeout) intGet the default timeout.byte[]getXFID()Base XFID function used by the interpreter to get the XFID byte array.byte[]Base XFID function used by the interpreter to get the XFID byte array.byte[]getXFIN(int p_index) Base XFIN function used by the interpreter to get the XFIN byte array.getXFINTemplate(int p_index) Get template string for base XFIN function.voidinsertKey(int p_keyNum, KeyDescription p_key) Insert key into file.voidinsertKey(String p_keyName, KeyDescription p_key) Insert key into file.booleanIs this an indexed file?booleanGet if this is a special file (like a device).voidlock()Lock the file.voidlock(int p_timeout) Lock the file.intreadAtCurrentPosition(byte[] p_buffer, int p_offset, int p_length, long p_move, int p_timeout) intreadAtCurrentPosition(io.netty.buffer.ByteBuf p_buffer, long p_move, int p_timeout) intreadAtCurrentPosition(ByteBuffer p_buffer, long p_move, int p_timeout) intreadAtCurrentPositionWithKey(byte[] p_buffer, int p_offset, int p_length, int p_keyNumber, long p_move, int p_timeout) intreadAtCurrentPositionWithKey(byte[] p_buffer, int p_offset, int p_length, String p_keyName, long p_move, int p_timeout) intreadAtCurrentPositionWithKey(io.netty.buffer.ByteBuf p_buffer, int p_keyNumber, long p_move, int p_timeout) intreadAtCurrentPositionWithKey(io.netty.buffer.ByteBuf p_buffer, String p_keyName, long p_move, int p_timeout) intreadAtCurrentPositionWithKey(ByteBuffer p_buffer, int p_keyNumber, long p_move, int p_timeout) intreadAtCurrentPositionWithKey(ByteBuffer p_buffer, String p_keyName, long p_move, int p_timeout) intreadByIndex(byte[] p_buffer, int p_offset, int p_length, long p_index, long p_move, int p_timeout) intreadByIndex(io.netty.buffer.ByteBuf p_buffer, long p_index, long p_move, int p_timeout) intreadByIndex(ByteBuffer p_buffer, long p_index, long p_move, int p_timeout) intreadByKey(byte[] p_buffer, int p_offset, int p_length, byte[] p_key, int p_koffset, int p_klength, int p_keyNumber, long p_move, int p_timeout) intreadByKey(byte[] p_buffer, int p_offset, int p_length, byte[] p_key, int p_koffset, int p_klength, String p_keyName, long p_move, int p_timeout) intreadByKey(io.netty.buffer.ByteBuf p_buffer, io.netty.buffer.ByteBuf p_key, int p_keyNumber, long p_move, int p_timeout) intreadByKey(io.netty.buffer.ByteBuf p_buffer, io.netty.buffer.ByteBuf p_key, String p_keyName, long p_move, int p_timeout) intreadByKey(ByteBuffer p_buffer, ByteBuffer p_key, int p_keyNumber, long p_move, int p_timeout) intreadByKey(ByteBuffer p_buffer, ByteBuffer p_key, String p_keyName, long p_move, int p_timeout) intreadFieldAtCurrentPosition(byte[] p_buffer, int p_offset, int p_length, long p_move, int p_timeout) intreadFieldAtCurrentPosition(io.netty.buffer.ByteBuf p_buffer, long p_move, int p_timeout) intreadFieldAtCurrentPosition(ByteBuffer p_buffer, long p_move, int p_timeout) intreadFieldByIndex(byte[] p_buffer, int p_offset, int p_length, long p_index, long p_move, int p_timeout) intreadFieldByIndex(io.netty.buffer.ByteBuf p_buffer, long p_index, long p_move, int p_timeout) intreadFieldByIndex(ByteBuffer p_buffer, long p_index, long p_move, int p_timeout) voidremoveByKey(byte[] p_key, int p_koffset, int p_klength, boolean p_dom, int p_timeout) voidremoveByKey(io.netty.buffer.ByteBuf p_key, boolean p_dom, int p_timeout) voidremoveByKey(ByteBuffer p_key, boolean p_dom, int p_timeout) voidremoveKey(int p_keyNum) Remove a key from file.voidRemove a key from file.voidreplaceKey(int p_keyNum, KeyDescription p_key) Replace key in file.voidreplaceKey(String p_keyName, KeyDescription p_key) Replace key in file.voidsetComment(String p_comment) Set user file comment.voidsetIDString(String p_idString) Set the ID string.voidsetKeyName(int p_keyNum, String p_keyName) Set key name for a key number.voidsetKeyName(String p_oldKeyName, String p_keyName) Set key name for a key name.voidsetOptions(String p_options) Set options.voidsetTimeout(int p_timeout) Set the default timeout.voidsync()Flush write caches.voidunlock()Unlock the file.voidupdateWithIndex(long p_index, byte[] p_old, int p_ooffset, int p_olength, byte[] p_new, int p_noffset, int p_nlength, int p_timeout) voidupdateWithIndex(long p_index, io.netty.buffer.ByteBuf p_old, io.netty.buffer.ByteBuf p_new, int p_timeout) voidupdateWithIndex(long p_index, ByteBuffer p_old, ByteBuffer p_new, int p_timeout) voidupdateWithKey(byte[] p_key, int p_koffset, int p_klength, byte[] p_old, int p_ooffset, int p_olength, byte[] p_new, int p_noffset, int p_nlength, int p_timeout) voidupdateWithKey(io.netty.buffer.ByteBuf p_key, io.netty.buffer.ByteBuf p_old, io.netty.buffer.ByteBuf p_new, int p_timeout) voidupdateWithKey(ByteBuffer p_key, ByteBuffer p_old, ByteBuffer p_new, int p_timeout) voidupdateWithKeys(byte[] p_oldKey, int p_okoffset, int p_oklength, byte[] p_old, int p_ooffset, int p_olength, byte[] p_newKey, int p_nkoffset, int p_nklength, byte[] p_new, int p_noffset, int p_nlength, int p_timeout) voidupdateWithKeys(io.netty.buffer.ByteBuf p_oldKey, io.netty.buffer.ByteBuf p_old, io.netty.buffer.ByteBuf p_newKey, io.netty.buffer.ByteBuf p_new, int p_timeout) voidupdateWithKeys(ByteBuffer p_oldKey, ByteBuffer p_old, ByteBuffer p_newKey, ByteBuffer p_new, int p_timeout) voidupdateWithoutPosition(byte[] p_old, int p_ooffset, int p_olength, byte[] p_new, int p_noffset, int p_nlength, int p_timeout) voidupdateWithoutPosition(io.netty.buffer.ByteBuf p_old, io.netty.buffer.ByteBuf p_new, int p_timeout) voidupdateWithoutPosition(ByteBuffer p_old, ByteBuffer p_new, int p_timeout) voidwriteWithIndex(byte[] p_buffer, int p_offset, int p_length, long p_index, long p_move, boolean p_dom, int p_timeout) voidwriteWithIndex(io.netty.buffer.ByteBuf p_buffer, long p_index, long p_move, boolean p_dom, int p_timeout) voidwriteWithIndex(ByteBuffer p_buffer, long p_index, long p_move, boolean p_dom, int p_timeout) voidwriteWithKey(byte[] p_buffer, int p_offset, int p_length, byte[] p_key, int p_koffset, int p_klength, long p_move, boolean p_dom, int p_timeout, boolean p_ignoreKeyIfCant) voidwriteWithKey(io.netty.buffer.ByteBuf p_buffer, io.netty.buffer.ByteBuf p_key, long p_move, boolean p_dom, int p_timeout, boolean p_ignoreKeyIfCant) voidwriteWithKey(ByteBuffer p_buffer, ByteBuffer p_key, long p_move, boolean p_dom, int p_timeout, boolean p_ignoreKeyIfCant) voidwriteWithoutPosition(byte[] p_buffer, int p_offset, int p_length, long p_move, boolean p_dom, int p_timeout, boolean p_allowoverwrite) voidwriteWithoutPosition(io.netty.buffer.ByteBuf p_buffer, long p_move, boolean p_dom, int p_timeout, boolean p_allowoverwrite) voidwriteWithoutPosition(ByteBuffer p_buffer, long p_move, boolean p_dom, int p_timeout, boolean p_allowoverwrite) Methods inherited from interface com.basis.filesystem.LegacyFilePosition
extract, extract, extract, extract, extract, extract, extract, extract, extract, extract, extract, getFirstKey, getFirstKey, getFirstKey, getKey, getKey, getKey, getKey, getKey, getLastKey, getLastKey, getLastKey, getNextKey, getNextKey, getNextKey, getNextKey, getNextKey, getNumKey, getNumKey, getNumKey, getNumKey, getPreviousKey, getPreviousKey, getPreviousKey, getPreviousKey, getPreviousKey, read, read, read, read, read, read, read, read, read, read, read, read, read, read, remove, remove, remove, remove, remove, update, update, update, update, write, write, write, write, write, write, write, write, write, write, write, write
-
Method Details
-
setTimeout
void setTimeout(int p_timeout) Set the default timeout. -
getTimeout
int getTimeout()Get the default timeout. -
lock
Lock the file.- Throws:
FilesystemException- If a filesystem problem occurs.
-
lock
Lock the file.- Parameters:
p_timeout-- Throws:
FilesystemException- If a filesystem problem occurs.
-
unlock
Unlock the file.- Throws:
FilesystemException- If a filesystem problem occurs.
-
close
Close the file position.- Specified by:
closein interfaceAutoCloseable- Throws:
FilesystemException- If a filesystem problem occurs.
-
getFID
Base FID function used by the interpreter to get the FID byte array.- Returns:
- FID byte array as expected by BBx.
- Throws:
FilesystemException- If a filesystem problem occurs.
-
getFIDServer
Base FID function used by the interpreter to get the FID byte array.- Returns:
- FID byte array as expected by BBx minus the file name.
- Throws:
FilesystemException- If a filesystem problem occurs.
-
getXFID
Base XFID function used by the interpreter to get the XFID byte array.- Returns:
- XFID byte array as expected by BBx.
- Throws:
FilesystemException- If a filesystem problem occurs.
-
getXFIDServer
Base XFID function used by the interpreter to get the XFID byte array.- Returns:
- XFID byte array as expected by BBj minus the file name.
- Throws:
FilesystemException- If a filesystem problem occurs.
-
getFileType
Get type of file.- Returns:
- Type of file using the constants defined in Filesystem.
- Throws:
FilesystemException- If a filesystem problem occurs.
-
getKeySize
Get logical key size (if applicable).- Returns:
- Logical key size for this file -- multi keyed MKEYED files return 0.
- Throws:
FilesystemException- If a filesystem problem occurs.
-
getNumberOfRecords
Get maximum number of records (if applicable).- Returns:
- Number of records or -1.
- Throws:
FilesystemException- If a filesystem problem occurs.
-
getRecordSize
Get record size (if applicable).- Returns:
- Record size.
- Throws:
FilesystemException- If a filesystem problem occurs.
-
getFilename
String getFilename()Get file name.- Returns:
- File name.
-
getCanonicalFilename
Get canonical file name.- Returns:
- File name.
- Throws:
FilesystemException- If a filesystem problem occurs.
-
isSpecial
Get if this is a special file (like a device).- Returns:
- true if this is a special file.
- Throws:
FilesystemException- If a filesystem problem occurs.
-
getFIN
Base FIN function used by the interpreter to get the FIN byte array.- Parameters:
p_index- Index of FIN to retrieve.- Returns:
- FIN byte array as expected by BBx.
- Throws:
FilesystemException- If a filesystem problem occurs.
-
getFINTemplate
Get template string for base FIN function.- Parameters:
p_index- Index of FIN to get template for.- Returns:
- Template for FIN index requested.
- Throws:
FilesystemException- If a filesystem problem occurs.
-
getXFIN
Base XFIN function used by the interpreter to get the XFIN byte array.- Parameters:
p_index- Index of FIN to retrieve.- Returns:
- XFIN byte array as expected by BBj.
- Throws:
FilesystemException- If a filesystem problem occurs.
-
getXFINTemplate
Get template string for base XFIN function.- Parameters:
p_index- Index of XFIN to get template for.- Returns:
- Template for XFIN index requested.
- Throws:
FilesystemException- If a filesystem problem occurs.
-
getLength
Get length of the file -- not valid for all file types.- Returns:
- Length of the file.
- Throws:
FilesystemException- If a filesystem problem occurs.
-
getIndex
Get current index -- this is not guaranteed to be useful for all file types.- Returns:
- Current index.
- Throws:
FilesystemException- If a filesystem problem occurs.
-
getLastModified
Get date and time of last file modification.- Returns:
- The last modified time of the file in milliseconds since the Epoch.
- Throws:
FilesystemException- If a filesystem problem occurs.
-
getMaxKeySize
Maximum number of bytes in any key. For non-keyed files this will be zero/- Returns:
- Maximum number of bytes in any key.
- Throws:
FilesystemException- If a filesystem problem occurs.
-
getMaxReadSize
Maximum number of bytes that a user is able to read from the file in a single read. For record files this is the record size (or maximum record size).- Returns:
- Maximum number of bytes that can possibly be read at one time.
- Throws:
FilesystemException- If a filesystem problem occurs.
-
getRecordCount
Get the number of records actually in the file.- Returns:
- The number of records actually in the file if available.
- Throws:
FilesystemException- If a filesystem problem occurs.
-
getKeyDescription
Get a KeyDescription from the file -- this only works for MKEYED and XKEYED.- Parameters:
p_keyNum- Key number to get KeyDescription for.- Returns:
- Key description for the key number indicated.
- Throws:
FilesystemException- If a filesystem problem occurs.
-
getKeyDescription
Get a KeyDescription from the file -- this only works for MKEYED and XKEYED.- Parameters:
p_keyName- Key name to get KeyDescription for.- Returns:
- Key description for the key number indicated.
- Throws:
FilesystemException- If a filesystem problem occurs.
-
getKeyDescriptions
Get list of KeyDescriptions from the file -- this only works for MKEYED and XKEYED.- Returns:
- Key descriptions for the file.
- Throws:
FilesystemException- If a filesystem problem occurs.
-
getCurrentKeyNumber
Get the current key number (if applicable).- Returns:
- key number is the file supports keys.
- Throws:
FilesystemException- If the file does not support keys.
-
getCurrentKeyName
Get the current key name (if applicable).- Returns:
- key name is the file supports keys.
- Throws:
FilesystemException- If the file does not support keys.
-
isIndexed
Is this an indexed file?- Throws:
FilesystemException
-
getInputStream
Get an InputStream from a STRING or PROGRAM file.- Returns:
- InputStream for file reads.
- Throws:
FilesystemException- If a filesystem problem occurs.
-
getOutputStream
Get an OutputStream from a STRING or PROGRAM file.- Returns:
- OutputStream for file writes.
- Throws:
FilesystemException- If a filesystem problem occurs.
-
sync
Flush write caches.- Throws:
FilesystemException- If a filesystem problem occurs.
-
canKeysChange
- Throws:
FilesystemException
-
removeKey
Remove a key from file. This currently only works for VKEYED.- Parameters:
p_keyNum- Key number to remove.- Throws:
FilesystemException- If a filesystem problem occurs.
-
insertKey
Insert key into file. This currently only works for VKEYED.- Parameters:
p_keyNum- Key number to insert.p_key- KeyDescriptions to add.- Throws:
FilesystemException- If a filesystem problem occurs.
-
replaceKey
Replace key in file. This currently only works for VKEYED.- Parameters:
p_keyNum- Key number to replace.p_key- KeyDescriptions to add.- Throws:
FilesystemException- If a filesystem problem occurs.
-
removeKey
Remove a key from file. This currently only works for VKEYED.- Parameters:
p_keyName- Key name to remove.- Throws:
FilesystemException- If a filesystem problem occurs.
-
insertKey
Insert key into file. This currently only works for VKEYED.- Parameters:
p_keyName- Key name to insert.p_key- KeyDescriptions to add.- Throws:
FilesystemException- If a filesystem problem occurs.
-
replaceKey
Replace key in file. This currently only works for VKEYED.- Parameters:
p_keyName- Key name to replace.p_key- KeyDescriptions to add.- Throws:
FilesystemException- If a filesystem problem occurs.
-
getKeyNames
Get an array of key names if applicable.- Throws:
FilesystemException
-
getKeyName
Get key name for a key number. This currently only works for VKEYED.- Parameters:
p_keyNum- Key number to get name for.- Throws:
FilesystemException- If a filesystem problem occurs.
-
getKeyNumber
Get key number for a key name. This currently only works for VKEYED.- Parameters:
p_keyName- Key name to get number for.- Throws:
FilesystemException- If a filesystem problem occurs.
-
setKeyName
Set key name for a key number. This currently only works for VKEYED.- Parameters:
p_keyNum- Key number to set name for.p_keyName- Key name to set.- Throws:
FilesystemException- If a filesystem problem occurs.
-
setKeyName
Set key name for a key name. This currently only works for VKEYED.- Parameters:
p_oldKeyName- Old key name.p_keyName- Key name to set.- Throws:
FilesystemException- If a filesystem problem occurs.
-
getComment
Get user file comment. This currently only works for VKEYED.- Throws:
FilesystemException- If a filesystem problem occurs.
-
setComment
Set user file comment. This currently only works for VKEYED.- Throws:
FilesystemException- If a filesystem problem occurs.
-
getHost
Get the license host (server for client/client for server).- Throws:
FilesystemException- If a filesystem problem occurs.
-
getIDString
Get the ID string.- Throws:
FilesystemException- If a filesystem problem occurs.
-
setIDString
Set the ID string.- Throws:
FilesystemException- If a filesystem problem occurs.
-
getOptions
Get options.- Throws:
FilesystemException- If a filesystem problem occurs.
-
setOptions
Set options.- Throws:
FilesystemException- If a filesystem problem occurs.
-
readAtCurrentPosition
int readAtCurrentPosition(byte[] p_buffer, int p_offset, int p_length, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
readFieldAtCurrentPosition
int readFieldAtCurrentPosition(byte[] p_buffer, int p_offset, int p_length, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
readAtCurrentPositionWithKey
int readAtCurrentPositionWithKey(byte[] p_buffer, int p_offset, int p_length, int p_keyNumber, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
readAtCurrentPositionWithKey
int readAtCurrentPositionWithKey(byte[] p_buffer, int p_offset, int p_length, String p_keyName, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
readByKey
int readByKey(byte[] p_buffer, int p_offset, int p_length, byte[] p_key, int p_koffset, int p_klength, int p_keyNumber, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
findByKey
int findByKey(byte[] p_buffer, int p_offset, int p_length, byte[] p_key, int p_koffset, int p_klength, int p_keyNumber, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
readByKey
int readByKey(byte[] p_buffer, int p_offset, int p_length, byte[] p_key, int p_koffset, int p_klength, String p_keyName, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
findByKey
int findByKey(byte[] p_buffer, int p_offset, int p_length, byte[] p_key, int p_koffset, int p_klength, String p_keyName, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
readByIndex
int readByIndex(byte[] p_buffer, int p_offset, int p_length, long p_index, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
readFieldByIndex
int readFieldByIndex(byte[] p_buffer, int p_offset, int p_length, long p_index, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
extractAtCurrentPosition
int extractAtCurrentPosition(byte[] p_buffer, int p_offset, int p_length, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
extractFieldAtCurrentPosition
int extractFieldAtCurrentPosition(byte[] p_buffer, int p_offset, int p_length, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
extractAtCurrentPositionWithKey
int extractAtCurrentPositionWithKey(byte[] p_buffer, int p_offset, int p_length, int p_keyNumber, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
extractAtCurrentPositionWithKey
int extractAtCurrentPositionWithKey(byte[] p_buffer, int p_offset, int p_length, String p_keyName, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
extractByKey
int extractByKey(byte[] p_buffer, int p_offset, int p_length, byte[] p_key, int p_koffset, int p_klength, int p_keyNumber, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
extractByKey
int extractByKey(byte[] p_buffer, int p_offset, int p_length, byte[] p_key, int p_koffset, int p_klength, String p_keyName, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
extractByIndex
int extractByIndex(byte[] p_buffer, int p_offset, int p_length, long p_index, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
extractFieldByIndex
int extractFieldByIndex(byte[] p_buffer, int p_offset, int p_length, long p_index, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
writeWithoutPosition
void writeWithoutPosition(byte[] p_buffer, int p_offset, int p_length, long p_move, boolean p_dom, int p_timeout, boolean p_allowoverwrite) throws FilesystemException - Throws:
FilesystemException
-
writeWithKey
void writeWithKey(byte[] p_buffer, int p_offset, int p_length, byte[] p_key, int p_koffset, int p_klength, long p_move, boolean p_dom, int p_timeout, boolean p_ignoreKeyIfCant) throws FilesystemException - Throws:
FilesystemException
-
writeWithIndex
void writeWithIndex(byte[] p_buffer, int p_offset, int p_length, long p_index, long p_move, boolean p_dom, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
removeByKey
void removeByKey(byte[] p_key, int p_koffset, int p_klength, boolean p_dom, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
getKeyAtCurrentPosition
int getKeyAtCurrentPosition(byte[] p_buffer, int p_offset, int p_length, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
getKeyBeforeCurrentPosition
int getKeyBeforeCurrentPosition(byte[] p_buffer, int p_offset, int p_length, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
getKeyAfterCurrentPosition
int getKeyAfterCurrentPosition(byte[] p_buffer, int p_offset, int p_length, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
getFirstKeyForCurrentPosition
int getFirstKeyForCurrentPosition(byte[] p_buffer, int p_offset, int p_length, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
getLastKeyForCurrentPosition
int getLastKeyForCurrentPosition(byte[] p_buffer, int p_offset, int p_length, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
getKeyByIndex
int getKeyByIndex(long p_index, byte[] p_buffer, int p_offset, int p_length, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
getSpecificKeyAtCurrentPosition
int getSpecificKeyAtCurrentPosition(byte[] p_buffer, int p_offset, int p_length, int p_keyNumber, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
getSpecificKeyAtCurrentPosition
int getSpecificKeyAtCurrentPosition(byte[] p_buffer, int p_offset, int p_length, String p_keyName, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
updateWithoutPosition
void updateWithoutPosition(byte[] p_old, int p_ooffset, int p_olength, byte[] p_new, int p_noffset, int p_nlength, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
updateWithKey
void updateWithKey(byte[] p_key, int p_koffset, int p_klength, byte[] p_old, int p_ooffset, int p_olength, byte[] p_new, int p_noffset, int p_nlength, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
updateWithKeys
void updateWithKeys(byte[] p_oldKey, int p_okoffset, int p_oklength, byte[] p_old, int p_ooffset, int p_olength, byte[] p_newKey, int p_nkoffset, int p_nklength, byte[] p_new, int p_noffset, int p_nlength, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
updateWithIndex
void updateWithIndex(long p_index, byte[] p_old, int p_ooffset, int p_olength, byte[] p_new, int p_noffset, int p_nlength, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
readAtCurrentPosition
int readAtCurrentPosition(ByteBuffer p_buffer, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
readFieldAtCurrentPosition
int readFieldAtCurrentPosition(ByteBuffer p_buffer, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
readAtCurrentPositionWithKey
int readAtCurrentPositionWithKey(ByteBuffer p_buffer, int p_keyNumber, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
readAtCurrentPositionWithKey
int readAtCurrentPositionWithKey(ByteBuffer p_buffer, String p_keyName, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
readByKey
int readByKey(ByteBuffer p_buffer, ByteBuffer p_key, int p_keyNumber, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
findByKey
int findByKey(ByteBuffer p_buffer, ByteBuffer p_key, int p_keyNumber, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
readByKey
int readByKey(ByteBuffer p_buffer, ByteBuffer p_key, String p_keyName, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
findByKey
int findByKey(ByteBuffer p_buffer, ByteBuffer p_key, String p_keyName, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
readByIndex
int readByIndex(ByteBuffer p_buffer, long p_index, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
readFieldByIndex
int readFieldByIndex(ByteBuffer p_buffer, long p_index, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
extractAtCurrentPosition
- Throws:
FilesystemException
-
extractFieldAtCurrentPosition
- Throws:
FilesystemException
-
extractAtCurrentPositionWithKey
int extractAtCurrentPositionWithKey(ByteBuffer p_buffer, int p_keyNumber, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
extractAtCurrentPositionWithKey
int extractAtCurrentPositionWithKey(ByteBuffer p_buffer, String p_keyName, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
extractByKey
int extractByKey(ByteBuffer p_buffer, ByteBuffer p_key, int p_keyNumber, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
extractByKey
int extractByKey(ByteBuffer p_buffer, ByteBuffer p_key, String p_keyName, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
extractByIndex
- Throws:
FilesystemException
-
extractFieldByIndex
int extractFieldByIndex(ByteBuffer p_buffer, long p_index, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
writeWithoutPosition
void writeWithoutPosition(ByteBuffer p_buffer, long p_move, boolean p_dom, int p_timeout, boolean p_allowoverwrite) throws FilesystemException - Throws:
FilesystemException
-
writeWithKey
void writeWithKey(ByteBuffer p_buffer, ByteBuffer p_key, long p_move, boolean p_dom, int p_timeout, boolean p_ignoreKeyIfCant) throws FilesystemException - Throws:
FilesystemException
-
writeWithIndex
void writeWithIndex(ByteBuffer p_buffer, long p_index, long p_move, boolean p_dom, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
removeByKey
- Throws:
FilesystemException
-
getKeyAtCurrentPosition
- Throws:
FilesystemException
-
getKeyBeforeCurrentPosition
- Throws:
FilesystemException
-
getKeyAfterCurrentPosition
- Throws:
FilesystemException
-
getFirstKeyForCurrentPosition
- Throws:
FilesystemException
-
getLastKeyForCurrentPosition
- Throws:
FilesystemException
-
getKeyByIndex
- Throws:
FilesystemException
-
getSpecificKeyAtCurrentPosition
int getSpecificKeyAtCurrentPosition(ByteBuffer p_buffer, int p_keyNumber, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
getSpecificKeyAtCurrentPosition
int getSpecificKeyAtCurrentPosition(ByteBuffer p_buffer, String p_keyName, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
updateWithoutPosition
void updateWithoutPosition(ByteBuffer p_old, ByteBuffer p_new, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
updateWithKey
void updateWithKey(ByteBuffer p_key, ByteBuffer p_old, ByteBuffer p_new, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
updateWithKeys
void updateWithKeys(ByteBuffer p_oldKey, ByteBuffer p_old, ByteBuffer p_newKey, ByteBuffer p_new, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
updateWithIndex
void updateWithIndex(long p_index, ByteBuffer p_old, ByteBuffer p_new, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
readAtCurrentPosition
int readAtCurrentPosition(io.netty.buffer.ByteBuf p_buffer, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
readFieldAtCurrentPosition
int readFieldAtCurrentPosition(io.netty.buffer.ByteBuf p_buffer, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
readAtCurrentPositionWithKey
int readAtCurrentPositionWithKey(io.netty.buffer.ByteBuf p_buffer, int p_keyNumber, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
readAtCurrentPositionWithKey
int readAtCurrentPositionWithKey(io.netty.buffer.ByteBuf p_buffer, String p_keyName, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
readByKey
int readByKey(io.netty.buffer.ByteBuf p_buffer, io.netty.buffer.ByteBuf p_key, int p_keyNumber, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
findByKey
int findByKey(io.netty.buffer.ByteBuf p_buffer, io.netty.buffer.ByteBuf p_key, int p_keyNumber, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
readByKey
int readByKey(io.netty.buffer.ByteBuf p_buffer, io.netty.buffer.ByteBuf p_key, String p_keyName, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
findByKey
int findByKey(io.netty.buffer.ByteBuf p_buffer, io.netty.buffer.ByteBuf p_key, String p_keyName, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
readByIndex
int readByIndex(io.netty.buffer.ByteBuf p_buffer, long p_index, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
readFieldByIndex
int readFieldByIndex(io.netty.buffer.ByteBuf p_buffer, long p_index, long p_move, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
extractAtCurrentPosition
int extractAtCurrentPosition(io.netty.buffer.ByteBuf p_buffer, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
extractFieldAtCurrentPosition
int extractFieldAtCurrentPosition(io.netty.buffer.ByteBuf p_buffer, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
extractAtCurrentPositionWithKey
int extractAtCurrentPositionWithKey(io.netty.buffer.ByteBuf p_buffer, int p_keyNumber, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
extractAtCurrentPositionWithKey
int extractAtCurrentPositionWithKey(io.netty.buffer.ByteBuf p_buffer, String p_keyName, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
extractByKey
int extractByKey(io.netty.buffer.ByteBuf p_buffer, io.netty.buffer.ByteBuf p_key, int p_keyNumber, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
extractByKey
int extractByKey(io.netty.buffer.ByteBuf p_buffer, io.netty.buffer.ByteBuf p_key, String p_keyName, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
extractByIndex
int extractByIndex(io.netty.buffer.ByteBuf p_buffer, long p_index, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
extractFieldByIndex
int extractFieldByIndex(io.netty.buffer.ByteBuf p_buffer, long p_index, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
writeWithoutPosition
void writeWithoutPosition(io.netty.buffer.ByteBuf p_buffer, long p_move, boolean p_dom, int p_timeout, boolean p_allowoverwrite) throws FilesystemException - Throws:
FilesystemException
-
writeWithKey
void writeWithKey(io.netty.buffer.ByteBuf p_buffer, io.netty.buffer.ByteBuf p_key, long p_move, boolean p_dom, int p_timeout, boolean p_ignoreKeyIfCant) throws FilesystemException - Throws:
FilesystemException
-
writeWithIndex
void writeWithIndex(io.netty.buffer.ByteBuf p_buffer, long p_index, long p_move, boolean p_dom, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
removeByKey
void removeByKey(io.netty.buffer.ByteBuf p_key, boolean p_dom, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
getKeyAtCurrentPosition
int getKeyAtCurrentPosition(io.netty.buffer.ByteBuf p_buffer, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
getKeyBeforeCurrentPosition
int getKeyBeforeCurrentPosition(io.netty.buffer.ByteBuf p_buffer, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
getKeyAfterCurrentPosition
int getKeyAfterCurrentPosition(io.netty.buffer.ByteBuf p_buffer, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
getFirstKeyForCurrentPosition
int getFirstKeyForCurrentPosition(io.netty.buffer.ByteBuf p_buffer, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
getLastKeyForCurrentPosition
int getLastKeyForCurrentPosition(io.netty.buffer.ByteBuf p_buffer, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
getKeyByIndex
int getKeyByIndex(long p_index, io.netty.buffer.ByteBuf p_buffer, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
getSpecificKeyAtCurrentPosition
int getSpecificKeyAtCurrentPosition(io.netty.buffer.ByteBuf p_buffer, int p_keyNumber, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
getSpecificKeyAtCurrentPosition
int getSpecificKeyAtCurrentPosition(io.netty.buffer.ByteBuf p_buffer, String p_keyName, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
updateWithoutPosition
void updateWithoutPosition(io.netty.buffer.ByteBuf p_old, io.netty.buffer.ByteBuf p_new, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
updateWithKey
void updateWithKey(io.netty.buffer.ByteBuf p_key, io.netty.buffer.ByteBuf p_old, io.netty.buffer.ByteBuf p_new, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
updateWithKeys
void updateWithKeys(io.netty.buffer.ByteBuf p_oldKey, io.netty.buffer.ByteBuf p_old, io.netty.buffer.ByteBuf p_newKey, io.netty.buffer.ByteBuf p_new, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-
updateWithIndex
void updateWithIndex(long p_index, io.netty.buffer.ByteBuf p_old, io.netty.buffer.ByteBuf p_new, int p_timeout) throws FilesystemException - Throws:
FilesystemException
-