Package com.basis.filesystem
Class Filesystem
java.lang.Object
com.basis.filesystem.Filesystem
This is the main interface class with the major Filesystem constants. It is
also how the user gets a
ConnectionMgr
to use in making
Filesystem calls.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface
static final class
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
C-ISAM old file type not supported by BBj.static final int
Encrypted file type, you should only see this opening in binary mode without decryption.static final Filesystem.CreateAuthClientContext
static final String
static final int
DIRECT/SORT file type.static final int
DIRECTORY file type.static final String
static final int
INDEXED file type.static final int
JKEYED file type.static final String
static final String
static final int
Max file type.static final int
Deprecated.static final int
Maximum record size.static final int
Modifier for a 4 Gig MKEYED file.static final int
Modifier for a 64-bit file.static final int
MKEYED file type.static final int
Modifier for a tagged record file.static final int
Append mode -- for STRING files.static final int
Create mode -- for STRING files.static final int
Exclusive mode -- for STRING files.static final int
Read only mode -- for all files.static final int
Truncate mode -- for STRING files.static final int
Modifier for ordered numeric key segments.static final int
PROGRAM file type.static final int
SERIAL file type.static final int
STRING file type.static final int
TEXTSEARCHstatic final int
Mask to get type signature out of the file type byte of the header.static final int
VKEYED file type.static final int
XKEYED file type. -
Method Summary
Modifier and TypeMethodDescriptionstatic String
fileTypeToString
(int p_type) static ConnectionMgr
Get aConnectionMgr
for use in making Filesystem calls.static ConnectionMgr
getConnectionMgr
(Filesystem.CreateAuthClientContext p_createAuthContext) Get aConnectionMgr
for use in making Filesystem calls.static ConnectionMgr
getConnectionMgr
(Filesystem.CreateAuthClientContext p_createAuthContext, InetAddress p_licenseHost, int p_licensePort, boolean p_ssl, boolean p_remoteLicense) Get aConnectionMgr
for use in making Filesystem calls.static InetAddress
Get one of the IPv4 loopback addresses.static InetAddress
Get the IPv6 loopback address.static InetAddress
Get the machine loopback address.static String
getServerFilename
(String p_filename, boolean p_remote) static boolean
isAbsolute
(String p_filename) Determine whether is path should be considered absolute.static boolean
isLoopback
(InetAddress p_addr) Is a given IP address the loopback address.static boolean
isLoopback
(SocketAddress p_address) static String
modesIntToString
(int p_mode) Create a mode string from the modes that files care about.static void
setDirectConnectionMgr
(Class<? extends com.basis.filesystem.remote.DirectConnectionMgr> p_direct) Set the class for the lowest ConnectionMgr access.
-
Field Details
-
MODE_APPEND
public static final int MODE_APPENDAppend mode -- for STRING files.- See Also:
-
MODE_TRUNC
public static final int MODE_TRUNCTruncate mode -- for STRING files.- See Also:
-
MODE_CREATE
public static final int MODE_CREATECreate mode -- for STRING files.- See Also:
-
MODE_EXCL
public static final int MODE_EXCLExclusive mode -- for STRING files.- See Also:
-
MODE_RDONLY
public static final int MODE_RDONLYRead only mode -- for all files.- See Also:
-
MAX_RECORD_SIZE
public static final int MAX_RECORD_SIZEMaximum record size.- See Also:
-
MAX_KEY_SIZE
Deprecated.Maximum key size for MKEYED files.- See Also:
-
INDEXED_FILE
public static final int INDEXED_FILEINDEXED file type.- See Also:
-
SERIAL_FILE
public static final int SERIAL_FILESERIAL file type.- See Also:
-
DIRECT_FILE
public static final int DIRECT_FILEDIRECT/SORT file type.- See Also:
-
STRING_FILE
public static final int STRING_FILESTRING file type.- See Also:
-
PROGRAM_FILE
public static final int PROGRAM_FILEPROGRAM file type.- See Also:
-
DIRECTORY_FILE
public static final int DIRECTORY_FILEDIRECTORY file type.- See Also:
-
MKEYED_FILE
public static final int MKEYED_FILEMKEYED file type.- See Also:
-
CISAM_FILE
public static final int CISAM_FILEC-ISAM old file type not supported by BBj.- See Also:
-
XKEYED_FILE
public static final int XKEYED_FILEXKEYED file type.- See Also:
-
TEXTSEARCH_FILE
public static final int TEXTSEARCH_FILETEXTSEARCH- See Also:
-
JKEYED_FILE
public static final int JKEYED_FILEJKEYED file type.- See Also:
-
CRYPT_FILE
public static final int CRYPT_FILEEncrypted file type, you should only see this opening in binary mode without decryption.- See Also:
-
VKEYED_FILE
public static final int VKEYED_FILEVKEYED file type.- See Also:
-
MAX_FILE_TYPE
public static final int MAX_FILE_TYPEMax file type.- See Also:
-
MKEYED_4GIG
public static final int MKEYED_4GIGModifier for a 4 Gig MKEYED file.- See Also:
-
MKEYED_TAGRECORD
public static final int MKEYED_TAGRECORDModifier for a tagged record file.- See Also:
-
MKEYED_64BIT
public static final int MKEYED_64BITModifier for a 64-bit file.- See Also:
-
ORDERED_NUMERIC_KEY
public static final int ORDERED_NUMERIC_KEYModifier for ordered numeric key segments.- See Also:
-
TYPEMASK
public static final int TYPEMASKMask to get type signature out of the file type byte of the header.- See Also:
-
LOCAL_SERVER_PROPERTY
- See Also:
-
LOCAL_PORT_PROPERTY
- See Also:
-
FORCE_LOCAL_PROPERTY
- See Also:
-
DEFAULT_LOCAL_SERVER
- See Also:
-
DEFAULT_CREATE_AUTH_CLIENT_CONTEXT
-
-
Method Details
-
fileTypeToString
-
setDirectConnectionMgr
public static void setDirectConnectionMgr(Class<? extends com.basis.filesystem.remote.DirectConnectionMgr> p_direct) Set the class for the lowest ConnectionMgr access. This method is used internally to initialize the ConnectionMgr for access. End users should never call this method.- Parameters:
p_direct
- Class for the lowest level ConnectionMgr.
-
getConnectionMgr
Get aConnectionMgr
for use in making Filesystem calls. -
getConnectionMgr
public static ConnectionMgr getConnectionMgr(Filesystem.CreateAuthClientContext p_createAuthContext) Get aConnectionMgr
for use in making Filesystem calls. -
getConnectionMgr
public static ConnectionMgr getConnectionMgr(Filesystem.CreateAuthClientContext p_createAuthContext, InetAddress p_licenseHost, int p_licensePort, boolean p_ssl, boolean p_remoteLicense) Get aConnectionMgr
for use in making Filesystem calls. This method lets the user specify a remote filesystem server to use for licensing and local file access. -
isAbsolute
Determine whether is path should be considered absolute.- Parameters:
p_filename
- File name to check.
-
modesIntToString
Create a mode string from the modes that files care about. -
getServerFilename
-
isLoopback
Is a given IP address the loopback address. This is actually harder to check than it seams at first glance. The method checks both IPv4 and IPv6.- Parameters:
p_addr
- InetAddress to check.
-
isLoopback
-
getLoopback
Get the machine loopback address. -
getIPv4Loopback
Get one of the IPv4 loopback addresses. -
getIPv6Loopback
Get the IPv6 loopback address.
-