com.basis.filesystem

Interface ConnectionMgr

public interface ConnectionMgr

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ConnectionMgr.ClearListener

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEBUG
static long	DEFAULT_ERASE_TIMEOUT
static long	DEFAULT_OPEN_TIMEOUT
static java.util.logging.Logger	LOG

Method Summary

Modifier and Type	Method and Description
void	addClearListener(ConnectionMgr.ClearListener p_listener)
void	authenticateBBj(byte[] p_auth)
void	backupJournaled(java.lang.String p_dir) Backup a journaled system.
void	backupJournaled(java.lang.String p_dir, java.lang.String p_user, java.lang.String p_password) Backup a journaled system.
void	changeDir(java.lang.String p_dir, boolean p_useRemote) Change current directory.
void	changeDir(java.lang.String p_dir, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password) Change current directory.
boolean	checkoutLicense() Try to checkout a license using the license connection if one is not already checked out.
void	chmod(java.lang.String p_filename, int p_permissions, boolean p_useRemote)
void	chmod(java.lang.String p_filename, int p_permissions, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password)
void	clear() Clear any cache that might exist.
void	clearFcbCache() Clear the FCBCACHE.
void	convert(java.lang.String p_filename, boolean p_recoverable, boolean p_overwrite, boolean p_useRemote, java.lang.String p_filePassword) Convert (upgrade) file to latest file format.
void	convert(java.lang.String p_filename, boolean p_recoverable, boolean p_overwrite, boolean p_useRemote, java.lang.String p_filePassword, long p_timeout) Convert (upgrade) file to latest file format.
void	convert(java.lang.String p_filename, boolean p_recoverable, boolean p_overwrite, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, java.lang.String p_filePassword) Convert (upgrade) file to latest file format.
void	convert(java.lang.String p_filename, boolean p_recoverable, boolean p_overwrite, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, java.lang.String p_filePassword, long p_timeout) Convert (upgrade) file to latest file format.
void	copyToJournaled(java.lang.String p_sourceFile, java.lang.String p_destinationFile, java.lang.String p_userName, java.lang.String p_password) This call will copy the source file to a file in the journaled filesystem as the destination file.
NagProcess	createDefaultNagProcess(NagListener p_listener)
void	createDirectFile(java.lang.String p_filename, byte p_keySize, long p_records, int p_recordSize, boolean p_useRemote) Create a DIRECT or SORT file.
void	createDirectFile(java.lang.String p_filename, byte p_keySize, long p_records, int p_recordSize, boolean p_useRemote, java.lang.String p_mode) Create a DIRECT or SORT file.
void	createDirectFile(java.lang.String p_filename, byte p_keySize, long p_records, int p_recordSize, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, int p_umask) Create a DIRECT or SORT file.
void	createDirectFile(java.lang.String p_filename, byte p_keySize, long p_records, int p_recordSize, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, int p_umask, java.lang.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, java.lang.String p_user, java.lang.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, java.lang.String p_user, java.lang.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, java.lang.String p_mode) Create a file generically from a FID.
void	createFile(byte[] p_fid, int p_fidlen, boolean p_useRemote, java.lang.String p_user, java.lang.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, java.lang.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, java.lang.String p_user, java.lang.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, java.lang.String p_user, java.lang.String p_password, int p_umask, java.lang.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, java.lang.String p_user, java.lang.String p_password, int p_umask, java.lang.String p_mode) Create a file generically from a FID.
default void	createFile(ByteBuf p_fid, ByteBuf p_fin, boolean p_useRemote, java.lang.String p_mode) Create a file generically from a FID.
default void	createFile(java.nio.ByteBuffer p_fid, java.nio.ByteBuffer p_fin, boolean p_useRemote, java.lang.String p_mode) Create a file generically from a FID.
void	createIndexedFile(java.lang.String p_filename, long p_records, int p_recordSize, boolean p_useRemote) Create an INDEXED file.
void	createIndexedFile(java.lang.String p_filename, long p_records, int p_recordSize, boolean p_useRemote, java.lang.String p_mode) Create an INDEXED file.
void	createIndexedFile(java.lang.String p_filename, long p_records, int p_recordSize, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, int p_umask) Create an INDEXED file.
void	createIndexedFile(java.lang.String p_filename, long p_records, int p_recordSize, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, int p_umask, java.lang.String p_mode) Create an INDEXED file.
void	createJournaled(java.lang.String p_name, int p_keySize, int p_recordSize) Create a journaled file.
void	createJournaled(java.lang.String p_name, int p_keySize, int p_recordSize, java.lang.String p_mode) Create a journaled file.
void	createJournaled(java.lang.String p_name, int p_keySize, int p_recordSize, java.lang.String p_user, java.lang.String p_password) Create a journaled file.
void	createJournaled(java.lang.String p_name, int p_keySize, int p_recordSize, java.lang.String p_user, java.lang.String p_password, java.lang.String p_mode) Create a journaled file.
void	createJournaled(java.lang.String p_name, java.util.List p_keys, int p_recordSize) Create a journaled file.
void	createJournaled(java.lang.String p_name, java.util.List p_keys, int p_recordSize, java.lang.String p_mode) Create a journaled file.
void	createJournaled(java.lang.String p_name, java.util.List p_keys, int p_recordSize, java.lang.String p_user, java.lang.String p_password) Create a journaled file.
void	createJournaled(java.lang.String p_name, java.util.List p_keys, int p_recordSize, java.lang.String p_user, java.lang.String p_password, java.lang.String p_mode) Create a journaled file.
void	createMKeyedFile(java.lang.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(java.lang.String p_filename, byte p_keySize, long p_records, int p_recordSize, boolean p_64bit, boolean p_tagged, boolean p_useRemote, java.lang.String p_mode) Create a single keyed MKEYED file.
void	createMKeyedFile(java.lang.String p_filename, byte p_keySize, long p_records, int p_recordSize, boolean p_64bit, boolean p_tagged, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, int p_umask) Create a single keyed MKEYED file.
void	createMKeyedFile(java.lang.String p_filename, byte p_keySize, long p_records, int p_recordSize, boolean p_64bit, boolean p_tagged, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, int p_umask, java.lang.String p_mode) Create a single keyed MKEYED file.
void	createMKeyedFile(java.lang.String p_filename, java.util.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(java.lang.String p_filename, java.util.List p_keys, long p_records, int p_recordSize, boolean p_64bit, boolean p_tagged, boolean p_useRemote, java.lang.String p_mode) Create a multi keyed MKEYED file.
void	createMKeyedFile(java.lang.String p_filename, java.util.List p_keys, long p_records, int p_recordSize, boolean p_64bit, boolean p_tagged, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, int p_umask) Create a multi keyed MKEYED file.
void	createMKeyedFile(java.lang.String p_filename, java.util.List p_keys, long p_records, int p_recordSize, boolean p_64bit, boolean p_tagged, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, int p_umask, java.lang.String p_mode) Create a multi keyed MKEYED file.
void	createSerialFile(java.lang.String p_filename, long p_records, int p_recordSize, boolean p_useRemote) Create a SERIAL file.
void	createSerialFile(java.lang.String p_filename, long p_records, int p_recordSize, boolean p_useRemote, java.lang.String p_mode) Create a SERIAL file.
void	createSerialFile(java.lang.String p_filename, long p_records, int p_recordSize, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, int p_umask) Create a SERIAL file.
void	createSerialFile(java.lang.String p_filename, long p_records, int p_recordSize, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, int p_umask, java.lang.String p_mode) Create a SERIAL file.
void	createStringFile(java.lang.String p_filename, boolean p_useRemote) Create a STRING file.
void	createStringFile(java.lang.String p_filename, boolean p_useRemote, java.lang.String p_mode) Create a STRING file.
void	createStringFile(java.lang.String p_filename, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, int p_umask) Create a STRING file.
void	createStringFile(java.lang.String p_filename, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, int p_umask, java.lang.String p_mode) Create a STRING file.
void	createTextSearchFile(java.lang.String p_filename, java.lang.String p_template, java.lang.String p_idField, boolean p_useRemote, java.lang.String p_mode) Create a text search file/directory.
void	createTextSearchFile(java.lang.String p_filename, java.lang.String p_template, java.lang.String p_idField, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, int p_umask, java.lang.String p_mode) Create a text search file/directory.
void	createVKeyedFile(java.lang.String p_filename, int p_keySize, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, java.lang.String p_mode) Create a single keyed VKEYED file.
void	createVKeyedFile(java.lang.String p_filename, int p_keySize, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, int p_umask, java.lang.String p_mode) Create a single keyed VKEYED file.
void	createVKeyedFile(java.lang.String p_filename, java.util.List p_keys, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, java.lang.String p_mode) Create a multi keyed VKEYED file.
void	createVKeyedFile(java.lang.String p_filename, java.util.List p_keys, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, int p_umask, java.lang.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, java.lang.String p_mode) Create a file generically from an XFID.
void	createXFile(byte[] p_xfid, boolean p_useRemote, java.lang.String p_user, java.lang.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, java.lang.String p_mode) Create a file generically from an XFID.
void	createXFile(byte[] p_xfid, byte[] p_xfin, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, int p_umask) Create a file generically from an XFID.
void	createXFile(byte[] p_xfid, byte[] p_xfin, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, int p_umask, java.lang.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, java.lang.String p_user, java.lang.String p_password, int p_umask, java.lang.String p_mode) Create a file generically from an XFID.
default void	createXFile(ByteBuf p_xfid, ByteBuf p_xfin, boolean p_useRemote, java.lang.String p_mode) Create a file generically from an XFID.
default void	createXFile(java.nio.ByteBuffer p_xfid, java.nio.ByteBuffer p_xfin, boolean p_useRemote, java.lang.String p_mode) Create a file generically from an XFID.
void	createXKeyedFile(java.lang.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(java.lang.String p_filename, int p_keySize, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, java.lang.String p_mode) Create a single keyed XKEYED file.
void	createXKeyedFile(java.lang.String p_filename, int p_keySize, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, int p_umask) Create a single keyed XKEYED file.
void	createXKeyedFile(java.lang.String p_filename, int p_keySize, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, int p_umask, java.lang.String p_mode) Create a single keyed XKEYED file.
void	createXKeyedFile(java.lang.String p_filename, java.util.List p_keys, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote) Create a multi keyed XKEYED file.
void	createXKeyedFile(java.lang.String p_filename, java.util.List p_keys, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, java.lang.String p_mode) Create a multi keyed XKEYED file.
void	createXKeyedFile(java.lang.String p_filename, java.util.List p_keys, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, int p_umask) Create a multi keyed XKEYED file.
void	createXKeyedFile(java.lang.String p_filename, java.util.List p_keys, long p_records, int p_recordSize, boolean p_tagged, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, int p_umask, java.lang.String p_mode) Create a multi keyed XKEYED file.
void	enableFcbCache(boolean p_enable) Enable or disable FCBCACHE.
void	erase(java.lang.String p_filename, boolean p_useRemote) Erase a file.
void	erase(java.lang.String p_filename, boolean p_useRemote, long p_timeout) Erase a file.
void	erase(java.lang.String p_filename, boolean p_useRemote, long p_timeout, java.lang.String p_user, java.lang.String p_password) Erase a file.
void	erase(java.lang.String p_filename, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password) Erase a file.
void	eraseJournaled(java.lang.String p_name) Erase a journaled file.
void	eraseJournaled(java.lang.String p_name, java.lang.String p_user, java.lang.String p_password) Erase a journaled file.
boolean	exists(java.lang.String p_filename, boolean p_useRemote) Does the named file exist?
boolean	exists(java.lang.String p_filename, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password) Does the named file exist?
boolean	fcbCacheEnabled() Is the FCBCACHE enabled?
java.lang.String	getActualLicenseVersion()
int	getAvailableCount() Get license available count.
java.util.List<ConnectionMgr.ClearListener>	getClearListeners()
java.lang.String	getConnectionID() Get the connection id.
java.lang.String	getConsole() Get the console for this ConnectionMgr.
long	getDefaultOpenTimeout() Get the default open timeout.
int	getDefaultServerPort() Get the default filesystem server port.
java.lang.String	getDir() Get current directory.
java.lang.String	getDir(java.lang.String p_user, java.lang.String p_password) Get current directory.
void	getDVKLic() obtaind DVKLicense.
boolean	getEnterprise() Get whether we have an enterprise license.
int	getExpirationDate() Get license expiration date.
boolean	getFullyFunctional() Get whether we have an fully functional license (as opposed to Runtime).
java.net.InetAddress	getHost() Get the host for this ConnectionMgr.
long	getLastUsed()
License	getLicense(java.lang.String p_feature, java.lang.String p_version) Get a user specified license.
java.lang.String	getLicenseMessage() Get license error message.
java.lang.String	getLicenseVersion()
int	getMachineUniqueId() Get a machine unique id.
java.lang.String	getPassword() Get the default password for this ConnectionMgr.
int	getPermissions(java.lang.String p_filename, boolean p_useRemote)
int	getPermissions(java.lang.String p_filename, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password)
void	getSAMLic() obtaind SAMLicense.
boolean	getScanAllRoots() Get whether or not the prefix scan should check all roots.
java.lang.String	getSerialNumber() Get serial number from license connection.
boolean	getSQLReadWrite() Get whether we have an SQL Read/Write license.
java.lang.String	getTempFilename(java.lang.String p_prefix, java.lang.String p_suffix) Get a temporary local filename.
java.lang.String	getTempFilename(java.lang.String p_prefix, java.lang.String p_suffix, java.lang.String p_directory) Get a temporary local filename.
java.lang.String	getTempFilename(java.lang.String p_prefix, java.lang.String p_suffix, java.lang.String p_user, java.lang.String p_password) Get a temporary local filename.
java.lang.String	getTempFilename(java.lang.String p_prefix, java.lang.String p_suffix, java.lang.String p_directory, java.lang.String p_user, java.lang.String p_password) Get a temporary local filename.
FilesystemTransaction	getTransaction(int p_degree, boolean p_readOnly) Get a transaction (possibly read only).
FilesystemTransaction	getTransaction(int p_degree, boolean p_readOnly, java.lang.String p_user, java.lang.String p_password) Get a transaction (possibly read only).
FilesystemTransaction	getTransaction(java.lang.String p_host, int p_port, int p_degree, boolean p_readOnly) Get a transaction (possibly read only).
FilesystemTransaction	getTransaction(java.lang.String p_host, int p_port, int p_degree, boolean p_readOnly, java.lang.String p_user, java.lang.String p_password) Get a transaction (possibly read only).
int	getUmask() Get the default UMASK.
java.lang.String	getUser() Get the default user name for this ConnectionMgr.
int	getUserCount() Get license user count.
boolean	hasLocalProtectedAccess()
boolean	haveLicenseConnection() Get whether license information is available to the user.
void	initLocalConnection() Initialize the local (license) connection -- making sure that the license is checked out and license information is available.
void	initLocalConnection(java.lang.String p_user, java.lang.String p_password) Initialize the local (license) connection -- making sure that the license is checked out and license information is available.
boolean	isFileLocal(java.lang.String p_filename, boolean p_useRemote)
boolean	isLocal(java.net.InetAddress p_address, int p_port)
boolean	isReadable(java.lang.String p_filename, boolean p_useRemote) Is the named file readable?
boolean	isReadable(java.lang.String p_filename, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password) Is the named file readable?
boolean	isSAMAvailable()
boolean	isWritable(java.lang.String p_filename, boolean p_useRemote) Is the named file writable?
boolean	isWritable(java.lang.String p_filename, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password) Is the named file writable?
void	mkdir(java.lang.String p_filename, boolean p_useRemote) Create a directory.
void	mkdir(java.lang.String p_filename, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, int p_umask) Create a directory.
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, boolean p_useRemote) Open a file normally (per the file type).
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, boolean p_useRemote, boolean p_advisoryLocking) Open a file normally (per the file type).
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, int p_mode, boolean p_useRemote, java.util.List p_path, boolean p_advisoryLocking, int p_umask) Open a file normally (per the file type).
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, int p_mode, boolean p_useRemote, java.util.List p_path, boolean p_advisoryLocking, int p_umask, long p_timeout) Open a file normally (per the file type).
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, int p_mode, boolean p_useRemote, java.util.List p_path, boolean p_advisoryLocking, int p_umask, java.lang.String p_filePassword) Open a file normally (per the file type).
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, int p_mode, boolean p_useRemote, java.util.List p_path, boolean p_advisoryLocking, int p_umask, java.lang.String p_filePassword, long p_timeout) Open a file normally (per the file type).
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, int p_mode, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, java.util.List p_path, boolean p_advisoryLocking, int p_umask, java.lang.String p_filePassword) Open a file normally (per the file type).
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, int p_mode, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, java.util.List p_path, boolean p_advisoryLocking, int p_umask, java.lang.String p_filePassword, long p_timeout) Open a file normally (per the file type).
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote) Open a file either as STRING or INDEXED.
FilePosition	open(java.lang.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.
FilePosition	open(java.lang.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.
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, java.util.List p_path) Open a file either as STRING or INDEXED.
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, java.util.List p_path, boolean p_advisoryLocking) Open a file either as STRING or INDEXED.
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, java.util.List p_path, boolean p_advisoryLocking, int p_umask) Open a file either as STRING or INDEXED.
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password) Open a file either as STRING or INDEXED.
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, boolean p_advisoryLocking) Open a file either as STRING or INDEXED.
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, boolean p_advisoryLocking, int p_umask) Open a file either as STRING or INDEXED.
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, java.util.List p_path) Open a file either as STRING or INDEXED.
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, java.util.List p_path, boolean p_advisoryLocking) Open a file either as STRING or INDEXED.
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, int p_recordSize, int p_mode, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, java.util.List p_path, boolean p_advisoryLocking, int p_umask) Open a file either as STRING or INDEXED.
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, int p_recordSize, java.lang.String p_modes, boolean p_useRemote, boolean p_advisoryLocking, int p_umask) Open a file either as STRING or INDEXED.
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, int p_recordSize, java.lang.String p_modes, boolean p_useRemote, boolean p_advisoryLocking, int p_umask, long p_timeout) Open a file either as STRING or INDEXED.
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, int p_recordSize, java.lang.String p_modes, boolean p_useRemote, java.util.List p_path, boolean p_advisoryLocking) Open a file either as STRING or INDEXED.
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, int p_recordSize, java.lang.String p_modes, boolean p_useRemote, java.util.List p_path, boolean p_advisoryLocking, int p_umask) Open a file either as STRING or INDEXED.
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, int p_recordSize, java.lang.String p_modes, boolean p_useRemote, java.util.List p_path, boolean p_advisoryLocking, int p_umask, long p_timeout) Open a file either as STRING or INDEXED.
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, int p_recordSize, java.lang.String p_modes, boolean p_useRemote, java.util.List p_path, boolean p_advisoryLocking, long p_timeout) Open a file either as STRING or INDEXED.
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, int p_recordSize, java.lang.String p_modes, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, java.util.List p_path, boolean p_advisoryLocking, int p_umask) Open a file either as STRING or INDEXED.
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, int p_recordSize, java.lang.String p_modes, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, java.util.List p_path, boolean p_advisoryLocking, int p_umask, long p_timeout) Open a file either as STRING or INDEXED.
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, java.lang.String p_encryptPassword, boolean p_useRemote) Open a file normally (per the file type).
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, java.lang.String p_encryptPassword, boolean p_useRemote, boolean p_advisoryLocking)
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, java.lang.String p_modes, boolean p_useRemote, java.util.List p_path, boolean p_advisoryLocking, int p_umask, java.lang.String p_filePassword) Open a file normally (per the file type).
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, java.lang.String p_modes, boolean p_useRemote, java.util.List p_path, boolean p_advisoryLocking, int p_umask, java.lang.String p_filePassword, long p_timeout) Open a file normally (per the file type).
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, java.lang.String p_modes, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, java.util.List p_path, boolean p_advisoryLocking, int p_umask, java.lang.String p_filePassword) Open a file normally (per the file type).
FilePosition	open(java.lang.String p_filename, boolean p_readOnly, java.lang.String p_modes, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, java.util.List p_path, boolean p_advisoryLocking, int p_umask, java.lang.String p_filePassword, long p_timeout) Open a file normally (per the file type).
FilePosition	openJournaled(java.lang.String p_name, FilesystemTransaction p_transaction, boolean p_readOnly) Open a journaled file.
FilePosition	openJournaled(java.lang.String p_name, FilesystemTransaction p_transaction, boolean p_readOnly, java.lang.String p_mode) Open a journaled file.
FilePosition	openJournaled(java.lang.String p_name, FilesystemTransaction p_transaction, boolean p_readOnly, java.lang.String p_mode, long p_timeout) Open a journaled file.
FilePosition	openJournaled(java.lang.String p_name, FilesystemTransaction p_transaction, boolean p_readOnly, java.lang.String p_user, java.lang.String p_password) Open a journaled file.
FilePosition	openJournaled(java.lang.String p_name, FilesystemTransaction p_transaction, boolean p_readOnly, java.lang.String p_user, java.lang.String p_password, java.lang.String p_mode) Open a journaled file.
FilePosition	openJournaled(java.lang.String p_name, FilesystemTransaction p_transaction, boolean p_readOnly, java.lang.String p_user, java.lang.String p_password, java.lang.String p_mode, long p_timeout) Open a journaled file.
FilePosition	openSelect(java.lang.String p_filename, java.lang.String p_fieldList, java.lang.String p_template, java.lang.String p_where, java.lang.String p_sortby, long p_limit, java.lang.String p_mode, boolean p_useRemote, java.util.List p_path, boolean p_advisoryLocking, java.lang.String p_filePassword) Open a file using SELECT.
FilePosition	openSelect(java.lang.String p_filename, java.lang.String p_fieldList, java.lang.String p_template, java.lang.String p_where, java.lang.String p_sortby, long p_limit, java.lang.String p_mode, boolean p_useRemote, java.util.List p_path, boolean p_advisoryLocking, java.lang.String p_filePassword, long p_timeout) Open a file using SELECT.
FilePosition	openSelect(java.lang.String p_filename, java.lang.String p_fieldList, java.lang.String p_template, java.lang.String p_where, java.lang.String p_sortby, long p_limit, java.lang.String p_mode, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, java.util.List p_path, boolean p_advisoryLocking, java.lang.String p_filePassword) Open a file using SELECT.
FilePosition	openSelect(java.lang.String p_filename, java.lang.String p_fieldList, java.lang.String p_template, java.lang.String p_where, java.lang.String p_sortby, long p_limit, java.lang.String p_mode, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, java.util.List p_path, boolean p_advisoryLocking, java.lang.String p_filePassword, long p_timeout) Open a file using SELECT.
RecoverStatus	recover(java.lang.String p_filename, boolean p_overwrite, boolean p_useRemote) Recover a recoverable file.
RecoverStatus	recover(java.lang.String p_filename, boolean p_overwrite, boolean p_useRemote, java.lang.String p_filePassword) Recover a recoverable file.
RecoverStatus	recover(java.lang.String p_filename, boolean p_overwrite, boolean p_useRemote, java.lang.String p_filePassword, long p_timeout) Recover a recoverable file.
RecoverStatus	recover(java.lang.String p_filename, boolean p_overwrite, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password) Recover a recoverable file.
RecoverStatus	recover(java.lang.String p_filename, boolean p_overwrite, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, long p_timeout) Recover a recoverable file.
RecoverStatus	recover(java.lang.String p_filename, boolean p_overwrite, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, java.lang.String p_filePassword) Recover a recoverable file.
RecoverStatus	recover(java.lang.String p_filename, boolean p_overwrite, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password, java.lang.String p_filePassword, long p_timeout) Recover a recoverable file.
void	removeClearListener(ConnectionMgr.ClearListener p_listener)
void	rename(java.lang.String p_fromFilename, java.lang.String p_toFilename, boolean p_useRemote) Rename a file.
void	rename(java.lang.String p_fromFilename, java.lang.String p_toFilename, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password) Rename a file.
void	renameJournaled(java.lang.String p_from, java.lang.String p_to) Rename a journaled file.
void	renameJournaled(java.lang.String p_from, java.lang.String p_to, java.lang.String p_user, java.lang.String p_password) Rename a journaled file.
void	rmdir(java.lang.String p_filename, boolean p_useRemote) Remove a directory.
void	rmdir(java.lang.String p_filename, boolean p_useRemote, long p_timeout) Remove a directory.
void	rmdir(java.lang.String p_filename, boolean p_useRemote, long p_timeout, java.lang.String p_user, java.lang.String p_password) Remove a directory.
void	rmdir(java.lang.String p_filename, boolean p_useRemote, java.lang.String p_user, java.lang.String p_password) Remove a directory.
void	setConnectionID(java.lang.String p_connectionID) Set the connection id.
void	setConsole(java.lang.String p_console)
void	setDefaultOpenTimeout(long p_timeout) Set the default open timeout.
void	setDisksyn(java.util.Map p_disksyn) Set disksyn map.
void	setEnforceEnterprise(boolean p_enforceEnterprise) Set whether the ConnectionMgr should enforce the enterprise license.
void	setHost(java.net.InetAddress p_host)
void	setNagProcess(NagProcess p_process) Set the NagProcess that will be used to process the nag message for licensing.
void	setPassword(java.lang.String p_password)
void	setPrefixes(java.util.List p_prefixes) Set the prefix list used for opening files.
void	setPrefixes(java.lang.String p_path) Set the prefix list used for opening files from a String path.
void	setPrefixes(java.lang.String p_path, char p_separator) Set the prefix list used for opening files from a String path given a separator character.
void	setScanAllRoots(boolean p_scan) Set whether or not the prefix scan should check all roots.
void	setUmask(int p_umask)
void	setUser(java.lang.String p_user) Set the default user name for this ConnectionMgr.
boolean	shouldNag()
void	updateLastUsed()
void	updateLicense() Call to update the license.
void	verifyLicenseConnection() Verify a license connection...
boolean	viewEnterprise()

Field Detail

LOG

static final java.util.logging.Logger LOG

DEBUG

static final boolean DEBUG

See Also:

Constant Field Values

DEFAULT_OPEN_TIMEOUT

static final long DEFAULT_OPEN_TIMEOUT

See Also:

Constant Field Values

DEFAULT_ERASE_TIMEOUT

static final long DEFAULT_ERASE_TIMEOUT

See Also:

Constant Field Values

Method Detail

addClearListener

void addClearListener(ConnectionMgr.ClearListener p_listener)

removeClearListener

void removeClearListener(ConnectionMgr.ClearListener p_listener)

getClearListeners

java.util.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(java.lang.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(java.lang.String p_password)

setUmask

void setUmask(int p_umask)

authenticateBBj

void authenticateBBj(byte[] p_auth)

setConsole

void setConsole(java.lang.String p_console)

setHost

void setHost(java.net.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

java.lang.String getUser()

Get the default user name for this ConnectionMgr.

Returns:

Default user name for the server connections from this ConnectionMgr.

getPassword

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

java.lang.String getConsole()

Get the console for this ConnectionMgr.

Returns:

Console for the server connections from this ConnectionMgr.

getHost

java.net.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(java.util.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(java.lang.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(java.lang.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(java.util.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(java.lang.String p_connectionID)

Set the connection id.

getConnectionID

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

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

getLicenseVersion

java.lang.String getLicenseVersion()
                            throws FilesystemException

Throws:

FilesystemException

getActualLicenseVersion

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

getSerialNumber

java.lang.String getSerialNumber()

Get serial number from license connection.

Returns:

Serial number or null if there is no license connection.

getLicenseMessage

java.lang.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()

getLicense

License getLicense(java.lang.String p_feature,
                   java.lang.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

FilePosition open(java.lang.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

FilePosition open(java.lang.String p_filename,
                  boolean p_readOnly,
                  java.lang.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

FilePosition open(java.lang.String p_filename,
                  boolean p_readOnly,
                  java.lang.String p_encryptPassword,
                  boolean p_useRemote,
                  boolean p_advisoryLocking)
           throws FilesystemException

Throws:

FilesystemException

open

FilePosition open(java.lang.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

FilePosition open(java.lang.String p_filename,
                  boolean p_readOnly,
                  int p_mode,
                  boolean p_useRemote,
                  java.util.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

FilePosition open(java.lang.String p_filename,
                  boolean p_readOnly,
                  int p_mode,
                  boolean p_useRemote,
                  java.util.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

FilePosition open(java.lang.String p_filename,
                  boolean p_readOnly,
                  int p_mode,
                  boolean p_useRemote,
                  java.util.List p_path,
                  boolean p_advisoryLocking,
                  int p_umask,
                  java.lang.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

FilePosition open(java.lang.String p_filename,
                  boolean p_readOnly,
                  int p_mode,
                  boolean p_useRemote,
                  java.util.List p_path,
                  boolean p_advisoryLocking,
                  int p_umask,
                  java.lang.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

FilePosition open(java.lang.String p_filename,
                  boolean p_readOnly,
                  java.lang.String p_modes,
                  boolean p_useRemote,
                  java.util.List p_path,
                  boolean p_advisoryLocking,
                  int p_umask,
                  java.lang.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

FilePosition open(java.lang.String p_filename,
                  boolean p_readOnly,
                  java.lang.String p_modes,
                  boolean p_useRemote,
                  java.util.List p_path,
                  boolean p_advisoryLocking,
                  int p_umask,
                  java.lang.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

FilePosition open(java.lang.String p_filename,
                  boolean p_readOnly,
                  int p_mode,
                  boolean p_useRemote,
                  java.lang.String p_user,
                  java.lang.String p_password,
                  java.util.List p_path,
                  boolean p_advisoryLocking,
                  int p_umask,
                  java.lang.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(java.lang.String p_filename,
                  boolean p_readOnly,
                  int p_mode,
                  boolean p_useRemote,
                  java.lang.String p_user,
                  java.lang.String p_password,
                  java.util.List p_path,
                  boolean p_advisoryLocking,
                  int p_umask,
                  java.lang.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

FilePosition open(java.lang.String p_filename,
                  boolean p_readOnly,
                  java.lang.String p_modes,
                  boolean p_useRemote,
                  java.lang.String p_user,
                  java.lang.String p_password,
                  java.util.List p_path,
                  boolean p_advisoryLocking,
                  int p_umask,
                  java.lang.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(java.lang.String p_filename,
                  boolean p_readOnly,
                  java.lang.String p_modes,
                  boolean p_useRemote,
                  java.lang.String p_user,
                  java.lang.String p_password,
                  java.util.List p_path,
                  boolean p_advisoryLocking,
                  int p_umask,
                  java.lang.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

FilePosition open(java.lang.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

FilePosition open(java.lang.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

FilePosition open(java.lang.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

FilePosition open(java.lang.String p_filename,
                  boolean p_readOnly,
                  int p_recordSize,
                  java.lang.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

FilePosition open(java.lang.String p_filename,
                  boolean p_readOnly,
                  int p_recordSize,
                  java.lang.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

FilePosition open(java.lang.String p_filename,
                  boolean p_readOnly,
                  int p_recordSize,
                  int p_mode,
                  boolean p_useRemote,
                  java.util.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

FilePosition open(java.lang.String p_filename,
                  boolean p_readOnly,
                  int p_recordSize,
                  int p_mode,
                  boolean p_useRemote,
                  java.util.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

FilePosition open(java.lang.String p_filename,
                  boolean p_readOnly,
                  int p_recordSize,
                  java.lang.String p_modes,
                  boolean p_useRemote,
                  java.util.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

FilePosition open(java.lang.String p_filename,
                  boolean p_readOnly,
                  int p_recordSize,
                  java.lang.String p_modes,
                  boolean p_useRemote,
                  java.util.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

FilePosition open(java.lang.String p_filename,
                  boolean p_readOnly,
                  int p_recordSize,
                  int p_mode,
                  boolean p_useRemote,
                  java.util.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

FilePosition open(java.lang.String p_filename,
                  boolean p_readOnly,
                  int p_recordSize,
                  java.lang.String p_modes,
                  boolean p_useRemote,
                  java.util.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

FilePosition open(java.lang.String p_filename,
                  boolean p_readOnly,
                  int p_recordSize,
                  java.lang.String p_modes,
                  boolean p_useRemote,
                  java.util.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

FilePosition open(java.lang.String p_filename,
                  boolean p_readOnly,
                  int p_recordSize,
                  int p_mode,
                  boolean p_useRemote,
                  java.lang.String p_user,
                  java.lang.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

FilePosition open(java.lang.String p_filename,
                  boolean p_readOnly,
                  int p_recordSize,
                  int p_mode,
                  boolean p_useRemote,
                  java.lang.String p_user,
                  java.lang.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

FilePosition open(java.lang.String p_filename,
                  boolean p_readOnly,
                  int p_recordSize,
                  int p_mode,
                  boolean p_useRemote,
                  java.lang.String p_user,
                  java.lang.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

FilePosition open(java.lang.String p_filename,
                  boolean p_readOnly,
                  int p_recordSize,
                  int p_mode,
                  boolean p_useRemote,
                  java.lang.String p_user,
                  java.lang.String p_password,
                  java.util.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

FilePosition open(java.lang.String p_filename,
                  boolean p_readOnly,
                  int p_recordSize,
                  int p_mode,
                  boolean p_useRemote,
                  java.lang.String p_user,
                  java.lang.String p_password,
                  java.util.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(java.lang.String p_filename,
                  boolean p_readOnly,
                  int p_recordSize,
                  int p_mode,
                  boolean p_useRemote,
                  java.lang.String p_user,
                  java.lang.String p_password,
                  java.util.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

FilePosition open(java.lang.String p_filename,
                  boolean p_readOnly,
                  int p_recordSize,
                  java.lang.String p_modes,
                  boolean p_useRemote,
                  java.lang.String p_user,
                  java.lang.String p_password,
                  java.util.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(java.lang.String p_filename,
                  boolean p_readOnly,
                  int p_recordSize,
                  java.lang.String p_modes,
                  boolean p_useRemote,
                  java.lang.String p_user,
                  java.lang.String p_password,
                  java.util.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(java.lang.String p_filename,
                        java.lang.String p_fieldList,
                        java.lang.String p_template,
                        java.lang.String p_where,
                        java.lang.String p_sortby,
                        long p_limit,
                        java.lang.String p_mode,
                        boolean p_useRemote,
                        java.util.List p_path,
                        boolean p_advisoryLocking,
                        java.lang.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(java.lang.String p_filename,
                        java.lang.String p_fieldList,
                        java.lang.String p_template,
                        java.lang.String p_where,
                        java.lang.String p_sortby,
                        long p_limit,
                        java.lang.String p_mode,
                        boolean p_useRemote,
                        java.util.List p_path,
                        boolean p_advisoryLocking,
                        java.lang.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(java.lang.String p_filename,
                        java.lang.String p_fieldList,
                        java.lang.String p_template,
                        java.lang.String p_where,
                        java.lang.String p_sortby,
                        long p_limit,
                        java.lang.String p_mode,
                        boolean p_useRemote,
                        java.lang.String p_user,
                        java.lang.String p_password,
                        java.util.List p_path,
                        boolean p_advisoryLocking,
                        java.lang.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(java.lang.String p_filename,
                        java.lang.String p_fieldList,
                        java.lang.String p_template,
                        java.lang.String p_where,
                        java.lang.String p_sortby,
                        long p_limit,
                        java.lang.String p_mode,
                        boolean p_useRemote,
                        java.lang.String p_user,
                        java.lang.String p_password,
                        java.util.List p_path,
                        boolean p_advisoryLocking,
                        java.lang.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:

FilePosition.getFID()

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:

FilePosition.getFID()

createFile

void createFile(byte[] p_fid,
                int p_fidlen,
                boolean p_useRemote,
                java.lang.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:

FilePosition.getFID()

createFile

void createFile(byte[] p_fid,
                boolean p_useRemote,
                java.lang.String p_user,
                java.lang.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:

FilePosition.getFID()

createFile

void createFile(byte[] p_fid,
                int p_fidlen,
                boolean p_useRemote,
                java.lang.String p_user,
                java.lang.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:

FilePosition.getFID()

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:

FilePosition.getFID(), FilePosition.getFIN(int)

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:

FilePosition.getFID(), FilePosition.getFIN(int)

createFile

void createFile(byte[] p_fid,
                int p_fidlen,
                byte[] p_fin,
                int p_finlen,
                boolean p_useRemote,
                java.lang.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:

FilePosition.getFID(), FilePosition.getFIN(int)

createFile

default void createFile(java.nio.ByteBuffer p_fid,
                        java.nio.ByteBuffer p_fin,
                        boolean p_useRemote,
                        java.lang.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:

FilePosition.getFID(), FilePosition.getFIN(int)

createFile

default void createFile(ByteBuf p_fid,
                        ByteBuf p_fin,
                        boolean p_useRemote,
                        java.lang.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:

FilePosition.getFID(), FilePosition.getFIN(int)

createFile

void createFile(byte[] p_fid,
                byte[] p_fin,
                boolean p_useRemote,
                java.lang.String p_user,
                java.lang.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:

FilePosition.getFID(), FilePosition.getFIN(int)

createFile

void createFile(byte[] p_fid,
                int p_fidlen,
                byte[] p_fin,
                int p_finlen,
                boolean p_useRemote,
                java.lang.String p_user,
                java.lang.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:

FilePosition.getFID(), FilePosition.getFIN(int)

createFile

void createFile(byte[] p_fid,
                int p_fidlen,
                byte[] p_fin,
                int p_finlen,
                boolean p_useRemote,
                java.lang.String p_user,
                java.lang.String p_password,
                int p_umask,
                java.lang.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:

FilePosition.getFID(), FilePosition.getFIN(int)

createFile

void createFile(byte[] p_fid,
                int p_fidOffset,
                int p_fidlen,
                byte[] p_fin,
                int p_finOffset,
                int p_finlen,
                boolean p_useRemote,
                java.lang.String p_user,
                java.lang.String p_password,
                int p_umask,
                java.lang.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:

FilePosition.getFID(), FilePosition.getFIN(int)

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:

FilePosition.getXFID()

createXFile

void createXFile(byte[] p_xfid,
                 boolean p_useRemote,
                 java.lang.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:

FilePosition.getXFID()

createXFile

void createXFile(byte[] p_xfid,
                 boolean p_useRemote,
                 java.lang.String p_user,
                 java.lang.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:

FilePosition.getXFID()

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:

FilePosition.getXFID(), FilePosition.getXFIN(int)

createXFile

void createXFile(byte[] p_xfid,
                 byte[] p_xfin,
                 boolean p_useRemote,
                 java.lang.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:

FilePosition.getXFID(), FilePosition.getXFIN(int)

createXFile

default void createXFile(java.nio.ByteBuffer p_xfid,
                         java.nio.ByteBuffer p_xfin,
                         boolean p_useRemote,
                         java.lang.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:

FilePosition.getXFID(), FilePosition.getXFIN(int)

createXFile

default void createXFile(ByteBuf p_xfid,
                         ByteBuf p_xfin,
                         boolean p_useRemote,
                         java.lang.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:

FilePosition.getXFID(), FilePosition.getXFIN(int)

createXFile

void createXFile(byte[] p_xfid,
                 byte[] p_xfin,
                 boolean p_useRemote,
                 java.lang.String p_user,
                 java.lang.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:

FilePosition.getXFID(), FilePosition.getXFIN(int)

createXFile

void createXFile(byte[] p_xfid,
                 byte[] p_xfin,
                 boolean p_useRemote,
                 java.lang.String p_user,
                 java.lang.String p_password,
                 int p_umask,
                 java.lang.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:

FilePosition.getXFID(), FilePosition.getXFIN(int)

createXFile

void createXFile(byte[] p_xfid,
                 int p_xfidoffset,
                 int p_xfidlen,
                 byte[] p_xfin,
                 int p_xfinoffset,
                 int p_xfinlength,
                 boolean p_useRemote,
                 java.lang.String p_user,
                 java.lang.String p_password,
                 int p_umask,
                 java.lang.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:

FilePosition.getXFID(), FilePosition.getXFIN(int)

createStringFile

void createStringFile(java.lang.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(java.lang.String p_filename,
                      boolean p_useRemote,
                      java.lang.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(java.lang.String p_filename,
                      boolean p_useRemote,
                      java.lang.String p_user,
                      java.lang.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(java.lang.String p_filename,
                      boolean p_useRemote,
                      java.lang.String p_user,
                      java.lang.String p_password,
                      int p_umask,
                      java.lang.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(java.lang.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(java.lang.String p_filename,
                      long p_records,
                      int p_recordSize,
                      boolean p_useRemote,
                      java.lang.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(java.lang.String p_filename,
                      long p_records,
                      int p_recordSize,
                      boolean p_useRemote,
                      java.lang.String p_user,
                      java.lang.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(java.lang.String p_filename,
                      long p_records,
                      int p_recordSize,
                      boolean p_useRemote,
                      java.lang.String p_user,
                      java.lang.String p_password,
                      int p_umask,
                      java.lang.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(java.lang.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(java.lang.String p_filename,
                       long p_records,
                       int p_recordSize,
                       boolean p_useRemote,
                       java.lang.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(java.lang.String p_filename,
                       long p_records,
                       int p_recordSize,
                       boolean p_useRemote,
                       java.lang.String p_user,
                       java.lang.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(java.lang.String p_filename,
                       long p_records,
                       int p_recordSize,
                       boolean p_useRemote,
                       java.lang.String p_user,
                       java.lang.String p_password,
                       int p_umask,
                       java.lang.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(java.lang.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(java.lang.String p_filename,
                      byte p_keySize,
                      long p_records,
                      int p_recordSize,
                      boolean p_useRemote,
                      java.lang.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(java.lang.String p_filename,
                      byte p_keySize,
                      long p_records,
                      int p_recordSize,
                      boolean p_useRemote,
                      java.lang.String p_user,
                      java.lang.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(java.lang.String p_filename,
                      byte p_keySize,
                      long p_records,
                      int p_recordSize,
                      boolean p_useRemote,
                      java.lang.String p_user,
                      java.lang.String p_password,
                      int p_umask,
                      java.lang.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(java.lang.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(java.lang.String p_filename,
                      byte p_keySize,
                      long p_records,
                      int p_recordSize,
                      boolean p_64bit,
                      boolean p_tagged,
                      boolean p_useRemote,
                      java.lang.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(java.lang.String p_filename,
                      byte p_keySize,
                      long p_records,
                      int p_recordSize,
                      boolean p_64bit,
                      boolean p_tagged,
                      boolean p_useRemote,
                      java.lang.String p_user,
                      java.lang.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(java.lang.String p_filename,
                      byte p_keySize,
                      long p_records,
                      int p_recordSize,
                      boolean p_64bit,
                      boolean p_tagged,
                      boolean p_useRemote,
                      java.lang.String p_user,
                      java.lang.String p_password,
                      int p_umask,
                      java.lang.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(java.lang.String p_filename,
                      java.util.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:

KeyDescription

createMKeyedFile

void createMKeyedFile(java.lang.String p_filename,
                      java.util.List p_keys,
                      long p_records,
                      int p_recordSize,
                      boolean p_64bit,
                      boolean p_tagged,
                      boolean p_useRemote,
                      java.lang.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:

KeyDescription

createMKeyedFile

void createMKeyedFile(java.lang.String p_filename,
                      java.util.List p_keys,
                      long p_records,
                      int p_recordSize,
                      boolean p_64bit,
                      boolean p_tagged,
                      boolean p_useRemote,
                      java.lang.String p_user,
                      java.lang.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:

KeyDescription

createMKeyedFile

void createMKeyedFile(java.lang.String p_filename,
                      java.util.List p_keys,
                      long p_records,
                      int p_recordSize,
                      boolean p_64bit,
                      boolean p_tagged,
                      boolean p_useRemote,
                      java.lang.String p_user,
                      java.lang.String p_password,
                      int p_umask,
                      java.lang.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:

KeyDescription

createXKeyedFile

void createXKeyedFile(java.lang.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(java.lang.String p_filename,
                      int p_keySize,
                      long p_records,
                      int p_recordSize,
                      boolean p_tagged,
                      boolean p_useRemote,
                      java.lang.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(java.lang.String p_filename,
                      int p_keySize,
                      long p_records,
                      int p_recordSize,
                      boolean p_tagged,
                      boolean p_useRemote,
                      java.lang.String p_user,
                      java.lang.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(java.lang.String p_filename,
                      int p_keySize,
                      long p_records,
                      int p_recordSize,
                      boolean p_tagged,
                      boolean p_useRemote,
                      java.lang.String p_user,
                      java.lang.String p_password,
                      int p_umask,
                      java.lang.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(java.lang.String p_filename,
                      java.util.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(java.lang.String p_filename,
                      java.util.List p_keys,
                      long p_records,
                      int p_recordSize,
                      boolean p_tagged,
                      boolean p_useRemote,
                      java.lang.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(java.lang.String p_filename,
                      java.util.List p_keys,
                      long p_records,
                      int p_recordSize,
                      boolean p_tagged,
                      boolean p_useRemote,
                      java.lang.String p_user,
                      java.lang.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(java.lang.String p_filename,
                      java.util.List p_keys,
                      long p_records,
                      int p_recordSize,
                      boolean p_tagged,
                      boolean p_useRemote,
                      java.lang.String p_user,
                      java.lang.String p_password,
                      int p_umask,
                      java.lang.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(java.lang.String p_filename,
                      int p_keySize,
                      long p_records,
                      int p_recordSize,
                      boolean p_tagged,
                      boolean p_useRemote,
                      java.lang.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(java.lang.String p_filename,
                      int p_keySize,
                      long p_records,
                      int p_recordSize,
                      boolean p_tagged,
                      boolean p_useRemote,
                      java.lang.String p_user,
                      java.lang.String p_password,
                      int p_umask,
                      java.lang.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(java.lang.String p_filename,
                      java.util.List p_keys,
                      long p_records,
                      int p_recordSize,
                      boolean p_tagged,
                      boolean p_useRemote,
                      java.lang.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(java.lang.String p_filename,
                      java.util.List p_keys,
                      long p_records,
                      int p_recordSize,
                      boolean p_tagged,
                      boolean p_useRemote,
                      java.lang.String p_user,
                      java.lang.String p_password,
                      int p_umask,
                      java.lang.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(java.lang.String p_filename,
                          java.lang.String p_template,
                          java.lang.String p_idField,
                          boolean p_useRemote,
                          java.lang.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(java.lang.String p_filename,
                          java.lang.String p_template,
                          java.lang.String p_idField,
                          boolean p_useRemote,
                          java.lang.String p_user,
                          java.lang.String p_password,
                          int p_umask,
                          java.lang.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(java.lang.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(java.lang.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(java.lang.String p_filename,
           boolean p_useRemote,
           java.lang.String p_user,
           java.lang.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(java.lang.String p_filename,
           boolean p_useRemote,
           long p_timeout,
           java.lang.String p_user,
           java.lang.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(java.lang.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(java.lang.String p_filename,
           boolean p_useRemote,
           java.lang.String p_user,
           java.lang.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(java.lang.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(java.lang.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(java.lang.String p_filename,
           boolean p_useRemote,
           java.lang.String p_user,
           java.lang.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(java.lang.String p_filename,
           boolean p_useRemote,
           long p_timeout,
           java.lang.String p_user,
           java.lang.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(java.lang.String p_fromFilename,
            java.lang.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(java.lang.String p_fromFilename,
            java.lang.String p_toFilename,
            boolean p_useRemote,
            java.lang.String p_user,
            java.lang.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(java.lang.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(java.lang.String p_dir,
               boolean p_useRemote,
               java.lang.String p_user,
               java.lang.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

java.lang.String getDir()
                 throws FilesystemException

Get current directory.

Throws:

FilesystemException - If a filesystem problem occurs.

getDir

java.lang.String getDir(java.lang.String p_user,
                        java.lang.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

java.lang.String getTempFilename(java.lang.String p_prefix,
                                 java.lang.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

java.lang.String getTempFilename(java.lang.String p_prefix,
                                 java.lang.String p_suffix,
                                 java.lang.String p_user,
                                 java.lang.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

java.lang.String getTempFilename(java.lang.String p_prefix,
                                 java.lang.String p_suffix,
                                 java.lang.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

java.lang.String getTempFilename(java.lang.String p_prefix,
                                 java.lang.String p_suffix,
                                 java.lang.String p_directory,
                                 java.lang.String p_user,
                                 java.lang.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

void convert(java.lang.String p_filename,
             boolean p_recoverable,
             boolean p_overwrite,
             boolean p_useRemote,
             java.lang.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

void convert(java.lang.String p_filename,
             boolean p_recoverable,
             boolean p_overwrite,
             boolean p_useRemote,
             java.lang.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

void convert(java.lang.String p_filename,
             boolean p_recoverable,
             boolean p_overwrite,
             boolean p_useRemote,
             java.lang.String p_user,
             java.lang.String p_password,
             java.lang.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

void convert(java.lang.String p_filename,
             boolean p_recoverable,
             boolean p_overwrite,
             boolean p_useRemote,
             java.lang.String p_user,
             java.lang.String p_password,
             java.lang.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.

recover

RecoverStatus recover(java.lang.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

RecoverStatus recover(java.lang.String p_filename,
                      boolean p_overwrite,
                      boolean p_useRemote,
                      java.lang.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

RecoverStatus recover(java.lang.String p_filename,
                      boolean p_overwrite,
                      boolean p_useRemote,
                      java.lang.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

RecoverStatus recover(java.lang.String p_filename,
                      boolean p_overwrite,
                      boolean p_useRemote,
                      java.lang.String p_user,
                      java.lang.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

RecoverStatus recover(java.lang.String p_filename,
                      boolean p_overwrite,
                      boolean p_useRemote,
                      java.lang.String p_user,
                      java.lang.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

RecoverStatus recover(java.lang.String p_filename,
                      boolean p_overwrite,
                      boolean p_useRemote,
                      java.lang.String p_user,
                      java.lang.String p_password,
                      java.lang.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

RecoverStatus recover(java.lang.String p_filename,
                      boolean p_overwrite,
                      boolean p_useRemote,
                      java.lang.String p_user,
                      java.lang.String p_password,
                      java.lang.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.

getTransaction

FilesystemTransaction getTransaction(int p_degree,
                                     boolean p_readOnly)
                              throws FilesystemException

Get a transaction (possibly read only).

Parameters:

p_degree - Degree of the transaction (1-3 inclusive).

p_readOnly - True if the transaction should be read only.

Returns:

Transaction for use with files.

Throws:

FilesystemException

getTransaction

FilesystemTransaction getTransaction(java.lang.String p_host,
                                     int p_port,
                                     int p_degree,
                                     boolean p_readOnly)
                              throws FilesystemException

Get a transaction (possibly read only).

Parameters:

p_host - Host to get a transaction for.

p_port - Port for the host.

p_degree - Degree of the transaction (1-3 inclusive).

p_readOnly - True if the transaction should be read only.

Returns:

Transaction for use with files.

Throws:

FilesystemException

getTransaction

FilesystemTransaction getTransaction(int p_degree,
                                     boolean p_readOnly,
                                     java.lang.String p_user,
                                     java.lang.String p_password)
                              throws FilesystemException

Get a transaction (possibly read only).

Parameters:

p_degree - Degree of the transaction (1-3 inclusive).

p_readOnly - True if the transaction should be read only.

p_user - User name for server connection.

p_password - Password for server connection.

Returns:

Transaction for use with files.

Throws:

FilesystemException

getTransaction

FilesystemTransaction getTransaction(java.lang.String p_host,
                                     int p_port,
                                     int p_degree,
                                     boolean p_readOnly,
                                     java.lang.String p_user,
                                     java.lang.String p_password)
                              throws FilesystemException

Get a transaction (possibly read only).

Parameters:

p_host - Host to get a transaction for.

p_port - Port for the host.

p_degree - Degree of the transaction (1-3 inclusive).

p_readOnly - True if the transaction should be read only.

p_user - User name for server connection.

p_password - Password for server connection.

Returns:

Transaction for use with files.

Throws:

FilesystemException

createJournaled

void createJournaled(java.lang.String p_name,
                     int p_keySize,
                     int p_recordSize)
              throws FilesystemException

Create a journaled file.

Parameters:

p_name - Name of the journaled file.

p_keySize - Size of a key -- must be greater than 1.

p_recordSize - Size of a record -- must be greater than or equal to 0.

Throws:

FilesystemException - If a filesystem problem occurs.

createJournaled

void createJournaled(java.lang.String p_name,
                     int p_keySize,
                     int p_recordSize,
                     java.lang.String p_mode)
              throws FilesystemException

Create a journaled file.

Parameters:

p_name - Name of the journaled file.

p_keySize - Size of a key -- must be greater than 1.

p_recordSize - Size of a record -- must be greater than or equal to 0.

p_mode - Mode string.

Throws:

FilesystemException - If a filesystem problem occurs.

createJournaled

void createJournaled(java.lang.String p_name,
                     int p_keySize,
                     int p_recordSize,
                     java.lang.String p_user,
                     java.lang.String p_password)
              throws FilesystemException

Create a journaled file.

Parameters:

p_name - Name of the journaled file.

p_keySize - Size of a key -- must be greater than 1.

p_recordSize - Size of a record -- must be greater than or equal to 0.

p_user - User name for server connection.

p_password - Password for server connection.

Throws:

FilesystemException - If a filesystem problem occurs.

createJournaled

void createJournaled(java.lang.String p_name,
                     int p_keySize,
                     int p_recordSize,
                     java.lang.String p_user,
                     java.lang.String p_password,
                     java.lang.String p_mode)
              throws FilesystemException

Create a journaled file.

Parameters:

p_name - Name of the journaled file.

p_keySize - Size of a key -- must be greater than 1.

p_recordSize - Size of a record -- must be greater than or equal to 0.

p_user - User name for server connection.

p_password - Password for server connection.

p_mode - Mode string.

Throws:

FilesystemException - If a filesystem problem occurs.

createJournaled

void createJournaled(java.lang.String p_name,
                     java.util.List p_keys,
                     int p_recordSize)
              throws FilesystemException

Create a journaled file.

Parameters:

p_name - Name of the journaled file.

p_keys - List of KeyDescription objects.

p_recordSize - Size of a record -- must be greater than or equal to 0.

Throws:

FilesystemException - If a filesystem problem occurs.

createJournaled

void createJournaled(java.lang.String p_name,
                     java.util.List p_keys,
                     int p_recordSize,
                     java.lang.String p_mode)
              throws FilesystemException

Create a journaled file.

Parameters:

p_name - Name of the journaled file.

p_keys - List of KeyDescription objects.

p_recordSize - Size of a record -- must be greater than or equal to 0.

p_mode - Mode string.

Throws:

FilesystemException - If a filesystem problem occurs.

createJournaled

void createJournaled(java.lang.String p_name,
                     java.util.List p_keys,
                     int p_recordSize,
                     java.lang.String p_user,
                     java.lang.String p_password)
              throws FilesystemException

Create a journaled file.

Parameters:

p_name - Name of the journaled file.

p_keys - List of KeyDescription objects.

p_recordSize - Size of a record -- must be greater than or equal to 0.

p_user - User name for server connection.

p_password - Password for server connection.

Throws:

FilesystemException - If a filesystem problem occurs.

createJournaled

void createJournaled(java.lang.String p_name,
                     java.util.List p_keys,
                     int p_recordSize,
                     java.lang.String p_user,
                     java.lang.String p_password,
                     java.lang.String p_mode)
              throws FilesystemException

Create a journaled file.

Parameters:

p_name - Name of the journaled file.

p_keys - List of KeyDescription objects.

p_recordSize - Size of a record -- must be greater than or equal to 0.

p_user - User name for server connection.

p_password - Password for server connection.

p_mode - Mode string.

Throws:

FilesystemException - If a filesystem problem occurs.

openJournaled

FilePosition openJournaled(java.lang.String p_name,
                           FilesystemTransaction p_transaction,
                           boolean p_readOnly)
                    throws FilesystemException

Open a journaled file.

Parameters:

p_name - Name of the journaled file.

p_transaction - Transaction that the file should be opened in, if this is null the file will be opened as auto-commit.

Throws:

FilesystemException

openJournaled

FilePosition openJournaled(java.lang.String p_name,
                           FilesystemTransaction p_transaction,
                           boolean p_readOnly,
                           java.lang.String p_mode)
                    throws FilesystemException

Open a journaled file.

Parameters:

p_name - Name of the journaled file.

p_transaction - Transaction that the file should be opened in, if this is null the file will be opened as auto-commit.

p_mode - Mode string.

Throws:

FilesystemException

openJournaled

FilePosition openJournaled(java.lang.String p_name,
                           FilesystemTransaction p_transaction,
                           boolean p_readOnly,
                           java.lang.String p_mode,
                           long p_timeout)
                    throws FilesystemException

Open a journaled file.

Parameters:

p_name - Name of the journaled file.

p_transaction - Transaction that the file should be opened in, if this is null the file will be opened as auto-commit.

p_mode - Mode string.

p_timeout - Open timeout.

Throws:

FilesystemException

openJournaled

FilePosition openJournaled(java.lang.String p_name,
                           FilesystemTransaction p_transaction,
                           boolean p_readOnly,
                           java.lang.String p_user,
                           java.lang.String p_password)
                    throws FilesystemException

Open a journaled file.

Parameters:

p_name - Name of the journaled file.

p_transaction - Transaction that the file should be opened in, if this is null the file will be opened as auto-commit.

p_user - User name for server connection.

p_password - Password for server connection.

Throws:

FilesystemException

openJournaled

FilePosition openJournaled(java.lang.String p_name,
                           FilesystemTransaction p_transaction,
                           boolean p_readOnly,
                           java.lang.String p_user,
                           java.lang.String p_password,
                           java.lang.String p_mode)
                    throws FilesystemException

Open a journaled file.

Parameters:

p_name - Name of the journaled file.

p_transaction - Transaction that the file should be opened in, if this is null the file will be opened as auto-commit.

p_user - User name for server connection.

p_password - Password for server connection.

p_mode - Mode string.

Throws:

FilesystemException

openJournaled

FilePosition openJournaled(java.lang.String p_name,
                           FilesystemTransaction p_transaction,
                           boolean p_readOnly,
                           java.lang.String p_user,
                           java.lang.String p_password,
                           java.lang.String p_mode,
                           long p_timeout)
                    throws FilesystemException

Open a journaled file.

Parameters:

p_name - Name of the journaled file.

p_transaction - Transaction that the file should be opened in, if this is null the file will be opened as auto-commit.

p_user - User name for server connection.

p_password - Password for server connection.

p_mode - Mode string.

p_timeout - Open timeout.

Throws:

FilesystemException

eraseJournaled

void eraseJournaled(java.lang.String p_name)
             throws FilesystemException

Erase a journaled file.

Parameters:

p_name - Name of the journaled file.

Throws:

FilesystemException

eraseJournaled

void eraseJournaled(java.lang.String p_name,
                    java.lang.String p_user,
                    java.lang.String p_password)
             throws FilesystemException

Erase a journaled file.

Parameters:

p_name - Name of the journaled file.

p_user - User name for server connection.

p_password - Password for server connection.

Throws:

FilesystemException

renameJournaled

void renameJournaled(java.lang.String p_from,
                     java.lang.String p_to)
              throws FilesystemException

Rename a journaled file.

Parameters:

p_from - Journaled file to rename.

p_to - New name.

Throws:

FilesystemException

renameJournaled

void renameJournaled(java.lang.String p_from,
                     java.lang.String p_to,
                     java.lang.String p_user,
                     java.lang.String p_password)
              throws FilesystemException

Rename a journaled file.

Parameters:

p_from - Journaled file to rename.

p_to - New name.

p_user - User name for server connection.

p_password - Password for server connection.

Throws:

FilesystemException

backupJournaled

void backupJournaled(java.lang.String p_dir)
              throws FilesystemException

Backup a journaled system.

Parameters:

p_dir - Directory to backup system to.

Throws:

FilesystemException

backupJournaled

void backupJournaled(java.lang.String p_dir,
                     java.lang.String p_user,
                     java.lang.String p_password)
              throws FilesystemException

Backup a journaled system.

Parameters:

p_dir - Directory to backup system to.

p_user - User name for server connection.

p_password - Password for server connection.

Throws:

FilesystemException

getPermissions

int getPermissions(java.lang.String p_filename,
                   boolean p_useRemote)
            throws FilesystemException

Throws:

FilesystemException

getPermissions

int getPermissions(java.lang.String p_filename,
                   boolean p_useRemote,
                   java.lang.String p_user,
                   java.lang.String p_password)
            throws FilesystemException

Throws:

FilesystemException

chmod

void chmod(java.lang.String p_filename,
           int p_permissions,
           boolean p_useRemote)
    throws FilesystemException

Throws:

FilesystemException

chmod

void chmod(java.lang.String p_filename,
           int p_permissions,
           boolean p_useRemote,
           java.lang.String p_user,
           java.lang.String p_password)
    throws FilesystemException

Throws:

FilesystemException

exists

boolean exists(java.lang.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(java.lang.String p_filename,
               boolean p_useRemote,
               java.lang.String p_user,
               java.lang.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(java.lang.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(java.lang.String p_filename,
                   boolean p_useRemote,
                   java.lang.String p_user,
                   java.lang.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(java.lang.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(java.lang.String p_filename,
                   boolean p_useRemote,
                   java.lang.String p_user,
                   java.lang.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(java.lang.String p_filename,
                    boolean p_useRemote)

copyToJournaled

void copyToJournaled(java.lang.String p_sourceFile,
                     java.lang.String p_destinationFile,
                     java.lang.String p_userName,
                     java.lang.String p_password)
              throws FilesystemException

This call will copy the source file to a file in the journaled filesystem as the destination file.

Parameters:

p_sourceFile - The full path to the source file to be copied.

p_destinationFile - The path relative to the base directory of the journaled filesystem.

Throws:

FilesystemException - If there is a problem performing the copy.

updateLicense

void updateLicense()
            throws FilesystemException

Call to update the license.

Throws:

FilesystemException

isLocal

boolean isLocal(java.net.InetAddress p_address,
                int p_port)

createDefaultNagProcess

NagProcess createDefaultNagProcess(NagListener p_listener)