InhibitAnyPolicy ("Entrust Authority Security Toolkit for the Java Platform")

java.lang.Object
- iaik.x509.V3Extension
- - com.entrust.toolkit.x509.extensions.InhibitAnyPolicy

```
public class InhibitAnyPolicy
extends V3Extension
```
This class implements the InhibitAnyPolicy extension.
The InhibitAnyPolicy extension is a standard X509v3 extension.
Each extension is associated with a specific certificateExtension object identifier, derived from:
```
 certificateExtension  OBJECT IDENTIFIER ::=
                            {joint-iso-ccitt(2) ds(5) 29}
 id-ce                 OBJECT IDENTIFIER ::=  certificateExtension
 
```
The object identifier for the InhibitAnyPolicy extension is defined as:
id-ce-inhibitAnyPolicy OBJECT IDENTIFIER ::= { id-ce 54 }
which corresponds to the OID string "2.5.29.54".
This extension indicates that the special anyPolicy OID, with the value { 2 5 29 32 0 }, is not considered an explicit match for other certificate policies. The valie indicates the number of additional certificates that may appear in the path before anyPolicy is no longer permitted.
```
 InhibitAnyPolicy ::= SkipCerts
 

 SkipCerts ::= INTEGER (0..MAX)
 
```
More information can be found in RFC 3280, section 4.2.1.15 "Inhibit Any-Policy".
For adding a InhibitAnyPolicy extension object to a X509Certificate, use the addExtension method of the iaik.x509.X509Certificate class, e.g.:
```
 InhibitAnyPolicy inhibitAnyPolicy = new InhibitAnyPolicy();
 inhibitAnyPolicy.setInhibitAnyPolicy(3);
 X509Certificate cert = new X509Certificate();
  ...
 cert.addExtension(inhibitAnyPolicy);
 
```
When intending to mark this extension as critical, use the setCritical method of the iaik.x509.V3Extension parent class (note that you have to mark an extension as critical before adding the extension to a certificate), e.g.:
```
 inhibitAnyPolicy.setCritical(true);
 
```
See Also:
V3Extension, X509Extensions, X509Certificate

Field Summary

Fields
Modifier and Type Field and Description

static ObjectID oid
The object identifier of this InhibitAnyPolicy extension.
- Fields inherited from class iaik.x509.V3Extension
  critical

Fields
Modifier and Type	Field and Description
`static ObjectID`	`oid` The object identifier of this InhibitAnyPolicy extension.

Constructor Summary

Constructors
Constructor and Description
`InhibitAnyPolicy()` Default constructor.
`InhibitAnyPolicy(int skipCerts)` Creates a new `InhibitAnyPolicy` from an integer specifying the number of additional certificates that may appear in the path before anyPolicy is no longer permitted.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getInhibitAnyPolicy()` Returns the value of this `InhibitAnyPolicy` extension specifying the number of additional certificates that may appear in the path before anyPolicy is no longer permitted.
`ObjectID`	`getObjectID()` Returns the object ID of this `InhibitAnyPolicy` extension
`int`	`hashCode()` Returns a hashcode for this identity.
`void`	`init(ASN1Object obj)` Inits the implementation with an ASN1Object.
`void`	`setInhibitAnyPolicy(int inhibitAnyPolicy)` Sets the value of this `InhibitAnyPolicy` extension for specifying the number of additional certificates that may appear in the path before anyPolicy is no longer permitted.
`ASN1Object`	`toASN1Object()` Returns an ASN1Object representing the value of this `InhibitAnyPolicy` extension object.
`java.lang.String`	`toString()` Returns a string that represents the contents of this `InhibitAnyPolicy` extension.

Methods inherited from class iaik.x509.V3Extension
getName, isCritical, setCritical

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

- Field Detail
  - oid
```
public static final ObjectID oid
```
    The object identifier of this InhibitAnyPolicy extension. The corresponding OID string is "2.5.29.54".
- Constructor Detail
  - InhibitAnyPolicy
```
public InhibitAnyPolicy()
```
    Default constructor. Creates an empty InhibitAnyPolicy object. Use the setInhibitAnyPolicy method for explicitly setting the inhibit anyPolicy, e.g.:
```
 InhibitAnyPolicy inhibit_anyPolicy = new InhibitAnyPolicy();
 inhibit_anyPolicy.setInhibitAnyPolicy(2);
 
```
  - InhibitAnyPolicy
```
public InhibitAnyPolicy(int skipCerts)
```
    Creates a new InhibitAnyPolicy from an integer specifying the number of additional certificates that may appear in the path before anyPolicy is no longer permitted.
    For instance:
    InhibitAnyPolicy inhibit_anyPolicy = new InhibitAnyPolicy(2);
    
    Parameters:
    skipCerts - the the number of additional certificates that may appear in the path before anyPolicy is no longer permitted.
- Method Detail
  - init
```
public void init(ASN1Object obj)
          throws X509ExtensionException
```
    Description copied from class: V3Extension
    
    Inits the implementation with an ASN1Object. This method is used by the X509Extensions class when parsing the ASN.1 representation of a certificate (or a CRL) for properly initializing any included extension. This method initilaizes a specific extension only with its value, but not with its critical specification. For that reason, this method shall not be explicitly called by an application.
    
    Specified by:
    
    init in class V3Extension
    
    Parameters:
    obj - the extension value as ASN1Object
    
    Throws:
    
    X509ExtensionException - if the extension could not parse the ASN1Object
  - setInhibitAnyPolicy
```
public void setInhibitAnyPolicy(int inhibitAnyPolicy)
```
    Sets the value of this InhibitAnyPolicy extension for specifying the number of additional certificates that may appear in the path before anyPolicy is no longer permitted.
    
    Parameters:
    inhibitAnyPolicy - the number of additional certificates that may appear in the path before anyPolicy is no longer permitted.
    See Also:
    getInhibitAnyPolicy()
  - getInhibitAnyPolicy
```
public int getInhibitAnyPolicy()
```
    Returns the value of this InhibitAnyPolicy extension specifying the number of additional certificates that may appear in the path before anyPolicy is no longer permitted.
    
    Returns:
    the value specifying the number of additional certificates that may appear in the path before anyPolicy is no longer permitted, or -1 if the value has yet not been set
    See Also:
    setInhibitAnyPolicy(int)
  - toASN1Object
```
public ASN1Object toASN1Object()
```
    Returns an ASN1Object representing the value of this InhibitAnyPolicy extension object.
    The returned ASN1Object is an ASN.1 INTEGER representing the BigInteger skipCerts value.
```
 SkipCerts ::= INTEGER (0..MAX)
 
```
    Specified by:
    
    toASN1Object in class V3Extension
    
    Returns:
    the value of this InhibitAnyPolicy as ASN1Object
  - hashCode
```
public int hashCode()
```
    Returns a hashcode for this identity.
    
    Specified by:
    
    hashCode in class V3Extension
    
    Returns:
    a hash code for this identity
  - getObjectID
```
public ObjectID getObjectID()
```
    Returns the object ID of this InhibitAnyPolicy extension
    
    Specified by:
    
    getObjectID in class V3Extension
    
    Returns:
    the object ID
  - toString
```
public java.lang.String toString()
```
    Returns a string that represents the contents of this InhibitAnyPolicy extension.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    the string representation

Class InhibitAnyPolicy

Field Summary

Fields inherited from class iaik.x509.V3Extension

Constructor Summary

Method Summary

Methods inherited from class iaik.x509.V3Extension

Methods inherited from class java.lang.Object

Field Detail

oid

Constructor Detail

InhibitAnyPolicy

InhibitAnyPolicy

Method Detail

init

setInhibitAnyPolicy

getInhibitAnyPolicy

toASN1Object

hashCode

getObjectID

toString