Class CMSEngine

java.lang.Object
com.netscape.cmscore.apps.CMSEngine
public class CMSEngine extends Object

  • Field Details

  • Constructor Details

    • CMSEngine

      public CMSEngine(String name)

  • Method Details

    • getApprovalCallback

      public org.mozilla.jss.ssl.SSLCertificateApprovalCallback getApprovalCallback()

    • setApprovalCallback

      public void setApprovalCallback(org.mozilla.jss.ssl.SSLCertificateApprovalCallback approvalCallback)

    • getID

      public String getID()

    • setID

      public void setID(String id)

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • getPluginRegistry

      public PluginRegistry getPluginRegistry()

    • getLogSubsystem

      public LogSubsystem getLogSubsystem()

    • getAuditor

      public Auditor getAuditor()

    • getClientSocketListener

      public PKIClientSocketListener getClientSocketListener()

    • getServerSocketListener

      public PKIServerSocketListener getServerSocketListener()

    • getJSSSubsystem

      public JssSubsystem getJSSSubsystem()

    • getDBSubsystem

      public DBSubsystem getDBSubsystem()

    • getRequestRepository

      public RequestRepository getRequestRepository()

    • setRequestRepository

      public void setRequestRepository(RequestRepository requestRepository)

    • getRequestQueue

      public RequestQueue getRequestQueue()

    • setRequestQueue

      public void setRequestQueue(RequestQueue requestQueue)

    • getUGSubsystem

      public UGSubsystem getUGSubsystem()

    • getOIDLoaderSubsystem

      public OidLoaderSubsystem getOIDLoaderSubsystem()

    • getX500NameSubsystem

      public X500NameSubsystem getX500NameSubsystem()

    • getRequestSubsystem

      public RequestSubsystem getRequestSubsystem()

    • getAuthSubsystem

      public AuthSubsystem getAuthSubsystem()

    • getAuthzSubsystem

      public AuthzSubsystem getAuthzSubsystem()

    • getCMSGateway

      public CMSGateway getCMSGateway()

    • getJobsScheduler

      public JobsScheduler getJobsScheduler()

    • getRequestNotifier

      public RequestNotifier getRequestNotifier()
      get request notifier

    • setRequestNotifier

      public void setRequestNotifier(RequestNotifier requestNotifier)

    • getRequestListenerNames

      public Enumeration<String> getRequestListenerNames()
      Retrieves all request listeners.
      Returns:
      name enumeration of all request listeners

    • getRequestListener

      public RequestListener getRequestListener(String name)
      Retrieves the request listener by name.
      Parameters:
      name - request listener name
      Returns:
      the request listener

    • registerRequestListener

      public void registerRequestListener(RequestListener listener)
      Registers a request listener.

    • registerRequestListener

      public void registerRequestListener(String name, RequestListener listener)
      Registers a request listener.
      Parameters:
      name - under request listener is going to be registered
      listener - request listener to be registered

    • removeRequestListener

      public void removeRequestListener(RequestListener listener)
      Removes a request listener.
      Parameters:
      listener - request listener to be removed

    • removeRequestListener

      public void removeRequestListener(String name)
      removes listener with a name.

    • getPendingNotifier

      public RequestNotifier getPendingNotifier()

    • setPendingNotifier

      public void setPendingNotifier(RequestNotifier pendingNotifier)

    • getPendingListener

      public RequestListener getPendingListener(String name)
      get listener from listener list

    • registerPendingListener

      public void registerPendingListener(RequestListener listener)
      register listener for pending requests

    • registerPendingListener

      public void registerPendingListener(String name, RequestListener listener)
      register listener for pending requests with a name.

    • loadConfig

      public void loadConfig(String path) throws Exception
      Throws:
      Exception

    • createConfig

      public EngineConfig createConfig(ConfigStorage storage) throws Exception
      Throws:
      Exception

    • getPasswordStore

      public PasswordStore getPasswordStore() throws EBaseException
      Throws:
      EBaseException

    • initDebug

      public void initDebug() throws Exception
      Throws:
      Exception

    • initSubsystemListeners

      public void initSubsystemListeners() throws Exception
      Throws:
      Exception

    • initPasswordStore

      public void initPasswordStore() throws Exception
      Throws:
      Exception

    • testLDAPConnections

      public void testLDAPConnections() throws Exception
      Throws:
      Exception

    • testLDAPConnection

      public int testLDAPConnection(String name, LDAPConnectionConfig connConfig, String binddn, String pwd) throws EBaseException
      Throws:
      EBaseException

    • initSecurityProvider

      public void initSecurityProvider()

    • initDatabase

      public void initDatabase() throws Exception
      Throws:
      Exception

    • initPluginRegistry

      public void initPluginRegistry() throws Exception
      Throws:
      Exception

    • initAuditor

      public void initAuditor() throws Exception
      Throws:
      Exception

    • initLogSubsystem

      public void initLogSubsystem() throws Exception
      Throws:
      Exception

    • initClientSocketListener

      public void initClientSocketListener()

    • initServerSocketListener

      public void initServerSocketListener()

    • initJssSubsystem

      public void initJssSubsystem() throws Exception
      Throws:
      Exception

    • initDBSubsystem

      public void initDBSubsystem() throws Exception
      Throws:
      Exception

    • initUGSubsystem

      public void initUGSubsystem() throws Exception
      Throws:
      Exception

    • initOIDLoaderSubsystem

      public void initOIDLoaderSubsystem() throws Exception
      Throws:
      Exception

    • initX500NameSubsystem

      public void initX500NameSubsystem() throws Exception
      Throws:
      Exception

    • initRequestSubsystem

      public void initRequestSubsystem() throws Exception
      Throws:
      Exception

    • initAuthSubsystem

      public void initAuthSubsystem() throws Exception
      Throws:
      Exception

    • initAuthzSubsystem

      public void initAuthzSubsystem() throws Exception
      Throws:
      Exception

    • initCMSGateway

      public void initCMSGateway() throws Exception
      Throws:
      Exception

    • initJobsScheduler

      public void initJobsScheduler() throws Exception
      Throws:
      Exception

    • configurePorts

      public void configurePorts() throws Exception
      Throws:
      Exception

    • initSecurityDomain

      public void initSecurityDomain() throws Exception
      Throws:
      Exception

    • init

      public void init() throws Exception
      initialize all static, dynamic and final static subsystems.
      Throws:
      Exception - if any error occur in subsystems during initialization.

    • loadConfigStore

      public ConfigStore loadConfigStore(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 SecurityDomainSessionTable getSecurityDomainSessionTable()

    • getEENonSSLPort

      public String getEENonSSLPort()

    • getEESSLPort

      public String getEESSLPort()

    • getEEClientAuthSSLPort

      public String getEEClientAuthSSLPort()

    • getAgentPort

      public String getAgentPort()

    • getAdminPort

      public String getAdminPort()

    • getSubsystems

      public Collection<Subsystem> getSubsystems()

    • getSubsystem

      public Subsystem getSubsystem(String name)

    • loadSubsystems

      protected void loadSubsystems() throws Exception
      load subsystems
      Throws:
      Exception

    • createSubsystem

      public Subsystem createSubsystem(SubsystemInfoConfig subsystemInfoConfig) throws Exception
      Throws:
      Exception

    • initSubsystem

      public void initSubsystem(Subsystem subsystem, ConfigStore subsystemConfig) throws Exception
      Throws:
      Exception

    • initSubsystems

      public void initSubsystems() throws Exception
      Throws:
      Exception

    • configureAutoShutdown

      public void configureAutoShutdown() throws Exception
      Throws:
      Exception

    • configureServerCertNickname

      public void configureServerCertNickname() throws EBaseException
      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

      protected void startupSubsystems() throws Exception
      Throws:
      Exception

    • notifySubsystemStarted

      public void notifySubsystemStarted()

    • start

      public void start() throws Exception
      Throws:
      Exception

    • initSequence

      protected void initSequence() throws Exception
      Throws:
      Exception

    • isInRunningState

      public boolean isInRunningState()

    • getServerCertNickname

      public String getServerCertNickname()

    • setServerCertNickname

      public void setServerCertNickname(String tokenName, String nickName)

    • setServerCertNickname

      public void setServerCertNickname(String newName)

    • 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

      public MailNotification getMailNotification()

    • getPasswordChecker

      public PasswordChecker 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

      public ConfigStore getConfigStore()
      returns the main config store

    • getConfig

      public EngineConfig getConfig()

    • getServerConfig

      public ServerConfig getServerConfig()

    • getStartupTime

      public long getStartupTime()
      get time server started up

    • putPasswordCache

      public void putPasswordCache(String tag, String pw)

    • getPID

      public int getPID()

    • setListOfVerifiedCerts

      public void setListOfVerifiedCerts(int size, long interval, long unknownStateInterval)

    • isRevoked

      public boolean isRevoked(X509Certificate[] certificates)

    • isReady

      public boolean isReady()

    • sleepOneMinute

      public void sleepOneMinute()

    • verifySystemCerts

      public void verifySystemCerts(boolean checkValidityOnly) throws Exception
      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

      public void verifySystemCertByTag(String tag) throws Exception
      Verify a certificate by its tag name, do a full verification.
      Throws:
      Exception - if something is wrong

    • verifySystemCertByTag

      public void verifySystemCertByTag(String tag, boolean checkValidityOnly) throws Exception
      Verify a certificate by its tag name. Perform optional validity check only.
      Throws:
      Exception - if something is wrong

    • getAuditGroups

      public String getAuditGroups(String subjectID)
      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