Apache POI - Common 5.3.0 · org.apache.poi.poifs.crypt.ChunkedCipherOutputStream

Modifier and Type	Field and Description
private final byte[]	chunk
private final int	chunkBits
private final int	chunkSize
private Cipher	cipher
private final DirectoryNode	dir
private final File	fileOut
private boolean	isClosed
private static final Logger	LOG
private final SparseBitSet	plainByteFlags
private long	pos
private static final int	STREAMING
private long	totalPos
private long	written

Access	Constructor and Description
public	ChunkedCipherOutputStream(DirectoryNode dir, int chunkSize)
public	ChunkedCipherOutputStream(OutputStream stream, int chunkSize)

Method Summary

Modifier and Type	Method and Description
protected abstract void	calculateChecksum(File fileOut, int oleStreamSize)
public void	close() Overrides java.io.FilterOutputStream.close. Implements java.io.Closeable.close. Closes this output stream and releases any system resources associated with the stream.
protected abstract void	createEncryptionInfoEntry(DirectoryNode dir, File tmpFile)
protected byte[]	getChunk()
protected int	getChunkMask()
protected SparseBitSet	getPlainByteFlags()
protected long	getPos()
protected long	getTotalPos()
public final Cipher	initCipherForBlock(int block, boolean lastChunk)
protected abstract Cipher	initCipherForBlock(Cipher existing, int block, boolean lastChunk)
protected Cipher	initCipherForBlockNoFlush(Cipher existing, int block, boolean lastChunk)
protected int	invokeCipher(int posInChunk, boolean doFinal) Helper function for overriding the cipher invocation, i.e. XOR doesn't use a cipher and uses its own implementation
private void	processPOIFSWriterEvent(POIFSWriterEvent event)
public void	setNextRecordSize(int the size of the next record recordSize, boolean `true` if the record is unencrypted isPlain) Some ciphers (actually just XOR) are based on the record size, which needs to be set before encryption
public void	write(int the `byte`. b) Overrides java.io.FilterOutputStream.write. Writes the specified `byte` to this output stream.
public void	write(byte[] the data to be written. b) Overrides java.io.FilterOutputStream.write. Writes `b.length` bytes to this output stream.
public void	write(byte[] the data. b, int the start offset in the data. off, int the number of bytes to write. len) Overrides java.io.FilterOutputStream.write. Writes `len` bytes from the specified `byte` array starting at offset `off` to this output stream.
protected void	write(byte[] b, int off, int len, boolean writePlain)
protected void	writeChunk(boolean continued)
public void	writePlain(byte[] b, int off, int len)

Inherited from java.io.FilterOutputStream:: flush

chunk	back to summary
private final byte[] chunk

chunkBits	back to summary
private final int chunkBits

chunkSize	back to summary
private final int chunkSize

cipher	back to summary
private Cipher cipher

dir	back to summary
private final DirectoryNode dir

fileOut	back to summary
private final File fileOut

isClosed	back to summary
private boolean isClosed

LOG	back to summary
private static final Logger LOG

plainByteFlags	back to summary
private final SparseBitSet plainByteFlags

pos	back to summary
private long pos

STREAMING	back to summary
private static final int STREAMING

totalPos	back to summary
private long totalPos

written	back to summary
private long written

ChunkedCipherOutputStream	back to summary
public ChunkedCipherOutputStream(DirectoryNode dir, int chunkSize) throws IOException, GeneralSecurityException

ChunkedCipherOutputStream	back to summary
public ChunkedCipherOutputStream(OutputStream stream, int chunkSize) throws IOException, GeneralSecurityException

Method Detail

calculateChecksum	back to summary
protected abstract void calculateChecksum(File fileOut, int oleStreamSize) throws GeneralSecurityException, IOException

close	back to summary
public void close() throws IOException Overrides java.io.FilterOutputStream.close. Implements java.io.Closeable.close. Doc from java.io.FilterOutputStream.close. Closes this output stream and releases any system resources associated with the stream. Annotations @Override Exceptions IOException: if an I/O error occurs.

back to summary

public void close() throws IOException

Overrides java.io.FilterOutputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.FilterOutputStream.close.

Closes this output stream and releases any system resources associated with the stream.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

createEncryptionInfoEntry	back to summary
protected abstract void createEncryptionInfoEntry(DirectoryNode dir, File tmpFile) throws IOException, GeneralSecurityException

getChunk	back to summary
protected byte[] getChunk()

getChunkMask	back to summary
protected int getChunkMask()

getPlainByteFlags	back to summary
protected SparseBitSet getPlainByteFlags()

getPos	back to summary
protected long getPos()

getTotalPos	back to summary
protected long getTotalPos()

initCipherForBlock	back to summary
public final Cipher initCipherForBlock(int block, boolean lastChunk) throws IOException, GeneralSecurityException

initCipherForBlock	back to summary
protected abstract Cipher initCipherForBlock(Cipher existing, int block, boolean lastChunk) throws IOException, GeneralSecurityException

initCipherForBlockNoFlush	back to summary
protected Cipher initCipherForBlockNoFlush(Cipher existing, int block, boolean lastChunk) throws IOException, GeneralSecurityException Annotations @Internal

invokeCipher	back to summary
protected int invokeCipher(int posInChunk, boolean doFinal) throws GeneralSecurityException, IOException Helper function for overriding the cipher invocation, i.e. XOR doesn't use a cipher and uses its own implementation

processPOIFSWriterEvent	back to summary
private void processPOIFSWriterEvent(POIFSWriterEvent event)

setNextRecordSize back to summary

setNextRecordSize	back to summary
public void setNextRecordSize(int recordSize, boolean isPlain) Some ciphers (actually just XOR) are based on the record size, which needs to be set before encryption Parameters recordSize:int the size of the next record isPlain:boolean `true` if the record is unencrypted

public void setNextRecordSize(int recordSize, boolean isPlain)

Some ciphers (actually just XOR) are based on the record size, which needs to be set before encryption

Parameters

recordSize:int: the size of the next record
isPlain:boolean: true if the record is unencrypted

write back to summary

write	back to summary
public void write(int b) throws IOException Overrides java.io.FilterOutputStream.write. Doc from java.io.FilterOutputStream.write. Writes the specified `byte` to this output stream. The `write` method of `FilterOutputStream` calls the `write` method of its underlying output stream, that is, it performs `out.write(b)`. Implements the abstract `write` method of `OutputStream`. Parameters b:int the `byte`. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void write(int b) throws IOException

Overrides java.io.FilterOutputStream.write.

Doc from java.io.FilterOutputStream.write.

Writes the specified byte to this output stream.

The write method of FilterOutputStream calls the write method of its underlying output stream, that is, it performs out.write(b).

Implements the abstract write method of OutputStream.

Parameters

b:int: the byte.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

write back to summary

write	back to summary
public void write(byte[] b) throws IOException Overrides java.io.FilterOutputStream.write. Doc from java.io.FilterOutputStream.write. Writes `b.length` bytes to this output stream. Parameters b:byte[] the data to be written. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void write(byte[] b) throws IOException

Overrides java.io.FilterOutputStream.write.

Doc from java.io.FilterOutputStream.write.

Writes b.length bytes to this output stream.

Parameters

b:byte[]: the data to be written.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

write back to summary

write	back to summary
public void write(byte[] b, int off, int len) throws IOException Overrides java.io.FilterOutputStream.write. Doc from java.io.FilterOutputStream.write. Writes `len` bytes from the specified `byte` array starting at offset `off` to this output stream. Parameters b:byte[] the data. off:int the start offset in the data. len:int the number of bytes to write. Annotations @Override Exceptions IOException: if an I/O error occurs.

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

Overrides java.io.FilterOutputStream.write.

Doc from java.io.FilterOutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream.

Parameters

b:byte[]: the data.
off:int: the start offset in the data.
len:int: the number of bytes to write.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

write	back to summary
protected void write(byte[] b, int off, int len, boolean writePlain) throws IOException

writeChunk	back to summary
protected void writeChunk(boolean continued) throws IOException

writePlain	back to summary
public void writePlain(byte[] b, int off, int len) throws IOException

public abstract Class ChunkedCipherOutputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail