Asn1OctetString

java.lang.Object
- com.objsys.asn1j.runtime.Asn1Type
- - com.objsys.asn1j.runtime.Asn1OctetString

All Implemented Interfaces:

Asn1TypeIF, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

Direct Known Subclasses:

Asn1Base64BinaryString, Asn1BCDString, Asn1OpenType, Asn1TBCDString
```
public class Asn1OctetString
extends Asn1Type
implements java.lang.Comparable
```
This is a container class for holding the components of an ASN.1 octet string value.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static Asn1Tag`	`TAG` The TAG constant describes the universal tag for this data type (UNIVERSAL 4).
`byte[]`	`value` This variable holds the octet string value.

Fields inherited from class com.objsys.asn1j.runtime.Asn1Type
BIT_STRING, BMPString, BOOLEAN, DATE, DATE_TIME, DURATION, ENUMERATED, EOC, EXTERNAL, GeneralString, GeneralTime, GraphicString, IA5String, INTEGER, mNonParameterizedTypeName, NULL, NumericString, OBJECT_IDENTIFIER, ObjectDescriptor, OCTET_STRING, OID_IRI, OpenType, PrintableString, REAL, RELATIVE_OID_IRI, RelativeOID, SEQUENCE, SET, T61String, TeletexString, TIME, TIME_OF_DAY, UniversalString, UTCTime, UTF8String, VideotexString, VisibleString

Constructor Summary

Constructors
Constructor and Description
`Asn1OctetString()` This constructor creates an empty octet string that can be used in a decode method call to receive an octet string value.
`Asn1OctetString(byte[] data)` This constructor initializes an octet string from the given byte array.
`Asn1OctetString(byte[] data, int offset, int nbytes)` This constructor initializes an octet string from a portion of the given byte array.
`Asn1OctetString(java.lang.String value_)` This constructor parses the given ASN.1 value text (either a binary or hex data string) and assigns the values to the internal bit string.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(java.lang.Object octstr)` This method compares two Asn1OctetString objects for equality.
`void`	`decode(Asn1BerDecodeBuffer buffer, boolean explicit, int implicitLength)` This method decodes an ASN.1 octet string value including the UNIVERSAL tag value and length if explicit tagging is specified.
`void`	`decode(Asn1JsonDecodeBuffer buffer)` Decode ASN.1 octet string from JSON.
`void`	`decode(Asn1MderDecodeBuffer buffer)` Decode an unconstrained octet string from the MDER encoding into this object.
`void`	`decode(Asn1MderDecodeBuffer buffer, int constrainedLength)` Decode an octet string from the MDER encoding into this object.
`void`	`decode(Asn1NasDecodeBuffer buffer, int nbytes)` Decode the given number of bytes from the buffer.
`void`	`decode(Asn1OerDecodeBuffer buffer)` This method decodes an ASN.1 octet string using the Octet Encoding Rules (OER).
`void`	`decode(Asn1PerDecodeBuffer buffer)` This method decodes an ASN.1 octet string value using the packed encoding rules (PER).
`void`	`decode(Asn1PerDecodeBuffer buffer, long lower, long upper)` This method decodes a sized ASN.1 octet string value using the packed encoding rules (PER).
`void`	`decodeAsBase64(Asn1JsonDecodeBuffer buffer)` Decode ASN.1 octet string, encoded in base64 form, from JSON.
`void`	`decodeAsHex(Asn1JsonDecodeBuffer buffer)` Decode ASN.1 octet string, encoded in standard, hexadecimal form, from JSON.
`void`	`decodeContent(Asn1OerDecodeBuffer buffer, int numOctets)` This method decodes an ASN.1 OCTET STRING's content that was encoded according to OER, given the total number of octets.
`void`	`decodeRemainingBits(Asn1NasDecodeBuffer buffer)` Decode all remaining bits in the current container from the buffer.
`void`	`decodeXER(java.lang.String buffer, java.lang.String attrs, boolean base64)` This method decodes ASN.1 octet string type using the XML encoding rules (XER).
`void`	`decodeXML(java.lang.String buffer, java.lang.String attrs)` This method decodes an ASN.1 octet string type using the XML schema encoding rules.
`int`	`encode(Asn1BerEncodeBuffer buffer, boolean explicit)` This method encodes an ASN.1 octet string value including the UNIVERSAL tag value and length if explicit tagging is specified.
`void`	`encode(Asn1BerOutputStream out, boolean explicit)` This method encodes and writes to the stream an ASN.1 octet string value including the UNIVERSAL tag value and length if explicit tagging is specified.
`void`	`encode(Asn1JsonOutputStream outstream)` Encode this octet string to JSON.
`void`	`encode(Asn1MderOutputStream out)` Encode this octet string into the MDER encoding.
`void`	`encode(Asn1MderOutputStream out, int constrainedLength)` Encode this octet string into the MDER encoding.
`void`	`encode(Asn1OerEncodeBuffer buffer)` This method encodes this ASN.1 OCTET STRING value, according to OER.
`void`	`encode(Asn1PerEncodeBuffer buffer)` This method encodes an unconstrained ASN.1 octet string value using the packed encoding rules (PER).
`void`	`encode(Asn1PerEncodeBuffer buffer, long lower, long upper)` This method encodes a size-constrained ASN.1 octet string value using the packed encoding rules (PER).
`void`	`encode(Asn1PerOutputStream out)` This method encodes an unconstrained ASN.1 octet string value using the packed encoding rules (PER).
`void`	`encode(Asn1PerOutputStream out, long lower, long upper)` This method encodes a size-constrained ASN.1 octet string value using the packed encoding rules (PER).
`void`	`encode(Asn1XerEncoder buffer, java.lang.String elemName)` This method encodes ASN.1 octet string type using the XML encoding rules (XER).
`void`	`encode(Asn1XmlEncoder buffer, java.lang.String elemName, java.lang.String nsPrefix)` This method encodes ASN.1 octet string type as an xmlhstring.
`void`	`encode(Asn1XmlEncoder buffer, java.lang.String elemName, java.lang.String nsPrefix, boolean base64)` This method encodes ASN.1 octet string type using the XML Encoding as specified in the XML schema standard(asn2xsd).
`void`	`encodeAsBase64(Asn1JsonOutputStream outstream)` Encode this octet string to JSON using BASE64 form (as required when a BASE64 encoding instruction applies).
`void`	`encodeAsHex(Asn1JsonOutputStream outstream)` Encode this octet string to JSON using the standard (hexadecimal) form.
`void`	`encodeAttribute(Asn1XmlEncoder buffer, java.lang.String attrName)` This method encodes ASN.1 octet string type using the XML Encoding as specified in the XML schema standard(asn2xsd).
`static java.lang.String`	`encodeBase64Binary(byte[] data)` Encodes bytes into base64 ASCII characters using the algorithm defined in RFC2045, as defined in w3c stadard http://www.w3.org/tr/2001/rec-xmlschema-2-20010502#base64Binary
`void`	`encodeContent(Asn1OerEncodeBuffer buffer)` This method encodes the content of an ASN.1 OCTET STRING, according to OER.
`boolean`	`equals(byte[] value)` This method compares this octet string value to the given value for equality.
`boolean`	`equals(java.lang.Object os)` This method compares this octet string value to the given value for equality.
`boolean`	`equals(java.lang.String s)` This method compares the given ASN.1 OCTET STRING value to this OCTET STRING value for equality.
`java.lang.String`	`getAsn1TypeName()` Returns the ASN.1 type name.
`int`	`getLength()` This method will return the length of the OCTET STRING in octets.
`int`	`getMderLength()` Return the length of the MDER encoding for this type, assuming that the type is NOT a fixed length OCTET STRING (if it is fixed length, you need not call this method!).
`int`	`hashCode()` This method returns the hashcode for the Asn1OctetString.
`static void`	`skip(Asn1PerDecodeBuffer buffer)` This method skips an ASN.1 octet string value using the packed encoding rules (PER).
`static void`	`skip(Asn1PerDecodeBuffer buffer, long lower, long upper)` This method skips a sized ASN.1 octet string value using the packed encoding rules (PER).
`java.io.InputStream`	`toInputStream()` This method will return a byte array input stream representation of the octet string value.
`java.lang.String`	`toString()` This method will return a string representation of the octet string value.

Methods inherited from class com.objsys.asn1j.runtime.Asn1Type
_setKey, _setLicLocation, clone, decode, decode, decode, decode, decode, decode, decode, decode, decode, encode, encode, encode, encode, encodeAsOpenType, equals, getNonParameterizedTypeName, getTypeName, indent, indent, isOpenType, matchTag, matchTag, pdiag, print, print, print, setNonParameterizedTypeName, setOpenType

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

- Field Detail
  - TAG
```
public static final Asn1Tag TAG
```
    The TAG constant describes the universal tag for this data type (UNIVERSAL 4).
  - value
```
public transient byte[] value
```
    This variable holds the octet string value. These are the octets that are encoded when encode is invoked. It is also where the decoded octet string is stored after a decode operation.
- Constructor Detail
  - Asn1OctetString
```
public Asn1OctetString()
```
    This constructor creates an empty octet string that can be used in a decode method call to receive an octet string value.
  - Asn1OctetString
```
public Asn1OctetString(byte[] data)
```
    This constructor initializes an octet string from the given byte array.
    
    Parameters:
    
    data - Byte array containing an octet string in binary form.
  - Asn1OctetString
```
public Asn1OctetString(byte[] data,
                       int offset,
                       int nbytes)
```
    This constructor initializes an octet string from a portion of the given byte array. A new byte array is created starting at the given offset and consisting of the given number of bytes.
    
    Parameters:
    
    data - Byte array containing an octet string in binary form.
    
    offset - Starting offset in data from which to copy bytes
    
    nbytes - Number of bytes to copy from target array
  - Asn1OctetString
```
public Asn1OctetString(java.lang.String value_)
                throws Asn1ValueParseException
```
    This constructor parses the given ASN.1 value text (either a binary or hex data string) and assigns the values to the internal bit string. Examples of valid value formats are as follows: Binary string: '11010010111001'B Hex string: '0fa56920014abc'H Char string: 'abcdefg'
    
    Parameters:
    
    value_ - The ASN.1 value specification text
    
    Throws:
    
    Asn1ValueParseException
- Method Detail
  - getAsn1TypeName
```
public java.lang.String getAsn1TypeName()
```
    Returns the ASN.1 type name.
    
    Overrides:
    
    getAsn1TypeName in class Asn1Type
    
    Returns:
    
    The ASN.1 type name OCTET STRING.
  - compareTo
```
public int compareTo(java.lang.Object octstr)
```
    This method compares two Asn1OctetString objects for equality. The OCTET STRING's are equal if a) all octets are equal, and b) the lengths are the same. This method is required to implement the Comparable interface used for sorting.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable
    
    Parameters:
    
    octstr - Asn1OctetString to compare
  - decode
```
public void decode(Asn1BerDecodeBuffer buffer,
                   boolean explicit,
                   int implicitLength)
            throws Asn1Exception,
                   java.io.IOException
```
    This method decodes an ASN.1 octet string value including the UNIVERSAL tag value and length if explicit tagging is specified.
    
    Specified by:
    
    decode in interface Asn1TypeIF
    
    Overrides:
    
    decode in class Asn1Type
    
    Parameters:
    
    buffer - Decode message buffer object
    
    explicit - Flag indicating element is explicitly tagged
    
    implicitLength - Length of contents if implicit
    
    Throws:
    
    Asn1Exception
    
    java.io.IOException
  - encode
```
public int encode(Asn1BerEncodeBuffer buffer,
                  boolean explicit)
           throws Asn1Exception
```
    This method encodes an ASN.1 octet string value including the UNIVERSAL tag value and length if explicit tagging is specified.
    
    Specified by:
    
    encode in interface Asn1TypeIF
    
    Overrides:
    
    encode in class Asn1Type
    
    Parameters:
    
    buffer - Encode message buffer object
    
    explicit - Flag indicating explicit tagging should be done
    
    Returns:
    
    Length of encoded component
    
    Throws:
    
    Asn1Exception
  - decode
```
public void decode(Asn1PerDecodeBuffer buffer)
            throws Asn1Exception,
                   java.io.IOException
```
    This method decodes an ASN.1 octet string value using the packed encoding rules (PER). The string is assumed to not contain a size constraint.
    
    Specified by:
    
    decode in interface Asn1TypeIF
    
    Overrides:
    
    decode in class Asn1Type
    
    Parameters:
    
    buffer - Decode message buffer object
    
    Throws:
    
    Asn1Exception
    
    java.io.IOException
  - decode
```
public void decode(Asn1PerDecodeBuffer buffer,
                   long lower,
                   long upper)
            throws Asn1Exception,
                   java.io.IOException
```
    This method decodes a sized ASN.1 octet string value using the packed encoding rules (PER).
    
    Parameters:
    
    buffer - Decode message buffer object
    
    lower - Lower bound (inclusive) of size constraint
    
    upper - Upper bound (inclusive) of size constraint
    
    Throws:
    
    java.io.IOException - for I/O exception
    
    Asn1Exception
  - skip
```
public static void skip(Asn1PerDecodeBuffer buffer)
                 throws Asn1Exception,
                        java.io.IOException
```
    This method skips an ASN.1 octet string value using the packed encoding rules (PER). The string is assumed to not have a size constraint.
    
    Parameters:
    
    buffer - Decode message buffer object
    
    Throws:
    
    Asn1Exception
    
    java.io.IOException
  - skip
```
public static void skip(Asn1PerDecodeBuffer buffer,
                        long lower,
                        long upper)
                 throws Asn1Exception,
                        java.io.IOException
```
    This method skips a sized ASN.1 octet string value using the packed encoding rules (PER).
    
    Parameters:
    
    buffer - Decode message buffer object
    
    lower - Lower bound (inclusive) of size constraint
    
    upper - Upper bound (inclusive) of size constraint
    
    Throws:
    
    java.io.IOException - for I/O exception
    
    Asn1Exception
  - encode
```
public void encode(Asn1PerEncodeBuffer buffer)
            throws Asn1Exception,
                   java.io.IOException
```
    This method encodes an unconstrained ASN.1 octet string value using the packed encoding rules (PER). The value to be encoded is stored in the 'value' public member variable within this class.
    
    Specified by:
    
    encode in interface Asn1TypeIF
    
    Overrides:
    
    encode in class Asn1Type
    
    Parameters:
    
    buffer - Encode message buffer object
    
    Throws:
    
    Asn1Exception
    
    java.io.IOException
  - encode
```
public void encode(Asn1PerEncodeBuffer buffer,
                   long lower,
                   long upper)
            throws Asn1Exception,
                   java.io.IOException
```
    This method encodes a size-constrained ASN.1 octet string value using the packed encoding rules (PER). The value to be encoded is stored in the 'value' public member variable within this class.
    
    Parameters:
    
    buffer - Encode message buffer object
    
    lower - Lower bound (inclusive) of size constraint
    
    upper - Upper bound (inclusive) of size constraint
    
    Throws:
    
    java.io.IOException - for I/O exception
    
    Asn1Exception
  - decode
```
public final void decode(Asn1NasDecodeBuffer buffer,
                         int nbytes)
                  throws java.io.IOException
```
    Decode the given number of bytes from the buffer.
    
    Parameters:
    
    buffer - The buffer to decode from.
    
    nbytes - The number of bytes to decode.
    
    Throws:
    
    java.io.IOException - for I/O exception
  - decodeRemainingBits
```
public final void decodeRemainingBits(Asn1NasDecodeBuffer buffer)
                               throws java.io.IOException
```
    Decode all remaining bits in the current container from the buffer. Containers are set by pushing/popping container lengths on/off the buffer's container stack. If no containers are on the stack, this decodes all remaining bits from the buffer.
    
    Parameters:
    
    buffer - The buffer to decode from.
    
    Throws:
    
    java.io.IOException - for I/O exception
  - decodeContent
```
public final void decodeContent(Asn1OerDecodeBuffer buffer,
                                int numOctets)
                         throws java.io.IOException
```
    This method decodes an ASN.1 OCTET STRING's content that was encoded according to OER, given the total number of octets. This does not decode a length determinant.
    
    Parameters:
    
    buffer - Decode message buffer object
    
    numOctets - Total number of octets encoding the content.
    
    Throws:
    
    java.io.IOException - for I/O exception
  - decode
```
public void decode(Asn1OerDecodeBuffer buffer)
            throws java.io.IOException
```
    This method decodes an ASN.1 octet string using the Octet Encoding Rules (OER). This implementation expects a length determinant in the encoding. This method may be overridden for ASN.1 types that have a fixed length to invoke decodeContent with the predetermined length.
    
    Overrides:
    
    decode in class Asn1Type
    
    Throws:
    
    java.io.IOException
  - encodeContent
```
public final void encodeContent(Asn1OerEncodeBuffer buffer)
```
    This method encodes the content of an ASN.1 OCTET STRING, according to OER. (The length determinant is not encoded.)
    
    Parameters:
    
    buffer - Encode message buffer object
  - encode
```
public void encode(Asn1OerEncodeBuffer buffer)
            throws java.io.IOException
```
    This method encodes this ASN.1 OCTET STRING value, according to OER. This encodes the length determinant, assuming that the OCTET STRING is not fixed-size constrained. Subclasses may override this to simply call encodeContent for fixed-size constrained strings.
    
    Overrides:
    
    encode in class Asn1Type
    
    Parameters:
    
    buffer - Encode message buffer object
    
    Throws:
    
    java.io.IOException - for I/O exception
  - decode
```
public void decode(Asn1MderDecodeBuffer buffer)
            throws Asn1Exception,
                   java.io.IOException
```
    Decode an unconstrained octet string from the MDER encoding into this object.
    
    Specified by:
    
    decode in interface Asn1TypeIF
    
    Overrides:
    
    decode in class Asn1Type
    
    Parameters:
    
    buffer - MDER Decode message buffer object
    
    Throws:
    
    java.io.IOException - for I/O exception
    
    Asn1Exception - Thrown, if operation is failed.
  - decode
```
public void decode(Asn1MderDecodeBuffer buffer,
                   int constrainedLength)
            throws Asn1Exception,
                   java.io.IOException
```
    Decode an octet string from the MDER encoding into this object.
    
    Parameters:
    
    buffer - The buffer to decode from.
    
    constrainedLength - The constrained length of the type being encoded. Pass -1 if the type is unconstrained. For a constrained length octet string, exactly that many octets will be read.
    
    Throws:
    
    java.io.IOException - for I/O exception
    
    Asn1Exception
  - getMderLength
```
public int getMderLength()
```
    Return the length of the MDER encoding for this type, assuming that the type is NOT a fixed length OCTET STRING (if it is fixed length, you need not call this method!).
    
    Returns:
    
    the length
  - encode
```
public void encode(Asn1XerEncoder buffer,
                   java.lang.String elemName)
            throws java.io.IOException,
                   Asn1Exception
```
    This method encodes ASN.1 octet string type using the XML encoding rules (XER).
    
    Specified by:
    
    encode in interface Asn1TypeIF
    
    Overrides:
    
    encode in class Asn1Type
    
    Parameters:
    
    buffer - Encode message buffer object
    
    elemName - XML element name used to wrap string
    
    Throws:
    
    java.io.IOException - Any exception thrown by the underlying stream.
    
    Asn1Exception - Thrown, if operation is failed.
  - decodeXER
```
public void decodeXER(java.lang.String buffer,
                      java.lang.String attrs,
                      boolean base64)
               throws Asn1Exception
```
    This method decodes ASN.1 octet string type using the XML encoding rules (XER). Extended-XER is supported by the base64 parameter.
    
    Parameters:
    
    buffer - String containing data to be decoded
    
    attrs - Attributes string from element tag
    
    base64 - pass true if encoding is base64 (extended-XER only)
    
    Throws:
    
    Asn1Exception
  - encode
```
public void encode(Asn1XmlEncoder buffer,
                   java.lang.String elemName,
                   java.lang.String nsPrefix)
            throws java.io.IOException,
                   Asn1Exception
```
    This method encodes ASN.1 octet string type as an xmlhstring.
    
    Overrides:
    
    encode in class Asn1Type
    
    Parameters:
    
    buffer - Encode message buffer object
    
    elemName - XML element name used to wrap string
    
    nsPrefix - XML element name space prefix
    
    Throws:
    
    java.io.IOException - for I/O exception
    
    Asn1Exception - Thrown, if operation is failed.
  - encode
```
public void encode(Asn1XmlEncoder buffer,
                   java.lang.String elemName,
                   java.lang.String nsPrefix,
                   boolean base64)
            throws java.io.IOException,
                   Asn1Exception
```
    This method encodes ASN.1 octet string type using the XML Encoding as specified in the XML schema standard(asn2xsd).
    
    Parameters:
    
    buffer - Encode message buffer object
    
    elemName - XML element name used to wrap string
    
    nsPrefix - XML element name space prefix
    
    base64 - Pass true to encode as base64 (extended-XER only, including XSD compilation)
    
    Throws:
    
    java.io.IOException - for I/O exception
    
    Asn1Exception
  - encodeAttribute
```
public void encodeAttribute(Asn1XmlEncoder buffer,
                            java.lang.String attrName)
                     throws Asn1Exception,
                            java.io.IOException
```
    This method encodes ASN.1 octet string type using the XML Encoding as specified in the XML schema standard(asn2xsd).
    
    Parameters:
    
    buffer - Encode message buffer object
    
    attrName - XML element name used to wrap string
    
    Throws:
    
    Asn1Exception
    
    java.io.IOException
  - decodeXML
```
public void decodeXML(java.lang.String buffer,
                      java.lang.String attrs)
               throws Asn1Exception
```
    This method decodes an ASN.1 octet string type using the XML schema encoding rules.
    
    Specified by:
    
    decodeXML in interface Asn1TypeIF
    
    Overrides:
    
    decodeXML in class Asn1Type
    
    Parameters:
    
    buffer - String containing data to be decoded
    
    attrs - Attributes string from element tag
    
    Throws:
    
    Asn1Exception
  - decodeAsBase64
```
public final void decodeAsBase64(Asn1JsonDecodeBuffer buffer)
                          throws java.io.IOException
```
    Decode ASN.1 octet string, encoded in base64 form, from JSON.
    
    Parameters:
    
    buffer - The buffer to decode from.
    
    Throws:
    
    java.io.IOException - for I/O exception
  - decodeAsHex
```
public final void decodeAsHex(Asn1JsonDecodeBuffer buffer)
                       throws java.io.IOException
```
    Decode ASN.1 octet string, encoded in standard, hexadecimal form, from JSON.
    
    Parameters:
    
    buffer - The buffer to decode from.
    
    Throws:
    
    java.io.IOException - for I/O exception
  - decode
```
public void decode(Asn1JsonDecodeBuffer buffer)
            throws java.io.IOException
```
    Decode ASN.1 octet string from JSON. This class's implementation decodes using decodeAsHex, but subclasses may override this to use decodeAsBase64 if encoding instructions require it.
    
    Overrides:
    
    decode in class Asn1Type
    
    Parameters:
    
    buffer - The buffer to decode from.
    
    Throws:
    
    java.io.IOException - for I/O exception
  - encodeAsBase64
```
public final void encodeAsBase64(Asn1JsonOutputStream outstream)
                          throws java.io.IOException
```
    Encode this octet string to JSON using BASE64 form (as required when a BASE64 encoding instruction applies).
    
    Throws:
    
    java.io.IOException
  - encodeAsHex
```
public final void encodeAsHex(Asn1JsonOutputStream outstream)
                       throws java.io.IOException
```
    Encode this octet string to JSON using the standard (hexadecimal) form.
    
    Parameters:
    
    outstream - The stream to encode to.
    
    Throws:
    
    java.io.IOException - for I/O exception
  - encode
```
public void encode(Asn1JsonOutputStream outstream)
            throws java.io.IOException
```
    Encode this octet string to JSON. The implementation for this class uses encodeAsHex; subclasses may override this to use encodeAsBase64 if encoding instructions require it.
    
    Overrides:
    
    encode in class Asn1Type
    
    Parameters:
    
    outstream - The stream to encode to.
    
    Throws:
    
    java.io.IOException - for I/O exception
  - encodeBase64Binary
```
public static java.lang.String encodeBase64Binary(byte[] data)
```
    Encodes bytes into base64 ASCII characters using the algorithm defined in RFC2045, as defined in w3c stadard http://www.w3.org/tr/2001/rec-xmlschema-2-20010502#base64Binary
    
    Parameters:
    
    data - Array containing bytes to be encoded
    
    Returns:
    
    Encoded ASCII string
  - equals
```
public boolean equals(byte[] value)
```
    This method compares this octet string value to the given value for equality.
    
    Parameters:
    
    value - Byte array containing octet data
    
    Returns:
    
    true if equal
  - equals
```
public boolean equals(java.lang.String s)
```
    This method compares the given ASN.1 OCTET STRING value to this OCTET STRING value for equality.
    
    Parameters:
    
    s - Textual representation of an OCTET STRING. Examples of valid value formats are as follows: Binary string: '11010010111001'B Hex string: '0fa56920014abc'H
    
    Returns:
    
    true if s represents the same OCTET STRING as this OCTET STRING.
  - equals
```
public boolean equals(java.lang.Object os)
```
    This method compares this octet string value to the given value for equality.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    os - Asn1OctetString object to compare
  - hashCode
```
public int hashCode()
```
    This method returns the hashcode for the Asn1OctetString.
    
    Overrides:
    
    hashCode in class Asn1Type
  - getLength
```
public int getLength()
              throws Asn1InvalidLengthException
```
    This method will return the length of the OCTET STRING in octets.
    
    Overrides:
    
    getLength in class Asn1Type
    
    Returns:
    
    Number of octets.
    
    Throws:
    
    Asn1InvalidLengthException
  - toInputStream
```
public java.io.InputStream toInputStream()
```
    This method will return a byte array input stream representation of the octet string value.
    
    Returns:
    
    Reference to input stream object
  - toString
```
public java.lang.String toString()
```
    This method will return a string representation of the octet string value. The format is the ASN.1 value format for this type..
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    Stringified representation of the value
  - encode
```
public void encode(Asn1BerOutputStream out,
                   boolean explicit)
            throws Asn1Exception,
                   java.io.IOException
```
    This method encodes and writes to the stream an ASN.1 octet string value including the UNIVERSAL tag value and length if explicit tagging is specified. This overloaded version uses the Basic Encoding Rules (BER).
    
    Specified by:
    
    encode in interface Asn1TypeIF
    
    Overrides:
    
    encode in class Asn1Type
    
    Parameters:
    
    out - BER Output Stream object
    
    explicit - Flag indicating explicit tagging should be done
    
    Throws:
    
    java.io.IOException - Any exception thrown by the underlying OutputStream.
    
    Asn1Exception - Thrown, if operation is failed.
  - encode
```
public void encode(Asn1PerOutputStream out)
            throws Asn1Exception,
                   java.io.IOException
```
    This method encodes an unconstrained ASN.1 octet string value using the packed encoding rules (PER). The value to be encoded is stored in the 'value' public member variable within this class.
    
    Specified by:
    
    encode in interface Asn1TypeIF
    
    Overrides:
    
    encode in class Asn1Type
    
    Parameters:
    
    out - PER Output Stream object
    
    Throws:
    
    java.io.IOException - Any exception thrown by the Asn1PerOutputStream.
    
    Asn1Exception - Thrown, if operation is failed.
  - encode
```
public void encode(Asn1PerOutputStream out,
                   long lower,
                   long upper)
            throws Asn1Exception,
                   java.io.IOException
```
    This method encodes a size-constrained ASN.1 octet string value using the packed encoding rules (PER). The value to be encoded is stored in the 'value' public member variable within this class.
    
    Parameters:
    
    out - PER Output Stream object
    
    lower - Lower bound (inclusive) of size constraint
    
    upper - Upper bound (inclusive) of size constraint
    
    Throws:
    
    java.io.IOException - Any exception thrown by the Asn1PerOutputStream.
    
    Asn1Exception - Thrown, if operation is failed.
  - encode
```
public void encode(Asn1MderOutputStream out)
            throws Asn1Exception,
                   java.io.IOException
```
    Encode this octet string into the MDER encoding. This should be used for octet string types that are not of fixed length.
    
    Specified by:
    
    encode in interface Asn1TypeIF
    
    Overrides:
    
    encode in class Asn1Type
    
    Parameters:
    
    out - MDER Encode message buffer object
    
    Throws:
    
    Asn1MderUnsupported - if the actual length > 65535 (maximum allowed by MDER).
    
    Asn1Exception - Thrown, if operation is failed.
    
    java.io.IOException - Any exception thrown by the underlying stream.
  - encode
```
public void encode(Asn1MderOutputStream out,
                   int constrainedLength)
            throws Asn1Exception,
                   java.io.IOException
```
    Encode this octet string into the MDER encoding.
    
    Parameters:
    
    out - The stream to encode to.
    
    constrainedLength - The constrained length of the type being encoded. Pass -1 if the type is unconstrained.
    
    Throws:
    
    java.io.IOException - for I/O exception
    
    Asn1ConsVioException - if a constrained length is given and the value is not exactly that length.
    
    Asn1MderUnsupported - if the length is unconstrained and the actual length > 65535 (maximum allowed by MDER).
    
    Asn1Exception

Class Asn1OctetString

Field Summary

Fields inherited from class com.objsys.asn1j.runtime.Asn1Type

Constructor Summary

Method Summary

Methods inherited from class com.objsys.asn1j.runtime.Asn1Type

Methods inherited from class java.lang.Object

Field Detail

TAG

value

Constructor Detail

Asn1OctetString

Asn1OctetString

Asn1OctetString

Asn1OctetString

Method Detail

getAsn1TypeName

compareTo

decode

encode

decode

decode

skip

skip

encode

encode

decode

decodeRemainingBits

decodeContent

decode

encodeContent

encode

decode

decode

getMderLength

encode

decodeXER

encode

encode

encodeAttribute

decodeXML

decodeAsBase64

decodeAsHex

decode

encodeAsBase64

encodeAsHex

encode

encodeBase64Binary

equals

equals

equals

hashCode

getLength

toInputStream

toString

encode

encode

encode

encode

encode