Package com.netscape.cms.profile.output
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
,CMMFOutput
,nsNKeyOutput
,PKCS12Output
,PKCS7Output
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 java.util.Vector<java.lang.String>
mConfigNames
-
Constructor Summary
Constructors Constructor Description EnrollOutput()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description 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<java.lang.String>
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<java.lang.String>
getValueNames()
Retrieves a list of names of the value parameter.void
init(IConfigStore config)
Initializes this default policy.abstract void
populate(java.util.Map<java.lang.String,java.lang.String> 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.
-
-
-
Method Detail
-
init
public void init(IConfigStore config) throws EProfileException
Initializes this default policy.- Specified by:
init
in classProfileOutput
- 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 classProfileOutput
- Returns:
- configuration store
-
addValueName
public void addValueName(java.lang.String name)
-
populate
public abstract void populate(java.util.Map<java.lang.String,java.lang.String> ctx, IRequest request) throws EProfileException
Populates the request with this policy default.- Specified by:
populate
in classProfileOutput
- Parameters:
ctx
- profile contextrequest
- 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 classProfileOutput
- Parameters:
locale
- user localename
- 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 classProfileOutput
- 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 classProfileOutput
- Parameters:
locale
- user locale- Returns:
- output policy description
-
getValueNames
public java.util.Enumeration<java.lang.String> getValueNames()
Retrieves a list of names of the value parameter.- Specified by:
getValueNames
in classProfileOutput
- 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 class:ProfileOutput
Retrieves the value of the given value parameter by name.- Specified by:
getValue
in classProfileOutput
- Parameters:
name
- property namelocale
- user localerequest
- 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 classProfileOutput
- Parameters:
name
- property namelocale
- user localerequest
- requestvalue
- property value- Throws:
EPropertyException
-
getConfigNames
public java.util.Enumeration<java.lang.String> getConfigNames()
Description copied from interface:IConfigTemplate
Returns a list of configuration parameter names.- 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.- Parameters:
locale
- user localename
- 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.- Parameters:
name
- parameter namevalue
- 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.- Returns:
- parameter
-
getDefaultConfig
public java.lang.String getDefaultConfig(java.lang.String name)
-
-