H2 Database Engine 2.3.232 · org.h2.store.fs.encrypt.FileEncrypt

Modifier and Type	Field and Description
private final FileChannel	base
public static final int	BLOCK_SIZE The block size.
pack-priv static final int	BLOCK_SIZE_MASK The block size bit mask.
private byte[]	encryptionKey
private static final int	HASH_ITERATIONS The number of iterations.
private static final byte[]	HEADER
pack-priv static final int	HEADER_LENGTH The length of the file header.
private final String	name
private static final int	SALT_LENGTH The length of the salt, in bytes.
private static final int	SALT_POS
private volatile long	size The current file size, from a user perspective.
private FileEncrypt	source
private volatile XTS	xts

Access	Constructor and Description
public	FileEncrypt(String name, byte[] encryptionKey, FileChannel base)
public	FileEncrypt(String name, FileEncrypt source, FileChannel base)

Method Summary

Modifier and Type	Method and Description
private synchronized XTS	createXTS()
public void	force(boolean If `true` then this method is required to force changes to both the file's content and metadata to be written to storage; otherwise, it need only force content changes to be written metaData) Overrides org.h2.store.fs.FileBase.force. Forces any updates to this channel's file to be written to the storage device that contains it.
protected void	implCloseChannel() Overrides org.h2.store.fs.FileBase.implCloseChannel. Closes this channel.
protected void	implTruncate(long the new size newSize) Implements abstract org.h2.store.fs.FileBaseDefault.implTruncate. The truncate implementation.
private XTS	init()
public int	read(ByteBuffer The buffer into which bytes are to be transferred dst, long The file position at which the transfer is to begin; must be non-negative position) Overrides org.h2.store.fs.FileBase.read. Reads a sequence of bytes from this channel into the given buffer, starting at the given file position.
private static void	readFully(FileChannel file, long pos, ByteBuffer dst)
private void	readInternal(ByteBuffer dst, long position, int len, XTS xts)
public long	size() Implements abstract java.nio.channels.FileChannel.size. Implements java.nio.channels.SeekableByteChannel.size. Returns the current size of this channel's file.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public FileLock	tryLock(long The position at which the locked region is to start; must be non-negative position, long The size of the locked region; must be non-negative, and the sum `position` + `size` must be non-negative. A value of zero means to lock all bytes from the specified starting position to the end of the file, regardless of whether the file is subsequently extended or truncated size, boolean `true` to request a shared lock, `false` to request an exclusive lock shared) Overrides org.h2.store.fs.FileBase.tryLock. Attempts to acquire a lock on the given region of this channel's file.
public int	write(ByteBuffer The buffer from which bytes are to be transferred src, long The file position at which the transfer is to begin; must be non-negative position) Overrides org.h2.store.fs.FileBase.write. Writes a sequence of bytes to this channel from the given buffer, starting at the given file position.
private static void	writeFully(FileChannel file, long pos, ByteBuffer src)
private void	writeInternal(ByteBuffer src, long position, int len, XTS xts)

Inherited from org.h2.store.fs.FileBaseDefault:: position position read truncate write

base	back to summary
private final FileChannel base

BLOCK_SIZE	back to summary
public static final int BLOCK_SIZE The block size.

BLOCK_SIZE_MASK	back to summary
pack-priv static final int BLOCK_SIZE_MASK The block size bit mask.

encryptionKey	back to summary
private byte[] encryptionKey

HASH_ITERATIONS	back to summary
private static final int HASH_ITERATIONS The number of iterations. It is relatively low; a higher value would slow down opening files on Android too much.

HEADER	back to summary
private static final byte[] HEADER

HEADER_LENGTH	back to summary
pack-priv static final int HEADER_LENGTH The length of the file header. Using a smaller header is possible, but would mean reads and writes are not aligned to the block size.

name	back to summary
private final String name

SALT_LENGTH	back to summary
private static final int SALT_LENGTH The length of the salt, in bytes.

SALT_POS	back to summary
private static final int SALT_POS

size	back to summary
private volatile long size The current file size, from a user perspective.

source	back to summary
private FileEncrypt source

xts	back to summary
private volatile XTS xts

FileEncrypt	back to summary
public FileEncrypt(String name, byte[] encryptionKey, FileChannel base)

FileEncrypt	back to summary
public FileEncrypt(String name, FileEncrypt source, FileChannel base)

Method Detail

createXTS	back to summary
private synchronized XTS createXTS() throws IOException

force back to summary

force	back to summary
public void force(boolean metaData) throws IOException Overrides org.h2.store.fs.FileBase.force. Doc from java.nio.channels.FileChannel.force. Forces any updates to this channel's file to be written to the storage device that contains it. If this channel's file resides on a local storage device then when this method returns it is guaranteed that all changes made to the file since this channel was created, or since this method was last invoked, will have been written to that device. This is useful for ensuring that critical information is not lost in the event of a system crash. If the file does not reside on a local device then no such guarantee is made. The `metaData` parameter can be used to limit the number of I/O operations that this method is required to perform. Passing `false` for this parameter indicates that only updates to the file's content need be written to storage; passing `true` indicates that updates to both the file's content and metadata must be written, which generally requires at least one more I/O operation. Whether this parameter actually has any effect is dependent upon the underlying operating system and is therefore unspecified. Invoking this method may cause an I/O operation to occur even if the channel was only opened for reading. Some operating systems, for example, maintain a last-access time as part of a file's metadata, and this time is updated whenever the file is read. Whether or not this is actually done is system-dependent and is therefore unspecified. This method is only guaranteed to force changes that were made to this channel's file via the methods defined in this class, or the methods defined by `java.io.FileOutputStream` or `java.io.RandomAccessFile` when the channel was obtained with the `getChannel` method. It may or may not force changes that were made by modifying the content of a `mapped byte buffer` obtained by invoking the `map` method. Invoking the `force` method of the mapped byte buffer will force changes made to the buffer's content to be written. Parameters metaData:boolean If `true` then this method is required to force changes to both the file's content and metadata to be written to storage; otherwise, it need only force content changes to be written Annotations @Override Exceptions IOException: If some other I/O error occurs

public void force(boolean metaData) throws IOException

Overrides org.h2.store.fs.FileBase.force.

Doc from java.nio.channels.FileChannel.force.

Forces any updates to this channel's file to be written to the storage device that contains it.

If this channel's file resides on a local storage device then when this method returns it is guaranteed that all changes made to the file since this channel was created, or since this method was last invoked, will have been written to that device. This is useful for ensuring that critical information is not lost in the event of a system crash.

If the file does not reside on a local device then no such guarantee is made.

The metaData parameter can be used to limit the number of I/O operations that this method is required to perform. Passing false for this parameter indicates that only updates to the file's content need be written to storage; passing true indicates that updates to both the file's content and metadata must be written, which generally requires at least one more I/O operation. Whether this parameter actually has any effect is dependent upon the underlying operating system and is therefore unspecified.

Invoking this method may cause an I/O operation to occur even if the channel was only opened for reading. Some operating systems, for example, maintain a last-access time as part of a file's metadata, and this time is updated whenever the file is read. Whether or not this is actually done is system-dependent and is therefore unspecified.

This method is only guaranteed to force changes that were made to this channel's file via the methods defined in this class, or the methods defined by java.io.FileOutputStream or java.io.RandomAccessFile when the channel was obtained with the getChannel method. It may or may not force changes that were made by modifying the content of a mapped byte buffer obtained by invoking the map method. Invoking the force method of the mapped byte buffer will force changes made to the buffer's content to be written.

Parameters

metaData:boolean: If true then this method is required to force changes to both the file's content and metadata to be written to storage; otherwise, it need only force content changes to be written

Annotations

@Override

Exceptions

IOException:: If some other I/O error occurs

implCloseChannel back to summary

implCloseChannel	back to summary
protected void implCloseChannel() throws IOException Overrides org.h2.store.fs.FileBase.implCloseChannel. Doc from java.nio.channels.spi.AbstractInterruptibleChannel.implCloseChannel. Closes this channel. This method is invoked by the `close` method in order to perform the actual work of closing the channel. This method is only invoked if the channel has not yet been closed, and it is never invoked more than once. An implementation of this method must arrange for any other thread that is blocked in an I/O operation upon this channel to return immediately, either by throwing an exception or by returning normally. Annotations @Override Exceptions IOException: If an I/O error occurs while closing the channel

protected void implCloseChannel() throws IOException

Overrides org.h2.store.fs.FileBase.implCloseChannel.

Doc from java.nio.channels.spi.AbstractInterruptibleChannel.implCloseChannel.

Closes this channel.

This method is invoked by the close method in order to perform the actual work of closing the channel. This method is only invoked if the channel has not yet been closed, and it is never invoked more than once.

An implementation of this method must arrange for any other thread that is blocked in an I/O operation upon this channel to return immediately, either by throwing an exception or by returning normally.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs while closing the channel

implTruncate	back to summary
protected void implTruncate(long newSize) throws IOException Implements abstract org.h2.store.fs.FileBaseDefault.implTruncate. Doc from org.h2.store.fs.FileBaseDefault.implTruncate. The truncate implementation. Parameters newSize:long the new size Annotations @Override Exceptions IOException: on failure

implTruncate

back to summary

protected void implTruncate(long newSize) throws IOException

Implements abstract org.h2.store.fs.FileBaseDefault.implTruncate.

Doc from org.h2.store.fs.FileBaseDefault.implTruncate.

The truncate implementation.

Parameters

newSize:long: the new size

Annotations

@Override

Exceptions

IOException:: on failure

init	back to summary
private XTS init() throws IOException

read back to summary

read	back to summary
public int read(ByteBuffer dst, long position) throws IOException Overrides org.h2.store.fs.FileBase.read. Doc from java.nio.channels.FileChannel.read. Reads a sequence of bytes from this channel into the given buffer, starting at the given file position. This method works in the same manner as the `read(ByteBuffer)` method, except that bytes are read starting at the given file position rather than at the channel's current position. This method does not modify this channel's position. If the given position is greater than or equal to the file's current size then no bytes are read. Parameters dst:ByteBuffer The buffer into which bytes are to be transferred position:long The file position at which the transfer is to begin; must be non-negative Returns:int The number of bytes read, possibly zero, or `-1` if the given position is greater than or equal to the file's current size Annotations @Override Exceptions IOException: If some other I/O error occurs

public int read(ByteBuffer dst, long position) throws IOException

Overrides org.h2.store.fs.FileBase.read.

Doc from java.nio.channels.FileChannel.read.

Reads a sequence of bytes from this channel into the given buffer, starting at the given file position.

This method works in the same manner as the read(ByteBuffer) method, except that bytes are read starting at the given file position rather than at the channel's current position. This method does not modify this channel's position. If the given position is greater than or equal to the file's current size then no bytes are read.

Parameters

dst:ByteBuffer: The buffer into which bytes are to be transferred
position:long: The file position at which the transfer is to begin; must be non-negative

Returns:int

The number of bytes read, possibly zero, or -1 if the given position is greater than or equal to the file's current size

Annotations

@Override

Exceptions

IOException:: If some other I/O error occurs

readFully	back to summary
private static void readFully(FileChannel file, long pos, ByteBuffer dst) throws IOException

readInternal	back to summary
private void readInternal(ByteBuffer dst, long position, int len, XTS xts) throws IOException

size	back to summary
public long size() throws IOException Implements abstract java.nio.channels.FileChannel.size. Implements java.nio.channels.SeekableByteChannel.size. Doc from java.nio.channels.FileChannel.size. Returns the current size of this channel's file. Returns:long The current size of this channel's file, measured in bytes Annotations @Override Exceptions IOException: If some other I/O error occurs

size

back to summary

public long size() throws IOException

Implements abstract java.nio.channels.FileChannel.size.

Implements java.nio.channels.SeekableByteChannel.size.

Doc from java.nio.channels.FileChannel.size.

Returns the current size of this channel's file.

Returns:long

The current size of this channel's file, measured in bytes

Annotations

@Override

Exceptions

IOException:: If some other I/O error occurs

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

tryLock back to summary

tryLock	back to summary
public FileLock tryLock(long position, long size, boolean shared) throws IOException Overrides org.h2.store.fs.FileBase.tryLock. Doc from java.nio.channels.FileChannel.tryLock. Attempts to acquire a lock on the given region of this channel's file. This method does not block. An invocation always returns immediately, either having acquired a lock on the requested region or having failed to do so. If it fails to acquire a lock because an overlapping lock is held by another program then it returns `null`. If it fails to acquire a lock for any other reason then an appropriate exception is thrown. The region specified by the `position` and `size` parameters need not be contained within, or even overlap, the actual underlying file. Lock regions are fixed in size; if a locked region initially contains the end of the file and the file grows beyond the region then the new portion of the file will not be covered by the lock. If a file is expected to grow in size and a lock on the entire file is required then a region starting at zero, and no smaller than the expected maximum size of the file, should be locked. The zero-argument `tryLock()` method simply locks a region of size `Long#MAX_VALUE`. If the `position` is non-negative and the `size` is zero, then a lock of size `Long.MAX_VALUE - position` is returned. Some operating systems do not support shared locks, in which case a request for a shared lock is automatically converted into a request for an exclusive lock. Whether the newly-acquired lock is shared or exclusive may be tested by invoking the resulting lock object's `isShared` method. File locks are held on behalf of the entire Java virtual machine. They are not suitable for controlling access to a file by multiple threads within the same virtual machine. Parameters position:long The position at which the locked region is to start; must be non-negative size:long The size of the locked region; must be non-negative, and the sum `position` + `size` must be non-negative. A value of zero means to lock all bytes from the specified starting position to the end of the file, regardless of whether the file is subsequently extended or truncated shared:boolean `true` to request a shared lock, `false` to request an exclusive lock Returns:FileLock A lock object representing the newly-acquired lock, or `null` if the lock could not be acquired because another program holds an overlapping lock Annotations @Override Exceptions IOException: If some other I/O error occurs

public FileLock tryLock(long position, long size, boolean shared) throws IOException

Overrides org.h2.store.fs.FileBase.tryLock.

Doc from java.nio.channels.FileChannel.tryLock.

Attempts to acquire a lock on the given region of this channel's file.

This method does not block. An invocation always returns immediately, either having acquired a lock on the requested region or having failed to do so. If it fails to acquire a lock because an overlapping lock is held by another program then it returns null. If it fails to acquire a lock for any other reason then an appropriate exception is thrown.

The region specified by the position and size parameters need not be contained within, or even overlap, the actual underlying file. Lock regions are fixed in size; if a locked region initially contains the end of the file and the file grows beyond the region then the new portion of the file will not be covered by the lock. If a file is expected to grow in size and a lock on the entire file is required then a region starting at zero, and no smaller than the expected maximum size of the file, should be locked. The zero-argument tryLock() method simply locks a region of size Long#MAX_VALUE. If the position is non-negative and the size is zero, then a lock of size Long.MAX_VALUE - position is returned.

Some operating systems do not support shared locks, in which case a request for a shared lock is automatically converted into a request for an exclusive lock. Whether the newly-acquired lock is shared or exclusive may be tested by invoking the resulting lock object's isShared method.

File locks are held on behalf of the entire Java virtual machine. They are not suitable for controlling access to a file by multiple threads within the same virtual machine.

Parameters

position:long: The position at which the locked region is to start; must be non-negative
size:long: The size of the locked region; must be non-negative, and the sum position + size must be non-negative. A value of zero means to lock all bytes from the specified starting position to the end of the file, regardless of whether the file is subsequently extended or truncated
shared:boolean: true to request a shared lock, false to request an exclusive lock

Returns:FileLock

A lock object representing the newly-acquired lock, or null if the lock could not be acquired because another program holds an overlapping lock

Annotations

@Override

Exceptions

IOException:: If some other I/O error occurs

write back to summary

write	back to summary
public int write(ByteBuffer src, long position) throws IOException Overrides org.h2.store.fs.FileBase.write. Doc from java.nio.channels.FileChannel.write. Writes a sequence of bytes to this channel from the given buffer, starting at the given file position. This method works in the same manner as the `write(ByteBuffer)` method, except that bytes are written starting at the given file position rather than at the channel's current position. This method does not modify this channel's position. If the given position is greater than or equal to the file's current size then the file will be grown to accommodate the new bytes; the values of any bytes between the previous end-of-file and the newly-written bytes are unspecified. If the file is open in append mode, then the effect of invoking this method is unspecified. Parameters src:ByteBuffer The buffer from which bytes are to be transferred position:long The file position at which the transfer is to begin; must be non-negative Returns:int The number of bytes written, possibly zero Annotations @Override Exceptions IOException: If some other I/O error occurs

public int write(ByteBuffer src, long position) throws IOException

Overrides org.h2.store.fs.FileBase.write.

Doc from java.nio.channels.FileChannel.write.

Writes a sequence of bytes to this channel from the given buffer, starting at the given file position.

This method works in the same manner as the write(ByteBuffer) method, except that bytes are written starting at the given file position rather than at the channel's current position. This method does not modify this channel's position. If the given position is greater than or equal to the file's current size then the file will be grown to accommodate the new bytes; the values of any bytes between the previous end-of-file and the newly-written bytes are unspecified.

If the file is open in append mode, then the effect of invoking this method is unspecified.

Parameters

src:ByteBuffer: The buffer from which bytes are to be transferred
position:long: The file position at which the transfer is to begin; must be non-negative

Returns:int

The number of bytes written, possibly zero

Annotations

@Override

Exceptions

IOException:: If some other I/O error occurs

writeFully	back to summary
private static void writeFully(FileChannel file, long pos, ByteBuffer src) throws IOException

writeInternal	back to summary
private void writeInternal(ByteBuffer src, long position, int len, XTS xts) throws IOException

public Class FileEncrypt

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail