Class GenericInput

java.lang.Object

com.netscape.cms.profile.common.ProfileInput

com.netscape.cms.profile.input.EnrollInput

com.netscape.cms.profile.input.GenericInput

All Implemented Interfaces:

IConfigTemplate

public class GenericInput
extends EnrollInput

This class implements a generic input.

Version:

$Revision$, $Date$

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_DISPLAY_NAME
static final String	CONFIG_ENABLE
static final String	CONFIG_NUM
static final String	CONFIG_PARAM_NAME
static final int	DEF_NUM

Fields inherited from class EnrollInput

logger, mConfig, mConfigNames, mProfile, mValueNames

Modifier and Type	Field	Description
static org.slf4j.Logger	logger
protected IConfigStore	mConfig
protected Vector<String>	mConfigNames
protected Profile	mProfile
protected Vector<String>	mValueNames

Constructor Summary

Constructors

Constructor	Description
GenericInput()

Method Summary

Modifier and Type	Method	Description
IDescriptor	getConfigDescriptor(Locale locale, String name)	Returns the descriptors of configuration parameter.
String	getName(Locale locale)	Retrieves the localizable name of this policy.
protected int	getNum()
String	getText(Locale locale)	Retrieves the localizable description of this policy.
IDescriptor	getValueDescriptor(Locale locale, String name)	Retrieves the descriptor of the given value parameter by name.
Enumeration<String>	getValueNames()	Returns selected value names based on the configuration.
void	init(Profile profile, IConfigStore config)	Initializes this default policy.
void	populate(Map<String,String> ctx, IRequest request)	Populates the request with this policy default.

Methods inherited from class EnrollInput

addConfigName, addValueName, auditSubjectID, getConfig, getConfigNames, getConfigStore, getDefaultConfig, getLocale, getValue, setConfig, setValue, verifyPOP

Modifier and Type	Method	Description
void	addConfigName(String name)
void	addValueName(String name)
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.
String	getConfig(String name)	Retrieves configuration parameter by name.
Enumeration<String>	getConfigNames()	Returns a list of configuration parameter names.
IConfigStore	getConfigStore()	Returns configuration store.
String	getDefaultConfig(String name)
Locale	getLocale(IRequest request)
String	getValue(String name, Locale locale, IRequest request)	Retrieves value from the request.
void	setConfig(String name, String value)	Sets configuration parameter.
void	setValue(String name, Locale locale, IRequest request, String value)	Sets the value of the given value parameter by name.
void	verifyPOP(Locale locale, org.mozilla.jss.pkix.crmf.CertReqMsg certReqMsg)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CONFIG_NUM

public static final String CONFIG_NUM

See Also:

• Constant Field Values

CONFIG_DISPLAY_NAME

public static final String CONFIG_DISPLAY_NAME

See Also:

• Constant Field Values

CONFIG_PARAM_NAME

public static final String CONFIG_PARAM_NAME

See Also:

• Constant Field Values

CONFIG_ENABLE

public static final String CONFIG_ENABLE

See Also:

• Constant Field Values

DEF_NUM

public static final int DEF_NUM

See Also:

• Constant Field Values

Constructor Details

GenericInput

public GenericInput()

Method Details

getNum

protected int getNum()

init

public void init(Profile profile,
 IConfigStore config)
          throws EProfileException

Initializes this default policy.

Overrides:

init in class EnrollInput

Throws:

EProfileException

getName

public String getName(Locale locale)

Retrieves the localizable name of this policy.

Specified by:

getName in class EnrollInput

Parameters:

locale - user locale

Returns:

localized input name

getText

public String getText(Locale locale)

Retrieves the localizable description of this policy.

Specified by:

getText in class EnrollInput

Parameters:

locale - user locale

Returns:

localized input description

getValueNames

public Enumeration<String> getValueNames()

Returns selected value names based on the configuration.

Overrides:

getValueNames in class EnrollInput

Returns:

a list of property names

populate

public void populate(Map<String,String> ctx,
 IRequest request)
              throws Exception

Populates the request with this policy default.

Specified by:

populate in class EnrollInput

Parameters:

ctx - profile context

request - request

Throws:

Exception - failed to populate

getConfigDescriptor

public IDescriptor getConfigDescriptor(Locale locale,
 String name)

Description copied from interface: IConfigTemplate

Returns the descriptors of configuration parameter.

Specified by:

getConfigDescriptor in interface IConfigTemplate

Overrides:

getConfigDescriptor in class EnrollInput

Parameters:

locale - user locale

name - configuration parameter name

Returns:

descriptor

getValueDescriptor

public IDescriptor getValueDescriptor(Locale locale,
 String name)

Retrieves the descriptor of the given value parameter by name.

Specified by:

getValueDescriptor in class EnrollInput

Parameters:

locale - user locale

name - property name

Returns:

descriptor of the property