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

java.lang.Object
- com.entrust.toolkit.asn1.crmf.Controls

All Implemented Interfaces:

ASN1Type
```
public class Controls
extends java.lang.Object
implements ASN1Type
```
This class implements the Controls structure as defined in the CRMF specification.
```
 Controls  ::= SEQUENCE SIZE(1..MAX) OF AttributeTypeAndValue
 
```
The generator of a CertRequest may include one or more control values pertaining to the processing of the request. The following controls are defined (it is recognized that this list may expand over time): regToken; authenticator; pkiPublicationInfo; pkiArchiveOptions; oldCertID; protocolEncrKey.

This class holds the controls in a hashtable, using the object ID as the key. This means that the Controls object can only ever contain each control once. Attempts to add a control more than once will simply overwrite each other because they use the same key (object ID).

Currently implementations exist for the following controls which are considered the "known-controls":
- RegToken
- Authenticator
- PKIPublicationInfo
- PKIArchiveOptions (partial implementation)
- OldCertId
- ProtocolEncrKey
- EntrustCertTypeAndDefn
Any controls that are not listed here must be created using the AttributeTypeAndValue object, and can then be added.
Since:

7.0

Constructor Summary

Constructors
Constructor and Description
`Controls()` Creates a new Constructor that constains no controls
`Controls(ASN1Object obj)` Creates a `Controls` object from an `ASN1Object`.
`Controls(AttributeTypeAndValue control)` Creates a new `Controls` object that contains a single control.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addControl(AttributeTypeAndValue control)` Adds the specified control.
`int`	`countControls()` Returns the number of controls this object holds.
`void`	`decode(ASN1Object obj)` Decodes a Controls structure from an `ASN1Object`.
`AttributeTypeAndValue`	`getControl(ObjectID oid)` Returns a particular control, specified by its object ID, if it exists in the Controls structure; otherwise `null` is returned.
`AttributeTypeAndValue[]`	`getControls()` Returns all the controls this object contains as an array of `AttribyteTypeAndValue` objects.
`ASN1Object`	`toASN1Object()` Encodes this `Controls` as an `ASN1Object`.
`java.lang.String`	`toString()` Creates a text representation of the ASN.1 structure of this `Controls` object.

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

- Constructor Detail
  - Controls
```
public Controls()
```
    Creates a new Constructor that constains no controls
  - Controls
```
public Controls(AttributeTypeAndValue control)
```
    Creates a new Controls object that contains a single control.
    
    Parameters:
    control - a control
  - Controls
```
public Controls(ASN1Object obj)
         throws CodingException
```
    Creates a Controls object from an ASN1Object.
    
    Parameters:
    obj - the ASN.1 representation of a Controls structure
    
    Throws:
    
    CodingException - thrown if an errors occurs while decoding the ANS1Object
- Method Detail
  - getControl
```
public AttributeTypeAndValue getControl(ObjectID oid)
```
    Returns a particular control, specified by its object ID, if it exists in the Controls structure; otherwise null is returned. If the control is an unknown-control the object returned will be the parent object of all controls - AttributeTypeAndValue; otherwise the appropriate known-control object will be returned. For known-controls, casting is needed get the actual known-control class.
    RegToken regToken = (RegToken)myControls.getControl( RegToken.oid )
    
    Parameters:
    oid - the object ID of the control
  - getControls
```
public AttributeTypeAndValue[] getControls()
```
    Returns all the controls this object contains as an array of AttribyteTypeAndValue objects. The controls that are unknown-controls will be returned as AttributeTypeAndValue objects; known-controls will be returned as their appropriate control objects.
    
    Returns:
    an array containing all the controls
  - countControls
```
public int countControls()
```
    Returns the number of controls this object holds.
    
    Returns:
    the number of controls
  - addControl
```
public void addControl(AttributeTypeAndValue control)
```
    Adds the specified control. If the control is a known-control, it ensures that it has a valid 'value' based on the indicated 'type'.
    
    Parameters:
    control - the control to be added
  - decode
```
public void decode(ASN1Object obj)
            throws CodingException
```
    Decodes a Controls structure from an ASN1Object.
    
    Specified by:
    
    decode in interface ASN1Type
    
    Parameters:
    obj - an ASN.1 representation of a Controls structure
    
    Throws:
    
    CodingException - thrown if an errors occurs while decoding the ANS1Object
  - toASN1Object
```
public ASN1Object toASN1Object()
```
    Encodes this Controls as an ASN1Object.
    
    Specified by:
    
    toASN1Object in interface ASN1Type
    
    Returns:
    an ASN.1 representation of this object
  - toString
```
public java.lang.String toString()
```
    Creates a text representation of the ASN.1 structure of this Controls object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    a text representation of the ASN.1 structure of this object

Class Controls

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Controls

Controls

Controls

Method Detail

getControl

getControls

countControls

addControl

decode

toASN1Object

toString