public interface ICMSEngine extends ISubsystem
The engine implementation is loaded by CMS at startup. It is responsible for starting up all the related subsystems.
Modifier and Type | Method and Description |
---|---|
boolean |
areRequestsDisabled()
Checks to ensure that all new incoming requests have been blocked.
|
void |
autoShutdown()
graceful shutdown, same as forceShutdown, but allowing
option to restart
|
void |
checkForAndAutoShutdown() |
IArgBlock |
createArgBlock()
Creates argument block.
|
IArgBlock |
createArgBlock(java.util.Hashtable<java.lang.String,java.lang.String> httpReq)
Creates argument block.
|
IArgBlock |
createArgBlock(java.lang.String realm,
java.util.Hashtable<java.lang.String,java.lang.String> httpReq)
Creates argument block.
|
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.
|
IConfigStore |
createFileConfigStore(java.lang.String path)
Create configuration file.
|
void |
debug(byte[] data)
Puts data of an byte array into the debug file.
|
void |
debug(int level,
java.lang.String msg)
Puts a message into the debug file.
|
void |
debug(java.lang.String msg)
Puts a message into the debug file.
|
void |
debug(java.lang.Throwable e)
Puts an exception into the debug file.
|
boolean |
debugOn()
Checks if the debug mode is on or not.
|
void |
debugStackTrace()
Puts the current stack trace in the debug file.
|
void |
disableRequests()
Blocks all new incoming requests.
|
void |
forceShutdown()
Performs graceful shutdown of CMS.
|
java.lang.String |
getAdminHost()
Retrieves the host name of the server's administration service.
|
java.lang.String |
getAdminIP()
Retrieves the IP address of the server's administration service.
|
java.lang.String |
getAdminPort()
Retrieves the port number of the server's administration service.
|
java.lang.String |
getAgentHost()
Retrieves the host name of the server's agent service.
|
java.lang.String |
getAgentIP()
Retrieves the IP address of the server's agent service.
|
java.lang.String |
getAgentPort()
Retrieves the port number of the server's agent service.
|
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) |
java.lang.String |
getConfigSDSessionId() |
java.lang.String |
getCRLIssuingPointRecordName()
Retrieves the default CRL issuing point record name.
|
int |
getCSState() |
java.util.Date |
getCurrentDate()
Returns a server wide system time.
|
java.lang.String |
getEEClientAuthSSLPort()
Retrieves the port number of the server's client auth secure end entity service.
|
java.lang.String |
getEEHost()
Retrieves the host name of the server's secure end entity service.
|
java.lang.String |
getEENonSSLHost()
Retrieves the host name of the server's non-secure end entity service.
|
java.lang.String |
getEENonSSLIP()
Retrieves the IP address of the server's non-secure end entity service.
|
java.lang.String |
getEENonSSLPort()
Retrieves the port number of the server's non-secure end entity service.
|
java.lang.String |
getEESSLHost()
Retrieves the host name of the server's secure end entity service.
|
java.lang.String |
getEESSLIP()
Retrieves the IP address of the server's secure end entity service.
|
java.lang.String |
getEESSLPort()
Retrieves the port number of the server's secure end entity service.
|
java.lang.String |
getEncodedCert(java.security.cert.X509Certificate cert)
Retrieves the certifcate in MIME-64 encoded format
with header and footer.
|
java.lang.String |
getId()
Gets this ID .
|
java.lang.String |
getInstanceDir()
Retrieves the instance roort path of this server.
|
java.lang.String |
getLogMessage(java.lang.String msgID,
java.lang.Object[] p)
Retrieves log message from LogMessages.properties or audit-evenst.properties.
|
IMailNotification |
getMailNotification()
Retrieves the email notification handler.
|
IPasswordCheck |
getPasswordChecker()
Retrieves the password check.
|
IPasswordStore |
getPasswordStore() |
int |
getPID()
Retrieves the process id of this server.
|
byte[] |
getPKCS7(java.util.Locale locale,
IRequest req) |
IResender |
getResender(IAuthority authority,
java.lang.String nickname,
java.lang.String clientCiphers,
IRemoteAuthority remote,
int interval)
Retrieves the request sender for use with connector.
|
ISecurityDomainSessionTable |
getSecurityDomainSessionTable() |
java.lang.String |
getServerCertNickname()
Retrieves the nickname of the server's server certificate.
|
java.lang.String |
getServerStatus() |
ISharedToken |
getSharedTokenClass(java.lang.String configName)
Retrieves the named SharedToken class
|
long |
getStartupTime()
Retrieves time server started up.
|
ISubsystem |
getSubsystem(java.lang.String name)
Retrieves the registered subsytem with the given name.
|
java.util.Enumeration<java.lang.String> |
getSubsystemNames()
Returns the names of all the registered subsystems.
|
java.util.Enumeration<ISubsystem> |
getSubsystems()
Returns all the registered subsystems.
|
java.lang.String |
getUserMessage(java.util.Locale locale,
java.lang.String msgID)
Retrieves the localized user message from UserMessages.properties.
|
java.lang.String |
getUserMessage(java.util.Locale locale,
java.lang.String msgID,
java.lang.String p1)
Retrieves the localized user message from UserMessages.properties.
|
java.lang.String |
getUserMessage(java.util.Locale locale,
java.lang.String msgID,
java.lang.String[] p)
Retrieves the localized user message from UserMessages.properties.
|
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.
|
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.
|
boolean |
isExcludedLdapAttr(java.lang.String key) |
boolean |
isExcludedLdapAttrsEnabled() |
boolean |
isInRunningState()
Is the server in running state.
|
boolean |
isPreOpMode() |
boolean |
isRevoked(java.security.cert.X509Certificate[] certificates)
Checks against the local certificate repository to see
if the certificates are revoked.
|
boolean |
isRunningMode() |
void |
putPasswordCache(java.lang.String tag,
java.lang.String pw)
Puts a password entry into the single-sign on cache.
|
void |
reinit(java.lang.String id) |
void |
setConfigSDSessionId(java.lang.String id) |
void |
setCSState(int mode) |
void |
setId(java.lang.String id)
Sets the identifier of this subsystem.
|
void |
setListOfVerifiedCerts(int size,
long interval,
long unknownStateInterval)
Sets list of verified certificates
|
void |
setServerCertNickname(java.lang.String newName)
Sets the nickname of the server's server certificate.
|
void |
setServerCertNickname(java.lang.String tokenName,
java.lang.String nickName)
Sets the nickname of the server's server certificate.
|
void |
setSubsystemEnabled(java.lang.String id,
boolean enabled)
Set whether the given subsystem is enabled.
|
void |
sleepOneMinute() |
void |
terminateRequests()
Terminates all requests that are currently in process.
|
void |
traceHashKey(java.lang.String type,
java.lang.String key)
Dump name/value pair debug information to debug file
|
void |
traceHashKey(java.lang.String type,
java.lang.String key,
java.lang.String val) |
void |
traceHashKey(java.lang.String type,
java.lang.String key,
java.lang.String val,
java.lang.String def) |
getConfigStore, init, shutdown, startup
java.lang.String getId()
getId
in interface ISubsystem
void setId(java.lang.String id) throws EBaseException
setId
in interface ISubsystem
id
- CMS engine identifierEBaseException
- failed to set idint getPID()
void reinit(java.lang.String id) throws EBaseException
EBaseException
int getCSState()
void setCSState(int mode)
boolean isPreOpMode()
boolean isRunningMode()
java.lang.String getInstanceDir()
java.util.Date getCurrentDate()
long getStartupTime()
boolean isInRunningState()
java.util.Enumeration<java.lang.String> getSubsystemNames()
java.util.Enumeration<ISubsystem> getSubsystems()
void setSubsystemEnabled(java.lang.String id, boolean enabled) throws EBaseException
id
- The subsystem ID.enabled
- Whether the subsystem is enabledEBaseException
ISubsystem getSubsystem(java.lang.String name)
name
- subsystem namevoid debug(byte[] data)
data
- byte array to be recorded in the debug filevoid debug(java.lang.String msg)
msg
- debugging messagevoid debug(int level, java.lang.String msg)
level
- 0-10msg
- debugging messagevoid debug(java.lang.Throwable e)
e
- exceptionboolean debugOn()
void debugStackTrace()
void traceHashKey(java.lang.String type, java.lang.String key)
void traceHashKey(java.lang.String type, java.lang.String key, java.lang.String val)
void traceHashKey(java.lang.String type, java.lang.String key, java.lang.String val, java.lang.String def)
byte[] getPKCS7(java.util.Locale locale, IRequest req)
java.lang.String getUserMessage(java.util.Locale locale, java.lang.String msgID)
locale
- end-user localemsgID
- message id defined in UserMessages.propertiesjava.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 parametersjava.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 parameterjava.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 parameterjava.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 parameterjava.lang.String getLogMessage(java.lang.String msgID, java.lang.Object[] p)
msgID
- message ID defined in LogMessages.properties or audit-evenst.propertiesp
- an array of parametersICRLIssuingPointRecord createCRLIssuingPointRecord(java.lang.String id, java.math.BigInteger crlNumber, java.lang.Long crlSize, java.util.Date thisUpdate, java.util.Date nextUpdate)
java.lang.String getCRLIssuingPointRecordName()
java.lang.String getEncodedCert(java.security.cert.X509Certificate cert)
cert
- certificatenetscape.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
ISharedToken getSharedTokenClass(java.lang.String configName)
IPasswordCheck getPasswordChecker()
void putPasswordCache(java.lang.String tag, java.lang.String pw)
tag
- password tagpw
- passwordjava.lang.String getServerCertNickname()
void setServerCertNickname(java.lang.String tokenName, java.lang.String nickName)
tokenName
- name of token where the certificate is locatednickName
- name of server certificatevoid setServerCertNickname(java.lang.String newName)
newName
- new nickname of server certificatejava.lang.String getEEHost()
java.lang.String getEENonSSLHost()
java.lang.String getEENonSSLIP()
java.lang.String getEENonSSLPort()
java.lang.String getEESSLHost()
java.lang.String getEESSLIP()
java.lang.String getEESSLPort()
java.lang.String getEEClientAuthSSLPort()
java.lang.String getAgentHost()
java.lang.String getAgentIP()
java.lang.String getAgentPort()
java.lang.String getAdminHost()
java.lang.String getAdminIP()
java.lang.String getAdminPort()
IMailNotification getMailNotification()
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 intervalvoid disableRequests()
void terminateRequests()
boolean areRequestsDisabled()
IConfigStore createFileConfigStore(java.lang.String path) throws EBaseException
path
- configuration pathEBaseException
- failed to create fileIArgBlock createArgBlock()
IArgBlock createArgBlock(java.lang.String realm, java.util.Hashtable<java.lang.String,java.lang.String> httpReq)
IArgBlock createArgBlock(java.util.Hashtable<java.lang.String,java.lang.String> httpReq)
boolean isRevoked(java.security.cert.X509Certificate[] certificates)
certificates
- certificatesvoid setListOfVerifiedCerts(int size, long interval, long unknownStateInterval)
size
- size of verified certificates listinterval
- interval in which certificate is not recheck
against local certificate repositoryunknownStateInterval
- interval in which certificate
may not recheck against local certificate repositoryvoid forceShutdown()
void autoShutdown()
void checkForAndAutoShutdown()
IPasswordStore getPasswordStore() throws EBaseException
EBaseException
ISecurityDomainSessionTable getSecurityDomainSessionTable()
void setConfigSDSessionId(java.lang.String id)
java.lang.String getConfigSDSessionId()
java.lang.String getServerStatus()
void sleepOneMinute()
boolean isExcludedLdapAttrsEnabled()
boolean isExcludedLdapAttr(java.lang.String key)