H2 Database Engine 2.3.232 · org.h2.store.FileStore · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private static final boolean	ASSERT
private Reference<?>	autoDeleteReference
private boolean	checkedWriting
private FileChannel	file
private long	fileLength
private long	filePos
private final DataHandler	handler The callback object is responsible to check access rights, and free up disk space if required.
private static final String	HEADER The magic file header.
public static final int	HEADER_LENGTH The size of the file header in bytes.
private FileLock	lock
private final String	mode
protected String	name The file name.

Access	Constructor and Description
protected	FileStore(DataHandler the callback object handler, String the file name name, String the access mode ("r", "rw", "rws", "rwd") mode) Create a new file using the given settings.

Method Summary

Modifier and Type	Method and Description
public void	autoDelete() Automatically delete the file once it is no longer in use.
private void	checkPowerOff()
private void	checkWritingAllowed()
public void	close() Close the file.
public void	closeAndDeleteSilently() Close the file (ignoring exceptions) and delete the file.
public void	closeFile() Close the file.
private void	closeFileSilently() Just close the file, without setting the reference to null.
public void	closeSilently() Close the file without throwing any exceptions.
protected byte[]	Returns: the random salt or the magic generateSalt() Generate the random salt bytes if required.
public long	Returns: the location getFilePointer() Get the current location of the file pointer.
public void	init() Initialize the file.
protected void	initKey(byte[] the salt salt) Initialize the key using the given salt.
public long	Returns: the file size length() Get the file size in bytes.
public static FileStore	Returns: the created object open(DataHandler the data handler handler, String the file name name, String the access mode (r, rw, rws, rwd) mode) Open a non encrypted file store with the given settings.
public static FileStore	Returns: the created object open(DataHandler the data handler handler, String the file name name, String the access mode (r, rw, rws, rwd) mode, String the name of the cipher algorithm cipher, byte[] the encryption key key) Open an encrypted file store with the given settings.
public static FileStore	Returns: the created object open(DataHandler the data handler handler, String the file name name, String the access mode (r, rw, rws, rwd) mode, String the name of the cipher algorithm cipher, byte[] the encryption key key, int the number of iterations the key should be hashed keyIterations) Open an encrypted file store with the given settings.
public void	openFile() Re-open the file.
public void	readFully(byte[] the target buffer b, int the offset off, int the number of bytes to read len) Read a number of bytes.
public void	readFullyDirect(byte[] the target buffer b, int the offset off, int the number of bytes to read len) Read a number of bytes without decrypting.
public synchronized void	releaseLock() Release the file lock.
public void	seek(long the location pos) Go to the specified file location.
public void	setCheckedWriting(boolean value)
public void	setLength(long the new file size newLength) Set the length of the file.
public void	stopAutoDelete() No longer automatically delete the file once it is no longer in use.
public void	sync() Call fsync.
private static void	trace(String method, String fileName, Object o)
public synchronized boolean	Returns: true if successful tryLock() Try to lock the file.
public void	write(byte[] the source buffer b, int the offset off, int the number of bytes to write len) Write a number of bytes.
protected void	writeDirect(byte[] the source buffer b, int the offset off, int the number of bytes to write len) Write a number of bytes without encrypting.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

ASSERT	back to summary
private static final boolean ASSERT

autoDeleteReference	back to summary
private Reference<?> autoDeleteReference

checkedWriting	back to summary
private boolean checkedWriting

file	back to summary
private FileChannel file

fileLength	back to summary
private long fileLength

filePos	back to summary
private long filePos

handler	back to summary
private final DataHandler handler The callback object is responsible to check access rights, and free up disk space if required.

HEADER	back to summary
private static final String HEADER The magic file header.

HEADER_LENGTH	back to summary
public static final int HEADER_LENGTH The size of the file header in bytes.

lock	back to summary
private FileLock lock

mode	back to summary
private final String mode

name	back to summary
protected String name The file name.

FileStore	back to summary
protected FileStore(DataHandler handler, String name, String mode) Create a new file using the given settings. Parameters handler:DataHandler the callback object name:String the file name mode:String the access mode ("r", "rw", "rws", "rwd")

Method Detail

autoDelete	back to summary
public void autoDelete() Automatically delete the file once it is no longer in use.

checkPowerOff	back to summary
private void checkPowerOff()

checkWritingAllowed	back to summary
private void checkWritingAllowed()

close	back to summary
public void close() Close the file.

closeAndDeleteSilently	back to summary
public void closeAndDeleteSilently() Close the file (ignoring exceptions) and delete the file.

closeFile	back to summary
public void closeFile() throws IOException Close the file. The file may later be re-opened using openFile. Exceptions IOException: on failure

closeFile

back to summary

public void closeFile() throws IOException

Close the file. The file may later be re-opened using openFile.

Exceptions

IOException:: on failure

closeFileSilently	back to summary
private void closeFileSilently() Just close the file, without setting the reference to null. This method is called when writing failed. The reference is not set to null so that there are no NullPointerExceptions later on.

closeSilently	back to summary
public void closeSilently() Close the file without throwing any exceptions. Exceptions are simply ignored.

generateSalt	back to summary
protected byte[] generateSalt() Generate the random salt bytes if required. Returns:byte[] the random salt or the magic

generateSalt

back to summary

protected byte[] generateSalt()

Generate the random salt bytes if required.

Returns:byte[]: the random salt or the magic

getFilePointer	back to summary
public long getFilePointer() Get the current location of the file pointer. Returns:long the location

getFilePointer

back to summary

public long getFilePointer()

Get the current location of the file pointer.

Returns:long: the location

init	back to summary
public void init() Initialize the file. This method will write or check the file header if required.

initKey	back to summary
protected void initKey(byte[] salt) Initialize the key using the given salt. Parameters salt:byte[] the salt Annotations @SuppressWarnings:unused

initKey

back to summary

protected void initKey(byte[] salt)

Initialize the key using the given salt.

Parameters

salt:byte[]: the salt

Annotations

@SuppressWarnings:unused

length	back to summary
public long length() Get the file size in bytes. Returns:long the file size

length

back to summary

public long length()

Get the file size in bytes.

Returns:long: the file size

open	back to summary
public static FileStore open(DataHandler handler, String name, String mode) Open a non encrypted file store with the given settings. Parameters handler:DataHandler the data handler name:String the file name mode:String the access mode (r, rw, rws, rwd) Returns:FileStore the created object

open

back to summary

public static FileStore open(DataHandler handler, String name, String mode)

Open a non encrypted file store with the given settings.

Parameters

handler:DataHandler: the data handler
name:String: the file name
mode:String: the access mode (r, rw, rws, rwd)

Returns:FileStore

the created object

open	back to summary
public static FileStore open(DataHandler handler, String name, String mode, String cipher, byte[] key) Open an encrypted file store with the given settings. Parameters handler:DataHandler the data handler name:String the file name mode:String the access mode (r, rw, rws, rwd) cipher:String the name of the cipher algorithm key:byte[] the encryption key Returns:FileStore the created object

open

back to summary

public static FileStore open(DataHandler handler, String name, String mode, String cipher, byte[] key)

Open an encrypted file store with the given settings.

Parameters

handler:DataHandler: the data handler
name:String: the file name
mode:String: the access mode (r, rw, rws, rwd)
cipher:String: the name of the cipher algorithm
key:byte[]: the encryption key

Returns:FileStore

the created object

open	back to summary
public static FileStore open(DataHandler handler, String name, String mode, String cipher, byte[] key, int keyIterations) Open an encrypted file store with the given settings. Parameters handler:DataHandler the data handler name:String the file name mode:String the access mode (r, rw, rws, rwd) cipher:String the name of the cipher algorithm key:byte[] the encryption key keyIterations:int the number of iterations the key should be hashed Returns:FileStore the created object

open

back to summary

public static FileStore open(DataHandler handler, String name, String mode, String cipher, byte[] key, int keyIterations)

Open an encrypted file store with the given settings.

Parameters

handler:DataHandler: the data handler
name:String: the file name
mode:String: the access mode (r, rw, rws, rwd)
cipher:String: the name of the cipher algorithm
key:byte[]: the encryption key
keyIterations:int: the number of iterations the key should be hashed

Returns:FileStore

the created object

openFile	back to summary
public void openFile() throws IOException Re-open the file. The file pointer will be reset to the previous location. Exceptions IOException: on failure

openFile

back to summary

public void openFile() throws IOException

Re-open the file. The file pointer will be reset to the previous location.

Exceptions

IOException:: on failure

readFully	back to summary
public void readFully(byte[] b, int off, int len) Read a number of bytes. Parameters b:byte[] the target buffer off:int the offset len:int the number of bytes to read

readFully

back to summary

public void readFully(byte[] b, int off, int len)

Read a number of bytes.

Parameters

b:byte[]: the target buffer
off:int: the offset
len:int: the number of bytes to read

readFullyDirect	back to summary
public void readFullyDirect(byte[] b, int off, int len) Read a number of bytes without decrypting. Parameters b:byte[] the target buffer off:int the offset len:int the number of bytes to read

readFullyDirect

back to summary

public void readFullyDirect(byte[] b, int off, int len)

Read a number of bytes without decrypting.

Parameters

b:byte[]: the target buffer
off:int: the offset
len:int: the number of bytes to read

releaseLock	back to summary
public synchronized void releaseLock() Release the file lock.

seek	back to summary
public void seek(long pos) Go to the specified file location. Parameters pos:long the location

seek

back to summary

public void seek(long pos)

Go to the specified file location.

Parameters

pos:long: the location

setCheckedWriting	back to summary
public void setCheckedWriting(boolean value)

setLength	back to summary
public void setLength(long newLength) Set the length of the file. This will expand or shrink the file. Parameters newLength:long the new file size

setLength

back to summary

public void setLength(long newLength)

Set the length of the file. This will expand or shrink the file.

Parameters

newLength:long: the new file size

stopAutoDelete	back to summary
public void stopAutoDelete() No longer automatically delete the file once it is no longer in use.

sync	back to summary
public void sync() Call fsync. Depending on the operating system and hardware, this may or may not in fact write the changes.

trace	back to summary
private static void trace(String method, String fileName, Object o)

tryLock	back to summary
public synchronized boolean tryLock() Try to lock the file. Returns:boolean true if successful

tryLock

back to summary

public synchronized boolean tryLock()

Try to lock the file.

Returns:boolean: true if successful

write	back to summary
public void write(byte[] b, int off, int len) Write a number of bytes. Parameters b:byte[] the source buffer off:int the offset len:int the number of bytes to write

write

back to summary

public void write(byte[] b, int off, int len)

Write a number of bytes.

Parameters

b:byte[]: the source buffer
off:int: the offset
len:int: the number of bytes to write

writeDirect	back to summary
protected void writeDirect(byte[] b, int off, int len) Write a number of bytes without encrypting. Parameters b:byte[] the source buffer off:int the offset len:int the number of bytes to write

writeDirect

back to summary

protected void writeDirect(byte[] b, int off, int len)

Write a number of bytes without encrypting.

Parameters

b:byte[]: the source buffer
off:int: the offset
len:int: the number of bytes to write

public Class FileStore

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail