Class EnrollInput

java.lang.Object
com.netscape.cms.profile.common.ProfileInput
com.netscape.cms.profile.input.EnrollInput
All Implemented Interfaces:
IConfigTemplate
Direct Known Subclasses:
CertReqInput, CMCCertReqInput, DualKeyGenInput, EncryptionKeyGenInput, FileSigningInput, GenericInput, ImageInput, KeyGenInput, nsHKeyCertReqInput, nsNKeyCertReqInput, SerialNumRenewInput, ServerKeygenInput, SigningKeyGenInput, SubjectAltNameExtInput, SubjectDNInput, SubjectNameInput, SubmitterInfoInput
public abstract class EnrollInput extends ProfileInput
This class implements the base enrollment input.
Version:
$Revision$, $Date$

  • Field Details

    • logger

      public static org.slf4j.Logger logger

    • mConfig

      protected IConfigStore mConfig

    • mValueNames

      protected Vector<String> mValueNames

    • mConfigNames

      protected Vector<String> mConfigNames

    • mProfile

      protected Profile mProfile

  • Constructor Details

    • EnrollInput

      public EnrollInput()

  • Method Details

    • init

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

    • getConfigStore

      public IConfigStore getConfigStore()
      Description copied from class: ProfileInput
      Returns configuration store.
      Specified by:
      getConfigStore in class ProfileInput
      Returns:
      configuration store

    • populate

      public abstract void populate(Map<String,String> ctx, IRequest request) throws Exception
      Populates the request with this policy default.
      Specified by:
      populate in class ProfileInput
      Parameters:
      ctx - profile context
      request - request
      Throws:
      Exception - failed to populate

    • getName

      public abstract String getName(Locale locale)
      Retrieves the localizable name of this policy.
      Specified by:
      getName in class ProfileInput
      Parameters:
      locale - user locale
      Returns:
      localized input name

    • getText

      public abstract String getText(Locale locale)
      Retrieves the localizable description of this policy.
      Specified by:
      getText in class ProfileInput
      Parameters:
      locale - user locale
      Returns:
      localized input description

    • getValueDescriptor

      public abstract IDescriptor getValueDescriptor(Locale locale, String name)
      Retrieves the descriptor of the given value property by name.
      Specified by:
      getValueDescriptor in class ProfileInput
      Parameters:
      locale - user locale
      name - property name
      Returns:
      descriptor of the property

    • addValueName

      public void addValueName(String name)

    • getValueNames

      public Enumeration<String> getValueNames()
      Retrieves a list of names of the value parameter.
      Specified by:
      getValueNames in class ProfileInput
      Returns:
      a list of property names

    • addConfigName

      public void addConfigName(String name)

    • getConfigNames

      public Enumeration<String> getConfigNames()
      Description copied from interface: IConfigTemplate
      Returns a list of configuration parameter names.
      Returns:
      parameter names

    • setConfig

      public void setConfig(String name, String value) throws EPropertyException
      Description copied from interface: IConfigTemplate
      Sets configuration parameter.
      Parameters:
      name - parameter name
      value - parameter value
      Throws:
      EPropertyException - failed to set parameter

    • getConfig

      public String getConfig(String name)
      Description copied from interface: IConfigTemplate
      Retrieves configuration parameter by name.
      Returns:
      parameter

    • getDefaultConfig

      public String getDefaultConfig(String name)

    • getValue

      public String getValue(String name, Locale locale, IRequest request) throws EProfileException
      Description copied from class: ProfileInput
      Retrieves value from the request.
      Specified by:
      getValue in class ProfileInput
      Parameters:
      name - property name
      locale - user locale
      request - request
      Throws:
      EProfileException - failed to get value

    • setValue

      public void setValue(String name, Locale locale, IRequest request, String value) throws EPropertyException
      Sets the value of the given value parameter by name.
      Specified by:
      setValue in class ProfileInput
      Parameters:
      name - property name
      locale - user locale
      request - request
      value - value
      Throws:
      EPropertyException

    • getLocale

      public Locale getLocale(IRequest request)

    • getConfigDescriptor

      public IDescriptor getConfigDescriptor(Locale locale, String name)
      Description copied from interface: IConfigTemplate
      Returns the descriptors of configuration parameter.
      Parameters:
      locale - user locale
      name - configuration parameter name
      Returns:
      descriptor

    • verifyPOP

      public void verifyPOP(Locale locale, org.mozilla.jss.pkix.crmf.CertReqMsg certReqMsg) throws EProfileException
      Throws:
      EProfileException

    • auditSubjectID

      protected String auditSubjectID()
      Signed Audit Log Subject ID This method is inherited by all extended "CMSServlet"s, and is called to obtain the "SubjectID" for a signed audit log message.

      Returns:
      id string containing the signed audit log message SubjectID