Package org.bouncycastle.asn1
Class ASN1TaggedObject
- java.lang.Object
-
- org.bouncycastle.asn1.ASN1Object
-
- org.bouncycastle.asn1.ASN1Primitive
-
- org.bouncycastle.asn1.ASN1TaggedObject
-
- All Implemented Interfaces:
ASN1Encodable
,ASN1TaggedObjectParser
,InMemoryRepresentable
,Encodable
- Direct Known Subclasses:
ASN1ApplicationSpecific
,BERTaggedObject
,DERTaggedObject
,DLTaggedObject
public abstract class ASN1TaggedObject extends ASN1Primitive implements ASN1TaggedObjectParser
ASN.1 TaggedObject - in ASN.1 notation this is any object preceded by a [n] where n is some number - these are assumed to follow the construction rules (as with sequences).
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
ASN1TaggedObject(boolean explicit, int tagClass, int tagNo, ASN1Encodable obj)
protected
ASN1TaggedObject(boolean explicit, int tagNo, ASN1Encodable obj)
Create a tagged object with the style given by the value of explicit.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ASN1Object
getBaseObject()
Needed for open types, until we have better type-guided parsing support.ASN1Primitive
getBaseUniversal(boolean declaredExplicit, int tagNo)
Note: tagged objects are generally context dependent.ASN1Object
getExplicitBaseObject()
Needed for open types, until we have better type-guided parsing support.ASN1TaggedObject
getExplicitBaseTagged()
ASN1TaggedObject
getImplicitBaseTagged(int baseTagClass, int baseTagNo)
static ASN1TaggedObject
getInstance(java.lang.Object obj)
static ASN1TaggedObject
getInstance(ASN1TaggedObject taggedObject, boolean declaredExplicit)
ASN1Primitive
getLoadedObject()
Get the in-memory representation of the ASN.1 object.ASN1Primitive
getObject()
Deprecated.Tagged objects now include thetag class
.ASN1Encodable
getObjectParser(int tag, boolean isExplicit)
Deprecated.int
getTagClass()
Return the tag class associated with this object.int
getTagNo()
Return the tag number associated with this object.boolean
hasContextTag(int tagNo)
int
hashCode()
boolean
hasTag(int tagClass, int tagNo)
boolean
isExplicit()
return whether or not the object may be explicitly tagged.ASN1Encodable
parseBaseUniversal(boolean declaredExplicit, int baseTagNo)
ASN1Encodable
parseExplicitBaseObject()
Needed for open types, until we have better type-guided parsing support.ASN1TaggedObjectParser
parseExplicitBaseTagged()
ASN1TaggedObjectParser
parseImplicitBaseTagged(int baseTagClass, int baseTagNo)
java.lang.String
toString()
-
Methods inherited from class org.bouncycastle.asn1.ASN1Primitive
encodeTo, encodeTo, equals, equals, equals, fromByteArray, toASN1Primitive
-
Methods inherited from class org.bouncycastle.asn1.ASN1Object
getEncoded, getEncoded, hasEncodedTagValue
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.bouncycastle.asn1.ASN1Encodable
toASN1Primitive
-
-
-
-
Constructor Detail
-
ASN1TaggedObject
protected ASN1TaggedObject(boolean explicit, int tagNo, ASN1Encodable obj)
Create a tagged object with the style given by the value of explicit.If the object implements ASN1Choice the tag style will always be changed to explicit in accordance with the ASN.1 encoding rules.
- Parameters:
explicit
- true if the object is explicitly tagged.tagNo
- the tag number for this object.obj
- the tagged object.
-
ASN1TaggedObject
protected ASN1TaggedObject(boolean explicit, int tagClass, int tagNo, ASN1Encodable obj)
-
-
Method Detail
-
getInstance
public static ASN1TaggedObject getInstance(java.lang.Object obj)
-
getInstance
public static ASN1TaggedObject getInstance(ASN1TaggedObject taggedObject, boolean declaredExplicit)
-
hashCode
public int hashCode()
- Specified by:
hashCode
in classASN1Primitive
-
getTagClass
public int getTagClass()
Description copied from interface:ASN1TaggedObjectParser
Return the tag class associated with this object.- Specified by:
getTagClass
in interfaceASN1TaggedObjectParser
- Returns:
- the tag class.
-
getTagNo
public int getTagNo()
Return the tag number associated with this object.- Specified by:
getTagNo
in interfaceASN1TaggedObjectParser
- Returns:
- the tag number.
-
hasContextTag
public boolean hasContextTag(int tagNo)
- Specified by:
hasContextTag
in interfaceASN1TaggedObjectParser
-
hasTag
public boolean hasTag(int tagClass, int tagNo)
- Specified by:
hasTag
in interfaceASN1TaggedObjectParser
-
isExplicit
public boolean isExplicit()
return whether or not the object may be explicitly tagged.Note: if the object has been read from an input stream, the only time you can be sure if isExplicit is returning the true state of affairs is if it returns false. An implicitly tagged object may appear to be explicitly tagged, so you need to understand the context under which the reading was done as well, see getObject below.
-
getObject
public ASN1Primitive getObject()
Deprecated.Tagged objects now include thetag class
. This method will raise an exception if it is notBERTags.CONTEXT_SPECIFIC
. UsegetBaseUniversal(boolean, int)
only after confirming the expected tag class.Return whatever was following the tag.Note: tagged objects are generally context dependent. If you're trying to extract a tagged object you should be going via the appropriate getInstance method.
-
getBaseObject
public ASN1Object getBaseObject()
Needed for open types, until we have better type-guided parsing support. Use sparingly for other purposes, and prefergetExplicitBaseTagged()
,getImplicitBaseTagged(int, int)
orgetBaseUniversal(boolean, int)
where possible. Before using, check for matching tagclass
andnumber
.
-
getExplicitBaseObject
public ASN1Object getExplicitBaseObject()
Needed for open types, until we have better type-guided parsing support. Use sparingly for other purposes, and prefergetExplicitBaseTagged()
orgetBaseUniversal(boolean, int)
where possible. Before using, check for matching tagclass
andnumber
.
-
getExplicitBaseTagged
public ASN1TaggedObject getExplicitBaseTagged()
-
getImplicitBaseTagged
public ASN1TaggedObject getImplicitBaseTagged(int baseTagClass, int baseTagNo)
-
getBaseUniversal
public ASN1Primitive getBaseUniversal(boolean declaredExplicit, int tagNo)
Note: tagged objects are generally context dependent. Before trying to extract a tagged object this way, make sure you have checked that both thetag class
andtag number
match what you are looking for.- Parameters:
declaredExplicit
- Whether the tagged type for this object was declared EXPLICIT.tagNo
- The universaltag number
of the expected base object.
-
getObjectParser
public ASN1Encodable getObjectParser(int tag, boolean isExplicit) throws java.io.IOException
Deprecated.Description copied from interface:ASN1TaggedObjectParser
Return a parser for the actual object tagged.- Specified by:
getObjectParser
in interfaceASN1TaggedObjectParser
- Parameters:
tag
- the primitive tag value for the object tagged originally.isExplicit
- true if the tagging was done explicitly.- Returns:
- a parser for the tagged object.
- Throws:
java.io.IOException
- if a parser cannot be constructed.
-
parseBaseUniversal
public ASN1Encodable parseBaseUniversal(boolean declaredExplicit, int baseTagNo) throws java.io.IOException
- Specified by:
parseBaseUniversal
in interfaceASN1TaggedObjectParser
- Throws:
java.io.IOException
-
parseExplicitBaseObject
public ASN1Encodable parseExplicitBaseObject() throws java.io.IOException
Description copied from interface:ASN1TaggedObjectParser
Needed for open types, until we have better type-guided parsing support. Use sparingly for other purposes, and preferASN1TaggedObjectParser.parseExplicitBaseTagged()
orASN1TaggedObjectParser.parseBaseUniversal(boolean, int)
where possible. Before using, check for matching tagclass
andnumber
.- Specified by:
parseExplicitBaseObject
in interfaceASN1TaggedObjectParser
- Throws:
java.io.IOException
-
parseExplicitBaseTagged
public ASN1TaggedObjectParser parseExplicitBaseTagged() throws java.io.IOException
- Specified by:
parseExplicitBaseTagged
in interfaceASN1TaggedObjectParser
- Throws:
java.io.IOException
-
parseImplicitBaseTagged
public ASN1TaggedObjectParser parseImplicitBaseTagged(int baseTagClass, int baseTagNo) throws java.io.IOException
- Specified by:
parseImplicitBaseTagged
in interfaceASN1TaggedObjectParser
- Throws:
java.io.IOException
-
getLoadedObject
public final ASN1Primitive getLoadedObject()
Description copied from interface:InMemoryRepresentable
Get the in-memory representation of the ASN.1 object.- Specified by:
getLoadedObject
in interfaceInMemoryRepresentable
- Returns:
- an ASN1Primitive representing the loaded object.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-