com.netscape.certsrv.property
Interface IConfigTemplate

All Known Subinterfaces:
ICertInfoPolicyDefault, IPolicyConstraint, IPolicyDefault, IProfileInput, IProfileOutput, IProfileUpdater
All Known Implementing Classes:
AuthInfoAccessExtDefault, AuthorityKeyIdentifierExtDefault, AuthTokenSubjectNameDefault, AutoAssignDefault, BasicConstraintsExtConstraint, BasicConstraintsExtDefault, CAEnrollConstraint, CAEnrollDefault, CAValidityConstraint, CAValidityDefault, CertificatePoliciesExtDefault, CertificateVersionDefault, CertOutput, CertReqInput, CMCCertReqInput, CMMFOutput, CRLDistributionPointsExtDefault, DualKeyGenInput, EnrollConstraint, EnrollDefault, EnrollExtDefault, EnrollInput, EnrollOutput, ExtendedKeyUsageExtConstraint, ExtendedKeyUsageExtDefault, ExtensionConstraint, FileSigningInput, FreshestCRLExtDefault, GenericExtDefault, GenericInput, ImageDefault, ImageInput, InhibitAnyPolicyExtDefault, IssuerAltNameExtDefault, KeyConstraint, KeyGenInput, KeyUsageExtConstraint, KeyUsageExtDefault, NameConstraintsExtDefault, NoConstraint, NoDefault, NSCCommentExtDefault, NSCertTypeExtConstraint, NSCertTypeExtDefault, nsHKeyCertReqInput, nsHKeySubjectNameDefault, nsNKeyCertReqInput, nsNKeyOutput, nsNKeySubjectNameDefault, nsTokenDeviceKeySubjectNameDefault, nsTokenUserKeySubjectNameDefault, OCSPNoCheckExtDefault, PKCS7Output, PolicyConstraintsExtDefault, PolicyMappingsExtDefault, PrivateKeyUsagePeriodExtDefault, RenewGracePeriodConstraint, SerialNumRenewInput, SigningAlgConstraint, SigningAlgDefault, SubjectAltNameExtDefault, SubjectDirAttributesExtDefault, SubjectDNInput, SubjectInfoAccessExtDefault, SubjectKeyIdentifierExtDefault, SubjectNameConstraint, SubjectNameDefault, SubjectNameInput, SubmitterInfoInput, SubsystemGroupUpdater, UniqueKeyConstraint, UniqueSubjectNameConstraint, UserExtensionDefault, UserKeyDefault, UserSigningAlgDefault, UserSubjectNameDefault, UserValidityDefault, ValidityConstraint, ValidityDefault

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: 1211 $, $Date: 2010-08-18 10:15:37 -0700 (Wed, 18 Aug 2010) $

Method Summary
 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 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 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