diff options
Diffstat (limited to 'base/common/src/com/netscape/certsrv/apps/ICMSEngine.java')
| -rw-r--r-- | base/common/src/com/netscape/certsrv/apps/ICMSEngine.java | 220 |
1 files changed, 110 insertions, 110 deletions
diff --git a/base/common/src/com/netscape/certsrv/apps/ICMSEngine.java b/base/common/src/com/netscape/certsrv/apps/ICMSEngine.java index ba9731867..41f4c348e 100644 --- a/base/common/src/com/netscape/certsrv/apps/ICMSEngine.java +++ b/base/common/src/com/netscape/certsrv/apps/ICMSEngine.java @@ -86,14 +86,14 @@ import com.netscape.cmsutil.password.IPasswordStore; * <p> * The engine implementation is loaded by CMS at startup. It is responsible for starting up all the related subsystems. * <p> - * + * * @version $Revision$, $Date$ */ public interface ICMSEngine extends ISubsystem { /** * Gets this ID . - * + * * @return CMS engine identifier */ public String getId(); @@ -101,14 +101,14 @@ public interface ICMSEngine extends ISubsystem { /** * Sets the identifier of this subsystem. Should never be called. * Returns error. - * + * * @param id CMS engine identifier */ public void setId(String id) throws EBaseException; /** * Retrieves the process id of this server. - * + * * @return process id of the server */ public int getPID(); @@ -125,7 +125,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the instance roort path of this server. - * + * * @return instance directory path name */ public String getInstanceDir(); @@ -133,14 +133,14 @@ public interface ICMSEngine extends ISubsystem { /** * Returns a server wide system time. Plugins should call * this method to retrieve system time. - * + * * @return current time */ public Date getCurrentDate(); /** * Retrieves time server started up. - * + * * @return last startup time */ public long getStartupTime(); @@ -150,28 +150,28 @@ public interface ICMSEngine extends ISubsystem { * server will be initialization state first. After the * initialization state, the server will be in the running * state. - * + * * @return true if the server is in the running state */ public boolean isInRunningState(); /** * Returns the names of all the registered subsystems. - * + * * @return a list of string-based subsystem names */ public Enumeration<String> getSubsystemNames(); /** * Returns all the registered subsystems. - * + * * @return a list of ISubsystem-based subsystems */ public Enumeration<ISubsystem> getSubsystems(); /** * Retrieves the registered subsytem with the given name. - * + * * @param name subsystem name * @return subsystem of the given name */ @@ -181,7 +181,7 @@ public interface ICMSEngine extends ISubsystem { * Returns the logger of the current server. The logger can * be used to log critical informational or critical error * messages. - * + * * @return logger */ public ILogger getLogger(); @@ -190,28 +190,28 @@ public interface ICMSEngine extends ISubsystem { * Returns the signed audit logger of the current server. This logger can * be used to log critical informational or critical error * messages. - * + * * @return signed audit logger */ public ILogger getSignedAuditLogger(); /** * Puts data of an byte array into the debug file. - * + * * @param data byte array to be recorded in the debug file */ public void debug(byte data[]); /** * Puts a message into the debug file. - * + * * @param msg debugging message */ public void debug(String msg); /** * Puts a message into the debug file. - * + * * @param level 0-10 * @param msg debugging message */ @@ -219,14 +219,14 @@ public interface ICMSEngine extends ISubsystem { /** * Puts an exception into the debug file. - * + * * @param e exception */ public void debug(Throwable e); /** * Checks if the debug mode is on or not. - * + * * @return true if debug mode is on */ public boolean debugOn(); @@ -249,7 +249,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the localized user message from UserMessages.properties. - * + * * @param locale end-user locale * @param msgID message id defined in UserMessages.properties * @return localized user message @@ -258,7 +258,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the localized user message from UserMessages.properties. - * + * * @param locale end-user locale * @param msgID message id defined in UserMessages.properties * @param p an array of parameters @@ -268,7 +268,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the localized user message from UserMessages.properties. - * + * * @param locale end-user locale * @param msgID message id defined in UserMessages.properties * @param p1 1st parameter @@ -278,7 +278,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the localized user message from UserMessages.properties. - * + * * @param locale end-user locale * @param msgID message id defined in UserMessages.properties * @param p1 1st parameter @@ -289,7 +289,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the localized user message from UserMessages.properties. - * + * * @param locale end-user locale * @param msgID message id defined in UserMessages.properties * @param p1 1st parameter @@ -301,7 +301,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the centralized log message from LogMessages.properties. - * + * * @param msgID message id defined in LogMessages.properties * @return localized log message */ @@ -309,7 +309,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the centralized log message from LogMessages.properties. - * + * * @param msgID message id defined in LogMessages.properties * @param p an array of parameters * @return localized log message @@ -318,7 +318,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the centralized log message from LogMessages.properties. - * + * * @param msgID message id defined in LogMessages.properties * @param p1 1st parameter * @return localized log message @@ -327,7 +327,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the centralized log message from LogMessages.properties. - * + * * @param msgID message id defined in LogMessages.properties * @param p1 1st parameter * @param p2 2nd parameter @@ -337,7 +337,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the centralized log message from LogMessages.properties. - * + * * @param msgID message id defined in LogMessages.properties * @param p1 1st parameter * @param p2 2nd parameter @@ -348,7 +348,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the centralized log message from LogMessages.properties. - * + * * @param msgID message id defined in LogMessages.properties * @param p1 1st parameter * @param p2 2nd parameter @@ -360,7 +360,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the centralized log message from LogMessages.properties. - * + * * @param msgID message id defined in LogMessages.properties * @param p1 1st parameter * @param p2 2nd parameter @@ -373,7 +373,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the centralized log message from LogMessages.properties. - * + * * @param msgID message id defined in LogMessages.properties * @param p1 1st parameter * @param p2 2nd parameter @@ -387,7 +387,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the centralized log message from LogMessages.properties. - * + * * @param msgID message id defined in LogMessages.properties * @param p1 1st parameter * @param p2 2nd parameter @@ -403,7 +403,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the centralized log message from LogMessages.properties. - * + * * @param msgID message id defined in LogMessages.properties * @param p1 1st parameter * @param p2 2nd parameter @@ -420,7 +420,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the centralized log message from LogMessages.properties. - * + * * @param msgID message id defined in LogMessages.properties * @param p1 1st parameter * @param p2 2nd parameter @@ -438,9 +438,9 @@ public interface ICMSEngine extends ISubsystem { /** * Parse ACL resource attributes - * + * * @param resACLs same format as the resourceACLs attribute: - * + * * <PRE> * <resource name>:<permission1,permission2,...permissionn>: * <allow|deny> (<subset of the permission set>) <evaluator expression> @@ -452,7 +452,7 @@ public interface ICMSEngine extends ISubsystem { /** * Creates an issuing poing record. - * + * * @return issuing record */ public ICRLIssuingPointRecord createCRLIssuingPointRecord(String id, BigInteger crlNumber, Long crlSize, @@ -460,14 +460,14 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the default CRL issuing point record name. - * + * * @return CRL issuing point record name */ public String getCRLIssuingPointRecordName(); /** * Returns the finger print of the given certificate. - * + * * @param cert certificate * @return finger print of certificate */ @@ -476,7 +476,7 @@ public interface ICMSEngine extends ISubsystem { /** * Returns the finger print of the given certificate. - * + * * @param cert certificate * @return finger print of certificate */ @@ -494,7 +494,7 @@ public interface ICMSEngine extends ISubsystem { /** * Creates a repository record in the internal database. - * + * * @return repository record */ public IRepositoryRecord createRepositoryRecord(); @@ -502,7 +502,7 @@ public interface ICMSEngine extends ISubsystem { /** * Creates a HTTP PKI Message that can be sent to a remote * authority. - * + * * @return a new PKI Message for remote authority */ public IPKIMessage getHttpPKIMessage(); @@ -510,14 +510,14 @@ public interface ICMSEngine extends ISubsystem { /** * Creates a request encoder. A request cannot be sent to * the remote authority in its regular format. - * + * * @return a request encoder */ public IRequestEncoder getHttpRequestEncoder(); /** * Converts a BER-encoded byte array into a MIME-64 encoded string. - * + * * @param data data in byte array format * @return base-64 encoding for the data */ @@ -525,7 +525,7 @@ public interface ICMSEngine extends ISubsystem { /** * Converts a MIME-64 encoded string into a BER-encoded byte array. - * + * * @param data base-64 encoding for the data * @return data data in byte array format */ @@ -534,7 +534,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the certifcate in MIME-64 encoded format * with header and footer. - * + * * @param cert certificate * @return base-64 format certificate */ @@ -542,7 +542,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the certificate pretty print handler. - * + * * @param delimiter delimiter * @return certificate pretty print handler */ @@ -550,7 +550,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the extension pretty print handler. - * + * * @param e extension * @param indent indentation * @return extension pretty print handler @@ -559,7 +559,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the certificate pretty print handler. - * + * * @param cert certificate * @return certificate pretty print handler */ @@ -567,7 +567,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the CRL pretty print handler. - * + * * @param crl CRL * @return CRL pretty print handler */ @@ -575,7 +575,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the CRL cache pretty print handler. - * + * * @param ip CRL issuing point * @return CRL pretty print handler */ @@ -584,7 +584,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the ldap connection information from the configuration * store. - * + * * @param config configuration parameters of ldap connection * @return a LDAP connection info */ @@ -595,7 +595,7 @@ public interface ICMSEngine extends ISubsystem { * Creates a LDAP SSL socket with the given nickname. The * certificate associated with the nickname will be used * for client authentication. - * + * * @param certNickname nickname of client certificate * @return LDAP SSL socket factory */ @@ -604,21 +604,21 @@ public interface ICMSEngine extends ISubsystem { /** * Creates a LDAP SSL socket. - * + * * @return LDAP SSL socket factory */ public LDAPSSLSocketFactoryExt getLdapJssSSLSocketFactory(); /** * Creates a LDAP Auth Info object. - * + * * @return LDAP authentication info */ public ILdapAuthInfo getLdapAuthInfo(); /** * Retrieves the LDAP connection factory. - * + * * @return bound LDAP connection pool */ public ILdapConnFactory getLdapBoundConnFactory() throws ELdapException; @@ -629,21 +629,21 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the LDAP connection factory. - * + * * @return anonymous LDAP connection pool */ public ILdapConnFactory getLdapAnonConnFactory() throws ELdapException; /** * Retrieves the password check. - * + * * @return default password checker */ public IPasswordCheck getPasswordChecker(); /** * Puts a password entry into the single-sign on cache. - * + * * @param tag password tag * @param pw password */ @@ -651,21 +651,21 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the password callback. - * + * * @return default password callback */ public PasswordCallback getPasswordCallback(); /** * Retrieves the nickname of the server's server certificate. - * + * * @return nickname of the server certificate */ public String getServerCertNickname(); /** * Sets the nickname of the server's server certificate. - * + * * @param tokenName name of token where the certificate is located * @param nickName name of server certificate */ @@ -673,112 +673,112 @@ public interface ICMSEngine extends ISubsystem { /** * Sets the nickname of the server's server certificate. - * + * * @param newName new nickname of server certificate */ public void setServerCertNickname(String newName); /** * Retrieves the host name of the server's secure end entity service. - * + * * @return host name of end-entity service */ public String getEEHost(); /** * Retrieves the host name of the server's non-secure end entity service. - * + * * @return host name of end-entity non-secure service */ public String getEENonSSLHost(); /** * Retrieves the IP address of the server's non-secure end entity service. - * + * * @return ip address of end-entity non-secure service */ public String getEENonSSLIP(); /** * Retrieves the port number of the server's non-secure end entity service. - * + * * @return port of end-entity non-secure service */ public String getEENonSSLPort(); /** * Retrieves the host name of the server's secure end entity service. - * + * * @return port of end-entity secure service */ public String getEESSLHost(); /** * Retrieves the IP address of the server's secure end entity service. - * + * * @return ip address of end-entity secure service */ public String getEESSLIP(); /** * Retrieves the port number of the server's secure end entity service. - * + * * @return port of end-entity secure service */ public String getEESSLPort(); /** * Retrieves the port number of the server's client auth secure end entity service. - * + * * @return port of end-entity client auth secure service */ public String getEEClientAuthSSLPort(); /** * Retrieves the host name of the server's agent service. - * + * * @return host name of agent service */ public String getAgentHost(); /** * Retrieves the IP address of the server's agent service. - * + * * @return ip address of agent service */ public String getAgentIP(); /** * Retrieves the port number of the server's agent service. - * + * * @return port of agent service */ public String getAgentPort(); /** * Retrieves the host name of the server's administration service. - * + * * @return host name of administration service */ public String getAdminHost(); /** * Retrieves the IP address of the server's administration service. - * + * * @return ip address of administration service */ public String getAdminIP(); /** * Retrieves the port number of the server's administration service. - * + * * @return port of administration service */ public String getAdminPort(); /** * Verifies all system certificates - * + * * @return true if all passed, false otherwise */ public boolean verifySystemCerts(); @@ -786,28 +786,28 @@ public interface ICMSEngine extends ISubsystem { /** * Verifies a system certificate by its tag name * as defined in <subsystemtype>.cert.list - * + * * @return true if passed, false otherwise */ public boolean verifySystemCertByTag(String tag); /** * Verifies a system certificate by its nickname - * + * * @return true if passed, false otherwise */ public boolean verifySystemCertByNickname(String nickname, String certificateUsage); /** * get the CertificateUsage as defined in JSS CryptoManager - * + * * @return CertificateUsage as defined in JSS CryptoManager */ public CertificateUsage getCertificateUsage(String certusage); /** * Checks if the given certificate is a signing certificate. - * + * * @param cert certificate * @return true if the given certificate is a signing certificate */ @@ -815,7 +815,7 @@ public interface ICMSEngine extends ISubsystem { /** * Checks if the given certificate is an encryption certificate. - * + * * @param cert certificate * @return true if the given certificate is an encryption certificate */ @@ -823,49 +823,49 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the default X.509 certificate template. - * + * * @return default certificate template */ public X509CertInfo getDefaultX509CertInfo(); /** * Retrieves the email form processor. - * + * * @return email form processor */ public IEmailFormProcessor getEmailFormProcessor(); /** * Retrieves the email form template. - * + * * @return email template */ public IEmailTemplate getEmailTemplate(String path); /** * Retrieves the email notification handler. - * + * * @return email notification */ public IMailNotification getMailNotification(); /** * Retrieves the email key resolver. - * + * * @return email key resolver */ public IEmailResolverKeys getEmailResolverKeys(); /** * Retrieves the email resolver that checks for subjectAlternateName. - * + * * @return email key resolver */ public IEmailResolver getReqCertSANameEmailResolver(); /** * Checks if the given OID is valid. - * + * * @param attrName attribute name * @param value attribute value * @return object identifier of the given attrName @@ -875,7 +875,7 @@ public interface ICMSEngine extends ISubsystem { /** * Creates a general name constraints. - * + * * @param generalNameChoice type of general name * @param value general name string * @return general name object @@ -885,7 +885,7 @@ public interface ICMSEngine extends ISubsystem { /** * Creates a general name. - * + * * @param generalNameChoice type of general name * @param value general name string * @return general name object @@ -896,7 +896,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves default general name configuration. - * + * * @param name configuration name * @param isValueConfigured true if value is configured * @param params configuration parameters @@ -907,7 +907,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves default general names configuration. - * + * * @param name configuration name * @param isValueConfigured true if value is configured * @param params configuration parameters @@ -918,7 +918,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves extended plugin info for general name configuration. - * + * * @param name configuration name * @param isValueConfigured true if value is configured * @param info configuration parameters @@ -929,7 +929,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves extended plugin info for general name configuration. - * + * * @param name configuration name * @param isValueConfigured true if value is configured * @param info configuration parameters @@ -940,7 +940,7 @@ public interface ICMSEngine extends ISubsystem { /** * Created general names configuration. - * + * * @param name configuration name * @param config configuration store * @param isValueConfigured true if value is configured @@ -953,7 +953,7 @@ public interface ICMSEngine extends ISubsystem { /** * Created general name constraints configuration. - * + * * @param name configuration name * @param config configuration store * @param isValueConfigured true if value is configured @@ -966,7 +966,7 @@ public interface ICMSEngine extends ISubsystem { /** * Created general name constraints configuration. - * + * * @param name configuration name * @param config configuration store * @param isValueConfigured true if value is configured @@ -979,7 +979,7 @@ public interface ICMSEngine extends ISubsystem { /** * Get default parameters for subject alt name configuration. - * + * * @param name configuration name * @param params configuration parameters */ @@ -987,7 +987,7 @@ public interface ICMSEngine extends ISubsystem { /** * Get extended plugin info for subject alt name configuration. - * + * * @param name configuration name * @param params configuration parameters */ @@ -995,7 +995,7 @@ public interface ICMSEngine extends ISubsystem { /** * Creates subject alt name configuration. - * + * * @param name configuration name * @param config configuration store * @param isValueConfigured true if value is configured @@ -1006,7 +1006,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the HTTP Connection for use with connector. - * + * * @param authority remote authority * @param factory socket factory * @return http connection to the remote authority @@ -1016,7 +1016,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the HTTP Connection for use with connector. - * + * * @param authority remote authority * @param factory socket factory * @param timeout return error if connection cannot be established within @@ -1028,7 +1028,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves the request sender for use with connector. - * + * * @param authority local authority * @param nickname nickname of the client certificate * @param remote remote authority @@ -1040,7 +1040,7 @@ public interface ICMSEngine extends ISubsystem { /** * Retrieves command queue - * + * * @return command queue */ public ICommandQueue getCommandQueue(); @@ -1059,14 +1059,14 @@ public interface ICMSEngine extends ISubsystem { * Checks to ensure that all new incoming requests have been blocked. * This method is used for reentrancy protection. * <P> - * + * * @return true or false */ public boolean areRequestsDisabled(); /** * Create configuration file. - * + * * @param path configuration path * @return configuration store * @exception EBaseException failed to create file @@ -1091,7 +1091,7 @@ public interface ICMSEngine extends ISubsystem { /** * Checks against the local certificate repository to see * if the certificates are revoked. - * + * * @param certificates certificates * @return true if certificate is revoked in the local * certificate repository @@ -1100,7 +1100,7 @@ public interface ICMSEngine extends ISubsystem { /** * Sets list of verified certificates - * + * * @param size size of verified certificates list * @param interval interval in which certificate is not recheck * against local certificate repository |