org.apache.derbyTesting.functionTests.util.corruptio

Class CorruptRandomAccessFile

java.lang.Object

org.apache.derbyTesting.functionTests.util.corruptio.CorruptRandomAccessFile

All Implemented Interfaces:

java.io.DataInput, java.io.DataOutput, org.apache.derby.io.StorageRandomAccessFile

public class CorruptRandomAccessFile
extends java.lang.Object
implements org.apache.derby.io.StorageRandomAccessFile

This class provides a proxy implementation of the StorageRandomAccess File interface. It is used by CorruptDiskStorageFactory to instrument the database engine i/o for testing puproses. How the i/o operation are corrupted is based on the values set in the instance of the Singleton CorruptibleIo class by the tests. Methods in this class functon similar to java.io.RandomAccessFile except when modified to perform the corruptios.

Version:

1.0

See Also:

RandomAccessFile, StorageRandomAccessFile

Field Summary

Fields

Modifier and Type	Field and Description
private CorruptibleIo	cbio
private java.io.File	realFile
private org.apache.derby.io.StorageRandomAccessFile	realRaf

Constructor Summary

Constructors

Constructor and Description
CorruptRandomAccessFile(org.apache.derby.io.StorageRandomAccessFile raf, java.io.File realFile) Construct a CorruptRandomAccessFile

Method Summary

Modifier and Type	Method and Description
void	close() Closes this file.
long	getFilePointer() Get the current offset in this file.
long	length() Gets the length of this file.
int	read(byte[] b, int off, int len) Reads up to len bytes of data from this file into an array of bytes.
boolean	readBoolean() Reads a byte and returns true if the byte is not zero otherwise false.
byte	readByte() returns one input byte from the stream.
char	readChar() returns a char value from the stream.
double	readDouble() returns a double from the stream.
float	readFloat() returns a float from the stream.
void	readFully(byte[] b) Reads some bytes from an input stream into the byte array.
void	readFully(byte[] b, int off, int len) Reads the specified number of bytes from an input stream.
int	readInt() returns an Int from the stream.
java.lang.String	readLine() returns the next line of text from the input stream.
long	readLong() returns a long from the stream.
short	readShort() returns a short value from the stream.
int	readUnsignedByte() Reads one input byte in the unsigned form.
int	readUnsignedShort() returns unsigned short.
java.lang.String	readUTF() returns a string that has been encoded using in the UTF-8 format.
void	seek(long newFilePointer) Set the file pointer.
void	setLength(long newLength) Sets the length of this file, either extending or truncating it.
int	skipBytes(int nBytes) skip over nBytes bytes of data
void	sync() Force any changes out to the persistent store.
void	write(byte[] b) Writes all the bytes in array to the stream.
void	write(byte[] b, int off, int len) Writes specified number bytes from array to the stream.
void	write(int b) Writes an int to the output stream .
void	writeBoolean(boolean value) Writes a boolean value to this output stream.
void	writeByte(int value) Writes to the eight low-order bits of ant int.
void	writeBytes(java.lang.String str) Writes a string as bytes to the stream.
void	writeChar(int value) Writes a char value to the output stream.
void	writeChars(java.lang.String str) Writes the string to the stream.
void	writeDouble(double value) Writes a a double value to the stream.
void	writeFloat(float value) Writes a float value to the output stream.
void	writeInt(int value) Writes an int value to the output stream.
void	writeLong(long value) Writes a long value to the output stream.
void	writeShort(int value) Writes a short value to the output stream
void	writeUTF(java.lang.String str) Writes the string in the utf format.

Methods inherited from class java.lang.Object

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

Field Detail

realRaf

private org.apache.derby.io.StorageRandomAccessFile realRaf

cbio

private CorruptibleIo cbio

realFile

private java.io.File realFile

Constructor Detail

CorruptRandomAccessFile

CorruptRandomAccessFile(org.apache.derby.io.StorageRandomAccessFile raf,
                        java.io.File realFile)

Construct a CorruptRandomAccessFile

Parameters:

raf - The real random access file to which calls are delegated fro this proxy class.

Method Detail

close

public void close()
           throws java.io.IOException

Closes this file.

Specified by:

close in interface org.apache.derby.io.StorageRandomAccessFile

Throws:

java.io.IOException

getFilePointer

public long getFilePointer()
                    throws java.io.IOException

Get the current offset in this file.

Specified by:

getFilePointer in interface org.apache.derby.io.StorageRandomAccessFile

Throws:

java.io.IOException

length

public long length()
            throws java.io.IOException

Gets the length of this file.

Specified by:

length in interface org.apache.derby.io.StorageRandomAccessFile

Throws:

java.io.IOException

seek

public void seek(long newFilePointer)
          throws java.io.IOException

Set the file pointer.

Specified by:

seek in interface org.apache.derby.io.StorageRandomAccessFile

Throws:

java.io.IOException

setLength

public void setLength(long newLength)
               throws java.io.IOException

Sets the length of this file, either extending or truncating it.

Specified by:

setLength in interface org.apache.derby.io.StorageRandomAccessFile

Throws:

java.io.IOException

sync

public void sync()
          throws java.io.IOException

Force any changes out to the persistent store.

Specified by:

sync in interface org.apache.derby.io.StorageRandomAccessFile

Throws:

java.io.IOException

readFully

public void readFully(byte[] b)
               throws java.io.IOException

Reads some bytes from an input stream into the byte array.

Specified by:

readFully in interface java.io.DataInput

Throws:

java.io.IOException

readFully

public void readFully(byte[] b,
                      int off,
                      int len)
               throws java.io.IOException

Reads the specified number of bytes from an input stream.

Specified by:

readFully in interface java.io.DataInput

Throws:

java.io.IOException

skipBytes

public int skipBytes(int nBytes)
              throws java.io.IOException

skip over nBytes bytes of data

Specified by:

skipBytes in interface java.io.DataInput

Throws:

java.io.IOException

readBoolean

public boolean readBoolean()
                    throws java.io.IOException

Reads a byte and returns true if the byte is not zero otherwise false.

Specified by:

readBoolean in interface java.io.DataInput

Throws:

java.io.IOException

readByte

public byte readByte()
              throws java.io.IOException

returns one input byte from the stream.

Specified by:

readByte in interface java.io.DataInput

Throws:

java.io.IOException

readUnsignedByte

public int readUnsignedByte()
                     throws java.io.IOException

Reads one input byte in the unsigned form.

Specified by:

readUnsignedByte in interface java.io.DataInput

Throws:

java.io.IOException

readShort

public short readShort()
                throws java.io.IOException

returns a short value from the stream.

Specified by:

readShort in interface java.io.DataInput

Throws:

java.io.IOException

readUnsignedShort

public int readUnsignedShort()
                      throws java.io.IOException

returns unsigned short.

Specified by:

readUnsignedShort in interface java.io.DataInput

Throws:

java.io.IOException

readChar

public char readChar()
              throws java.io.IOException

returns a char value from the stream.

Specified by:

readChar in interface java.io.DataInput

Throws:

java.io.IOException

readInt

public int readInt()
            throws java.io.IOException

returns an Int from the stream.

Specified by:

readInt in interface java.io.DataInput

Throws:

java.io.IOException

readLong

public long readLong()
              throws java.io.IOException

returns a long from the stream.

Specified by:

readLong in interface java.io.DataInput

Throws:

java.io.IOException

readFloat

public float readFloat()
                throws java.io.IOException

returns a float from the stream.

Specified by:

readFloat in interface java.io.DataInput

Throws:

java.io.IOException

readDouble

public double readDouble()
                  throws java.io.IOException

returns a double from the stream.

Specified by:

readDouble in interface java.io.DataInput

Throws:

java.io.IOException

readLine

public java.lang.String readLine()
                          throws java.io.IOException

returns the next line of text from the input stream.

Specified by:

readLine in interface java.io.DataInput

Throws:

java.io.IOException

readUTF

public java.lang.String readUTF()
                         throws java.io.IOException

returns a string that has been encoded using in the UTF-8 format.

Specified by:

readUTF in interface java.io.DataInput

Throws:

java.io.IOException

write

public void write(int b)
           throws java.io.IOException

Writes an int to the output stream .

Specified by:

write in interface java.io.DataOutput

Throws:

java.io.IOException

write

public void write(byte[] b)
           throws java.io.IOException

Writes all the bytes in array to the stream.

Specified by:

write in interface java.io.DataOutput

Throws:

java.io.IOException

write

public void write(byte[] b,
                  int off,
                  int len)
           throws java.io.IOException

Writes specified number bytes from array to the stream. If the corruption flags are enabled, byte array is corrupted before doing the real write.

Specified by:

write in interface java.io.DataOutput

Throws:

java.io.IOException

writeBoolean

public void writeBoolean(boolean value)
                  throws java.io.IOException

Writes a boolean value to this output stream.

Specified by:

writeBoolean in interface java.io.DataOutput

Throws:

java.io.IOException

writeByte

public void writeByte(int value)
               throws java.io.IOException

Writes to the eight low-order bits of ant int.

Specified by:

writeByte in interface java.io.DataOutput

Throws:

java.io.IOException

writeShort

public void writeShort(int value)
                throws java.io.IOException

Writes a short value to the output stream

Specified by:

writeShort in interface java.io.DataOutput

Throws:

java.io.IOException

writeChar

public void writeChar(int value)
               throws java.io.IOException

Writes a char value to the output stream.

Specified by:

writeChar in interface java.io.DataOutput

Parameters:

value - the char value to be written.

Throws:

java.io.IOException - if an I/O error occurs.

writeInt

public void writeInt(int value)
              throws java.io.IOException

Writes an int value to the output stream.

Specified by:

writeInt in interface java.io.DataOutput

Throws:

java.io.IOException

writeLong

public void writeLong(long value)
               throws java.io.IOException

Writes a long value to the output stream.

Specified by:

writeLong in interface java.io.DataOutput

Throws:

java.io.IOException

writeFloat

public void writeFloat(float value)
                throws java.io.IOException

Writes a float value to the output stream.

Specified by:

writeFloat in interface java.io.DataOutput

Throws:

java.io.IOException

writeDouble

public void writeDouble(double value)
                 throws java.io.IOException

Writes a a double value to the stream.

Specified by:

writeDouble in interface java.io.DataOutput

Throws:

java.io.IOException

writeBytes

public void writeBytes(java.lang.String str)
                throws java.io.IOException

Writes a string as bytes to the stream.

Specified by:

writeBytes in interface java.io.DataOutput

Throws:

java.io.IOException

writeChars

public void writeChars(java.lang.String str)
                throws java.io.IOException

Writes the string to the stream.

Specified by:

writeChars in interface java.io.DataOutput

Throws:

java.io.IOException

writeUTF

public void writeUTF(java.lang.String str)
              throws java.io.IOException

Writes the string in the utf format.

Specified by:

writeUTF in interface java.io.DataOutput

Throws:

java.io.IOException

read

public int read(byte[] b,
                int off,
                int len)
         throws java.io.IOException

Reads up to len bytes of data from this file into an array of bytes. This method blocks until at least one byte of input is available.

Specified by:

read in interface org.apache.derby.io.StorageRandomAccessFile

Parameters:

b - the buffer into which the data is read.

off - the start offset in array b at which the data is written.

len - the maximum number of bytes read.

Returns:

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the file has been reached.

Throws:

java.io.IOException - If the first byte cannot be read for any reason other than end of file, or if the random access file has been closed, or if some other I/O error occurs.

java.lang.NullPointerException - If b is null.

java.lang.IndexOutOfBoundsException - If off is negative, len is negative, or len is greater than b.length - off