com.netscape.cms.profile.output
Class EnrollOutput

java.lang.Object
  extended by com.netscape.cms.profile.output.EnrollOutput
All Implemented Interfaces:
IProfileOutput, IConfigTemplate
Direct Known Subclasses:
CertOutput, CMMFOutput, nsNKeyOutput, PKCS7Output

public abstract class EnrollOutput
extends java.lang.Object
implements IProfileOutput

This class implements the basic enrollment output.

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

Field Summary
protected  java.util.Vector mConfigNames
           
 
Constructor Summary
EnrollOutput()
           
 
Method Summary
 void addValueName(java.lang.String name)
           
 java.lang.String getConfig(java.lang.String name)
          Retrieves configuration parameter by name.
 IDescriptor getConfigDescriptor(java.util.Locale locale, java.lang.String name)
          Returns the descriptors of configuration parameter.
 java.util.Enumeration getConfigNames()
          Returns a list of configuration parameter names.
 IConfigStore getConfigStore()
          Retrieves configuration store.
 java.lang.String getDefaultConfig(java.lang.String name)
           
abstract  java.lang.String getName(java.util.Locale locale)
          Retrieves the localizable name of this policy.
abstract  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, IRequest request)
          Retrieves the value of the given value parameter by name.
abstract  IDescriptor getValueDescriptor(java.util.Locale locale, java.lang.String name)
          Retrieves the descriptor of the given value parameter by name.
 java.util.Enumeration getValueNames()
          Retrieves a list of names of the value parameter.
 void init(IProfile profile, IConfigStore config)
          Initializes this default policy.
abstract  void populate(IProfileContext ctx, IRequest request)
          Populates the request with this policy default.
 void setConfig(java.lang.String name, java.lang.String value)
          Sets configuration parameter.
 void setValue(java.lang.String name, java.util.Locale locale, IRequest request, java.lang.String value)
          Sets the value of the given value parameter by name.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

mConfigNames

protected java.util.Vector mConfigNames
Constructor Detail

EnrollOutput

public EnrollOutput()
Method Detail

init

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

Specified by:
init in interface IProfileOutput
Parameters:
profile - owner of this policy
config - configuration store
Throws:
EProfileException - failed to initialize

getConfigStore

public IConfigStore getConfigStore()
Description copied from interface: IProfileOutput
Retrieves configuration store.

Specified by:
getConfigStore in interface IProfileOutput
Returns:
configuration store

addValueName

public void addValueName(java.lang.String name)

populate

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

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

getValueDescriptor

public abstract 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 IProfileOutput
Parameters:
locale - user locale
name - property name
Returns:
property descriptor

getName

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

Specified by:
getName in interface IProfileOutput
Parameters:
locale - user locale
Returns:
output policy name

getText

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

Specified by:
getText in interface IProfileOutput
Parameters:
locale - user locale
Returns:
output policy description

getValueNames

public java.util.Enumeration getValueNames()
Retrieves a list of names of the value parameter.

Specified by:
getValueNames in interface IProfileOutput
Returns:
a list of property names

getValue

public java.lang.String getValue(java.lang.String name,
                                 java.util.Locale locale,
                                 IRequest request)
                          throws EProfileException
Description copied from interface: IProfileOutput
Retrieves the value of the given value parameter by name.

Specified by:
getValue in interface IProfileOutput
Parameters:
name - property name
locale - user locale
request - request
Returns:
property value
Throws:
EProfileException - failed to retrieve value

setValue

public void setValue(java.lang.String name,
                     java.util.Locale locale,
                     IRequest request,
                     java.lang.String value)
              throws EPropertyException
Sets the value of the given value parameter by name.

Specified by:
setValue in interface IProfileOutput
Parameters:
name - property name
locale - user locale
request - request
value - property value
Throws:
EPropertyException

getConfigNames

public java.util.Enumeration getConfigNames()
Description copied from interface: IConfigTemplate
Returns a list of configuration parameter names.

Specified by:
getConfigNames in interface IConfigTemplate
Returns:
parameter names

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
Parameters:
locale - user locale
name - configuration parameter name
Returns:
descriptor

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
Parameters:
name - parameter name
value - parameter value
Throws:
EPropertyException - failed to set parameter

getConfig

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

Specified by:
getConfig in interface IConfigTemplate
Returns:
parameter

getDefaultConfig

public java.lang.String getDefaultConfig(java.lang.String name)