eve.io.block

Class BlockOutputStream

java.lang.Object

eve.io.block.BlockOutputStream

All Implemented Interfaces:

IBlockOutput

Direct Known Subclasses:

SecureBlockOutputStream

public class BlockOutputStream
extends Object
implements IBlockOutput

A BlockOutputStream is used to write out a block of data that is received by a BlockInputStream as a single block.

You can also provide an Encryptor for the Stream in which case the receiving BlockInputStream must also have a matching Decryptor.

Field Summary

Fields

Modifier and Type	Field and Description
static int	maximumOutputBlockSize By default this is 5 MB.
protected OutputStream	out

Constructor Summary

Constructors

Constructor and Description
BlockOutputStream(OutputStream out) Create a BlockOutputStream using the provided OutputStream for writing out data.

Method Summary

Modifier and Type	Method and Description
void	blockWrite(byte[] src, int offset, int length) Set the Public/Private keys.
void	close() Close this BlockOutputStream and the underlying OutputStream.
protected boolean	encrypt(byte[] source, int offset, int length, ByteArray dest) This is called during the writeBlock() method.
void	writeBlock(byte[] source, int offset, int length) Write out a block of data, encrypting if necessary.
void	writeBlock(ByteArray data) Write out a block of data.
protected void	writeDirect(byte[] source, int offset, int length)

Methods inherited from class java.lang.Object

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

Field Detail

out

protected OutputStream out

maximumOutputBlockSize

public static int maximumOutputBlockSize

By default this is 5 MB. If any outgoing block is bigger than this an IOException is thrown.

Constructor Detail

BlockOutputStream

public BlockOutputStream(OutputStream out)

Create a BlockOutputStream using the provided OutputStream for writing out data.

Method Detail

writeBlock

public void writeBlock(ByteArray data)
                throws IOException

Write out a block of data.

Throws:

IOException

writeDirect

protected void writeDirect(byte[] source,
                           int offset,
                           int length)
                    throws IOException

Throws:

IOException

encrypt

protected boolean encrypt(byte[] source,
                          int offset,
                          int length,
                          ByteArray dest)
                   throws IOException

This is called during the writeBlock() method. If encryption of the data is to be done it should encrypt the data and place it into dest and then return true. If no encryption is to be done it should simply return false.

Parameters:

source - the source data.

offset - the offset of the source data bytes.

length - the number of bytes to be sent.

dest - a destination ByteArray that will not be null and will be cleared before being passed.

Returns:

true if encryption was done and the result is now in dest, false if no encryption was done.

Throws:

IOException - if there was an error encrypting the data.

writeBlock

public void writeBlock(byte[] source,
                       int offset,
                       int length)
                throws IOException

Write out a block of data, encrypting if necessary.

Throws:

IOException

close

public void close()
           throws IOException

Close this BlockOutputStream and the underlying OutputStream.

Specified by:

close in interface IBlockOutput

Throws:

IOException - if an error occurs closing the underlying OutputStream.

blockWrite

public void blockWrite(byte[] src,
                       int offset,
                       int length)
                throws IOException

Set the Public/Private keys.

Specified by:

blockWrite in interface IBlockOutput

Parameters:

remotePublicKey - This is the public key of the receiver and the symmetric key used to encrypt each block of data will be encrypted using this key.

myPrivateKey - if this is not null it will be used to sign data being transmitted. If you do not want to sign outgoing data, you can leave this null.

Throws:

IOException