DerOutputStream (kona-crypto 1.0.4 API)

java.lang.Object
- java.io.OutputStream
- - java.io.ByteArrayOutputStream
  - - com.tencent.kona.sun.security.util.DerOutputStream

All Implemented Interfaces:

DerEncoder, java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable
```
public class DerOutputStream
extends java.io.ByteArrayOutputStream
implements DerEncoder
```
Output stream marshaling DER-encoded data. This is eventually provided in the form of a byte array; there is no advance limit on the size of that byte array.
At this time, this class supports only a subset of the types of DER data encodings which are defined. That subset is sufficient for generating most X.509 certificates.

Field Summary
- Fields inherited from class java.io.ByteArrayOutputStream
  buf, count

Constructor Summary

Constructors
Constructor and Description

DerOutputStream()
Construct a DER output stream.

DerOutputStream(int size)
Construct a DER output stream.

Constructors
Constructor and Description
`DerOutputStream()` Construct a DER output stream.
`DerOutputStream(int size)` Construct a DER output stream.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`encode(DerOutputStream out)` Write the current contents of this `DerOutputStream` to an `OutputStream`.
`DerOutputStream`	`putBitString(byte[] bits)` Marshals a DER bit string on the output stream.
`DerOutputStream`	`putBMPString(java.lang.String s)` Marshals a string as a DER encoded BMPString.
`DerOutputStream`	`putBoolean(boolean val)` Marshals a DER boolean on the output stream.
`DerOutputStream`	`putDerValue(DerValue val)` Marshals pre-encoded DER value onto the output stream.
`DerOutputStream`	`putEnumerated(int i)` Marshals a DER enumerated on the output stream.
`DerOutputStream`	`putGeneralizedTime(java.util.Date d)` Marshals a DER Generalized Time/date value.
`DerOutputStream`	`putGeneralString(java.lang.String s)` Marshals a string as a DER encoded GeneralString.
`DerOutputStream`	`putIA5String(java.lang.String s)` Marshals a string as a DER encoded IA5String.
`DerOutputStream`	`putInteger(java.math.BigInteger i)` Marshals a DER integer on the output stream.
`DerOutputStream`	`putInteger(byte[] buf)` Marshals a DER integer on the output stream.
`DerOutputStream`	`putInteger(int i)` Marshals a DER integer on the output stream.
`DerOutputStream`	`putInteger(java.lang.Integer i)` Marshals a DER integer on the output stream.
`void`	`putLength(int len)` Put the encoding of the length in the stream.
`DerOutputStream`	`putNull()` Marshals a DER "null" value on the output stream.
`DerOutputStream`	`putOctetString(byte[] octets)` DER-encodes an ASN.1 OCTET STRING value on the output stream.
`DerOutputStream`	`putOID(ObjectIdentifier oid)` Marshals an object identifier (OID) on the output stream.
`DerOutputStream`	`putOrderedSet(byte tag, DerEncoder[] set)` Marshals the contents of a set on the output stream.
`DerOutputStream`	`putOrderedSetOf(byte tag, DerEncoder[] set)` Marshals the contents of a set on the output stream.
`DerOutputStream`	`putPrintableString(java.lang.String s)` Marshals a string as a DER encoded PrintableString.
`DerOutputStream`	`putSequence(DerValue[] seq)` Marshals a sequence on the output stream.
`DerOutputStream`	`putSet(DerValue[] set)` Marshals the contents of a set on the output stream without ordering the elements.
`DerOutputStream`	`putT61String(java.lang.String s)` Marshals a string as a DER encoded T61String.
`DerOutputStream`	`putTruncatedUnalignedBitString(BitArray ba)` Marshals a truncated DER bit string on the output stream.
`DerOutputStream`	`putUnalignedBitString(BitArray ba)` Marshals a DER bit string on the output stream.
`DerOutputStream`	`putUTCTime(java.util.Date d)` Marshals a DER UTC time/date value.
`DerOutputStream`	`putUTF8String(java.lang.String s)` Marshals a string as a DER encoded UTF8String.
`DerOutputStream`	`write(byte tag, byte[] buf)` Writes tagged, pre-marshaled data.
`DerOutputStream`	`write(byte tag, DerOutputStream out)` Writes tagged data using buffer-to-buffer copy.
`DerOutputStream`	`write(DerEncoder encoder)` Write a DerEncoder onto the output stream.
`DerOutputStream`	`writeImplicit(byte tag, DerOutputStream value)` Writes implicitly tagged data using buffer-to-buffer copy.

Methods inherited from class java.io.ByteArrayOutputStream
close, reset, size, toByteArray, toString, toString, toString, write, write, writeTo

Methods inherited from class java.io.OutputStream
flush, write

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

- Constructor Detail
  - DerOutputStream
```
public DerOutputStream(int size)
```
    Construct a DER output stream.
    
    Parameters:
    
    size - how large a buffer to preallocate.
  - DerOutputStream
```
public DerOutputStream()
```
    Construct a DER output stream.
- Method Detail
  - write
```
public DerOutputStream write(byte tag,
                             byte[] buf)
                      throws java.io.IOException
```
    Writes tagged, pre-marshaled data. This calculates and encodes the length, so that the output data is the standard triple of { tag, length, data } used by all DER values.
    
    Parameters:
    
    tag - the DER value tag for the data, such as DerValue.tag_Sequence
    
    buf - buffered data, which must be DER-encoded
    
    Throws:
    
    java.io.IOException
  - write
```
public DerOutputStream write(byte tag,
                             DerOutputStream out)
                      throws java.io.IOException
```
    Writes tagged data using buffer-to-buffer copy. As above, this writes a standard DER record. This is often used when efficiently encapsulating values in sequences.
    
    Parameters:
    
    tag - the DER value tag for the data, such as DerValue.tag_Sequence
    
    out - buffered data
    
    Throws:
    
    java.io.IOException
  - writeImplicit
```
public DerOutputStream writeImplicit(byte tag,
                                     DerOutputStream value)
                              throws java.io.IOException
```
    Writes implicitly tagged data using buffer-to-buffer copy. As above, this writes a standard DER record. This is often used when efficiently encapsulating implicitly tagged values.
    Parameters:
    tag - the DER value of the context-specific tag that replaces original tag of the value in the output, such as in
    <field> [N] IMPLICIT <type>
    For example, FooLength [1] IMPLICIT INTEGER, with value=4; would be encoded as "81 01 04" whereas in explicit tagging it would be encoded as "A1 03 02 01 04". Notice that the tag is A1 and not 81, this is because with explicit tagging the form is always constructed.
    value - original value being implicitly tagged
    
    Throws:
    
    java.io.IOException
  - putDerValue
```
public DerOutputStream putDerValue(DerValue val)
                            throws java.io.IOException
```
    Marshals pre-encoded DER value onto the output stream.
    
    Throws:
    
    java.io.IOException
  - putBoolean
```
public DerOutputStream putBoolean(boolean val)
                           throws java.io.IOException
```
    Marshals a DER boolean on the output stream.
    
    Throws:
    
    java.io.IOException
  - putEnumerated
```
public DerOutputStream putEnumerated(int i)
                              throws java.io.IOException
```
    Marshals a DER enumerated on the output stream.
    
    Parameters:
    
    i - the enumerated value.
    
    Throws:
    
    java.io.IOException
  - putInteger
```
public DerOutputStream putInteger(java.math.BigInteger i)
                           throws java.io.IOException
```
    Marshals a DER integer on the output stream.
    
    Parameters:
    
    i - the integer in the form of a BigInteger.
    
    Throws:
    
    java.io.IOException
  - putInteger
```
public DerOutputStream putInteger(byte[] buf)
                           throws java.io.IOException
```
    Marshals a DER integer on the output stream.
    
    Parameters:
    
    buf - the integer in bytes, equivalent to BigInteger::toByteArray.
    
    Throws:
    
    java.io.IOException
  - putInteger
```
public DerOutputStream putInteger(java.lang.Integer i)
                           throws java.io.IOException
```
    Marshals a DER integer on the output stream.
    
    Parameters:
    
    i - the integer in the form of an Integer.
    
    Throws:
    
    java.io.IOException
  - putInteger
```
public DerOutputStream putInteger(int i)
                           throws java.io.IOException
```
    Marshals a DER integer on the output stream.
    
    Parameters:
    
    i - the integer.
    
    Throws:
    
    java.io.IOException
  - putBitString
```
public DerOutputStream putBitString(byte[] bits)
                             throws java.io.IOException
```
    Marshals a DER bit string on the output stream. The bit string must be byte-aligned.
    
    Parameters:
    
    bits - the bit string, MSB first
    
    Throws:
    
    java.io.IOException
  - putUnalignedBitString
```
public DerOutputStream putUnalignedBitString(BitArray ba)
                                      throws java.io.IOException
```
    Marshals a DER bit string on the output stream. The bit strings need not be byte-aligned.
    
    Parameters:
    
    ba - the bit string, MSB first
    
    Throws:
    
    java.io.IOException
  - putTruncatedUnalignedBitString
```
public DerOutputStream putTruncatedUnalignedBitString(BitArray ba)
                                               throws java.io.IOException
```
    Marshals a truncated DER bit string on the output stream. The bit strings need not be byte-aligned.
    
    Parameters:
    
    ba - the bit string, MSB first
    
    Throws:
    
    java.io.IOException
  - putOctetString
```
public DerOutputStream putOctetString(byte[] octets)
                               throws java.io.IOException
```
    DER-encodes an ASN.1 OCTET STRING value on the output stream.
    
    Parameters:
    
    octets - the octet string
    
    Throws:
    
    java.io.IOException
  - putNull
```
public DerOutputStream putNull()
                        throws java.io.IOException
```
    Marshals a DER "null" value on the output stream. These are often used to indicate optional values which have been omitted.
    
    Throws:
    
    java.io.IOException
  - putOID
```
public DerOutputStream putOID(ObjectIdentifier oid)
                       throws java.io.IOException
```
    Marshals an object identifier (OID) on the output stream. Corresponds to the ASN.1 "OBJECT IDENTIFIER" construct.
    
    Throws:
    
    java.io.IOException
  - putSequence
```
public DerOutputStream putSequence(DerValue[] seq)
                            throws java.io.IOException
```
    Marshals a sequence on the output stream. This supports both the ASN.1 "SEQUENCE" (zero to N values) and "SEQUENCE OF" (one to N values) constructs.
    
    Throws:
    
    java.io.IOException
  - putSet
```
public DerOutputStream putSet(DerValue[] set)
                       throws java.io.IOException
```
    Marshals the contents of a set on the output stream without ordering the elements. Ok for BER encoding, but not for DER encoding. For DER encoding, use orderedPutSet() or orderedPutSetOf().
    
    Throws:
    
    java.io.IOException
  - putOrderedSetOf
```
public DerOutputStream putOrderedSetOf(byte tag,
                                       DerEncoder[] set)
                                throws java.io.IOException
```
    Marshals the contents of a set on the output stream. Sets are semantically unordered, but DER requires that encodings of set elements be sorted into ascending lexicographical order before being output. Hence, sets with the same tags and elements have the same DER encoding. This method supports the ASN.1 "SET OF" construct, but not "SET", which uses a different order.
    
    Throws:
    
    java.io.IOException
  - putOrderedSet
```
public DerOutputStream putOrderedSet(byte tag,
                                     DerEncoder[] set)
                              throws java.io.IOException
```
    Marshals the contents of a set on the output stream. Sets are semantically unordered, but DER requires that encodings of set elements be sorted into ascending tag order before being output. Hence, sets with the same tags and elements have the same DER encoding. This method supports the ASN.1 "SET" construct, but not "SET OF", which uses a different order.
    
    Throws:
    
    java.io.IOException
  - putUTF8String
```
public DerOutputStream putUTF8String(java.lang.String s)
                              throws java.io.IOException
```
    Marshals a string as a DER encoded UTF8String.
    
    Throws:
    
    java.io.IOException
  - putPrintableString
```
public DerOutputStream putPrintableString(java.lang.String s)
                                   throws java.io.IOException
```
    Marshals a string as a DER encoded PrintableString.
    
    Throws:
    
    java.io.IOException
  - putT61String
```
public DerOutputStream putT61String(java.lang.String s)
                             throws java.io.IOException
```
    Marshals a string as a DER encoded T61String.
    
    Throws:
    
    java.io.IOException
  - putIA5String
```
public DerOutputStream putIA5String(java.lang.String s)
                             throws java.io.IOException
```
    Marshals a string as a DER encoded IA5String.
    
    Throws:
    
    java.io.IOException
  - putBMPString
```
public DerOutputStream putBMPString(java.lang.String s)
                             throws java.io.IOException
```
    Marshals a string as a DER encoded BMPString.
    
    Throws:
    
    java.io.IOException
  - putGeneralString
```
public DerOutputStream putGeneralString(java.lang.String s)
                                 throws java.io.IOException
```
    Marshals a string as a DER encoded GeneralString.
    
    Throws:
    
    java.io.IOException
  - putUTCTime
```
public DerOutputStream putUTCTime(java.util.Date d)
                           throws java.io.IOException
```
    Marshals a DER UTC time/date value.
    YYMMDDhhmmss{Z|+hhmm|-hhmm} ... emits only using Zulu time and with seconds (even if seconds=0) as per RFC 5280.
    
    Throws:
    
    java.io.IOException
  - putGeneralizedTime
```
public DerOutputStream putGeneralizedTime(java.util.Date d)
                                   throws java.io.IOException
```
    Marshals a DER Generalized Time/date value.
    YYYYMMDDhhmmss{Z|+hhmm|-hhmm} ... emits only using Zulu time and with seconds (even if seconds=0) as per RFC 5280.
    
    Throws:
    
    java.io.IOException
  - putLength
```
public void putLength(int len)
               throws java.io.IOException
```
    Put the encoding of the length in the stream.
    
    Parameters:
    
    len - the length of the attribute.
    
    Throws:
    
    java.io.IOException - on writing errors.
  - encode
```
public void encode(DerOutputStream out)
            throws java.io.IOException
```
    Write the current contents of this DerOutputStream to an OutputStream.
    
    Specified by:
    
    encode in interface DerEncoder
    
    Parameters:
    
    out - the stream on which the DER encoding is written.
    
    Throws:
    
    java.io.IOException - on output error.
  - write
```
public DerOutputStream write(DerEncoder encoder)
                      throws java.io.IOException
```
    Write a DerEncoder onto the output stream.
    
    Parameters:
    
    encoder - the DerEncoder
    
    Throws:
    
    java.io.IOException - on output error

Class DerOutputStream

Field Summary

Fields inherited from class java.io.ByteArrayOutputStream

Constructor Summary

Method Summary

Methods inherited from class java.io.ByteArrayOutputStream

Methods inherited from class java.io.OutputStream

Methods inherited from class java.lang.Object

Constructor Detail

DerOutputStream

DerOutputStream

Method Detail

write

write

writeImplicit

putDerValue

putBoolean

putEnumerated

putInteger

putInteger

putInteger

putInteger

putBitString

putUnalignedBitString

putTruncatedUnalignedBitString

putOctetString

putNull

putOID

putSequence

putSet

putOrderedSetOf

putOrderedSet

putUTF8String

putPrintableString

putT61String

putIA5String

putBMPString

putGeneralString

putUTCTime

putGeneralizedTime

putLength

encode

write