java.lang.Object
- com.netscape.cms.profile.def.PolicyDefault
- - com.netscape.cms.profile.def.EnrollDefault
  - - com.netscape.cms.profile.def.UserKeyDefault

All Implemented Interfaces:

IConfigTemplate
```
public class UserKeyDefault
extends EnrollDefault
```
This class implements an enrollment default policy that populates a user supplied key into the certificate template.

Version:

$Revision$, $Date$

Field Summary

Fields
Modifier and Type Field Description

static org.slf4j.Logger logger

static java.lang.String VAL_KEY

static java.lang.String VAL_LEN

static java.lang.String VAL_TYPE
- Fields inherited from class com.netscape.cms.profile.def.EnrollDefault
  GN_ANY_NAME, GN_DIRECTORY_NAME, GN_DNS_NAME, GN_EDI_NAME, GN_IP_NAME, GN_OID_NAME, GN_RFC822_NAME, GN_URI_NAME, mConfig, mConfigNames, mValueNames, PROP_NAME

Constructor Summary

Constructors
Constructor Description

UserKeyDefault()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getDSAKeyLen(org.mozilla.jss.netscape.security.x509.X509Key key)`
`int`	`getRSAKeyLen(org.mozilla.jss.netscape.security.x509.X509Key key)`
`java.lang.String`	`getText(java.util.Locale locale)`	Retrieves the localizable description of this policy.
`java.lang.String`	`getValue(java.lang.String name, java.util.Locale locale, org.mozilla.jss.netscape.security.x509.X509CertInfo info)`	Retrieves certificate template values and returns them to the approval page.
`IDescriptor`	`getValueDescriptor(java.util.Locale locale, java.lang.String name)`	Retrieves the descriptor of the given property by name.
`void`	`populate(IRequest request, org.mozilla.jss.netscape.security.x509.X509CertInfo info)`	Populates the request with this policy default.
`void`	`setValue(java.lang.String name, java.util.Locale locale, org.mozilla.jss.netscape.security.x509.X509CertInfo info, java.lang.String value)`	Sets values from the approval page into certificate template.

Methods inherited from class com.netscape.cms.profile.def.EnrollDefault
addConfigName, addExtension, addValueName, buildRecords, deleteExtension, getBoolean, getBytes, getConfig, getConfig, getConfigBoolean, getConfigDescriptor, getConfigInt, getConfigNames, getConfigStore, getExtension, getExtension, getGeneralNameType, getGeneralNameValue, getInt, getLocale, getName, getValue, getValueDescriptor, getValueNames, init, isGeneralNameType, isGeneralNameValid, isOptional, isValidOID, mapPattern, parseGeneralName, parseGeneralName, parseRecords, populate, refreshConfigAndValueNames, replaceExtension, setConfig, setValue, toGeneralNameString, toHexString

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

- Field Detail
  - logger
```
public static org.slf4j.Logger logger
```
  - VAL_KEY
```
public static final java.lang.String VAL_KEY
```
    See Also:
    
    Constant Field Values
  - VAL_LEN
```
public static final java.lang.String VAL_LEN
```
    See Also:
    
    Constant Field Values
  - VAL_TYPE
```
public static final java.lang.String VAL_TYPE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - UserKeyDefault
```
public UserKeyDefault()
```
- Method Detail
  - getValueDescriptor
```
public IDescriptor getValueDescriptor(java.util.Locale locale,
                                      java.lang.String name)
```
    Description copied from class: PolicyDefault
    
    Retrieves the descriptor of the given property by name. The descriptor contains syntax information.
    
    Specified by:
    
    getValueDescriptor in class PolicyDefault
    
    Parameters:
    
    locale - locale of the end user
    
    name - name of property
    
    Returns:
    
    descriptor of the property
  - setValue
```
public void setValue(java.lang.String name,
                     java.util.Locale locale,
                     org.mozilla.jss.netscape.security.x509.X509CertInfo info,
                     java.lang.String value)
              throws EPropertyException
```
    Description copied from class: EnrollDefault
    
    Sets values from the approval page into certificate template.
    
    Specified by:
    
    setValue in class EnrollDefault
    
    Parameters:
    
    name - name of the attribute
    
    locale - user locale
    
    info - certificate template
    
    value - attribute value
    
    Throws:
    
    EPropertyException
  - getValue
```
public java.lang.String getValue(java.lang.String name,
                                 java.util.Locale locale,
                                 org.mozilla.jss.netscape.security.x509.X509CertInfo info)
                          throws EPropertyException
```
    Description copied from class: EnrollDefault
    
    Retrieves certificate template values and returns them to the approval page.
    
    Specified by:
    
    getValue in class EnrollDefault
    
    Parameters:
    
    name - name of the attribute
    
    locale - user locale
    
    info - certificate template
    
    Throws:
    
    EPropertyException
  - getText
```
public java.lang.String getText(java.util.Locale locale)
```
    Description copied from class: EnrollDefault
    
    Retrieves the localizable description of this policy.
    
    Specified by:
    
    getText in class EnrollDefault
    
    Parameters:
    
    locale - locale of the end user
    
    Returns:
    
    localized description of this default policy
  - getRSAKeyLen
```
public int getRSAKeyLen(org.mozilla.jss.netscape.security.x509.X509Key key)
                 throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - getDSAKeyLen
```
public int getDSAKeyLen(org.mozilla.jss.netscape.security.x509.X509Key key)
                 throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - populate
```
public void populate(IRequest request,
                     org.mozilla.jss.netscape.security.x509.X509CertInfo info)
              throws EProfileException
```
    Populates the request with this policy default.
    
    Specified by:
    
    populate in class EnrollDefault
    
    Parameters:
    
    request - enrollment request
    
    info - certificate template
    
    Throws:
    
    EProfileException - failed to populate attributes into request

Modifier and Type	Field	Description
`static org.slf4j.Logger`	`logger`
`static java.lang.String`	`VAL_KEY`
`static java.lang.String`	`VAL_LEN`
`static java.lang.String`	`VAL_TYPE`

Class UserKeyDefault

Field Summary

Fields inherited from class com.netscape.cms.profile.def.EnrollDefault

Constructor Summary

Method Summary

Methods inherited from class com.netscape.cms.profile.def.EnrollDefault

Methods inherited from class java.lang.Object

Field Detail

logger

VAL_KEY

VAL_LEN

VAL_TYPE

Constructor Detail

UserKeyDefault

Method Detail

getValueDescriptor

setValue

getValue

getText

getRSAKeyLen

getDSAKeyLen

populate