java.lang.Object
- com.netscape.cms.profile.constraint.EnrollConstraint
- - com.netscape.cms.profile.constraint.KeyConstraint

All Implemented Interfaces:

IPolicyConstraint, IConfigTemplate
```
public class KeyConstraint
extends EnrollConstraint
```
This constraint is to check the key type and key length.

Version:

$Revision$, $Date$

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String CONFIG_KEY_PARAMETERS

static java.lang.String CONFIG_KEY_TYPE
- Fields inherited from class com.netscape.cms.profile.constraint.EnrollConstraint
  CONFIG_NAME, CONFIG_PARAMS, mConfig, mConfigNames

Constructor Summary

Constructors
Constructor Description

KeyConstraint()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`IDescriptor`	`getConfigDescriptor(java.util.Locale locale, java.lang.String name)`	Returns the descriptors of configuration parameter.
`int`	`getDSAKeyLen(X509Key key)`
`int`	`getRSAKeyLen(X509Key key)`
`java.lang.String`	`getText(java.util.Locale locale)`	Returns localized description of this constraint.
`void`	`init(IProfile profile, IConfigStore config)`	Initializes this constraint policy.
`boolean`	`isApplicable(IPolicyDefault def)`	Checks if this constraint is applicable to the given default policy.
`void`	`setConfig(java.lang.String name, java.lang.String value)`	Sets configuration parameter.
`void`	`validate(IRequest request, X509CertInfo info)`	Validates the request.

Methods inherited from class com.netscape.cms.profile.constraint.EnrollConstraint
addConfigName, getBoolean, getConfig, getConfig, getConfigBoolean, getConfigInt, getConfigNames, getConfigStore, getExtension, getInt, getLocale, getName, getValueDescriptor, isOptional, validate

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

- Field Detail
  - CONFIG_KEY_TYPE
```
public static final java.lang.String CONFIG_KEY_TYPE
```
    See Also:
    
    Constant Field Values
  - CONFIG_KEY_PARAMETERS
```
public static final java.lang.String CONFIG_KEY_PARAMETERS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - KeyConstraint
```
public KeyConstraint()
```
- Method Detail
  - init
```
public void init(IProfile profile,
                 IConfigStore config)
          throws EProfileException
```
    Description copied from interface: IPolicyConstraint
    
    Initializes this constraint policy.
    
    Specified by:
    
    init in interface IPolicyConstraint
    
    Overrides:
    
    init in class EnrollConstraint
    
    Parameters:
    
    profile - owner of this policy
    
    config - configuration store for this constraint
    
    Throws:
    
    EProfileException - failed to initialize
  - getConfigDescriptor
```
public IDescriptor getConfigDescriptor(java.util.Locale locale,
                                       java.lang.String name)
```
    Description copied from interface: IConfigTemplate
    
    Returns the descriptors of configuration parameter.
    
    Specified by:
    
    getConfigDescriptor in interface IConfigTemplate
    
    Overrides:
    
    getConfigDescriptor in class EnrollConstraint
    
    Parameters:
    
    locale - user locale
    
    name - configuration parameter name
    
    Returns:
    
    descriptor
  - validate
```
public void validate(IRequest request,
                     X509CertInfo info)
              throws ERejectException
```
    Validates the request. The request is not modified during the validation.
    
    Specified by:
    
    validate in class EnrollConstraint
    
    Parameters:
    
    request - enrollment request
    
    info - certificate template
    
    Throws:
    
    ERejectException - request is rejected due to violation of constraint
  - getRSAKeyLen
```
public int getRSAKeyLen(X509Key key)
                 throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - getDSAKeyLen
```
public int getDSAKeyLen(X509Key key)
                 throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - getText
```
public java.lang.String getText(java.util.Locale locale)
```
    Description copied from interface: IPolicyConstraint
    
    Returns localized description of this constraint.
    
    Specified by:
    
    getText in interface IPolicyConstraint
    
    Overrides:
    
    getText in class EnrollConstraint
    
    Parameters:
    
    locale - locale of the end-user
    
    Returns:
    
    localized description of this constraint
  - isApplicable
```
public boolean isApplicable(IPolicyDefault def)
```
    Description copied from interface: IPolicyConstraint
    
    Checks if this constraint is applicable to the given default policy.
    
    Specified by:
    
    isApplicable in interface IPolicyConstraint
    
    Overrides:
    
    isApplicable in class EnrollConstraint
    
    Parameters:
    
    def - default policy to be checked
    
    Returns:
    
    true if this constraint can be applied to the given default policy
  - setConfig
```
public void setConfig(java.lang.String name,
                      java.lang.String value)
               throws EPropertyException
```
    Description copied from interface: IConfigTemplate
    
    Sets configuration parameter.
    
    Specified by:
    
    setConfig in interface IConfigTemplate
    
    Overrides:
    
    setConfig in class EnrollConstraint
    
    Parameters:
    
    name - parameter name
    
    value - parameter value
    
    Throws:
    
    EPropertyException - failed to set parameter

Modifier and Type	Field	Description
`static java.lang.String`	`CONFIG_KEY_PARAMETERS`
`static java.lang.String`	`CONFIG_KEY_TYPE`

Class KeyConstraint

Field Summary

Fields inherited from class com.netscape.cms.profile.constraint.EnrollConstraint

Constructor Summary

Method Summary

Methods inherited from class com.netscape.cms.profile.constraint.EnrollConstraint

Methods inherited from class java.lang.Object

Field Detail

CONFIG_KEY_TYPE

CONFIG_KEY_PARAMETERS

Constructor Detail

KeyConstraint

Method Detail

init

getConfigDescriptor

validate

getRSAKeyLen

getDSAKeyLen

getText

isApplicable

setConfig