Package com.netscape.cmscore.apps
Class CMSEngine
java.lang.Object
com.netscape.cmscore.apps.CMSEngine
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected org.mozilla.jss.ssl.SSLCertificateApprovalCallback
protected Auditor
protected AuthSubsystem
protected AuthzSubsystem
protected PKIClientSocketListener
protected EngineConfig
protected DBSubsystem
protected CMSGateway
protected JobsScheduler
protected JssSubsystem
static org.slf4j.Logger
protected LogSubsystem
protected EngineConfig
protected OidLoaderSubsystem
protected RequestNotifier
protected RequestNotifier
protected RequestQueue
protected RequestRepository
protected RequestSubsystem
protected ServerConfig
protected PKIServerSocketListener
final Map<String,
SubsystemInfoConfig> protected UGSubsystem
protected X500NameSubsystem
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
void
void
autoShutdown
(boolean restart) void
sign some known data to determine if signing key is botched; if so, proceed to graceful shutdownvoid
void
void
createConfig
(ConfigStorage storage) createLdapAnonConnFactory
(String id, int minConns, int maxConns, LdapConnInfo connInfo) createLdapAnonConnFactory
(String id, LDAPConfig ldapConfig) createLdapBoundConnFactory
(String id, int minConns, int maxConns, LdapConnInfo connInfo, LdapAuthInfo authInfo) createLdapBoundConnFactory
(String id, LDAPConfig ldapConfig) void
void
void
Shuts down subsystems in backwards order exceptions are ignored.org.mozilla.jss.ssl.SSLCertificateApprovalCallback
getAuditGroups
(String subjectID) Get signed audit groups This method is called to extract all groups associated with the audit subject ID.returns the main config storeint
getID()
getName()
getPendingListener
(String name) get listener from listener listint
getPID()
getRequestListener
(String name) Retrieves the request listener by name.Retrieves all request listeners.get request notifierlong
get time server started upgetSubsystem
(String name) void
init()
initialize all static, dynamic and final static subsystems.void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
protected void
void
void
initSubsystem
(Subsystem subsystem, ConfigStore subsystemConfig) void
void
void
void
boolean
static boolean
isNT()
boolean
boolean
isReady()
boolean
isRevoked
(X509Certificate[] certificates) boolean
void
loadConfig
(String path) loadConfigStore
(String path) protected void
load subsystemsvoid
void
putPasswordCache
(String tag, String pw) void
Resends requests New non-blocking recover method.void
registerPendingListener
(RequestListener listener) register listener for pending requestsvoid
registerPendingListener
(String name, RequestListener listener) register listener for pending requests with a name.void
registerRequestListener
(RequestListener listener) Registers a request listener.void
registerRequestListener
(String name, RequestListener listener) Registers a request listener.void
removeRequestListener
(RequestListener listener) Removes a request listener.void
removeRequestListener
(String name) removes listener with a name.void
setApprovalCallback
(org.mozilla.jss.ssl.SSLCertificateApprovalCallback approvalCallback) void
setCSState
(int mode) void
void
setListOfVerifiedCerts
(int size, long interval, long unknownStateInterval) void
void
setPendingNotifier
(RequestNotifier pendingNotifier) void
setRequestNotifier
(RequestNotifier requestNotifier) void
setRequestQueue
(RequestQueue requestQueue) void
setRequestRepository
(RequestRepository requestRepository) void
setServerCertNickname
(String newName) void
setServerCertNickname
(String tokenName, String nickName) void
shutdown()
Shuts down subsystems in backwards order exceptions are ignored.void
void
void
void
void
void
void
void
void
void
protected void
void
void
void
void
start()
protected void
void
int
testLDAPConnection
(String name, LDAPConnectionConfig connConfig, String binddn, String pwd) void
void
Verify a certificate by its tag name, do a full verification.void
verifySystemCertByTag
(String tag, boolean checkValidityOnly) Verify a certificate by its tag name.void
verifySystemCerts
(boolean checkValidityOnly) Go through all system certs and check to see if they are good and audit the result.
-
Field Details
-
logger
public static org.slf4j.Logger logger -
id
-
name
-
instanceDir
-
config
-
mConfig
-
serverConfig
-
auditor
-
logSubsystem
-
clientSocketListener
-
serverSocketListener
-
jssSubsystem
-
dbSubsystem
-
requestRepository
-
requestQueue
-
ugSubsystem
-
oidLoaderSubsystem
-
x500NameSubsystem
-
requestSubsystem
-
authSubsystem
-
authzSubsystem
-
gateway
-
jobsScheduler
-
subsystemInfos
-
subsystems
-
unsecurePort
-
securePort
-
requestNotifier
-
pendingNotifier
-
approvalCallback
protected org.mozilla.jss.ssl.SSLCertificateApprovalCallback approvalCallback -
mVCList
-
-
Constructor Details
-
CMSEngine
-
-
Method Details
-
getApprovalCallback
public org.mozilla.jss.ssl.SSLCertificateApprovalCallback getApprovalCallback() -
setApprovalCallback
public void setApprovalCallback(org.mozilla.jss.ssl.SSLCertificateApprovalCallback approvalCallback) -
getID
-
setID
-
getName
-
setName
-
getPluginRegistry
-
getLogSubsystem
-
getAuditor
-
getClientSocketListener
-
getServerSocketListener
-
getJSSSubsystem
-
getDBSubsystem
-
getRequestRepository
-
setRequestRepository
-
getRequestQueue
-
setRequestQueue
-
getUGSubsystem
-
getOIDLoaderSubsystem
-
getX500NameSubsystem
-
getRequestSubsystem
-
getAuthSubsystem
-
getAuthzSubsystem
-
getCMSGateway
-
getJobsScheduler
-
getRequestNotifier
get request notifier -
setRequestNotifier
-
getRequestListenerNames
Retrieves all request listeners.- Returns:
- name enumeration of all request listeners
-
getRequestListener
Retrieves the request listener by name.- Parameters:
name
- request listener name- Returns:
- the request listener
-
registerRequestListener
Registers a request listener. -
registerRequestListener
Registers a request listener.- Parameters:
name
- under request listener is going to be registeredlistener
- request listener to be registered
-
removeRequestListener
Removes a request listener.- Parameters:
listener
- request listener to be removed
-
removeRequestListener
removes listener with a name. -
getPendingNotifier
-
setPendingNotifier
-
getPendingListener
get listener from listener list -
registerPendingListener
register listener for pending requests -
registerPendingListener
register listener for pending requests with a name. -
loadConfig
- Throws:
Exception
-
createConfig
- Throws:
Exception
-
getPasswordStore
- Throws:
EBaseException
-
initDebug
- Throws:
Exception
-
initSubsystemListeners
- Throws:
Exception
-
initPasswordStore
- Throws:
Exception
-
testLDAPConnections
- Throws:
Exception
-
testLDAPConnection
public int testLDAPConnection(String name, LDAPConnectionConfig connConfig, String binddn, String pwd) throws EBaseException - Throws:
EBaseException
-
initSecurityProvider
public void initSecurityProvider() -
initDatabase
- Throws:
Exception
-
initPluginRegistry
- Throws:
Exception
-
initAuditor
- Throws:
Exception
-
initLogSubsystem
- Throws:
Exception
-
initClientSocketListener
public void initClientSocketListener() -
initServerSocketListener
public void initServerSocketListener() -
initJssSubsystem
- Throws:
Exception
-
initDBSubsystem
- Throws:
Exception
-
initUGSubsystem
- Throws:
Exception
-
initOIDLoaderSubsystem
- Throws:
Exception
-
initX500NameSubsystem
- Throws:
Exception
-
initRequestSubsystem
- Throws:
Exception
-
initAuthSubsystem
- Throws:
Exception
-
initAuthzSubsystem
- Throws:
Exception
-
initCMSGateway
- Throws:
Exception
-
initJobsScheduler
- Throws:
Exception
-
configurePorts
- Throws:
Exception
-
initSecurityDomain
- Throws:
Exception
-
init
initialize all static, dynamic and final static subsystems.- Throws:
Exception
- if any error occur in subsystems during initialization.
-
loadConfigStore
- Throws:
EBaseException
-
isPreOpMode
public boolean isPreOpMode() -
isRunningMode
public boolean isRunningMode() -
setCSState
public void setCSState(int mode) -
getCSState
public int getCSState() -
getSecurityDomainSessionTable
-
getEENonSSLPort
-
getEESSLPort
-
getEEClientAuthSSLPort
-
getAgentPort
-
getAdminPort
-
getSubsystems
-
getSubsystem
-
loadSubsystems
load subsystems- Throws:
Exception
-
initSubsystem
- Throws:
Exception
-
initSubsystems
- Throws:
Exception
-
configureAutoShutdown
- Throws:
Exception
-
configureServerCertNickname
- Throws:
EBaseException
-
checkForAndAutoShutdown
public void checkForAndAutoShutdown()sign some known data to determine if signing key is botched; if so, proceed to graceful shutdown -
recoverRequestQueue
public void recoverRequestQueue()Resends requests New non-blocking recover method. -
startupSubsystems
- Throws:
Exception
-
notifySubsystemStarted
public void notifySubsystemStarted() -
start
- Throws:
Exception
-
initSequence
- Throws:
Exception
-
isInRunningState
public boolean isInRunningState() -
getServerCertNickname
-
setServerCertNickname
-
setServerCertNickname
-
createLdapAnonConnFactory
public LdapAnonConnFactory createLdapAnonConnFactory(String id, LDAPConfig ldapConfig) throws EBaseException - Throws:
EBaseException
-
createLdapAnonConnFactory
public LdapAnonConnFactory createLdapAnonConnFactory(String id, int minConns, int maxConns, LdapConnInfo connInfo) throws EBaseException - Throws:
EBaseException
-
createLdapBoundConnFactory
public LdapBoundConnFactory createLdapBoundConnFactory(String id, LDAPConfig ldapConfig) throws EBaseException - Throws:
EBaseException
-
createLdapBoundConnFactory
public LdapBoundConnFactory createLdapBoundConnFactory(String id, int minConns, int maxConns, LdapConnInfo connInfo, LdapAuthInfo authInfo) throws EBaseException - Throws:
EBaseException
-
getMailNotification
-
getPasswordChecker
-
disableRequests
public void disableRequests() -
areRequestsDisabled
public boolean areRequestsDisabled() -
terminateRequests
public void terminateRequests() -
isNT
public static boolean isNT() -
shutdownJobsScheduler
public void shutdownJobsScheduler() -
shutdownAuthzSubsystem
public void shutdownAuthzSubsystem() -
shutdownAuthSubsystem
public void shutdownAuthSubsystem() -
shutdownRequestSubsystem
public void shutdownRequestSubsystem() -
shutdownX500NameSubsystem
public void shutdownX500NameSubsystem() -
shutdownOIDLoaderSubsystem
public void shutdownOIDLoaderSubsystem() -
shutdownUGSubsystem
public void shutdownUGSubsystem() -
shutdownDBSubsystem
public void shutdownDBSubsystem() -
shutdownJSSSubsystem
public void shutdownJSSSubsystem() -
shutdownLogSubsystem
public void shutdownLogSubsystem() -
shutdownDatabase
public void shutdownDatabase() -
shutdownPluginRegistry
public void shutdownPluginRegistry() -
shutdown
public void shutdown()Shuts down subsystems in backwards order exceptions are ignored. process exists at end to force exit. -
forceShutdown
public void forceShutdown()Shuts down subsystems in backwards order exceptions are ignored. process exists at end to force exit. Added extra call to shutdown the web server. -
autoShutdown
public void autoShutdown() -
autoShutdown
public void autoShutdown(boolean restart) -
disableSubsystem
public void disableSubsystem() -
shutdownSubsystems
protected void shutdownSubsystems() -
getConfigStore
returns the main config store -
getConfig
-
getServerConfig
-
getStartupTime
public long getStartupTime()get time server started up -
putPasswordCache
-
getPID
public int getPID() -
setListOfVerifiedCerts
public void setListOfVerifiedCerts(int size, long interval, long unknownStateInterval) -
isRevoked
-
isReady
public boolean isReady() -
sleepOneMinute
public void sleepOneMinute() -
verifySystemCerts
Go through all system certs and check to see if they are good and audit the result. Optionally only check certs validity.- Throws:
Exception
- if something is wrong
-
verifySystemCertByTag
Verify a certificate by its tag name, do a full verification.- Throws:
Exception
- if something is wrong
-
verifySystemCertByTag
Verify a certificate by its tag name. Perform optional validity check only.- Throws:
Exception
- if something is wrong
-
getAuditGroups
Get signed audit groups This method is called to extract all groups associated with the audit subject ID.- Parameters:
subjectID
- audit subject ID- Returns:
- a comma-delimited string of groups associated with the audit subject ID
-