Package com.netscape.cmscore.apps
Class CMSEngine
- java.lang.Object
-
- com.netscape.cmscore.apps.CMSEngine
-
- All Implemented Interfaces:
java.util.EventListener
,javax.servlet.ServletContextListener
public class CMSEngine extends java.lang.Object implements javax.servlet.ServletContextListener
-
-
Field Summary
Fields Modifier and Type Field Description protected AuthSubsystem
authSubsystem
protected AuthzSubsystem
authzSubsystem
protected EngineConfig
config
protected DBSubsystem
dbSubsystem
static java.lang.String[]
excludedLdapAttrs
java.util.List<java.lang.String>
excludedLdapAttrsList
java.lang.String
id
java.lang.String
instanceDir
protected JobsScheduler
jobsScheduler
protected JssSubsystem
jssSubsystem
static org.slf4j.Logger
logger
protected LogSubsystem
logSubsystem
protected EngineConfig
mConfig
java.lang.String
name
protected OidLoaderSubsystem
oidLoaderSubsystem
static java.lang.String
PROP_SIGNED_AUDIT_CERT_NICKNAME
protected RequestSubsystem
requestSubsystem
java.lang.String
securePort
protected ServerXml
serverXml
java.util.Map<java.lang.String,SubsystemInfo>
subsystemInfos
java.util.Map<java.lang.String,ISubsystem>
subsystems
protected UGSubsystem
ugSubsystem
java.lang.String
unsecurePort
protected X500NameSubsystem
x500NameSubsystem
-
Constructor Summary
Constructors Constructor Description CMSEngine(java.lang.String name)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
areRequestsDisabled()
void
autoShutdown()
void
autoShutdown(boolean restart)
void
checkForAndAutoShutdown()
sign some known data to determine if signing key is botched; if so, proceed to graceful shutdownvoid
configureAutoShutdown()
void
configureExcludedLdapAttrs()
void
configurePorts()
void
configureServerCertNickname()
void
contextDestroyed(javax.servlet.ServletContextEvent event)
void
contextInitialized(javax.servlet.ServletContextEvent event)
EngineConfig
createConfig(ConfigStorage storage)
Configurator
createConfigurator()
IConfigStore
createFileConfigStore(java.lang.String path)
void
disableRequests()
void
disableSubsystem()
void
forceShutdown()
Shuts down subsystems in backwards order exceptions are ignored.java.lang.String
getAdminPort()
java.lang.String
getAgentPort()
AuthSubsystem
getAuthSubsystem()
AuthzSubsystem
getAuthzSubsystem()
EngineConfig
getConfig()
IConfigStore
getConfigStore()
returns the main config storeint
getCSState()
DBSubsystem
getDBSubsystem()
java.lang.String
getEEClientAuthSSLPort()
java.lang.String
getEENonSSLPort()
java.lang.String
getEESSLPort()
java.lang.String
getInstanceDir()
Retrieves the instance root path of this server.JobsScheduler
getJobsScheduler()
JssSubsystem
getJSSSubsystem()
LogSubsystem
getLogSubsystem()
com.netscape.certsrv.notification.IMailNotification
getMailNotification()
OidLoaderSubsystem
getOIDLoaderSubsystem()
com.netscape.certsrv.password.IPasswordCheck
getPasswordChecker()
IPasswordStore
getPasswordStore()
int
getPID()
PluginRegistry
getPluginRegistry()
RequestSubsystem
getRequestSubsystem()
ISecurityDomainSessionTable
getSecurityDomainSessionTable()
java.lang.String
getServerCertNickname()
ServerXml
getServerXml()
com.netscape.certsrv.authentication.ISharedToken
getSharedTokenClass(java.lang.String configName)
long
getStartupTime()
get time server started upISubsystem
getSubsystem(java.lang.String name)
java.util.Collection<ISubsystem>
getSubsystems()
UGSubsystem
getUGSubsystem()
X500NameSubsystem
getX500NameSubsystem()
void
init()
initialize all static, dynamic and final static subsystems.void
initAuthSubsystem()
void
initAuthzSubsystem()
void
initDatabase()
void
initDBSubsystem()
void
initDebug()
void
initJobsScheduler()
void
initJssSubsystem()
void
initLogSubsystem()
void
initOIDLoaderSubsystem()
void
initPasswordStore()
void
initPluginRegistry()
void
initRequestSubsystem()
void
initSecurityDomain()
void
initSecurityProvider()
void
initSubsystem(ISubsystem subsystem, IConfigStore subsystemConfig)
void
initSubsystems()
void
initUGSubsystem()
void
initX500NameSubsystem()
boolean
isExcludedLdapAttr(java.lang.String key)
boolean
isExcludedLdapAttrsEnabled()
boolean
isInRunningState()
static boolean
isNT()
boolean
isPreOpMode()
boolean
isReady()
boolean
isRevoked(java.security.cert.X509Certificate[] certificates)
boolean
isRunningMode()
void
loadConfig(java.lang.String path)
protected void
loadSubsystems()
load subsystemsvoid
putPasswordCache(java.lang.String tag, java.lang.String pw)
void
reinit(java.lang.String id)
void
setCSState(int mode)
void
setListOfVerifiedCerts(int size, long interval, long unknownStateInterval)
void
setServerCertNickname(java.lang.String newName)
void
setServerCertNickname(java.lang.String tokenName, java.lang.String nickName)
void
setSubsystemEnabled(java.lang.String id, boolean enabled)
void
shutdown()
Shuts down subsystems in backwards order exceptions are ignored.void
shutdownAuthSubsystem()
void
shutdownAuthzSubsystem()
void
shutdownDatabase()
void
shutdownDBSubsystem()
void
shutdownJobsScheduler()
void
shutdownJSSSubsystem()
void
shutdownLogSubsystem()
void
shutdownOIDLoaderSubsystem()
void
shutdownPluginRegistry()
void
shutdownRequestSubsystem()
protected void
shutdownSubsystems()
void
shutdownUGSubsystem()
void
shutdownX500NameSubsystem()
void
sleepOneMinute()
void
start()
protected void
startupSubsystems()
void
terminateRequests()
int
testLDAPConnection(java.lang.String name, LdapConnInfo info, java.lang.String binddn, java.lang.String pwd)
static void
upgradeConfig(IConfigStore c)
-
-
-
Field Detail
-
logger
public static org.slf4j.Logger logger
-
PROP_SIGNED_AUDIT_CERT_NICKNAME
public static final java.lang.String PROP_SIGNED_AUDIT_CERT_NICKNAME
- See Also:
- Constant Field Values
-
id
public java.lang.String id
-
name
public java.lang.String name
-
instanceDir
public java.lang.String instanceDir
-
config
protected EngineConfig config
-
mConfig
protected EngineConfig mConfig
-
serverXml
protected ServerXml serverXml
-
logSubsystem
protected LogSubsystem logSubsystem
-
jssSubsystem
protected JssSubsystem jssSubsystem
-
dbSubsystem
protected DBSubsystem dbSubsystem
-
ugSubsystem
protected UGSubsystem ugSubsystem
-
oidLoaderSubsystem
protected OidLoaderSubsystem oidLoaderSubsystem
-
x500NameSubsystem
protected X500NameSubsystem x500NameSubsystem
-
requestSubsystem
protected RequestSubsystem requestSubsystem
-
authSubsystem
protected AuthSubsystem authSubsystem
-
authzSubsystem
protected AuthzSubsystem authzSubsystem
-
jobsScheduler
protected JobsScheduler jobsScheduler
-
subsystemInfos
public final java.util.Map<java.lang.String,SubsystemInfo> subsystemInfos
-
subsystems
public final java.util.Map<java.lang.String,ISubsystem> subsystems
-
unsecurePort
public java.lang.String unsecurePort
-
securePort
public java.lang.String securePort
-
excludedLdapAttrsList
public java.util.List<java.lang.String> excludedLdapAttrsList
-
excludedLdapAttrs
public static java.lang.String[] excludedLdapAttrs
-
-
Method Detail
-
getPluginRegistry
public PluginRegistry getPluginRegistry()
-
getLogSubsystem
public LogSubsystem getLogSubsystem()
-
getJSSSubsystem
public JssSubsystem getJSSSubsystem()
-
getDBSubsystem
public DBSubsystem getDBSubsystem()
-
getUGSubsystem
public UGSubsystem getUGSubsystem()
-
getOIDLoaderSubsystem
public OidLoaderSubsystem getOIDLoaderSubsystem()
-
getX500NameSubsystem
public X500NameSubsystem getX500NameSubsystem()
-
getRequestSubsystem
public RequestSubsystem getRequestSubsystem()
-
getAuthSubsystem
public AuthSubsystem getAuthSubsystem()
-
getAuthzSubsystem
public AuthzSubsystem getAuthzSubsystem()
-
getJobsScheduler
public JobsScheduler getJobsScheduler()
-
loadConfig
public void loadConfig(java.lang.String path) throws java.lang.Exception
- Throws:
java.lang.Exception
-
createConfig
public EngineConfig createConfig(ConfigStorage storage) throws java.lang.Exception
- Throws:
java.lang.Exception
-
getInstanceDir
public java.lang.String getInstanceDir()
Retrieves the instance root path of this server.
-
getPasswordStore
public IPasswordStore getPasswordStore() throws EBaseException
- Throws:
EBaseException
-
initDebug
public void initDebug() throws java.lang.Exception
- Throws:
java.lang.Exception
-
initPasswordStore
public void initPasswordStore() throws java.lang.Exception
- Throws:
java.lang.Exception
-
testLDAPConnection
public int testLDAPConnection(java.lang.String name, LdapConnInfo info, java.lang.String binddn, java.lang.String pwd)
-
initSecurityProvider
public void initSecurityProvider()
-
initDatabase
public void initDatabase() throws java.lang.Exception
- Throws:
java.lang.Exception
-
initPluginRegistry
public void initPluginRegistry() throws java.lang.Exception
- Throws:
java.lang.Exception
-
initLogSubsystem
public void initLogSubsystem() throws java.lang.Exception
- Throws:
java.lang.Exception
-
initJssSubsystem
public void initJssSubsystem() throws java.lang.Exception
- Throws:
java.lang.Exception
-
initDBSubsystem
public void initDBSubsystem() throws java.lang.Exception
- Throws:
java.lang.Exception
-
initUGSubsystem
public void initUGSubsystem() throws java.lang.Exception
- Throws:
java.lang.Exception
-
initOIDLoaderSubsystem
public void initOIDLoaderSubsystem() throws java.lang.Exception
- Throws:
java.lang.Exception
-
initX500NameSubsystem
public void initX500NameSubsystem() throws java.lang.Exception
- Throws:
java.lang.Exception
-
initRequestSubsystem
public void initRequestSubsystem() throws java.lang.Exception
- Throws:
java.lang.Exception
-
initAuthSubsystem
public void initAuthSubsystem() throws java.lang.Exception
- Throws:
java.lang.Exception
-
initAuthzSubsystem
public void initAuthzSubsystem() throws java.lang.Exception
- Throws:
java.lang.Exception
-
initJobsScheduler
public void initJobsScheduler() throws java.lang.Exception
- Throws:
java.lang.Exception
-
configurePorts
public void configurePorts() throws java.lang.Exception
- Throws:
java.lang.Exception
-
initSecurityDomain
public void initSecurityDomain() throws java.lang.Exception
- Throws:
java.lang.Exception
-
init
public void init() throws java.lang.Exception
initialize all static, dynamic and final static subsystems.- Throws:
java.lang.Exception
- if any error occur in subsystems during initialization.
-
createConfigurator
public Configurator createConfigurator() throws java.lang.Exception
- Throws:
java.lang.Exception
-
createFileConfigStore
public IConfigStore createFileConfigStore(java.lang.String path) throws EBaseException
- Throws:
EBaseException
-
isPreOpMode
public boolean isPreOpMode()
-
isRunningMode
public boolean isRunningMode()
-
setCSState
public void setCSState(int mode)
-
getCSState
public int getCSState()
-
getSecurityDomainSessionTable
public ISecurityDomainSessionTable getSecurityDomainSessionTable()
-
getEENonSSLPort
public java.lang.String getEENonSSLPort()
-
getEESSLPort
public java.lang.String getEESSLPort()
-
getEEClientAuthSSLPort
public java.lang.String getEEClientAuthSSLPort()
-
getAgentPort
public java.lang.String getAgentPort()
-
getAdminPort
public java.lang.String getAdminPort()
-
getSubsystems
public java.util.Collection<ISubsystem> getSubsystems()
-
getSubsystem
public ISubsystem getSubsystem(java.lang.String name)
-
setSubsystemEnabled
public void setSubsystemEnabled(java.lang.String id, boolean enabled)
-
loadSubsystems
protected void loadSubsystems() throws java.lang.Exception
load subsystems- Throws:
java.lang.Exception
-
initSubsystem
public void initSubsystem(ISubsystem subsystem, IConfigStore subsystemConfig) throws java.lang.Exception
- Throws:
java.lang.Exception
-
initSubsystems
public void initSubsystems() throws java.lang.Exception
- Throws:
java.lang.Exception
-
configureAutoShutdown
public void configureAutoShutdown() throws java.lang.Exception
- Throws:
java.lang.Exception
-
configureServerCertNickname
public void configureServerCertNickname() throws EBaseException
- Throws:
EBaseException
-
configureExcludedLdapAttrs
public void configureExcludedLdapAttrs() throws EBaseException
- Throws:
EBaseException
-
isExcludedLdapAttrsEnabled
public boolean isExcludedLdapAttrsEnabled()
-
isExcludedLdapAttr
public boolean isExcludedLdapAttr(java.lang.String key)
-
checkForAndAutoShutdown
public void checkForAndAutoShutdown()
sign some known data to determine if signing key is botched; if so, proceed to graceful shutdown
-
reinit
public void reinit(java.lang.String id) throws EBaseException
- Throws:
EBaseException
-
startupSubsystems
protected void startupSubsystems() throws java.lang.Exception
- Throws:
java.lang.Exception
-
start
public void start() throws java.lang.Exception
- Throws:
java.lang.Exception
-
isInRunningState
public boolean isInRunningState()
-
getServerCertNickname
public java.lang.String getServerCertNickname()
-
setServerCertNickname
public void setServerCertNickname(java.lang.String tokenName, java.lang.String nickName)
-
setServerCertNickname
public void setServerCertNickname(java.lang.String newName)
-
getMailNotification
public com.netscape.certsrv.notification.IMailNotification getMailNotification()
-
getPasswordChecker
public com.netscape.certsrv.password.IPasswordCheck getPasswordChecker()
-
getSharedTokenClass
public com.netscape.certsrv.authentication.ISharedToken getSharedTokenClass(java.lang.String configName)
-
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
public IConfigStore getConfigStore()
returns the main config store
-
getConfig
public EngineConfig getConfig()
-
getServerXml
public ServerXml getServerXml()
-
getStartupTime
public long getStartupTime()
get time server started up
-
putPasswordCache
public void putPasswordCache(java.lang.String tag, java.lang.String pw)
-
getPID
public int getPID()
-
upgradeConfig
public static void upgradeConfig(IConfigStore c) throws EBaseException
- Throws:
EBaseException
-
setListOfVerifiedCerts
public void setListOfVerifiedCerts(int size, long interval, long unknownStateInterval)
-
isRevoked
public boolean isRevoked(java.security.cert.X509Certificate[] certificates)
-
isReady
public boolean isReady()
-
sleepOneMinute
public void sleepOneMinute()
-
contextInitialized
public void contextInitialized(javax.servlet.ServletContextEvent event)
- Specified by:
contextInitialized
in interfacejavax.servlet.ServletContextListener
-
contextDestroyed
public void contextDestroyed(javax.servlet.ServletContextEvent event)
- Specified by:
contextDestroyed
in interfacejavax.servlet.ServletContextListener
-
-