Package org.apache.activemq.artemis.jdbc.store.file

Class JDBCSequentialFile

java.lang.Object

org.apache.activemq.artemis.jdbc.store.file.JDBCSequentialFile

All Implemented Interfaces:

SequentialFile

public class JDBCSequentialFile
extends Object
implements SequentialFile

Method Summary

Modifier and Type	Method	Description
void	addMetaData(Object key, Object value)
void	blockingWriteDirect(ByteBuffer bytes, boolean sync, boolean releaseBuffer)	Write directly to the file without using any intermediate buffer and wait completion. If releaseBuffer is true the provided bytes should be released through SequentialFileFactory.releaseBuffer(ByteBuffer), if supported.
int	calculateBlockStart(int position)
SequentialFile	cloneFile()
void	close()
void	close(boolean waitOnSync, boolean block)	When closing a file from a finalize block, you cant wait on syncs or anything like that.
void	copyTo(SequentialFile cloneFile)
void	delete()
boolean	exists()
void	fill(int size)
boolean	fits(int size)
String	getExtension()
String	getFilename()
String	getFileName()
long	getId()
File	getJavaFile()	Returns a native File of the file underlying this sequential file.
Object	getMetaData(Object key)
int	internalWrite(ActiveMQBuffer buffer, IOCallback callback)
int	internalWrite(ActiveMQBuffer buffer, IOCallback callback, boolean append)
boolean	isOpen()
ByteBuffer	map(int position, long size)
void	open()
void	open(int maxIO, boolean useExecutor)	The maximum number of simultaneous writes accepted
long	position()
void	position(long pos)
int	read(ByteBuffer bytes)
int	read(ByteBuffer bytes, IOCallback callback)
void	renameTo(String newFileName)
void	setId(long id)
void	setTimedBuffer(TimedBuffer buffer)
long	size()
void	sync()
void	write(ActiveMQBuffer bytes, boolean sync)
void	write(ActiveMQBuffer bytes, boolean sync, IOCallback callback)
void	write(ActiveMQBuffer bytes, boolean sync, IOCallback callback, boolean append)
void	write(EncodingSupport bytes, boolean sync)
void	write(EncodingSupport bytes, boolean sync, IOCallback callback)
void	writeDirect(ByteBuffer bytes, boolean sync)	Write directly to the file without using intermediate any buffer
void	writeDirect(ByteBuffer bytes, boolean sync, IOCallback callback)	Write directly to the file without using any buffer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.activemq.artemis.core.io.SequentialFile

afterComplete

Method Detail

isOpen

public boolean isOpen()

Specified by:

isOpen in interface SequentialFile

exists

public boolean exists()

Specified by:

exists in interface SequentialFile

open

public void open()
          throws Exception

Specified by:

open in interface SequentialFile

Throws:

Exception

open

public void open(int maxIO,
                 boolean useExecutor)
          throws Exception

Description copied from interface: SequentialFile

The maximum number of simultaneous writes accepted

Specified by:

open in interface SequentialFile

Throws:

Exception

fits

public boolean fits(int size)

Specified by:

fits in interface SequentialFile

calculateBlockStart

public int calculateBlockStart(int position)
                        throws Exception

Specified by:

calculateBlockStart in interface SequentialFile

Throws:

Exception

getFileName

public String getFileName()

Specified by:

getFileName in interface SequentialFile

fill

public void fill(int size)
          throws Exception

Specified by:

fill in interface SequentialFile

Throws:

Exception

map

public ByteBuffer map(int position,
                      long size)
               throws IOException

Specified by:

map in interface SequentialFile

Throws:

IOException

delete

public void delete()
            throws IOException,
                   InterruptedException,
                   ActiveMQException

Specified by:

delete in interface SequentialFile

Throws:

IOException

InterruptedException

ActiveMQException

internalWrite

public int internalWrite(ActiveMQBuffer buffer,
                         IOCallback callback)

internalWrite

public int internalWrite(ActiveMQBuffer buffer,
                         IOCallback callback,
                         boolean append)

write

public void write(ActiveMQBuffer bytes,
                  boolean sync,
                  IOCallback callback,
                  boolean append)
           throws Exception

Throws:

Exception

write

public void write(ActiveMQBuffer bytes,
                  boolean sync,
                  IOCallback callback)
           throws Exception

Specified by:

write in interface SequentialFile

Throws:

Exception

write

public void write(ActiveMQBuffer bytes,
                  boolean sync)
           throws Exception

Specified by:

write in interface SequentialFile

Throws:

Exception

write

public void write(EncodingSupport bytes,
                  boolean sync,
                  IOCallback callback)
           throws Exception

Specified by:

write in interface SequentialFile

Throws:

Exception

write

public void write(EncodingSupport bytes,
                  boolean sync)
           throws Exception

Specified by:

write in interface SequentialFile

Throws:

Exception

writeDirect

public void writeDirect(ByteBuffer bytes,
                        boolean sync,
                        IOCallback callback)

Description copied from interface: SequentialFile

Write directly to the file without using any buffer

Specified by:

writeDirect in interface SequentialFile

Parameters:

bytes - the ByteBuffer must be compatible with the SequentialFile implementation (AIO or NIO). To be safe, use a buffer from the corresponding SequentialFileFactory.newBuffer(int).

blockingWriteDirect

public void blockingWriteDirect(ByteBuffer bytes,
                                boolean sync,
                                boolean releaseBuffer)

Description copied from interface: SequentialFile

Write directly to the file without using any intermediate buffer and wait completion.
If releaseBuffer is true the provided bytes should be released through SequentialFileFactory.releaseBuffer(ByteBuffer), if supported.

Specified by:

blockingWriteDirect in interface SequentialFile

Parameters:

bytes - the ByteBuffer must be compatible with the SequentialFile implementation (AIO or NIO). If releaseBuffer is true use a buffer from SequentialFileFactory.newBuffer(int), SequentialFileFactory.allocateDirectBuffer(int) otherwise.

sync - if true will durable flush the written data on the file, false otherwise

releaseBuffer - if true will release the buffer, false otherwise

writeDirect

public void writeDirect(ByteBuffer bytes,
                        boolean sync)
                 throws Exception

Description copied from interface: SequentialFile

Write directly to the file without using intermediate any buffer

Specified by:

writeDirect in interface SequentialFile

Parameters:

bytes - the ByteBuffer must be compatible with the SequentialFile implementation (AIO or NIO). To be safe, use a buffer from the corresponding SequentialFileFactory.newBuffer(int).

Throws:

Exception

read

public int read(ByteBuffer bytes,
                IOCallback callback)
         throws SQLException

Specified by:

read in interface SequentialFile

Parameters:

bytes - the ByteBuffer must be compatible with the SequentialFile implementation (AIO or NIO). To be safe, use a buffer from the corresponding SequentialFileFactory.newBuffer(int).

Throws:

SQLException

read

public int read(ByteBuffer bytes)
         throws Exception

Specified by:

read in interface SequentialFile

Parameters:

bytes - the ByteBuffer must be compatible with the SequentialFile implementation (AIO or NIO). To be safe, use a buffer from the corresponding SequentialFileFactory.newBuffer(int).

Throws:

Exception

position

public void position(long pos)
              throws IOException

Specified by:

position in interface SequentialFile

Throws:

IOException

position

public long position()

Specified by:

position in interface SequentialFile

close

public void close()
           throws Exception

Specified by:

close in interface SequentialFile

Throws:

Exception

close

public void close(boolean waitOnSync,
                  boolean block)
           throws Exception

Description copied from interface: SequentialFile

When closing a file from a finalize block, you cant wait on syncs or anything like that. otherwise the VM may hung. Especially on the testsuite.

Specified by:

close in interface SequentialFile

Throws:

Exception

sync

public void sync()
          throws IOException

Specified by:

sync in interface SequentialFile

Throws:

IOException

size

public long size()
          throws Exception

Specified by:

size in interface SequentialFile

Throws:

Exception

renameTo

public void renameTo(String newFileName)
              throws Exception

Specified by:

renameTo in interface SequentialFile

Throws:

Exception

cloneFile

public SequentialFile cloneFile()

Specified by:

cloneFile in interface SequentialFile

copyTo

public void copyTo(SequentialFile cloneFile)
            throws Exception

Specified by:

copyTo in interface SequentialFile

Throws:

Exception

getId

public long getId()

setId

public void setId(long id)

getFilename

public String getFilename()

getExtension

public String getExtension()

setTimedBuffer

public void setTimedBuffer(TimedBuffer buffer)

Specified by:

setTimedBuffer in interface SequentialFile

getJavaFile

public File getJavaFile()

Description copied from interface: SequentialFile

Returns a native File of the file underlying this sequential file.

Specified by:

getJavaFile in interface SequentialFile

addMetaData

public void addMetaData(Object key,
                        Object value)

getMetaData

public Object getMetaData(Object key)