com.netscape.cms.profile.input
Class KeyGenInput

java.lang.Object
  extended by com.netscape.cms.profile.input.EnrollInput
      extended by com.netscape.cms.profile.input.KeyGenInput
All Implemented Interfaces:
IProfileInput, IConfigTemplate

public class KeyGenInput
extends EnrollInput
implements IProfileInput

This class implements the key generation input that populates parameters to the enrollment page for key generation.

This input normally is used with user-based or non certificate request profile.

Version:
$Revision: 1211 $, $Date: 2010-08-18 10:15:37 -0700 (Wed, 18 Aug 2010) $

Field Summary
 EnrollProfile mEnrollProfile
           
static java.lang.String VAL_KEYGEN_REQUEST
           
static java.lang.String VAL_KEYGEN_REQUEST_TYPE
           
 
Fields inherited from class com.netscape.cms.profile.input.EnrollInput
mConfig, mConfigNames, mProfile, mSignedAuditLogger, mValueNames
 
Constructor Summary
KeyGenInput()
           
 
Method Summary
 java.lang.String getName(java.util.Locale locale)
          Retrieves the localizable name of this policy.
 java.lang.String getText(java.util.Locale locale)
          Retrieves the localizable description of this policy.
 IDescriptor getValueDescriptor(java.util.Locale locale, java.lang.String name)
          Retrieves the descriptor of the given value parameter by name.
 void init(IProfile profile, IConfigStore config)
          Initializes this default policy.
 void populate(IProfileContext ctx, IRequest request)
          Populates the request with this policy default.
 
Methods inherited from class com.netscape.cms.profile.input.EnrollInput
addConfigName, addValueName, audit, auditSubjectID, getConfig, getConfigDescriptor, getConfigNames, getConfigStore, getDefaultConfig, getLocale, getValue, getValueNames, setConfig, setValue, verifyPOP
 
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.profile.IProfileInput
getConfigStore, getValue, getValueNames, setValue
 
Methods inherited from interface com.netscape.certsrv.property.IConfigTemplate
getConfig, getConfigDescriptor, getConfigNames, setConfig
 

Field Detail

VAL_KEYGEN_REQUEST_TYPE

public static final java.lang.String VAL_KEYGEN_REQUEST_TYPE
See Also:
Constant Field Values

VAL_KEYGEN_REQUEST

public static final java.lang.String VAL_KEYGEN_REQUEST
See Also:
Constant Field Values

mEnrollProfile

public EnrollProfile mEnrollProfile
Constructor Detail

KeyGenInput

public KeyGenInput()
Method Detail

init

public void init(IProfile profile,
                 IConfigStore config)
          throws EProfileException
Initializes this default policy.

Specified by:
init in interface IProfileInput
Overrides:
init in class EnrollInput
Parameters:
profile - owner of this input
config - configuration store
Throws:
EProfileException - failed to initialize

getName

public java.lang.String getName(java.util.Locale locale)
Retrieves the localizable name of this policy.

Specified by:
getName in interface IProfileInput
Specified by:
getName in class EnrollInput
Parameters:
locale - user locale
Returns:
localized input name

getText

public java.lang.String getText(java.util.Locale locale)
Retrieves the localizable description of this policy.

Specified by:
getText in interface IProfileInput
Specified by:
getText in class EnrollInput
Parameters:
locale - user locale
Returns:
localized input description

populate

public void populate(IProfileContext ctx,
                     IRequest request)
              throws EProfileException
Populates the request with this policy default.

Specified by:
populate in interface IProfileInput
Specified by:
populate in class EnrollInput
Parameters:
ctx - profile context
request - request
Throws:
EProfileException - failed to populate

getValueDescriptor

public IDescriptor getValueDescriptor(java.util.Locale locale,
                                      java.lang.String name)
Retrieves the descriptor of the given value parameter by name.

Specified by:
getValueDescriptor in interface IProfileInput
Specified by:
getValueDescriptor in class EnrollInput
Parameters:
locale - user locale
name - property name
Returns:
descriptor of the property