Package com.netscape.cmscore.apps
Class CMSEngine
- java.lang.Object
-
- com.netscape.cmscore.apps.CMSEngine
-
public class CMSEngine extends java.lang.Object
-
-
Field Summary
Fields Modifier and Type Field Description java.util.Collection<java.lang.String>
dynSubsystems
static java.lang.String[]
excludedLdapAttrs
java.util.List<java.lang.String>
excludedLdapAttrsList
java.util.Collection<java.lang.String>
finalSubsystems
java.lang.String
hostname
java.lang.String
instanceDir
static org.slf4j.Logger
logger
protected EngineConfig
mConfig
java.lang.String
name
static java.lang.String
PROP_SIGNED_AUDIT_CERT_NICKNAME
java.lang.String
securePort
protected ServerXml
serverXml
java.util.Collection<java.lang.String>
staticSubsystems
java.util.Map<java.lang.String,SubsystemInfo>
subsystemInfos
java.util.Map<java.lang.String,ISubsystem>
subsystems
java.lang.String
unsecurePort
-
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 SubsystemInfo
addSubsystem(java.lang.String id, ISubsystem instance)
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
configureServerCertNickname()
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
getAdminHost()
java.lang.String
getAdminIP()
java.lang.String
getAdminPort()
java.lang.String
getAgentHost()
java.lang.String
getAgentIP()
java.lang.String
getAgentPort()
EngineConfig
getConfig()
IConfigStore
getConfigStore()
returns the main config storeint
getCSState()
java.lang.String
getEEClientAuthSSLPort()
java.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
getInstanceDir()
Retrieves the instance root path of this server.JssSubsystem
getJSSSubsystem()
IMailNotification
getMailNotification()
IPasswordCheck
getPasswordChecker()
IPasswordStore
getPasswordStore()
int
getPID()
PluginRegistry
getPluginRegistry()
ISecurityDomainSessionTable
getSecurityDomainSessionTable()
java.lang.String
getServerCertNickname()
ServerXml
getServerXml()
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()
void
init()
initialize all static, dynamic and final static subsystems.void
initializePasswordStore(EngineConfig config)
protected void
initSubsystems()
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
sleepOneMinute()
void
startup()
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
-
name
public java.lang.String name
-
instanceDir
public java.lang.String instanceDir
-
mConfig
protected EngineConfig mConfig
-
serverXml
protected ServerXml serverXml
-
staticSubsystems
public java.util.Collection<java.lang.String> staticSubsystems
-
dynSubsystems
public java.util.Collection<java.lang.String> dynSubsystems
-
finalSubsystems
public java.util.Collection<java.lang.String> finalSubsystems
-
subsystemInfos
public final java.util.Map<java.lang.String,SubsystemInfo> subsystemInfos
-
subsystems
public final java.util.Map<java.lang.String,ISubsystem> subsystems
-
hostname
public java.lang.String hostname
-
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
-
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
-
initializePasswordStore
public void initializePasswordStore(EngineConfig config) throws EBaseException, java.io.IOException
- Throws:
EBaseException
java.io.IOException
-
testLDAPConnection
public int testLDAPConnection(java.lang.String name, LdapConnInfo info, java.lang.String binddn, java.lang.String pwd)
-
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()
-
getEEHost
public java.lang.String getEEHost()
-
getEENonSSLHost
public java.lang.String getEENonSSLHost()
-
getEENonSSLIP
public java.lang.String getEENonSSLIP()
-
getEENonSSLPort
public java.lang.String getEENonSSLPort()
-
getEESSLHost
public java.lang.String getEESSLHost()
-
getEESSLIP
public java.lang.String getEESSLIP()
-
getEESSLPort
public java.lang.String getEESSLPort()
-
getEEClientAuthSSLPort
public java.lang.String getEEClientAuthSSLPort()
-
getAgentHost
public java.lang.String getAgentHost()
-
getAgentIP
public java.lang.String getAgentIP()
-
getAgentPort
public java.lang.String getAgentPort()
-
getAdminHost
public java.lang.String getAdminHost()
-
getAdminIP
public java.lang.String getAdminIP()
-
getAdminPort
public java.lang.String getAdminPort()
-
addSubsystem
public SubsystemInfo addSubsystem(java.lang.String id, ISubsystem instance)
-
getSubsystems
public java.util.Collection<ISubsystem> getSubsystems()
-
getSubsystem
public ISubsystem getSubsystem(java.lang.String name)
-
getJSSSubsystem
public JssSubsystem getJSSSubsystem()
-
setSubsystemEnabled
public void setSubsystemEnabled(java.lang.String id, boolean enabled)
-
loadSubsystems
protected void loadSubsystems() throws EBaseException
load subsystems- Throws:
EBaseException
-
initSubsystems
protected 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
public void startupSubsystems() throws EBaseException
- Throws:
EBaseException
-
startup
public void startup() throws EBaseException
- Throws:
EBaseException
-
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 IMailNotification getMailNotification()
-
getPasswordChecker
public IPasswordCheck getPasswordChecker()
-
getSharedTokenClass
public ISharedToken getSharedTokenClass(java.lang.String configName)
-
disableRequests
public void disableRequests()
-
areRequestsDisabled
public boolean areRequestsDisabled()
-
terminateRequests
public void terminateRequests()
-
isNT
public static boolean isNT()
-
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()
-
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()
-
getPluginRegistry
public PluginRegistry getPluginRegistry()
-
getUGSubsystem
public UGSubsystem getUGSubsystem()
-
-