IConfigTemplate (pki-javadoc)

All Known Subinterfaces:

IProfileUpdater

All Known Implementing Classes:

CertOutput, CertReqInput, CMCCertReqInput, DualKeyGenInput, EncryptionKeyGenInput, EnrollInput, EnrollOutput, FileSigningInput, GenericInput, ImageInput, KeyGenInput, nsHKeyCertReqInput, nsNKeyCertReqInput, nsNKeyOutput, PKCS12Output, PolicyConstraint, PolicyDefault, ProfileInput, ProfileOutput, SerialNumRenewInput, ServerKeygenInput, SigningKeyGenInput, SubjectAltNameExtInput, SubjectDNInput, SubjectNameInput, SubmitterInfoInput, SubsystemGroupUpdater
```
public interface IConfigTemplate
```
This interface provides a standard way to describe a set of configuration parameters and its associated syntax. It provides programmatic methods for querying template description.
A plugin, for example, can be described as a property template.

Version:

$Revision$, $Date$

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`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.
`void`	`setConfig(java.lang.String name, java.lang.String value)`	Sets configuration parameter.

- Method Detail
  - getConfigNames
```
java.util.Enumeration<java.lang.String> getConfigNames()
```
    Returns a list of configuration parameter names.
    
    Returns:
    
    parameter names
  - getConfigDescriptor
```
IDescriptor getConfigDescriptor(java.util.Locale locale,
                                java.lang.String name)
```
    Returns the descriptors of configuration parameter.
    
    Parameters:
    
    locale - user locale
    
    name - configuration parameter name
    
    Returns:
    
    descriptor
  - setConfig
```
void setConfig(java.lang.String name,
               java.lang.String value)
        throws EPropertyException
```
    Sets configuration parameter.
    
    Parameters:
    
    name - parameter name
    
    value - parameter value
    
    Throws:
    
    EPropertyException - failed to set parameter
  - getConfig
```
java.lang.String getConfig(java.lang.String name)
```
    Retrieves configuration parameter by name.
    
    Returns:
    
    parameter