SecureByteArrayOutputStream ("Entrust Authority Security Toolkit for the Java Platform")

java.lang.Object
- java.io.OutputStream
- - com.entrust.toolkit.util.SecureByteArrayOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable
```
public class SecureByteArrayOutputStream
extends java.io.OutputStream
```
Used as the output stream for sensitive binary data in buffer-based decryption.
The buffer automatically grows as data is written to it, and any temporary data is wiped following use.

Field Summary

Fields
Modifier and Type Field and Description

protected byte[] buf
Buffer where data is stored.

protected int count
Number of valid bytes in the buffer.

Fields
Modifier and Type	Field and Description
`protected byte[]`	`buf` Buffer where data is stored.
`protected int`	`count` Number of valid bytes in the buffer.

Constructor Summary

Constructors
Constructor and Description
`SecureByteArrayOutputStream()` Creates a new `SecureByteArrayOutputStream`.
`SecureByteArrayOutputStream(int size)` Creates a new `SecureByteArrayOutputStream`, with a buffer capacity of `size` bytes.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closing a `SecureByteArrayOutputStream` has no effect.
`void`	`reset()` Wipes the contents of the buffer, so that all accumulated output is destroyed.
`int`	`size()` Returns the number of bytes held in the output stream.
`byte[]`	`toByteArray()` Returns a `byte[]` that holds the contents of this output stream.
`SecureByteArray`	`toSecureByteArray()` Returns a `SecureByteArray` that holds the contents of this output stream.
`SecureByteArray`	`toSecureByteArray(int sensitivity)` Returns a `SecureByteArray` that holds the contents of this output stream with the specified sensitivity.
`void`	`write(byte[] ba)` Writes `ba.length` bytes from the specified byte array to this `SecureByteArrayOutputStream`.
`void`	`write(byte[] ba, int off, int len)` Writes `len` bytes from the specified byte array starting at offset `off` to this `SecureByteArrayOutputStream`.
`void`	`write(int b)` Writes the specified byte to this `SecureByteArrayOutputStream`.

Methods inherited from class java.io.OutputStream
flush

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - buf
```
protected byte[] buf
```
    Buffer where data is stored.
  - count
```
protected int count
```
    Number of valid bytes in the buffer.
- Constructor Detail
  - SecureByteArrayOutputStream
```
public SecureByteArrayOutputStream()
```
    Creates a new SecureByteArrayOutputStream.
    The buffer capacity is initially 32 bytes, but its size increases if necessary.
  - SecureByteArrayOutputStream
```
public SecureByteArrayOutputStream(int size)
```
    Creates a new SecureByteArrayOutputStream, with a buffer capacity of size bytes.
    
    Parameters:
    
    size - initial buffer size
- Method Detail
  - close
```
public void close()
```
    Closing a SecureByteArrayOutputStream has no effect.
    The methods in this class can be called after the stream has been closed without generating an IOException.
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Overrides:
    
    close in class java.io.OutputStream
  - reset
```
public void reset()
```
    Wipes the contents of the buffer, so that all accumulated output is destroyed.
    The SecureByteArrayOutputStream can be used again, reusing the already allocated buffer space.
  - size
```
public int size()
```
    Returns the number of bytes held in the output stream.
    
    Returns:
    
    the number of bytes in the output stream
  - toByteArray
```
public byte[] toByteArray()
```
    Returns a byte[] that holds the contents of this output stream.
    Creates a newly allocated byte array. Its size is the current size of this output stream and the valid contents of the buffer have been copied into it.
    
    Note
    
    The contents of the SecureByteArrayOutputStream are not wiped following this call. If you want to destroy the contents, use the reset() method to wipe the contents of the SecureByteArrayOutputStream object.
    
    Ensure that the memory held by the byte[] is cleared after use.
    
    Returns:
    
    a byte[] that holds the contents of this output stream
  - toSecureByteArray
```
public SecureByteArray toSecureByteArray()
```
    Returns a SecureByteArray that holds the contents of this output stream.
    Creates a newly allocated SecureByteArray. Its size is the current size of this output stream and the valid contents of the buffer have been copied into it.
    
    The sensitivity is set to the default value — BASE.
    
    Note
    
    The contents of the SecureByteArrayOutputStream are not wiped following this call. If you want to destroy the contents, use the reset() method to wipe the contents of the SecureByteArrayOutputStream object.
    
    Returns:
    
    a SecureByteArray that holds the contents of this output stream
  - toSecureByteArray
```
public SecureByteArray toSecureByteArray(int sensitivity)
```
    Returns a SecureByteArray that holds the contents of this output stream with the specified sensitivity.
    Creates a newly allocated SecureByteArray. Its size is the current size of this output stream and the valid contents of the buffer have been copied into it.
    
    Note
    
    The contents of the SecureByteArrayOutputStream are not wiped following this call. If you want to destroy the contents, use the reset() method to wipe the contents of the SecureByteArrayOutputStream object.
    
    Parameters:
    
    sensitivity - sensitivity of the data
    
    Returns:
    
    a SecureByteArray that holds the contents of this output stream
  - write
```
public void write(byte[] ba)
```
    Writes ba.length bytes from the specified byte array to this SecureByteArrayOutputStream.
    If the internal buffer needs to be expanded, a new one is created and the old one is wiped to ensure that only one copy of the data exists in memory.
    
    Note
    
    The input byte array ba is not wiped by this method, but all internal temporary data is wiped prior to returning. If want to destroy the contents of ba, use the SecureUtils.wipe(byte []) method.
    
    Overrides:
    
    write in class java.io.OutputStream
    
    Parameters:
    
    ba - the byte array of data to be written
  - write
```
public void write(byte[] ba,
                  int off,
                  int len)
```
    Writes len bytes from the specified byte array starting at offset off to this SecureByteArrayOutputStream.
    If the buffer needs to be expanded, a new one is created and the old one is wiped to ensure that only one copy of the data exists in memory.
    
    Note
    
    The input byte array ba is not wiped by this method, but all internal temporary data is wiped prior to returning. If want to destroy the contents of ba, use the SecureUtils.wipe(byte []) method.
    
    Overrides:
    
    write in class java.io.OutputStream
    
    Parameters:
    
    ba - the byte array data to be written
    
    off - the start offset in the data
    
    len - the number of bytes to write
  - write
```
public void write(int b)
```
    Writes the specified byte to this SecureByteArrayOutputStream.
    If the buffer needs to be expanded, a new one is created and the old one is wiped to ensure that only one copy of the data exists in memory.
    
    Note
    
    All internal temporary data is wiped prior to returning.
    
    Specified by:
    
    write in class java.io.OutputStream
    
    Parameters:
    
    b - the byte to be written

Class SecureByteArrayOutputStream

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.io.OutputStream

Methods inherited from class java.lang.Object

Field Detail

buf

count

Constructor Detail

SecureByteArrayOutputStream

SecureByteArrayOutputStream

Method Detail

close

reset

size

toByteArray

toSecureByteArray

toSecureByteArray

write

write

write