Modifier and Type	Class and Description
public static class	SMIMESignedWriter.Builder
private class	SMIMESignedWriter.ContentOutputStream

Modifier and Type	Field and Description
private final String	boundary
private final String	contentTransferEncoding
private final OutputStream	mimeOut
public static final Map<K, V>	RFC3851_MICALGS
public static final Map<K, V>	RFC5751_MICALGS
private final CMSSignedDataStreamGenerator	sigGen
public static final Map<K, V>	STANDARD_MICALGS

Access	Constructor and Description
private	SMIMESignedWriter(SMIMESignedWriter.Builder builder, Map<String, String> headers, String boundary, OutputStream mimeOut)

Modifier and Type	Method and Description
public OutputStream	Returns: an output stream for data to be signed to be written to. getContentStream() Implements abstract org.bouncycastle.mime.MimeWriter.getContentStream. Return a content stream for the signer - note data written to this stream needs to properly canonicalised if necessary.

boundary	back to summary
private final String boundary

contentTransferEncoding	back to summary
private final String contentTransferEncoding

mimeOut	back to summary
private final OutputStream mimeOut

RFC3851_MICALGS	back to summary
public static final Map<K, V> RFC3851_MICALGS

RFC5751_MICALGS	back to summary
public static final Map<K, V> RFC5751_MICALGS

sigGen	back to summary
private final CMSSignedDataStreamGenerator sigGen

STANDARD_MICALGS	back to summary
public static final Map<K, V> STANDARD_MICALGS

SMIMESignedWriter	back to summary
private SMIMESignedWriter(SMIMESignedWriter.Builder builder, Map<String, String> headers, String boundary, OutputStream mimeOut)

getContentStream	back to summary
public OutputStream getContentStream() throws IOException Implements abstract org.bouncycastle.mime.MimeWriter.getContentStream. Return a content stream for the signer - note data written to this stream needs to properly canonicalised if necessary. Returns:OutputStream an output stream for data to be signed to be written to. Exceptions IOException: on a stream error.

org.bouncycastle.mime.smime back to summary

public Class SMIMESignedWriter.Builder

Class Inheritance

extends Object

java.lang.Object
org.bouncycastle.mime.smime.SMIMESignedWriter.Builder

Field Summary

Modifier and Type	Field and Description
pack-priv String	contentTransferEncoding
private static final String[]	detHeaders
private static final String[]	detValues
private final boolean	encapsulated
private static final String[]	encHeaders
private static final String[]	encValues
private final Map<String, String>	extraHeaders
private final Map<K, V>	micAlgs
private final CMSSignedDataStreamGenerator	sigGen

Constructor Summary

Access	Constructor and Description
public	Builder()
public	Builder(boolean encapsulated)

Method Summary

Modifier and Type	Method and Description
private void	addBoundary(StringBuffer header, String boundary)
public SMIMESignedWriter.Builder	addCertificate(X509CertificateHolder certificate)
public SMIMESignedWriter.Builder	addCertificates(Store<T> certificates)
private void	addHashHeader(StringBuffer header, List<E> signers)
public SMIMESignedWriter.Builder	Returns: the current Builder instance. addSignerInfoGenerator(SignerInfoGenerator a generator for a signer info object. signerGenerator) Add a generator to produce the signer info required.
public SMIMESignedWriter	build(OutputStream mimeOut)
private String	generateBoundary()
public SMIMESignedWriter.Builder	Returns: the current Builder instance. withHeader(String name of the MIME header. headerName, String value of the MIME header. headerValue) Specify a MIME header (name, value) pair for this builder.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

contentTransferEncoding	back to summary
pack-priv String contentTransferEncoding

detHeaders	back to summary
private static final String[] detHeaders

detValues	back to summary
private static final String[] detValues

encapsulated	back to summary
private final boolean encapsulated

encHeaders	back to summary
private static final String[] encHeaders

encValues	back to summary
private static final String[] encValues

extraHeaders	back to summary
private final Map<String, String> extraHeaders

micAlgs	back to summary
private final Map<K, V> micAlgs

sigGen	back to summary
private final CMSSignedDataStreamGenerator sigGen

Constructor Detail

Builder	back to summary
public Builder()

Builder	back to summary
public Builder(boolean encapsulated)

Method Detail

addBoundary	back to summary
private void addBoundary(StringBuffer header, String boundary)

addCertificate	back to summary
public SMIMESignedWriter.Builder addCertificate(X509CertificateHolder certificate) throws CMSException

addCertificates	back to summary
public SMIMESignedWriter.Builder addCertificates(Store<T> certificates) throws CMSException

addHashHeader	back to summary
private void addHashHeader(StringBuffer header, List<E> signers)

addSignerInfoGenerator	back to summary
public SMIMESignedWriter.Builder addSignerInfoGenerator(SignerInfoGenerator signerGenerator) Add a generator to produce the signer info required. Parameters signerGenerator:SignerInfoGenerator a generator for a signer info object. Returns:SMIMESignedWriter.Builder the current Builder instance.

addSignerInfoGenerator

back to summary

public SMIMESignedWriter.Builder addSignerInfoGenerator(SignerInfoGenerator signerGenerator)

Add a generator to produce the signer info required.

Parameters

signerGenerator:SignerInfoGenerator: a generator for a signer info object.

Returns:SMIMESignedWriter.Builder

the current Builder instance.

build	back to summary
public SMIMESignedWriter build(OutputStream mimeOut)

generateBoundary	back to summary
private String generateBoundary()

withHeader	back to summary
public SMIMESignedWriter.Builder withHeader(String headerName, String headerValue) Specify a MIME header (name, value) pair for this builder. If the headerName already exists it will be overridden. Parameters headerName:String name of the MIME header. headerValue:String value of the MIME header. Returns:SMIMESignedWriter.Builder the current Builder instance.

withHeader

back to summary

public SMIMESignedWriter.Builder withHeader(String headerName, String headerValue)

Specify a MIME header (name, value) pair for this builder. If the headerName already exists it will be overridden.

Parameters

headerName:String: name of the MIME header.
headerValue:String: value of the MIME header.

Returns:SMIMESignedWriter.Builder

the current Builder instance.

org.bouncycastle.mime.smime back to summary

private Class SMIMESignedWriter.ContentOutputStream

Class Inheritance

extends OutputStream

java.lang.Object
java.io.OutputStream
org.bouncycastle.mime.smime.SMIMESignedWriter.ContentOutputStream

Field Summary

Modifier and Type	Field and Description
private final OutputStream	backing
private final OutputStream	main
private final OutputStream	sigBase
private final ByteArrayOutputStream	sigStream

Constructor Summary

Access	Constructor and Description
pack-priv	ContentOutputStream(OutputStream main, OutputStream backing, ByteArrayOutputStream sigStream, OutputStream sigBase)

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides java.io.OutputStream.close. Implements java.io.Closeable.close. Closes this output stream and releases any system resources associated with this stream.
public void	write(byte[] the data. buf) Overrides java.io.OutputStream.write. Writes `b.length` bytes from the specified byte array to this output stream.
public void	write(byte[] the data. buf, int the start offset in the data. off, int the number of bytes to write. len) Overrides java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream.
public void	write(int the `byte`. i) Implements abstract java.io.OutputStream.write. Writes the specified byte to this output stream.

Inherited from java.io.OutputStream:: flush nullOutputStream

Field Detail

backing	back to summary
private final OutputStream backing

main	back to summary
private final OutputStream main

sigBase	back to summary
private final OutputStream sigBase

sigStream	back to summary
private final ByteArrayOutputStream sigStream

Constructor Detail

ContentOutputStream	back to summary
pack-priv ContentOutputStream(OutputStream main, OutputStream backing, ByteArrayOutputStream sigStream, OutputStream sigBase)

Method Detail

close back to summary

close	back to summary
public void close() throws IOException Overrides java.io.OutputStream.close. Implements java.io.Closeable.close. Doc from java.io.OutputStream.close. Closes this output stream and releases any system resources associated with this stream. The general contract of `close` is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened. Exceptions IOException: if an I/O error occurs.

public void close() throws IOException

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.OutputStream.close.

Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

Exceptions

IOException:: if an I/O error occurs.

write back to summary

write	back to summary
public void write(byte[] buf) throws IOException Overrides java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes `b.length` bytes from the specified byte array to this output stream. The general contract for `write(b)` is that it should have exactly the same effect as the call `write(b, 0, b.length)`. Parameters buf:byte[] the data. Exceptions IOException: if an I/O error occurs.

public void write(byte[] buf) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes b.length bytes from the specified byte array to this output stream. The general contract for write(b) is that it should have exactly the same effect as the call write(b, 0, b.length).

Parameters

buf:byte[]: the data.

Exceptions

IOException:: if an I/O error occurs.

write back to summary

write	back to summary
public void write(byte[] buf, int off, int len) throws IOException Overrides java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream. The general contract for `write(b, off, len)` is that some of the bytes in the array `b` are written to the output stream in order; element `b[off]` is the first byte written and `b[off+len-1]` is the last byte written by this operation. If `b` is `null`, a `NullPointerException` is thrown. If `off` is negative, or `len` is negative, or `off+len` is greater than the length of the array `b`, then an `IndexOutOfBoundsException` is thrown. Parameters buf:byte[] the data. off:int the start offset in the data. len:int the number of bytes to write. Exceptions IOException: if an I/O error occurs. In particular, an `IOException` is thrown if the output stream is closed.

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

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Parameters

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

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.

write back to summary

write	back to summary
public void write(int i) throws IOException Implements abstract java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes the specified byte to this output stream. The general contract for `write` is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument `b`. The 24 high-order bits of `b` are ignored. Parameters i:int the `byte`. Exceptions IOException: if an I/O error occurs. In particular, an `IOException` may be thrown if the output stream has been closed.

public void write(int i) throws IOException

Implements abstract java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Parameters

i:int: the byte.

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

public Class SMIMESignedWriter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class SMIMESignedWriter.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class SMIMESignedWriter.ContentOutputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail