com.netscape.certsrv.profile
Interface IProfileOutput

All Superinterfaces:
IConfigTemplate
All Known Implementing Classes:
CertOutput, CMMFOutput, EnrollOutput, nsNKeyOutput, PKCS7Output

public interface IProfileOutput
extends IConfigTemplate

This interface represents a output policy which provides information on how to build the result page for the enrollment.

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

Method Summary
 IConfigStore getConfigStore()
          Retrieves configuration store.
 java.lang.String getName(java.util.Locale locale)
          Retrieves the localizable name of this policy.
 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.
 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.
 void populate(IProfileContext ctx, IRequest request)
          Populates the request with this policy default.
 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 interface com.netscape.certsrv.property.IConfigTemplate
getConfig, getConfigDescriptor, getConfigNames, setConfig
 

Method Detail

init

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

Parameters:
profile - owner of this policy
config - configuration store
Throws:
EProfileException - failed to initialize

getConfigStore

IConfigStore getConfigStore()
Retrieves configuration store.

Returns:
configuration store

populate

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

Parameters:
ctx - profile context
request - request
Throws:
EProfileException - failed to populate

getName

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

Parameters:
locale - user locale
Returns:
output policy name

getText

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

Parameters:
locale - user locale
Returns:
output policy description

getValueNames

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

Returns:
a list of property names

getValueDescriptor

IDescriptor getValueDescriptor(java.util.Locale locale,
                               java.lang.String name)
Retrieves the descriptor of the given value parameter by name.

Parameters:
locale - user locale
name - property name
Returns:
property descriptor

getValue

java.lang.String getValue(java.lang.String name,
                          java.util.Locale locale,
                          IRequest request)
                          throws EProfileException
Retrieves the value of the given value parameter by name.

Parameters:
name - property name
locale - user locale
request - request
Returns:
property value
Throws:
EProfileException - failed to retrieve value

setValue

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.

Parameters:
name - property name
locale - user locale
request - request
value - property value
Throws:
EProfileException - failed to retrieve value
EPropertyException