com.basis.filesystem

Class Filesystem

java.lang.Object

com.basis.filesystem.Filesystem

public class Filesystem
extends java.lang.Object

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.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CISAM_FILE C-ISAM old file type not supported by BBj.
static int	CRYPT_FILE Encrypted file type, you should only see this opening in binary mode without decryption.
static java.lang.String	DEFAULT_LOCAL_SERVER
static int	DIRECT_FILE DIRECT/SORT file type.
static int	DIRECTORY_FILE DIRECTORY file type.
static java.lang.String	FORCE_LOCAL_PROPERTY
static int	INDEXED_FILE INDEXED file type.
static int	JKEYED_FILE JKEYED file type.
static java.lang.String	LOCAL_PORT_PROPERTY
static java.lang.String	LOCAL_SERVER_PROPERTY
static int	MAX_FILE_TYPE Max file type.
static int	MAX_KEY_SIZE Deprecated.
static int	MAX_RECORD_SIZE Maximum record size.
static int	MKEYED_4GIG Modifier for a 4 Gig MKEYED file.
static int	MKEYED_64BIT Modifier for a 64-bit file.
static int	MKEYED_FILE MKEYED file type.
static int	MKEYED_TAGRECORD Modifier for a tagged record file.
static int	MODE_APPEND Append mode -- for STRING files.
static int	MODE_CREATE Create mode -- for STRING files.
static int	MODE_EXCL Exclusive mode -- for STRING files.
static int	MODE_RDONLY Read only mode -- for all files.
static int	MODE_TRUNC Truncate mode -- for STRING files.
static int	ORDERED_NUMERIC_KEY Modifier for ordered numeric key segments.
static int	PROGRAM_FILE PROGRAM file type.
static int	SERIAL_FILE SERIAL file type.
static int	STRING_FILE STRING file type.
static int	TEXTSEARCH_FILE TEXTSEARCH
static int	TYPEMASK Mask to get type signature out of the file type byte of the header.
static int	VKEYED_FILE VKEYED file type.
static int	XKEYED_FILE XKEYED file type.

Method Summary

Modifier and Type	Method and Description
static ConnectionMgr	getConnectionMgr() Get a ConnectionMgr for use in making Filesystem calls.
static ConnectionMgr	getConnectionMgr(java.net.InetAddress p_licenseHost, int p_licensePort, boolean p_ssl, boolean p_remoteLicense) Get a ConnectionMgr for use in making Filesystem calls.
static java.net.InetAddress	getIPv4Loopback() Get one of the IPv4 loopback addresses.
static java.net.InetAddress	getIPv6Loopback() Get the IPv6 loopback address.
static java.net.InetAddress	getLoopback() Get the machine loopback address.
static java.lang.String	getServerFilename(java.lang.String p_filename, boolean p_remote)
static boolean	isAbsolute(java.lang.String p_filename) Determine whether is path should be considered absolute.
static boolean	isLoopback(java.net.InetAddress p_addr) Is a given IP address the loopback address.
static java.lang.String	modesIntToString(int p_mode) Create a mode string from the modes that files care about.
static void	setDirectConnectionMgr(java.lang.Class<? extends DirectConnectionMgr> p_direct) Set the class for the lowest ConnectionMgr access.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MODE_APPEND

public static final int MODE_APPEND

Append mode -- for STRING files.

See Also:

Constant Field Values

MODE_TRUNC

public static final int MODE_TRUNC

Truncate mode -- for STRING files.

See Also:

Constant Field Values

MODE_CREATE

public static final int MODE_CREATE

Create mode -- for STRING files.

See Also:

Constant Field Values

MODE_EXCL

public static final int MODE_EXCL

Exclusive mode -- for STRING files.

See Also:

Constant Field Values

MODE_RDONLY

public static final int MODE_RDONLY

Read only mode -- for all files.

See Also:

Constant Field Values

MAX_RECORD_SIZE

public static final int MAX_RECORD_SIZE

Maximum record size.

See Also:

Constant Field Values

MAX_KEY_SIZE

@Deprecated
public static final int MAX_KEY_SIZE

Deprecated.

Maximum key size for MKEYED files.

See Also:

Constant Field Values

INDEXED_FILE

public static final int INDEXED_FILE

INDEXED file type.

See Also:

Constant Field Values

SERIAL_FILE

public static final int SERIAL_FILE

SERIAL file type.

See Also:

Constant Field Values

DIRECT_FILE

public static final int DIRECT_FILE

DIRECT/SORT file type.

See Also:

Constant Field Values

STRING_FILE

public static final int STRING_FILE

STRING file type.

See Also:

Constant Field Values

PROGRAM_FILE

public static final int PROGRAM_FILE

PROGRAM file type.

See Also:

Constant Field Values

DIRECTORY_FILE

public static final int DIRECTORY_FILE

DIRECTORY file type.

See Also:

Constant Field Values

MKEYED_FILE

public static final int MKEYED_FILE

MKEYED file type.

See Also:

Constant Field Values

CISAM_FILE

public static final int CISAM_FILE

C-ISAM old file type not supported by BBj.

See Also:

Constant Field Values

XKEYED_FILE

public static final int XKEYED_FILE

XKEYED file type.

See Also:

Constant Field Values

TEXTSEARCH_FILE

public static final int TEXTSEARCH_FILE

TEXTSEARCH

See Also:

Constant Field Values

JKEYED_FILE

public static final int JKEYED_FILE

JKEYED file type.

See Also:

Constant Field Values

CRYPT_FILE

public static final int CRYPT_FILE

Encrypted file type, you should only see this opening in binary mode without decryption.

See Also:

Constant Field Values

VKEYED_FILE

public static final int VKEYED_FILE

VKEYED file type.

See Also:

Constant Field Values

MAX_FILE_TYPE

public static final int MAX_FILE_TYPE

Max file type.

See Also:

Constant Field Values

MKEYED_4GIG

public static final int MKEYED_4GIG

Modifier for a 4 Gig MKEYED file.

See Also:

Constant Field Values

MKEYED_TAGRECORD

public static final int MKEYED_TAGRECORD

Modifier for a tagged record file.

See Also:

Constant Field Values

MKEYED_64BIT

public static final int MKEYED_64BIT

Modifier for a 64-bit file.

See Also:

Constant Field Values

ORDERED_NUMERIC_KEY

public static final int ORDERED_NUMERIC_KEY

Modifier for ordered numeric key segments.

See Also:

Constant Field Values

TYPEMASK

public static final int TYPEMASK

Mask to get type signature out of the file type byte of the header.

See Also:

Constant Field Values

LOCAL_SERVER_PROPERTY

public static final java.lang.String LOCAL_SERVER_PROPERTY

See Also:

Constant Field Values

LOCAL_PORT_PROPERTY

public static final java.lang.String LOCAL_PORT_PROPERTY

See Also:

Constant Field Values

FORCE_LOCAL_PROPERTY

public static final java.lang.String FORCE_LOCAL_PROPERTY

See Also:

Constant Field Values

DEFAULT_LOCAL_SERVER

public static final java.lang.String DEFAULT_LOCAL_SERVER

See Also:

Constant Field Values

Method Detail

setDirectConnectionMgr

public static void setDirectConnectionMgr(java.lang.Class<? extends 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

public static ConnectionMgr getConnectionMgr()

Get a ConnectionMgr for use in making Filesystem calls.

getConnectionMgr

public static ConnectionMgr getConnectionMgr(java.net.InetAddress p_licenseHost,
                                             int p_licensePort,
                                             boolean p_ssl,
                                             boolean p_remoteLicense)

Get a ConnectionMgr 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

public static boolean isAbsolute(java.lang.String p_filename)

Determine whether is path should be considered absolute.

Parameters:

p_filename - File name to check.

modesIntToString

public static java.lang.String modesIntToString(int p_mode)

Create a mode string from the modes that files care about.

getServerFilename

public static java.lang.String getServerFilename(java.lang.String p_filename,
                                                 boolean p_remote)

isLoopback

public static boolean isLoopback(java.net.InetAddress p_addr)

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.

getLoopback

public static java.net.InetAddress getLoopback()

Get the machine loopback address.

getIPv4Loopback

public static java.net.InetAddress getIPv4Loopback()

Get one of the IPv4 loopback addresses.

getIPv6Loopback

public static java.net.InetAddress getIPv6Loopback()

Get the IPv6 loopback address.