diff options
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/apps/CMS.java')
| -rw-r--r-- | pki/base/common/src/com/netscape/certsrv/apps/CMS.java | 637 |
1 files changed, 325 insertions, 312 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/apps/CMS.java b/pki/base/common/src/com/netscape/certsrv/apps/CMS.java index 137a609f..4842e0ec 100644 --- a/pki/base/common/src/com/netscape/certsrv/apps/CMS.java +++ b/pki/base/common/src/com/netscape/certsrv/apps/CMS.java @@ -17,7 +17,6 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.apps; - import java.io.ByteArrayOutputStream; import java.io.PrintStream; import java.math.BigInteger; @@ -98,18 +97,15 @@ import com.netscape.certsrv.usrgrp.IUGSubsystem; import com.netscape.cmsutil.net.ISocketFactory; import com.netscape.cmsutil.password.IPasswordStore; - /** - * This represents the CMS server. Plugins can access other - * public objects such as subsystems via this inteface. - * This object also include a set of utility functions. - * - * This object does not include the actual implementation. - * It acts as a public interface for plugins, and the - * actual implementation is in the CMS engine - * (com.netscape.cmscore.apps.CMSEngine) that implements - * ICMSEngine interface. - * + * This represents the CMS server. Plugins can access other public objects such + * as subsystems via this inteface. This object also include a set of utility + * functions. + * + * This object does not include the actual implementation. It acts as a public + * interface for plugins, and the actual implementation is in the CMS engine + * (com.netscape.cmscore.apps.CMSEngine) that implements ICMSEngine interface. + * * @version $Revision$, $Date$ */ public final class CMS { @@ -129,7 +125,7 @@ public final class CMS { public static final String SUBSYSTEM_KRA = IKeyRecoveryAuthority.ID; public static final String SUBSYSTEM_OCSP = IOCSPAuthority.ID; public static final String SUBSYSTEM_TKS = ITKSAuthority.ID; - public static final String SUBSYSTEM_UG = IUGSubsystem.ID; + public static final String SUBSYSTEM_UG = IUGSubsystem.ID; public static final String SUBSYSTEM_AUTH = IAuthSubsystem.ID; public static final String SUBSYSTEM_AUTHZ = IAuthzSubsystem.ID; public static final String SUBSYSTEM_REGISTRY = IPluginRegistry.ID; @@ -141,7 +137,7 @@ public final class CMS { /** * Private constructor. - * + * * @param engine CMS engine implementation */ private CMS(ICMSEngine engine) { @@ -149,8 +145,9 @@ public final class CMS { } /** - * This method is used for unit tests. It allows the underlying _engine - * to be stubbed out. + * This method is used for unit tests. It allows the underlying _engine to + * be stubbed out. + * * @param engine The stub engine to set, for testing. */ public static void setCMSEngine(ICMSEngine engine) { @@ -159,7 +156,7 @@ public final class CMS { /** * Gets this ID . - * + * * @return CMS engine identifier */ public static String getId() { @@ -167,9 +164,9 @@ public final class CMS { } /** - * Sets the identifier of this subsystem. Should never be called. - * Returns error. - * + * Sets the identifier of this subsystem. Should never be called. Returns + * error. + * * @param id CMS engine identifier */ public static void setId(String id) throws EBaseException { @@ -178,14 +175,14 @@ public final class CMS { /** * Initialize all static, dynamic and final static subsystems. - * + * * @param owner null * @param config main config store. - * @exception EBaseException if any error occur in subsystems during - * initialization. + * @exception EBaseException if any error occur in subsystems during + * initialization. */ - public static void init(ISubsystem owner, IConfigStore config) - throws EBaseException { + public static void init(ISubsystem owner, IConfigStore config) + throws EBaseException { _engine.init(owner, config); } @@ -195,7 +192,7 @@ public final class CMS { /** * Starts up all subsystems. subsystems must be initialized. - * + * * @exception EBaseException if any subsystem fails to startup. */ public static void startup() throws EBaseException { @@ -217,10 +214,10 @@ public final class CMS { } /** - * Checks to ensure that all new incoming requests have been blocked. - * This method is used for reentrancy protection. + * Checks to ensure that all new incoming requests have been blocked. This + * method is used for reentrancy protection. * <P> - * + * * @return true or false */ public static boolean areRequestsDisabled() { @@ -228,34 +225,33 @@ public final class CMS { } /** - * Shuts down subsystems in backwards order - * exceptions are ignored. process exists at end to force exit. + * Shuts down subsystems in backwards order exceptions are ignored. process + * exists at end to force exit. */ public static void shutdown() { _engine.shutdown(); } /** - * Shuts down subsystems in backwards order - * exceptions are ignored. process exists at end to force exit. + * Shuts down subsystems in backwards order exceptions are ignored. process + * exists at end to force exit. */ - public static void forceShutdown() { + public static void forceShutdown() { - _engine.forceShutdown(); - } + _engine.forceShutdown(); + } - /** - * mode = 0 (pre-operational) - * mode = 1 (running) - */ - public static void setCSState(int mode) { - _engine.setCSState(mode); - } + /** + * mode = 0 (pre-operational) mode = 1 (running) + */ + public static void setCSState(int mode) { + _engine.setCSState(mode); + } - public static int getCSState() { - return _engine.getCSState(); - } + public static int getCSState() { + return _engine.getCSState(); + } public static boolean isPreOpMode() { return _engine.isPreOpMode(); @@ -266,10 +262,9 @@ public final class CMS { } /** - * Is the server in running state. After server startup, the - * server will be initialization state first. After the - * initialization state, the server will be in the running - * state. + * Is the server in running state. After server startup, the 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 */ @@ -278,10 +273,9 @@ public final class CMS { } /** - * Returns the logger of the current server. The logger can - * be used to log critical informational or critical error - * messages. - * + * Returns the logger of the current server. The logger can be used to log + * critical informational or critical error messages. + * * @return logger */ public static ILogger getLogger() { @@ -289,10 +283,9 @@ public final class CMS { } /** - * Returns the signed audit logger of the current server. This logger can - * be used to log critical informational or critical error - * messages. - * + * 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 static ILogger getSignedAuditLogger() { @@ -301,7 +294,7 @@ public final class CMS { /** * Creates a repository record in the internal database. - * + * * @return repository record */ public static IRepositoryRecord createRepositoryRecord() { @@ -310,8 +303,10 @@ public final class CMS { /** * Parse ACL resource attributes + * * @param resACLs same format as the resourceACLs attribute: - * <PRE> + * + * <PRE> * <resource name>:<permission1,permission2,...permissionn>: * <allow|deny> (<subset of the permission set>) <evaluator expression> * </PRE> @@ -324,16 +319,18 @@ public final class CMS { /** * Creates an issuing poing record. - * + * * @return issuing record */ - public static ICRLIssuingPointRecord createCRLIssuingPointRecord(String id, BigInteger crlNumber, Long crlSize, Date thisUpdate, Date nextUpdate) { - return _engine.createCRLIssuingPointRecord(id, crlNumber, crlSize, thisUpdate, nextUpdate); + public static ICRLIssuingPointRecord createCRLIssuingPointRecord(String id, + BigInteger crlNumber, Long crlSize, Date thisUpdate, Date nextUpdate) { + return _engine.createCRLIssuingPointRecord(id, crlNumber, crlSize, + thisUpdate, nextUpdate); } /** * Retrieves the default CRL issuing point record name. - * + * * @return CRL issuing point record name */ public static String getCRLIssuingPointRecordName() { @@ -342,7 +339,7 @@ public final class CMS { /** * Retrieves the process id of this server. - * + * * @return process id of the server */ public static int getpid() { @@ -351,7 +348,7 @@ public final class CMS { /** * Retrieves the instance roort path of this server. - * + * * @return instance directory path name */ public static String getInstanceDir() { @@ -359,9 +356,9 @@ public final class CMS { } /** - * Returns a server wide system time. Plugins should call - * this method to retrieve system time. - * + * Returns a server wide system time. Plugins should call this method to + * retrieve system time. + * * @return current time */ public static Date getCurrentDate() { @@ -372,7 +369,7 @@ public final class CMS { /** * Puts data of an byte array into the debug file. - * + * * @param data byte array to be recorded in the debug file */ public static void debug(byte data[]) { @@ -382,7 +379,7 @@ public final class CMS { /** * Puts a message into the debug file. - * + * * @param msg debugging message */ public static void debug(String msg) { @@ -392,7 +389,7 @@ public final class CMS { /** * Puts a message into the debug file. - * + * * @param level 0-10 (0 is less detail, 10 is more detail) * @param msg debugging message */ @@ -403,7 +400,7 @@ public final class CMS { /** * Puts an exception into the debug file. - * + * * @param e exception */ public static void debug(Throwable e) { @@ -413,7 +410,7 @@ public final class CMS { /** * Checks if the debug mode is on or not. - * + * * @return true if debug mode is on */ public static boolean debugOn() { @@ -430,42 +427,46 @@ public final class CMS { _engine.debugStackTrace(); } - /* - * If debugging for the particular realm is enabled, output name/value - * pair info to the debug file. This is useful to dump out what hidden - * config variables the server is looking at, or what HTTP variables it - * is expecting to find, or what database attributes it is looking for. - * @param type indicates what the source of key/val is. For example, - * this could be 'CS.cfg', or something else. In the debug - * subsystem, there is a mechanism to filter this so only the types - * you care about are listed - * @param key the 'key' of the hashtable which is being accessed. - * This could be the name of the config parameter, or the http param - * name. - * @param val the value of the parameter + /* + * If debugging for the particular realm is enabled, output name/value pair + * info to the debug file. This is useful to dump out what hidden config + * variables the server is looking at, or what HTTP variables it is + * expecting to find, or what database attributes it is looking for. + * + * @param type indicates what the source of key/val is. For example, this + * could be 'CS.cfg', or something else. In the debug subsystem, there is a + * mechanism to filter this so only the types you care about are listed + * + * @param key the 'key' of the hashtable which is being accessed. This could + * be the name of the config parameter, or the http param name. + * + * @param val the value of the parameter + * * @param default the default value if the param is not found - */ + */ public static void traceHashKey(String type, String key) { if (_engine != null) { - _engine.traceHashKey(type, key); - } - } + _engine.traceHashKey(type, key); + } + } + public static void traceHashKey(String type, String key, String val) { if (_engine != null) { - _engine.traceHashKey(type, key, val); - } - } - public static void traceHashKey(String type, String key, String val, String def) { - if (_engine != null) { - _engine.traceHashKey(type, key, val, def); - } - } + _engine.traceHashKey(type, key, val); + } + } + public static void traceHashKey(String type, String key, String val, + String def) { + if (_engine != null) { + _engine.traceHashKey(type, key, val, def); + } + } /** * Returns the names of all the registered subsystems. - * + * * @return a list of string-based subsystem names */ public static Enumeration getSubsystemNames() { @@ -478,7 +479,7 @@ public final class CMS { /** * Returns all the registered subsystems. - * + * * @return a list of ISubsystem-based subsystems */ public static Enumeration getSubsystems() { @@ -487,7 +488,7 @@ public final class CMS { /** * Retrieves the registered subsytem with the given name. - * + * * @param name subsystem name * @return subsystem of the given name */ @@ -497,7 +498,7 @@ public final class CMS { /** * Retrieves the localized user message from UserMessages.properties. - * + * * @param msgID message id defined in UserMessages.properties * @return localized user message */ @@ -509,7 +510,7 @@ public final class CMS { /** * 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 @@ -522,7 +523,7 @@ public final class CMS { /** * Retrieves the localized user message from UserMessages.properties. - * + * * @param msgID message id defined in UserMessages.properties * @param p1 1st parameter * @return localized user message @@ -530,12 +531,13 @@ public final class CMS { public static String getUserMessage(String msgID, String p1) { if (_engine == null) return msgID; - return _engine.getUserMessage(null /* from session context */, msgID, p1); + return _engine.getUserMessage(null /* from session context */, msgID, + p1); } /** * 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 @@ -549,7 +551,7 @@ public final class CMS { /** * Retrieves the localized user message from UserMessages.properties. - * + * * @param msgID message id defined in UserMessages.properties * @param p1 1st parameter * @param p2 2nd parameter @@ -558,19 +560,21 @@ public final class CMS { public static String getUserMessage(String msgID, String p1, String p2) { if (_engine == null) return msgID; - return _engine.getUserMessage(null /* from session context */, msgID, p1, p2); + return _engine.getUserMessage(null /* from session context */, msgID, + p1, p2); } /** * 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 * @param p2 2nd parameter * @return localized user message */ - public static String getUserMessage(Locale locale, String msgID, String p1, String p2) { + public static String getUserMessage(Locale locale, String msgID, String p1, + String p2) { if (_engine == null) return msgID; return _engine.getUserMessage(locale, msgID, p1, p2); @@ -578,30 +582,31 @@ public final class CMS { /** * Retrieves the localized user message from UserMessages.properties. - * + * * @param msgID message id defined in UserMessages.properties * @param p1 1st parameter * @param p2 2nd parameter * @param p3 3rd parameter * @return localized user message */ - public static String getUserMessage(String msgID, String p1, String p2, String p3) { + public static String getUserMessage(String msgID, String p1, String p2, + String p3) { if (_engine == null) return msgID; - return _engine.getUserMessage(null /* from session context */, msgID, p1, p2, p3); + return _engine.getUserMessage(null /* from session context */, msgID, + p1, p2, p3); } public static LDAPConnection getBoundConnection(String host, int port, - int version, LDAPSSLSocketFactoryExt fac, String bindDN, - String bindPW) throws LDAPException - { - return _engine.getBoundConnection(host, port, version, fac, - bindDN, bindPW); + int version, LDAPSSLSocketFactoryExt fac, String bindDN, + String bindPW) throws LDAPException { + return _engine.getBoundConnection(host, port, version, fac, bindDN, + bindPW); } /** * 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 @@ -609,7 +614,8 @@ public final class CMS { * @param p3 3rd parameter * @return localized user message */ - public static String getUserMessage(Locale locale, String msgID, String p1, String p2, String p3) { + public static String getUserMessage(Locale locale, String msgID, String p1, + String p2, String p3) { if (_engine == null) return msgID; return _engine.getUserMessage(locale, msgID, p1, p2, p3); @@ -617,7 +623,7 @@ public final class CMS { /** * Retrieves the localized user message from UserMessages.properties. - * + * * @param msgID message id defined in UserMessages.properties * @param p an array of parameters * @return localized user message @@ -625,12 +631,13 @@ public final class CMS { public static String getUserMessage(String msgID, String p[]) { if (_engine == null) return msgID; - return _engine.getUserMessage(null /* from session context */, msgID, p); + return _engine + .getUserMessage(null /* from session context */, msgID, p); } /** * 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 @@ -644,7 +651,7 @@ public final class CMS { /** * Retrieves the centralized log message from LogMessages.properties. - * + * * @param msgID message id defined in LogMessages.properties * @return localized log message */ @@ -654,7 +661,7 @@ public final class CMS { /** * 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 @@ -665,7 +672,7 @@ public final class CMS { /** * Retrieves the centralized log message from LogMessages.properties. - * + * * @param msgID message id defined in LogMessages.properties * @param p1 1st parameter * @return localized log message @@ -676,7 +683,7 @@ public final class CMS { /** * Retrieves the centralized log message from LogMessages.properties. - * + * * @param msgID message id defined in LogMessages.properties * @param p1 1st parameter * @param p2 2nd parameter @@ -688,20 +695,21 @@ public final class CMS { /** * Retrieves the centralized log message from LogMessages.properties. - * + * * @param msgID message id defined in LogMessages.properties * @param p1 1st parameter * @param p2 2nd parameter * @param p3 3rd parameter * @return localized log message */ - public static String getLogMessage(String msgID, String p1, String p2, String p3) { + public static String getLogMessage(String msgID, String p1, String p2, + String p3) { return _engine.getLogMessage(msgID, p1, p2, p3); } /** * Retrieves the centralized log message from LogMessages.properties. - * + * * @param msgID message id defined in LogMessages.properties * @param p1 1st parameter * @param p2 2nd parameter @@ -709,13 +717,14 @@ public final class CMS { * @param p4 4th parameter * @return localized log message */ - public static String getLogMessage(String msgID, String p1, String p2, String p3, String p4) { + public static String getLogMessage(String msgID, String p1, String p2, + String p3, String p4) { return _engine.getLogMessage(msgID, p1, p2, p3, p4); } /** * Retrieves the centralized log message from LogMessages.properties. - * + * * @param msgID message id defined in LogMessages.properties * @param p1 1st parameter * @param p2 2nd parameter @@ -724,13 +733,14 @@ public final class CMS { * @param p5 5th parameter * @return localized log message */ - public static String getLogMessage(String msgID, String p1, String p2, String p3, String p4, String p5) { + public static String getLogMessage(String msgID, String p1, String p2, + String p3, String p4, String p5) { return _engine.getLogMessage(msgID, p1, p2, p3, p4, p5); } /** * Retrieves the centralized log message from LogMessages.properties. - * + * * @param msgID message id defined in LogMessages.properties * @param p1 1st parameter * @param p2 2nd parameter @@ -740,13 +750,14 @@ public final class CMS { * @param p6 6th parameter * @return localized log message */ - public static String getLogMessage(String msgID, String p1, String p2, String p3, String p4, String p5, String p6) { + public static String getLogMessage(String msgID, String p1, String p2, + String p3, String p4, String p5, String p6) { return _engine.getLogMessage(msgID, p1, p2, p3, p4, p5, p6); } /** * Retrieves the centralized log message from LogMessages.properties. - * + * * @param msgID message id defined in LogMessages.properties * @param p1 1st parameter * @param p2 2nd parameter @@ -757,13 +768,14 @@ public final class CMS { * @param p7 7th parameter * @return localized log message */ - public static String getLogMessage(String msgID, String p1, String p2, String p3, String p4, String p5, String p6, String p7) { + public static String getLogMessage(String msgID, String p1, String p2, + String p3, String p4, String p5, String p6, String p7) { return _engine.getLogMessage(msgID, p1, p2, p3, p4, p5, p6, p7); } /** * Retrieves the centralized log message from LogMessages.properties. - * + * * @param msgID message id defined in LogMessages.properties * @param p1 1st parameter * @param p2 2nd parameter @@ -775,13 +787,14 @@ public final class CMS { * @param p8 8th parameter * @return localized log message */ - public static String getLogMessage(String msgID, String p1, String p2, String p3, String p4, String p5, String p6, String p7, String p8) { + public static String getLogMessage(String msgID, String p1, String p2, + String p3, String p4, String p5, String p6, String p7, String p8) { return _engine.getLogMessage(msgID, p1, p2, p3, p4, p5, p6, p7, p8); } /** * Retrieves the centralized log message from LogMessages.properties. - * + * * @param msgID message id defined in LogMessages.properties * @param p1 1st parameter * @param p2 2nd parameter @@ -794,13 +807,15 @@ public final class CMS { * @param p9 9th parameter * @return localized log message */ - public static String getLogMessage(String msgID, String p1, String p2, String p3, String p4, String p5, String p6, String p7, String p8, String p9) { + public static String getLogMessage(String msgID, String p1, String p2, + String p3, String p4, String p5, String p6, String p7, String p8, + String p9) { return _engine.getLogMessage(msgID, p1, p2, p3, p4, p5, p6, p7, p8, p9); } /** * Returns the main config store. It is a handle to CMS.cfg. - * + * * @return configuration store */ public static IConfigStore getConfigStore() { @@ -809,7 +824,7 @@ public final class CMS { /** * Retrieves time server started up. - * + * * @return last startup time */ public static long getStartupTime() { @@ -818,41 +833,41 @@ public final class CMS { /** * Retrieves the HTTP Connection for use with connector. - * + * * @param authority remote authority * @param factory socket factory * @return http connection to the remote authority */ - public static IHttpConnection getHttpConnection(IRemoteAuthority authority, - ISocketFactory factory) { + public static IHttpConnection getHttpConnection(IRemoteAuthority authority, + ISocketFactory factory) { return _engine.getHttpConnection(authority, factory); } /** * 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 - * the timeout period + * the timeout period * @return http connection to the remote authority */ - public static IHttpConnection getHttpConnection(IRemoteAuthority authority, - ISocketFactory factory, int timeout) { + public static IHttpConnection getHttpConnection(IRemoteAuthority authority, + ISocketFactory factory, int timeout) { return _engine.getHttpConnection(authority, factory, timeout); } /** * Retrieves the request sender for use with connector. - * + * * @param authority local authority * @param nickname nickname of the client certificate * @param remote remote authority * @param interval timeout interval * @return resender */ - public static IResender getResender(IAuthority authority, String nickname, - IRemoteAuthority remote, int interval) { + public static IResender getResender(IAuthority authority, String nickname, + IRemoteAuthority remote, int interval) { return _engine.getResender(authority, nickname, remote, interval); } @@ -867,7 +882,7 @@ public final class CMS { /** * 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 */ @@ -877,7 +892,7 @@ public final class CMS { /** * Sets the nickname of the server's server certificate. - * + * * @param newName new nickname of server certificate */ public static void setServerCertNickname(String newName) { @@ -886,7 +901,7 @@ public final class CMS { /** * Retrieves the host name of the server's secure end entity service. - * + * * @return host name of end-entity service */ public static String getEEHost() { @@ -895,7 +910,7 @@ public final class CMS { /** * Retrieves the host name of the server's non-secure end entity service. - * + * * @return host name of end-entity non-secure service */ public static String getEENonSSLHost() { @@ -904,7 +919,7 @@ public final class CMS { /** * Retrieves the IP address of the server's non-secure end entity service. - * + * * @return ip address of end-entity non-secure service */ public static String getEENonSSLIP() { @@ -913,7 +928,7 @@ public final class CMS { /** * Retrieves the port number of the server's non-secure end entity service. - * + * * @return port of end-entity non-secure service */ public static String getEENonSSLPort() { @@ -922,7 +937,7 @@ public final class CMS { /** * Retrieves the host name of the server's secure end entity service. - * + * * @return port of end-entity secure service */ public static String getEESSLHost() { @@ -931,7 +946,7 @@ public final class CMS { /** * Retrieves the host name of the server's secure end entity service. - * + * * @return port of end-entity secure service */ public static String getEEClientAuthSSLPort() { @@ -940,7 +955,7 @@ public final class CMS { /** * Retrieves the IP address of the server's secure end entity service. - * + * * @return ip address of end-entity secure service */ public static String getEESSLIP() { @@ -949,7 +964,7 @@ public final class CMS { /** * Retrieves the port number of the server's secure end entity service. - * + * * @return port of end-entity secure service */ public static String getEESSLPort() { @@ -958,7 +973,7 @@ public final class CMS { /** * Retrieves the host name of the server's agent service. - * + * * @return host name of agent service */ public static String getAgentHost() { @@ -967,7 +982,7 @@ public final class CMS { /** * Retrieves the IP address of the server's agent service. - * + * * @return ip address of agent service */ public static String getAgentIP() { @@ -976,7 +991,7 @@ public final class CMS { /** * Retrieves the port number of the server's agent service. - * + * * @return port of agent service */ public static String getAgentPort() { @@ -985,7 +1000,7 @@ public final class CMS { /** * Retrieves the host name of the server's administration service. - * + * * @return host name of administration service */ public static String getAdminHost() { @@ -994,7 +1009,7 @@ public final class CMS { /** * Retrieves the IP address of the server's administration service. - * + * * @return ip address of administration service */ public static String getAdminIP() { @@ -1003,7 +1018,7 @@ public final class CMS { /** * Retrieves the port number of the server's administration service. - * + * * @return port of administration service */ public static String getAdminPort() { @@ -1012,26 +1027,27 @@ public final class CMS { /** * Creates a general name constraints. - * + * * @param generalNameChoice type of general name * @param value general name string * @return general name object * @exception EBaseException failed to create general name constraint */ - public static GeneralName form_GeneralNameAsConstraints(String generalNameChoice, String value) throws EBaseException { + public static GeneralName form_GeneralNameAsConstraints( + String generalNameChoice, String value) throws EBaseException { return _engine.form_GeneralName(generalNameChoice, value); } /** * Creates a general name. - * + * * @param generalNameChoice type of general name * @param value general name string * @return general name object * @exception EBaseException failed to create general name */ public static GeneralName form_GeneralName(String generalNameChoice, - String value) throws EBaseException { + String value) throws EBaseException { return _engine.form_GeneralName(generalNameChoice, value); } @@ -1041,193 +1057,195 @@ public final class CMS { * @param name configuration name * @param params configuration parameters */ - public static void getSubjAltNameConfigDefaultParams(String name, - Vector params) { + public static void getSubjAltNameConfigDefaultParams(String name, + Vector params) { _engine.getSubjAltNameConfigDefaultParams(name, params); } /** * Get extended plugin info for subject alt name configuration. - * + * * @param name configuration name * @param params configuration parameters */ - public static void getSubjAltNameConfigExtendedPluginInfo(String name, - Vector params) { + public static void getSubjAltNameConfigExtendedPluginInfo(String name, + Vector params) { _engine.getSubjAltNameConfigExtendedPluginInfo(name, params); } /** * Creates subject alt name configuration. - * + * * @param name configuration name * @param config configuration store * @param isValueConfigured true if value is configured * @exception EBaseException failed to create subject alt name configuration */ - public static ISubjAltNameConfig createSubjAltNameConfig(String name, IConfigStore config, boolean isValueConfigured) throws EBaseException { - return _engine.createSubjAltNameConfig( - name, config, isValueConfigured); + public static ISubjAltNameConfig createSubjAltNameConfig(String name, + IConfigStore config, boolean isValueConfigured) + throws EBaseException { + return _engine.createSubjAltNameConfig(name, config, isValueConfigured); } /** * Retrieves default general name configuration. - * + * * @param name configuration name * @param isValueConfigured true if value is configured * @param params configuration parameters * @exception EBaseException failed to create subject alt name configuration */ public static void getGeneralNameConfigDefaultParams(String name, - boolean isValueConfigured, Vector params) { - _engine.getGeneralNameConfigDefaultParams(name, - isValueConfigured, params); + boolean isValueConfigured, Vector params) { + _engine.getGeneralNameConfigDefaultParams(name, isValueConfigured, + params); } /** * Retrieves default general names configuration. - * + * * @param name configuration name * @param isValueConfigured true if value is configured * @param params configuration parameters * @exception EBaseException failed to create subject alt name configuration */ public static void getGeneralNamesConfigDefaultParams(String name, - boolean isValueConfigured, Vector params) { - _engine.getGeneralNamesConfigDefaultParams(name, - isValueConfigured, params); + boolean isValueConfigured, Vector params) { + _engine.getGeneralNamesConfigDefaultParams(name, isValueConfigured, + params); } /** * Retrieves extended plugin info for general name configuration. - * + * * @param name configuration name * @param isValueConfigured true if value is configured * @param info configuration parameters * @exception EBaseException failed to create subject alt name configuration */ public static void getGeneralNameConfigExtendedPluginInfo(String name, - boolean isValueConfigured, Vector info) { - _engine.getGeneralNameConfigExtendedPluginInfo(name, - isValueConfigured, info); + boolean isValueConfigured, Vector info) { + _engine.getGeneralNameConfigExtendedPluginInfo(name, isValueConfigured, + info); } /** * Retrieves extended plugin info for general name configuration. - * + * * @param name configuration name * @param isValueConfigured true if value is configured * @param info configuration parameters * @exception EBaseException failed to create subject alt name configuration */ public static void getGeneralNamesConfigExtendedPluginInfo(String name, - boolean isValueConfigured, Vector info) { + boolean isValueConfigured, Vector info) { _engine.getGeneralNamesConfigExtendedPluginInfo(name, - isValueConfigured, info); + isValueConfigured, info); } /** * Created general names configuration. - * + * * @param name configuration name * @param config configuration store * @param isValueConfigured true if value is configured * @param isPolicyEnabled true if policy is enabled * @exception EBaseException failed to create subject alt name configuration */ - public static IGeneralNamesConfig createGeneralNamesConfig(String name, - IConfigStore config, boolean isValueConfigured, - boolean isPolicyEnabled) throws EBaseException { - return _engine.createGeneralNamesConfig(name, config, isValueConfigured, - isPolicyEnabled); + public static IGeneralNamesConfig createGeneralNamesConfig(String name, + IConfigStore config, boolean isValueConfigured, + boolean isPolicyEnabled) throws EBaseException { + return _engine.createGeneralNamesConfig(name, config, + isValueConfigured, isPolicyEnabled); } /** * Created general name constraints configuration. - * + * * @param name configuration name * @param config configuration store * @param isValueConfigured true if value is configured * @param isPolicyEnabled true if policy is enabled * @exception EBaseException failed to create subject alt name configuration */ - public static IGeneralNameAsConstraintsConfig createGeneralNameAsConstraintsConfig(String name, IConfigStore config, boolean isValueConfigured, - boolean isPolicyEnabled) throws EBaseException { - return _engine.createGeneralNameAsConstraintsConfig( - name, config, isValueConfigured, isPolicyEnabled); + public static IGeneralNameAsConstraintsConfig createGeneralNameAsConstraintsConfig( + String name, IConfigStore config, boolean isValueConfigured, + boolean isPolicyEnabled) throws EBaseException { + return _engine.createGeneralNameAsConstraintsConfig(name, config, + isValueConfigured, isPolicyEnabled); } /** * Created general name constraints configuration. - * + * * @param name configuration name * @param config configuration store * @param isValueConfigured true if value is configured * @param isPolicyEnabled true if policy is enabled * @exception EBaseException failed to create subject alt name configuration */ - public static IGeneralNamesAsConstraintsConfig createGeneralNamesAsConstraintsConfig(String name, IConfigStore config, boolean isValueConfigured, - boolean isPolicyEnabled) throws EBaseException { - return _engine.createGeneralNamesAsConstraintsConfig( - name, config, isValueConfigured, isPolicyEnabled); + public static IGeneralNamesAsConstraintsConfig createGeneralNamesAsConstraintsConfig( + String name, IConfigStore config, boolean isValueConfigured, + boolean isPolicyEnabled) throws EBaseException { + return _engine.createGeneralNamesAsConstraintsConfig(name, config, + isValueConfigured, isPolicyEnabled); } /** * Returns the finger print of the given certificate. - * - * @param cert certificate + * + * @param cert certificate * @return finger print of certificate */ public static String getFingerPrint(Certificate cert) - throws CertificateEncodingException, NoSuchAlgorithmException { + throws CertificateEncodingException, NoSuchAlgorithmException { return _engine.getFingerPrint(cert); } /** * Returns the finger print of the given certificate. - * - * @param certDer DER byte array of the certificate + * + * @param certDer DER byte array of the certificate * @return finger print of certificate */ public static String getFingerPrints(byte[] certDer) - throws NoSuchAlgorithmException { + throws NoSuchAlgorithmException { return _engine.getFingerPrints(certDer); } /** * Returns the finger print of the given certificate. - * - * @param cert certificate + * + * @param cert certificate * @return finger print of certificate */ public static String getFingerPrints(Certificate cert) - throws NoSuchAlgorithmException, CertificateEncodingException { + throws NoSuchAlgorithmException, CertificateEncodingException { return _engine.getFingerPrints(cert); } - /** - * Creates a HTTP PKI Message that can be sent to a remote - * authority. - * + /** + * Creates a HTTP PKI Message that can be sent to a remote authority. + * * @return a new PKI Message for remote authority */ public static IPKIMessage getHttpPKIMessage() { return _engine.getHttpPKIMessage(); } - /** - * Creates a request encoder. A request cannot be sent to - * the remote authority in its regular format. - * + /** + * Creates a request encoder. A request cannot be sent to the remote + * authority in its regular format. + * * @return a request encoder */ public static IRequestEncoder getHttpRequestEncoder() { return _engine.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 */ @@ -1235,9 +1253,9 @@ public final class CMS { return _engine.BtoA(data); } - /** + /** * 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 */ @@ -1246,42 +1264,40 @@ public final class CMS { } /** - * Retrieves the ldap connection information from the configuration - * store. - * + * Retrieves the ldap connection information from the configuration store. + * * @param config configuration parameters of ldap connection * @return a LDAP connection info */ public static ILdapConnInfo getLdapConnInfo(IConfigStore config) - throws EBaseException, ELdapException { + throws EBaseException, ELdapException { return _engine.getLdapConnInfo(config); } /** - * Creates a LDAP SSL socket with the given nickname. The - * certificate associated with the nickname will be used - * for client authentication. - * + * 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 */ - public static LDAPSSLSocketFactoryExt getLdapJssSSLSocketFactory( - String certNickname) { + public static LDAPSSLSocketFactoryExt getLdapJssSSLSocketFactory( + String certNickname) { return _engine.getLdapJssSSLSocketFactory(certNickname); } /** * Creates a LDAP SSL socket. - * + * * @return LDAP SSL socket factory */ - public static LDAPSSLSocketFactoryExt getLdapJssSSLSocketFactory() { + public static LDAPSSLSocketFactoryExt getLdapJssSSLSocketFactory() { return _engine.getLdapJssSSLSocketFactory(); } /** * Creates a LDAP Auth Info object. - * + * * @return LDAP authentication info */ public static ILdapAuthInfo getLdapAuthInfo() { @@ -1290,27 +1306,27 @@ public final class CMS { /** * Retrieves the LDAP connection factory. - * + * * @return bound LDAP connection pool */ public static ILdapConnFactory getLdapBoundConnFactory() - throws ELdapException { + throws ELdapException { return _engine.getLdapBoundConnFactory(); } /** * Retrieves the LDAP connection factory. - * + * * @return anonymous LDAP connection pool */ public static ILdapConnFactory getLdapAnonConnFactory() - throws ELdapException { + throws ELdapException { return _engine.getLdapAnonConnFactory(); } /** * Retrieves the default X.509 certificate template. - * + * * @return default certificate template */ public static X509CertInfo getDefaultX509CertInfo() { @@ -1318,9 +1334,9 @@ public final class CMS { } /** - * Retrieves the certifcate in MIME-64 encoded format - * with header and footer. - * + * Retrieves the certifcate in MIME-64 encoded format with header and + * footer. + * * @param cert certificate * @return base-64 format certificate */ @@ -1328,26 +1344,26 @@ public final class CMS { return _engine.getEncodedCert(cert); } - /** - * Verifies all system certs - * with tags defined in <subsystemtype>.cert.list - */ + /** + * Verifies all system certs with tags defined in <subsystemtype>.cert.list + */ public static boolean verifySystemCerts() { return _engine.verifySystemCerts(); } - /** - * Verify a system cert by tag name - * with tags defined in <subsystemtype>.cert.list - */ + /** + * Verify a system cert by tag name with tags defined in + * <subsystemtype>.cert.list + */ public static boolean verifySystemCertByTag(String tag) { return _engine.verifySystemCertByTag(tag); } - /** - * Verify a system cert by certificate nickname - */ - public static boolean verifySystemCertByNickname(String nickname, String certificateUsage) { + /** + * Verify a system cert by certificate nickname + */ + public static boolean verifySystemCertByNickname(String nickname, + String certificateUsage) { return _engine.verifySystemCertByNickname(nickname, certificateUsage); } @@ -1360,7 +1376,7 @@ public final class CMS { /** * Checks if the given certificate is a signing certificate. - * + * * @param cert certificate * @return true if the given certificate is a signing certificate */ @@ -1370,7 +1386,7 @@ public final class CMS { /** * Checks if the given certificate is an encryption certificate. - * + * * @param cert certificate * @return true if the given certificate is an encryption certificate */ @@ -1380,7 +1396,7 @@ public final class CMS { /** * Retrieves the email form processor. - * + * * @return email form processor */ public static IEmailFormProcessor getEmailFormProcessor() { @@ -1389,7 +1405,7 @@ public final class CMS { /** * Retrieves the email form template. - * + * * @return email template */ public static IEmailTemplate getEmailTemplate(String path) { @@ -1398,7 +1414,7 @@ public final class CMS { /** * Retrieves the email notification handler. - * + * * @return email notification */ public static IMailNotification getMailNotification() { @@ -1407,7 +1423,7 @@ public final class CMS { /** * Retrieves the email key resolver. - * + * * @return email key resolver */ public static IEmailResolverKeys getEmailResolverKeys() { @@ -1416,19 +1432,19 @@ public final class CMS { /** * Checks if the given OID is valid. - * + * * @param attrName attribute name * @param value attribute value * @return object identifier of the given attrName */ - public static ObjectIdentifier checkOID(String attrName, String value) - throws EBaseException { + public static ObjectIdentifier checkOID(String attrName, String value) + throws EBaseException { return _engine.checkOID(attrName, value); } /** * Retrieves the email resolver that checks for subjectAlternateName. - * + * * @return email key resolver */ public static IEmailResolver getReqCertSANameEmailResolver() { @@ -1437,7 +1453,7 @@ public final class CMS { /** * Retrieves the extension pretty print handler. - * + * * @param e extension * @param indent indentation * @return extension pretty print handler @@ -1445,10 +1461,10 @@ public final class CMS { public static IExtPrettyPrint getExtPrettyPrint(Extension e, int indent) { return _engine.getExtPrettyPrint(e, indent); } - + /** * Retrieves the certificate pretty print handler. - * + * * @param delimiter delimiter * @return certificate pretty print handler */ @@ -1458,7 +1474,7 @@ public final class CMS { /** * Retrieves the CRL pretty print handler. - * + * * @param crl CRL * @return CRL pretty print handler */ @@ -1468,7 +1484,7 @@ public final class CMS { /** * Retrieves the CRL cache pretty print handler. - * + * * @param ip CRL issuing point * @return CRL pretty print handler */ @@ -1478,7 +1494,7 @@ public final class CMS { /** * Retrieves the certificate pretty print handler. - * + * * @param cert certificate * @return certificate pretty print handler */ @@ -1496,7 +1512,7 @@ public final class CMS { /** * Retrieves the password check. - * + * * @return default password checker */ public static IPasswordCheck getPasswordChecker() { @@ -1505,7 +1521,7 @@ public final class CMS { /** * Puts a password entry into the single-sign on cache. - * + * * @param tag password tag * @param pw password */ @@ -1524,7 +1540,7 @@ public final class CMS { /** * Retrieves command queue - * + * * @return command queue */ public static ICommandQueue getCommandQueue() { @@ -1533,33 +1549,28 @@ public final class CMS { /** * Loads the configuration file and starts CMS's core implementation. - * + * * @param path path to configuration file (CMS.cfg) * @exception EBaseException failed to start CMS */ public static void start(String path) throws EBaseException { - //FileConfigStore mainConfig = null; -/* - try { - mainConfig = new FileConfigStore(path); - } catch (EBaseException e) { - e.printStackTrace(); - System.out.println( - "Error: The Server is not fully configured.\n" + - "Finish configuring server using Configure Setup Wizard in " + - "the Certificate Server Console."); - System.out.println(e.toString()); - System.exit(0); - } -*/ + // FileConfigStore mainConfig = null; + /* + * try { mainConfig = new FileConfigStore(path); } catch (EBaseException + * e) { e.printStackTrace(); System.out.println( + * "Error: The Server is not fully configured.\n" + + * "Finish configuring server using Configure Setup Wizard in " + + * "the Certificate Server Console."); System.out.println(e.toString()); + * System.exit(0); } + */ String classname = "com.netscape.cmscore.apps.CMSEngine"; CMS cms = null; try { - ICMSEngine engine = (ICMSEngine) - Class.forName(classname).newInstance(); + ICMSEngine engine = (ICMSEngine) Class.forName(classname) + .newInstance(); cms = new CMS(engine); IConfigStore mainConfig = createFileConfigStore(path); @@ -1568,16 +1579,16 @@ public final class CMS { } catch (EBaseException e) { // catch everything here purposely CMS.debug("CMS:Caught EBaseException"); - CMS.debug(e); + CMS.debug(e); - // Raidzilla Bug #57592: Always print error message to stdout. + // Raidzilla Bug #57592: Always print error message to stdout. System.out.println(e.toString()); shutdown(); throw e; - } catch (Exception e) { // catch everything here purposely - ByteArrayOutputStream bos = new ByteArrayOutputStream(); - PrintStream ps = new PrintStream(bos); + } catch (Exception e) { // catch everything here purposely + ByteArrayOutputStream bos = new ByteArrayOutputStream(); + PrintStream ps = new PrintStream(bos); e.printStackTrace(ps); System.out.println(Constants.SERVER_SHUTDOWN_MESSAGE); @@ -1586,7 +1597,8 @@ public final class CMS { } } - public static IConfigStore createFileConfigStore(String path) throws EBaseException { + public static IConfigStore createFileConfigStore(String path) + throws EBaseException { return _engine.createFileConfigStore(path); } @@ -1606,10 +1618,11 @@ public final class CMS { return _engine.isRevoked(certificates); } - public static void setListOfVerifiedCerts(int size, long interval, long unknownStateInterval) { + public static void setListOfVerifiedCerts(int size, long interval, + long unknownStateInterval) { _engine.setListOfVerifiedCerts(size, interval, unknownStateInterval); } - + public static IPasswordStore getPasswordStore() { return _engine.getPasswordStore(); } |