com.entrust.toolkit

Class PKCS7EncodeStream.ConsumerInputStream

java.lang.Object

java.io.InputStream

com.entrust.toolkit.PKCS7EncodeStream.ConsumerInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Enclosing class:

PKCS7EncodeStream

public class PKCS7EncodeStream.ConsumerInputStream
extends java.io.InputStream

Represents the buffer of a producer/consumer scheme as an input stream from which the consumer reads.

The buffer is a circular buffer. The first data byte is at m_readIndex, the last data byte is at m_writeIndex - 1.

m_writeIndex == m_readIndex indicates an empty buffer. m_writeIndex == m_readIndex - 1 indicates a full buffer. The buffer can hold only buffer.size-1 bytes.

Constructor Summary

Constructors

Constructor and Description
ConsumerInputStream(int bufferSize) Creates a ConsumerInputStream object with the specified buffer size.

Method Summary

Modifier and Type	Method and Description
int	available() Returns the number of bytes that can be read from this input stream without blocking.
void	close() Closes this input stream.
java.io.IOException	getException() Returns the exception to the producer.
void	mark(int readlimit)
boolean	markSupported()
int	read() Reads the next byte of data from this input stream.
int	read(byte[] b) Reads up to b.length bytes of data from this input stream into an array of bytes.
int	read(byte[] b, int off, int len) Reads up to len bytes of data from this input stream into an array of bytes.
void	reset()
void	setException(java.io.IOException e) Allows the consumer to pass an exception to the producer.
long	skip(long n) Skips over and discards n bytes of data from the buffer.
void	write(byte[] b, int off, int len) Writes len bytes from the specified byte array.
void	write(int b) Writes one byte to the buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsumerInputStream

public ConsumerInputStream(int bufferSize)
                    throws java.lang.IllegalArgumentException

Creates a ConsumerInputStream object with the specified buffer size.

Parameters:

bufferSize - the size of the internal buffer

Throws:

java.lang.IllegalArgumentException - thrown if bufferSize is below 2

Method Detail

write

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

Writes one byte to the buffer.

If the buffer is full, this method blocks until there is space left in the buffer.

Parameters:

b - the byte to write to the buffer

Throws:

java.io.IOException - thrown if the input stream is closed

write

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

Writes len bytes from the specified byte array.

The method starts with offset off of the buffer. If the buffer is full, the method blocks until there is enough space to write the data to the buffer.

Parameters:

b - the data

off - the start offset in the data

len - the number of bytes to write

Throws:

java.io.IOException - thrown if the input stream is closed

java.lang.ArrayIndexOutOfBoundsException - thrown if off or off+len-1 are not within the bounds of b

available

public int available()

Returns the number of bytes that can be read from this input stream without blocking.

Overrides:

available in class java.io.InputStream

Returns:

the number of bytes that can be read from this input stream without blocking

read

public int read()

Reads the next byte of data from this input stream.

The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Specified by:

read in class java.io.InputStream

Returns:

the next byte of data, or -1 if the end of the stream is reached

read

public int read(byte[] b)

Reads up to b.length bytes of data from this input stream into an array of bytes.

This method calls read(b, 0, b.length)

Overrides:

read in class java.io.InputStream

Parameters:

b - the buffer into which the data is read

Returns:

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

read

public int read(byte[] b,
                int off,
                int len)

Reads up to len bytes of data from this input stream into an array of bytes.

This method blocks until some input is available. If the argument b is null, a NullPointerException is thrown.

Overrides:

read in class java.io.InputStream

Parameters:

b - the buffer into which the data is read

off - the start offset of the data

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 stream has been reached

skip

public long skip(long n)

Skips over and discards n bytes of data from the buffer.

There are a number of reasons why the skip method might skip over a number of bytes smaller than n, possibly 0. The actual number of bytes skipped is always returned.

Overrides:

skip in class java.io.InputStream

Parameters:

n - the number of bytes to be skipped

Returns:

the actual number of bytes skipped

close

public void close()

Closes this input stream.

After reading all remaining data from the buffer, the reader will not block, but receives an end of stream message.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.InputStream

markSupported

public boolean markSupported()

Overrides:

markSupported in class java.io.InputStream

mark

public void mark(int readlimit)

Overrides:

mark in class java.io.InputStream

reset

public void reset()
           throws java.io.IOException

Overrides:

reset in class java.io.InputStream

Throws:

java.io.IOException

setException

public void setException(java.io.IOException e)

Allows the consumer to pass an exception to the producer.

Parameters:

e - the exception that the consumer wants to pass to the producer

getException

public java.io.IOException getException()

Returns the exception to the producer.

Returns:

the exception thrown inside the consumer, or null if the consumer has run without errors