Class EnrollOutput

java.lang.Object

com.netscape.cms.profile.common.ProfileOutput

com.netscape.cms.profile.output.EnrollOutput

All Implemented Interfaces:

IConfigTemplate

Direct Known Subclasses:

CertOutput, nsNKeyOutput, PKCS12Output

public abstract class EnrollOutput
extends ProfileOutput

This class implements the basic enrollment output.

Version:

$Revision$, $Date$

Field Summary

Fields

Modifier and Type	Field	Description
protected Vector<String>	mConfigNames

Constructor Summary

Constructors

Constructor	Description
EnrollOutput()

Method Summary

Modifier and Type	Method	Description
void	addValueName(String name)
String	getConfig(String name)	Retrieves configuration parameter by name.
IDescriptor	getConfigDescriptor(Locale locale, String name)	Returns the descriptors of configuration parameter.
Enumeration<String>	getConfigNames()	Returns a list of configuration parameter names.
IConfigStore	getConfigStore()	Retrieves configuration store.
String	getDefaultConfig(String name)
abstract String	getName(Locale locale)	Retrieves the localizable name of this policy.
abstract String	getText(Locale locale)	Retrieves the localizable description of this policy.
String	getValue(String name, Locale locale, IRequest request)	Retrieves the value of the given value parameter by name.
abstract IDescriptor	getValueDescriptor(Locale locale, String name)	Retrieves the descriptor of the given value parameter by name.
Enumeration<String>	getValueNames()	Retrieves a list of names of the value parameter.
void	init(IConfigStore config)	Initializes this default policy.
abstract void	populate(Map<String,String> ctx, IRequest request)	Populates the request with this policy default.
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.

Methods inherited from class java.lang.Object

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

Field Details

mConfigNames

protected Vector<String> mConfigNames

Constructor Details

EnrollOutput

public EnrollOutput()

Method Details

init

public void init(IConfigStore config)
          throws EProfileException

Initializes this default policy.

Specified by:

init in class ProfileOutput

Parameters:

config - configuration store

Throws:

EProfileException - failed to initialize

getConfigStore

public IConfigStore getConfigStore()

Description copied from class: ProfileOutput

Retrieves configuration store.

Specified by:

getConfigStore in class ProfileOutput

Returns:

configuration store

addValueName

public void addValueName(String name)

populate

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

Populates the request with this policy default.

Specified by:

populate in class ProfileOutput

Parameters:

ctx - profile context

request - request

Throws:

EProfileException - failed to populate

getValueDescriptor

public abstract IDescriptor getValueDescriptor(Locale locale,
 String name)

Retrieves the descriptor of the given value parameter by name.

Specified by:

getValueDescriptor in class ProfileOutput

Parameters:

locale - user locale

name - property name

Returns:

property descriptor

getName

public abstract String getName(Locale locale)

Retrieves the localizable name of this policy.

Specified by:

getName in class ProfileOutput

Parameters:

locale - user locale

Returns:

output policy name

getText

public abstract String getText(Locale locale)

Retrieves the localizable description of this policy.

Specified by:

getText in class ProfileOutput

Parameters:

locale - user locale

Returns:

output policy description

getValueNames

public Enumeration<String> getValueNames()

Retrieves a list of names of the value parameter.

Specified by:

getValueNames in class ProfileOutput

Returns:

a list of property names

getValue

public String getValue(String name,
 Locale locale,
 IRequest request)
                throws EProfileException

Description copied from class: ProfileOutput

Retrieves the value of the given value parameter by name.

Specified by:

getValue in class ProfileOutput

Parameters:

name - property name

locale - user locale

request - request

Returns:

property value

Throws:

EProfileException - failed to retrieve 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 ProfileOutput

Parameters:

name - property name

locale - user locale

request - request

value - property value

Throws:

EPropertyException

getConfigNames

public Enumeration<String> getConfigNames()

Description copied from interface: IConfigTemplate

Returns a list of configuration parameter names.

Returns:

parameter names

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

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)