public final class CMS
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CONFIG_FILE |
static int |
DEBUG_INFORM |
static int |
DEBUG_OBNOXIOUS |
static int |
DEBUG_VERBOSE |
static org.slf4j.Logger |
logger |
static int |
PRE_OP_MODE |
static int |
RUNNING_MODE |
static java.lang.String |
SUBSYSTEM_AUTH |
static java.lang.String |
SUBSYSTEM_AUTHZ |
static java.lang.String |
SUBSYSTEM_CA |
static java.lang.String |
SUBSYSTEM_CRYPTO |
static java.lang.String |
SUBSYSTEM_DBS |
static java.lang.String |
SUBSYSTEM_JOBS |
static java.lang.String |
SUBSYSTEM_KRA |
static java.lang.String |
SUBSYSTEM_LOG |
static java.lang.String |
SUBSYSTEM_OCSP |
static java.lang.String |
SUBSYSTEM_PROFILE |
static java.lang.String |
SUBSYSTEM_RA |
static java.lang.String |
SUBSYSTEM_REGISTRY |
static java.lang.String |
SUBSYSTEM_SELFTESTS |
static java.lang.String |
SUBSYSTEM_TKS |
static java.lang.String |
SUBSYSTEM_UG |
Modifier and Type | Method and Description |
---|---|
static void |
checkForAndAutoShutdown() |
static IArgBlock |
createArgBlock() |
static IArgBlock |
createArgBlock(java.util.Hashtable<java.lang.String,java.lang.String> httpReq) |
static IArgBlock |
createArgBlock(java.lang.String realm,
java.util.Hashtable<java.lang.String,java.lang.String> httpReq) |
static ICRLIssuingPointRecord |
createCRLIssuingPointRecord(java.lang.String id,
java.math.BigInteger crlNumber,
java.lang.Long crlSize,
java.util.Date thisUpdate,
java.util.Date nextUpdate)
Creates an issuing poing record.
|
static IConfigStore |
createFileConfigStore(java.lang.String path) |
static void |
debug(java.lang.String msg)
Puts a message into the debug file.
|
static void |
debug(java.lang.Throwable e)
Puts an exception into the debug file.
|
static boolean |
debugOn()
Checks if the debug mode is on or not.
|
static void |
debugStackTrace()
Puts the current stack trace in the debug file.
|
static java.lang.String |
getAdminPort()
Retrieves the port number of the server's administration service.
|
static java.lang.String |
getAgentHost()
Retrieves the host name of the server's agent service.
|
static java.lang.String |
getAgentPort()
Retrieves the port number of the server's agent service.
|
static netscape.ldap.LDAPConnection |
getBoundConnection(java.lang.String id,
java.lang.String host,
int port,
int version,
netscape.ldap.LDAPSSLSocketFactoryExt fac,
java.lang.String bindDN,
java.lang.String bindPW) |
static ICMSEngine |
getCMSEngine() |
static java.lang.String |
getConfigSDSessionId() |
static IConfigStore |
getConfigStore()
Returns the main config store.
|
static java.lang.String |
getCRLIssuingPointRecordName()
Retrieves the default CRL issuing point record name.
|
static java.util.Date |
getCurrentDate()
Returns a server wide system time.
|
static java.lang.String |
getEEClientAuthSSLPort()
Retrieves the host name of the server's secure end entity service.
|
static java.lang.String |
getEEHost()
Retrieves the host name of the server's secure end entity service.
|
static java.lang.String |
getEENonSSLHost()
Retrieves the host name of the server's non-secure end entity service.
|
static java.lang.String |
getEENonSSLPort()
Retrieves the port number of the server's non-secure end entity service.
|
static java.lang.String |
getEESSLHost()
Retrieves the host name of the server's secure end entity service.
|
static java.lang.String |
getEESSLPort()
Retrieves the port number of the server's secure end entity service.
|
static java.lang.String |
getEncodedCert(java.security.cert.X509Certificate cert)
Retrieves the certifcate in MIME-64 encoded format
with header and footer.
|
static java.lang.String |
getInstanceDir()
Retrieves the instance roort path of this server.
|
static java.lang.String |
getLogMessage(java.lang.String msgID)
Retrieves log message from LogMessages.properties or audit-events.properties.
|
static java.lang.String |
getLogMessage(java.lang.String msgID,
java.lang.Object[] params)
Retrieves log message from LogMessages.properties or audit-events.properties.
|
static java.lang.String |
getLogMessage(java.lang.String msgID,
java.lang.String... params)
Retrieves log message from LogMessages.properties or audit-events.properties.
|
static IMailNotification |
getMailNotification()
Retrieves the email notification handler.
|
static IPasswordCheck |
getPasswordChecker()
Retrieves the password check.
|
static IPasswordStore |
getPasswordStore() |
static int |
getPID()
Retrieves the process id of this server.
|
static byte[] |
getPKCS7(java.util.Locale locale,
IRequest req) |
static IResender |
getResender(IAuthority authority,
java.lang.String nickname,
java.lang.String clientCiphers,
IRemoteAuthority remote,
int interval)
Retrieves the request sender for use with connector.
|
static ISecurityDomainSessionTable |
getSecurityDomainSessionTable() |
static java.lang.String |
getServerCertNickname()
Retrieves the nickname of the server's server certificate.
|
static java.lang.String |
getServerStatus() |
static ISharedToken |
getSharedTokenClass(java.lang.String configName)
Retrieves the SharedToken class.
|
static long |
getStartupTime()
Retrieves time server started up.
|
static ISubsystem |
getSubsystem(java.lang.String name)
Retrieves the registered subsytem with the given name.
|
static java.lang.String |
getUserMessage(java.util.Locale locale,
java.lang.String msgID)
Retrieves the localized user message from UserMessages.properties.
|
static java.lang.String |
getUserMessage(java.util.Locale locale,
java.lang.String msgID,
java.lang.String p1)
Retrieves the localized user message from UserMessages.properties.
|
static java.lang.String |
getUserMessage(java.util.Locale locale,
java.lang.String msgID,
java.lang.String[] p)
Retrieves the localized user message from UserMessages.properties.
|
static java.lang.String |
getUserMessage(java.util.Locale locale,
java.lang.String msgID,
java.lang.String p1,
java.lang.String p2)
Retrieves the localized user message from UserMessages.properties.
|
static java.lang.String |
getUserMessage(java.util.Locale locale,
java.lang.String msgID,
java.lang.String p1,
java.lang.String p2,
java.lang.String p3)
Retrieves the localized user message from UserMessages.properties.
|
static java.lang.String |
getUserMessage(java.lang.String msgID)
Retrieves the localized user message from UserMessages.properties.
|
static java.lang.String |
getUserMessage(java.lang.String msgID,
java.lang.String p1)
Retrieves the localized user message from UserMessages.properties.
|
static java.lang.String |
getUserMessage(java.lang.String msgID,
java.lang.String[] p)
Retrieves the localized user message from UserMessages.properties.
|
static java.lang.String |
getUserMessage(java.lang.String msgID,
java.lang.String p1,
java.lang.String p2)
Retrieves the localized user message from UserMessages.properties.
|
static java.lang.String |
getUserMessage(java.lang.String msgID,
java.lang.String p1,
java.lang.String p2,
java.lang.String p3)
Retrieves the localized user message from UserMessages.properties.
|
static boolean |
isExcludedLdapAttr(java.lang.String key) |
static boolean |
isInRunningState()
Is the server in running state.
|
static boolean |
isPreOpMode() |
static boolean |
isRevoked(java.security.cert.X509Certificate[] certificates) |
static boolean |
isRunningMode() |
static boolean |
isSensitive(java.lang.String name)
Check whether the string is contains password
|
static void |
putPasswordCache(java.lang.String tag,
java.lang.String pw)
Puts a password entry into the single-sign on cache.
|
static void |
setCMSEngine(ICMSEngine engine)
This method is used for unit tests.
|
static void |
setConfigSDSessionId(java.lang.String val) |
static void |
setListOfVerifiedCerts(int size,
long interval,
long unknownStateInterval) |
static void |
setServerCertNickname(java.lang.String newName)
Sets the nickname of the server's server certificate.
|
static void |
setServerCertNickname(java.lang.String tokenName,
java.lang.String nickName)
Sets the nickname of the server's server certificate.
|
static void |
traceHashKey(java.lang.String type,
java.lang.String key) |
static void |
traceHashKey(java.lang.String type,
java.lang.String key,
java.lang.String val) |
static void |
traceHashKey(java.lang.String type,
java.lang.String key,
java.lang.String val,
java.lang.String def) |
public static org.slf4j.Logger logger
public static final int DEBUG_OBNOXIOUS
public static final int DEBUG_VERBOSE
public static final int DEBUG_INFORM
public static final java.lang.String CONFIG_FILE
public static final java.lang.String SUBSYSTEM_LOG
public static final java.lang.String SUBSYSTEM_CRYPTO
public static final java.lang.String SUBSYSTEM_DBS
public static final java.lang.String SUBSYSTEM_CA
public static final java.lang.String SUBSYSTEM_RA
public static final java.lang.String SUBSYSTEM_KRA
public static final java.lang.String SUBSYSTEM_OCSP
public static final java.lang.String SUBSYSTEM_TKS
public static final java.lang.String SUBSYSTEM_UG
public static final java.lang.String SUBSYSTEM_AUTH
public static final java.lang.String SUBSYSTEM_AUTHZ
public static final java.lang.String SUBSYSTEM_REGISTRY
public static final java.lang.String SUBSYSTEM_PROFILE
public static final java.lang.String SUBSYSTEM_JOBS
public static final java.lang.String SUBSYSTEM_SELFTESTS
public static final int PRE_OP_MODE
public static final int RUNNING_MODE
public static ICMSEngine getCMSEngine()
public static void setCMSEngine(ICMSEngine engine)
engine
- The stub engine to set, for testing.public static void checkForAndAutoShutdown()
public static boolean isPreOpMode()
public static boolean isRunningMode()
public static boolean isInRunningState()
public static ICRLIssuingPointRecord createCRLIssuingPointRecord(java.lang.String id, java.math.BigInteger crlNumber, java.lang.Long crlSize, java.util.Date thisUpdate, java.util.Date nextUpdate)
public static java.lang.String getCRLIssuingPointRecordName()
public static int getPID()
public static java.lang.String getInstanceDir()
public static java.util.Date getCurrentDate()
public static void debug(java.lang.String msg)
msg
- debugging messagepublic static void debug(java.lang.Throwable e)
e
- exceptionpublic static boolean debugOn()
public static void debugStackTrace()
public static void traceHashKey(java.lang.String type, java.lang.String key)
public static void traceHashKey(java.lang.String type, java.lang.String key, java.lang.String val)
public static void traceHashKey(java.lang.String type, java.lang.String key, java.lang.String val, java.lang.String def)
public static byte[] getPKCS7(java.util.Locale locale, IRequest req)
public static ISubsystem getSubsystem(java.lang.String name)
name
- subsystem namepublic static java.lang.String getUserMessage(java.lang.String msgID)
msgID
- message id defined in UserMessages.propertiespublic static java.lang.String getUserMessage(java.util.Locale locale, java.lang.String msgID)
locale
- end-user localemsgID
- message id defined in UserMessages.propertiespublic static java.lang.String getUserMessage(java.lang.String msgID, java.lang.String p1)
msgID
- message id defined in UserMessages.propertiesp1
- 1st parameterpublic static java.lang.String getUserMessage(java.util.Locale locale, java.lang.String msgID, java.lang.String p1)
locale
- end-user localemsgID
- message id defined in UserMessages.propertiesp1
- 1st parameterpublic static java.lang.String getUserMessage(java.lang.String msgID, java.lang.String p1, java.lang.String p2)
msgID
- message id defined in UserMessages.propertiesp1
- 1st parameterp2
- 2nd parameterpublic static java.lang.String getUserMessage(java.util.Locale locale, java.lang.String msgID, java.lang.String p1, java.lang.String p2)
locale
- end-user localemsgID
- message id defined in UserMessages.propertiesp1
- 1st parameterp2
- 2nd parameterpublic static java.lang.String getUserMessage(java.lang.String msgID, java.lang.String p1, java.lang.String p2, java.lang.String p3)
msgID
- message id defined in UserMessages.propertiesp1
- 1st parameterp2
- 2nd parameterp3
- 3rd parameterpublic static netscape.ldap.LDAPConnection getBoundConnection(java.lang.String id, java.lang.String host, int port, int version, netscape.ldap.LDAPSSLSocketFactoryExt fac, java.lang.String bindDN, java.lang.String bindPW) throws netscape.ldap.LDAPException
netscape.ldap.LDAPException
public static java.lang.String getUserMessage(java.util.Locale locale, java.lang.String msgID, java.lang.String p1, java.lang.String p2, java.lang.String p3)
locale
- end-user localemsgID
- message id defined in UserMessages.propertiesp1
- 1st parameterp2
- 2nd parameterp3
- 3rd parameterpublic static java.lang.String getUserMessage(java.lang.String msgID, java.lang.String[] p)
msgID
- message id defined in UserMessages.propertiesp
- an array of parameterspublic static java.lang.String getUserMessage(java.util.Locale locale, java.lang.String msgID, java.lang.String[] p)
locale
- end-user localemsgID
- message id defined in UserMessages.propertiesp
- an array of parameterspublic static java.lang.String getLogMessage(java.lang.String msgID)
msgID
- message ID defined in LogMessages.properties or audit-events.propertiespublic static java.lang.String getLogMessage(java.lang.String msgID, java.lang.Object[] params)
msgID
- message ID defined in LogMessages.properties or audit-events.propertiesparams
- object parameterspublic static java.lang.String getLogMessage(java.lang.String msgID, java.lang.String... params)
msgID
- message ID defined in LogMessages.properties or audit-events.propertiesparams
- string parameterspublic static IConfigStore getConfigStore()
public static long getStartupTime()
public static IResender getResender(IAuthority authority, java.lang.String nickname, java.lang.String clientCiphers, IRemoteAuthority remote, int interval)
authority
- local authoritynickname
- nickname of the client certificateremote
- remote authorityinterval
- timeout intervalpublic static java.lang.String getServerCertNickname()
public static void setServerCertNickname(java.lang.String tokenName, java.lang.String nickName)
tokenName
- name of token where the certificate is locatednickName
- name of server certificatepublic static void setServerCertNickname(java.lang.String newName)
newName
- new nickname of server certificatepublic static java.lang.String getEEHost()
public static java.lang.String getEENonSSLHost()
public static java.lang.String getEENonSSLPort()
public static java.lang.String getEESSLHost()
public static java.lang.String getEEClientAuthSSLPort()
public static java.lang.String getEESSLPort()
public static java.lang.String getAgentHost()
public static java.lang.String getAgentPort()
public static java.lang.String getAdminPort()
public static java.lang.String getEncodedCert(java.security.cert.X509Certificate cert)
cert
- certificatepublic static IMailNotification getMailNotification()
public static java.lang.String getConfigSDSessionId()
public static void setConfigSDSessionId(java.lang.String val)
public static IPasswordCheck getPasswordChecker()
public static ISharedToken getSharedTokenClass(java.lang.String configName)
public static void putPasswordCache(java.lang.String tag, java.lang.String pw)
tag
- password tagpw
- passwordpublic static IConfigStore createFileConfigStore(java.lang.String path) throws EBaseException
EBaseException
public static IArgBlock createArgBlock()
public static IArgBlock createArgBlock(java.lang.String realm, java.util.Hashtable<java.lang.String,java.lang.String> httpReq)
public static IArgBlock createArgBlock(java.util.Hashtable<java.lang.String,java.lang.String> httpReq)
public static boolean isRevoked(java.security.cert.X509Certificate[] certificates)
public static void setListOfVerifiedCerts(int size, long interval, long unknownStateInterval)
public static IPasswordStore getPasswordStore() throws EBaseException
EBaseException
public static ISecurityDomainSessionTable getSecurityDomainSessionTable()
public static java.lang.String getServerStatus()
public static boolean isExcludedLdapAttr(java.lang.String key)
public static boolean isSensitive(java.lang.String name)
name
- key string