com.netscape.certsrv.base
Interface IExtendedPluginInfo

All Known Implementing Classes:
AttributePresentConstraints, AuthInfoAccessExt, AuthorityKeyIdentifierExt, BasicAclAuthz, BasicConstraintsExt, CertificatePoliciesExt, CertificateRenewalWindowExt, CertificateScopeOfUseExt, CMCAuth, CMSAuthInfoAccessExtension, CMSAuthorityKeyIdentifierExtension, CMSCertificateIssuerExtension, CMSCRLNumberExtension, CMSCRLReasonExtension, CMSDeltaCRLIndicatorExtension, CMSFreshestCRLExtension, CMSHoldInstructionExtension, CMSInvalidityDateExtension, CMSIssuerAlternativeNameExtension, CMSIssuingDistributionPointExtension, CRLDistributionPointsExt, DefaultRevocation, DefStore, DirAclAuthz, DirBasedAuthentication, DSAKeyConstraints, ExtendedKeyUsageExt, ExtendedPluginInfo, FileBasedPublisher, FlatFileAuth, GenericASN1Ext, HashAuthentication, IssuerAltNameExt, IssuerConstraints, KeyAlgorithmConstraints, KeyUsageExt, LdapCaCertPublisher, LdapCaSimpleMap, LdapCertCompsMap, LdapCertExactMap, LdapCertificatePairPublisher, LdapCertSubjMap, LdapCrlIssuerCompsMap, LdapCrlPublisher, LdapDNCompsMap, LdapEncryptCertPublisher, LdapEnhancedMap, LdapSimpleMap, LDAPStore, LdapUserCertPublisher, LogFile, NameConstraintsExt, NoMap, NSCCommentExt, NSCertTypeExt, OCSPNoCheckExt, OCSPPublisher, PolicyConstraintsExt, PolicyMappingsExt, PortalEnroll, PrivateKeyUsagePeriodExt, PublishCertsJob, RemoveBasicConstraintsExt, RenewalConstraints, RenewalNotificationJob, RenewalValidityConstraints, RequestInQueueJob, RevocationConstraints, RollingLogFile, RSAKeyConstraints, SigningAlgorithmConstraints, SubCANameConstraints, SubjAltNameExt, SubjectAltNameExt, SubjectDirectoryAttributesExt, SubjectKeyIdentifierExt, UdnPwdDirAuthentication, UidPwdDirAuthentication, UidPwdPinDirAuthentication, UniqueSubjectName, UniqueSubjectNameConstraints, UnpublishExpiredJob, UserPwdDirAuthentication, ValidityConstraints

public interface IExtendedPluginInfo

Plugin which can return extended information to console

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

Field Summary
static java.lang.String HELP_TEXT
           
static java.lang.String HELP_TOKEN
           
 
Method Summary
 java.lang.String[] getExtendedPluginInfo(java.util.Locale locale)
          This method returns an array of strings.
 

Field Detail

HELP_TOKEN

static final java.lang.String HELP_TOKEN
See Also:
Constant Field Values

HELP_TEXT

static final java.lang.String HELP_TEXT
See Also:
Constant Field Values
Method Detail

getExtendedPluginInfo

java.lang.String[] getExtendedPluginInfo(java.util.Locale locale)
This method returns an array of strings. Each element of the array represents a configurable parameter, or some other meta-info (such as help-token) there is an entry indexed on that parameter name ;[,required];;... Where: type_info is either 'string', 'number', 'boolean', 'password' or 'choice(ch1,ch2,ch3,...)' If the marker 'required' is included after the type_info, the parameter will has some visually distinctive marking in the UI. 'description' is a short sentence describing the parameter 'choice' is rendered as a drop-down list. The first parameter in the list will be activated by default 'boolean' is rendered as a checkbox. The resulting parameter will be either 'true' or 'false' 'string' allows any characters 'number' allows only numbers 'password' is rendered as a password field (the characters are replaced with *'s when being types. This parameter is not passed through to the plugin. It is instead inserted directly into the password cache keyed on the instance name. The value of the parameter 'bindPWPrompt' (see example below) is set to the key. In addition to the configurable parameters, the following magic parameters may be defined: HELP_TOKEN;helptoken - a pointer to the online manual section for this plugin HELP_TEXT;helptext - a general help string describing the plugin For example: "username;string;The username you wish to login as" "bindPWPrompt;password;Enter password to bind as above user with" "algorithm;choice(RSA,DSA);Which algorithm do you want to use" "enable;boolean;Do you want to run this plugin" "port;number;Which port number do you want to use"