AuthInfoAccessExt (pki-javadoc)

java.lang.Object
- com.netscape.cms.policy.APolicyRule
- - com.netscape.cms.policy.extensions.AuthInfoAccessExt

All Implemented Interfaces:

IExtendedPluginInfo, IEnrollmentPolicy, IPolicyRule, IPolicy

Deprecated.
```
public class AuthInfoAccessExt
extends APolicyRule
implements IEnrollmentPolicy, IExtendedPluginInfo
```
Authority Information Access extension policy. If this policy is enabled, it adds an authority information access extension to the certificate. The following listed sample configuration parameters: ca.Policy.impl.AuthInfoAccess.class=com.netscape.certsrv.policy.AuthInfoAccessExt ca.Policy.rule.aia.ad0_location=uriName:http://ocsp1.netscape.com ca.Policy.rule.aia.ad0_method=ocsp ca.Policy.rule.aia.ad1_location_type=URI ca.Policy.rule.aia.ad1_location=http://ocsp2.netscape.com ca.Policy.rule.aia.ad1_method=ocsp ca.Policy.rule.aia.ad2_location= ca.Policy.rule.aia.ad2_method= ca.Policy.rule.aia.ad3_location= ca.Policy.rule.aia.ad3_method= ca.Policy.rule.aia.ad4_location= ca.Policy.rule.aia.ad4_method= ca.Policy.rule.aia.critical=true ca.Policy.rule.aia.enable=true ca.Policy.rule.aia.implName=AuthInfoAccess ca.Policy.rule.aia.predicate= Currently, this policy only supports the following location: uriName:[URI], dirName:[DN]
```
 NOTE:  The Policy Framework has been replaced by the Profile Framework.
 
```
Version:

$Revision$, $Date$

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`MAX_AD` Deprecated.
`IConfigStore`	`mConfig` Deprecated.
`protected static java.lang.String`	`PROP_AD` Deprecated.
`protected static java.lang.String`	`PROP_CRITICAL` Deprecated.
`protected static java.lang.String`	`PROP_LOCATION` Deprecated.
`protected static java.lang.String`	`PROP_LOCATION_TYPE` Deprecated.
`protected static java.lang.String`	`PROP_METHOD` Deprecated.
`protected static java.lang.String`	`PROP_NUM_ADS` Deprecated.

Fields inherited from class com.netscape.cms.policy.APolicyRule
DESC, mFilterExp, mInstanceName, mLogger, NAME

Fields inherited from interface com.netscape.certsrv.policy.IPolicyRule
PROP_ENABLE, PROP_IMPLNAME, PROP_PREDICATE

Fields inherited from interface com.netscape.certsrv.base.IExtendedPluginInfo
HELP_TEXT, HELP_TOKEN

Constructor Summary

Constructors
Constructor and Description

AuthInfoAccessExt()
Deprecated.

Constructors
Constructor and Description
`AuthInfoAccessExt()` Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`PolicyResult`	`apply(IRequest req)` Deprecated. If this policy is enabled, add the authority information access extension to the certificate.
`java.util.Vector<java.lang.String>`	`getDefaultParams()` Deprecated. Return default parameters for a policy implementation.
`java.lang.String[]`	`getExtendedPluginInfo(java.util.Locale locale)` Deprecated. This method returns an array of strings.
`java.util.Vector<java.lang.String>`	`getInstanceParams()` Deprecated. Return configured parameters for a policy rule instance.
`void`	`init(ISubsystem owner, IConfigStore config)` Deprecated. Initializes this policy rule.

Methods inherited from class com.netscape.cms.policy.APolicyRule
agentApproved, createKeyIdentifier, deferred, formSHA1KeyId, formSpkiSHA1KeyId, getDescription, getInstanceName, getName, getPredicate, log, setError, setError, setError, setInstanceName, setPolicyException, setPolicyException, setPredicate

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

Methods inherited from interface com.netscape.certsrv.policy.IPolicyRule
getDescription, getInstanceName, getName, getPredicate, setError, setInstanceName, setPolicyException, setPredicate

- Field Detail
  - PROP_CRITICAL
```
protected static final java.lang.String PROP_CRITICAL
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - PROP_AD
```
protected static final java.lang.String PROP_AD
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - PROP_METHOD
```
protected static final java.lang.String PROP_METHOD
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - PROP_LOCATION
```
protected static final java.lang.String PROP_LOCATION
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - PROP_LOCATION_TYPE
```
protected static final java.lang.String PROP_LOCATION_TYPE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - PROP_NUM_ADS
```
protected static final java.lang.String PROP_NUM_ADS
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - MAX_AD
```
public static final int MAX_AD
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - mConfig
```
public IConfigStore mConfig
```
    Deprecated.
- Constructor Detail
  - AuthInfoAccessExt
```
public AuthInfoAccessExt()
```
    Deprecated.
- Method Detail
  - getExtendedPluginInfo
```
public java.lang.String[] getExtendedPluginInfo(java.util.Locale locale)
```
    Deprecated.
    
    Description copied from interface: IExtendedPluginInfo
    
    This method returns an array of strings. Each element of the array represents a configurable parameter, or some other meta-info (such as help-token) there is an entry indexed on that parameter name ;[,required];;... Where: type_info is either 'string', 'number', 'boolean', 'password' or 'choice(ch1,ch2,ch3,...)' If the marker 'required' is included after the type_info, the parameter will has some visually distinctive marking in the UI. 'description' is a short sentence describing the parameter 'choice' is rendered as a drop-down list. The first parameter in the list will be activated by default 'boolean' is rendered as a checkbox. The resulting parameter will be either 'true' or 'false' 'string' allows any characters 'number' allows only numbers 'password' is rendered as a password field (the characters are replaced with *'s when being types. This parameter is not passed through to the plugin. It is instead inserted directly into the password cache keyed on the instance name. The value of the parameter 'bindPWPrompt' (see example below) is set to the key. In addition to the configurable parameters, the following magic parameters may be defined: HELP_TOKEN;helptoken - a pointer to the online manual section for this plugin HELP_TEXT;helptext - a general help string describing the plugin For example: "username;string;The username you wish to login as" "bindPWPrompt;password;Enter password to bind as above user with" "algorithm;choice(RSA,DSA);Which algorithm do you want to use" "enable;boolean;Do you want to run this plugin" "port;number;Which port number do you want to use"
    
    Specified by:
    
    getExtendedPluginInfo in interface IExtendedPluginInfo
  - init
```
public void init(ISubsystem owner,
                 IConfigStore config)
          throws EBaseException
```
    Deprecated.
    
    Initializes this policy rule.
    The entries may be of the form: ca.Policy.rule..implName=AuthInfoAccessExt ca.Policy.rule..enable=true ca.Policy.rule..predicate=
    
    Specified by:
    
    init in interface IPolicyRule
    
    Specified by:
    
    init in class APolicyRule
    
    Parameters:
    
    config - The config store reference
    
    Throws:
    
    EBaseException
  - apply
```
public PolicyResult apply(IRequest req)
```
    Deprecated.
    
    If this policy is enabled, add the authority information access extension to the certificate.
    
    Specified by:
    
    apply in interface IPolicyRule
    
    Specified by:
    
    apply in interface IPolicy
    
    Specified by:
    
    apply in class APolicyRule
    
    Parameters:
    
    req - The request on which to apply policy.
    
    Returns:
    
    The policy result object.
  - getInstanceParams
```
public java.util.Vector<java.lang.String> getInstanceParams()
```
    Deprecated.
    
    Return configured parameters for a policy rule instance.
    
    Specified by:
    
    getInstanceParams in interface IPolicyRule
    
    Specified by:
    
    getInstanceParams in class APolicyRule
    
    Returns:
    
    nvPairs A Vector of name/value pairs.
  - getDefaultParams
```
public java.util.Vector<java.lang.String> getDefaultParams()
```
    Deprecated.
    
    Return default parameters for a policy implementation.
    
    Specified by:
    
    getDefaultParams in interface IPolicyRule
    
    Specified by:
    
    getDefaultParams in class APolicyRule
    
    Returns:
    
    nvPairs A Vector of name/value pairs.

Class AuthInfoAccessExt

Field Summary

Fields inherited from class com.netscape.cms.policy.APolicyRule

Fields inherited from interface com.netscape.certsrv.policy.IPolicyRule

Fields inherited from interface com.netscape.certsrv.base.IExtendedPluginInfo

Constructor Summary

Method Summary

Methods inherited from class com.netscape.cms.policy.APolicyRule

Methods inherited from class java.lang.Object

Methods inherited from interface com.netscape.certsrv.policy.IPolicyRule

Field Detail

PROP_CRITICAL

PROP_AD

PROP_METHOD

PROP_LOCATION

PROP_LOCATION_TYPE

PROP_NUM_ADS

MAX_AD

mConfig

Constructor Detail

AuthInfoAccessExt

Method Detail

getExtendedPluginInfo

init

apply

getInstanceParams

getDefaultParams