Interface ICMSEngine

  • All Superinterfaces:
    ISubsystem

    public interface ICMSEngine
    extends ISubsystem
    This interface represents the CMS core framework. The framework contains a set of services that provide the foundation of a security application.

    The engine implementation is loaded by CMS at startup. It is responsible for starting up all the related subsystems.

    Version:
    $Revision$, $Date$
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method 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.lang.String realm, java.util.Hashtable<java.lang.String,​java.lang.String> httpReq)
      Creates argument block.
      IArgBlock createArgBlock​(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.
      IRepositoryRecord createRepositoryRecord()
      Creates a repository record in the internal database.
      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)
      Retrieves the centralized log message from LogMessages.properties.
      java.lang.String getLogMessage​(java.lang.String msgID, java.lang.Object[] p)
      Retrieves the centralized log message from LogMessages.properties.
      java.lang.String getLogMessage​(java.lang.String msgID, java.lang.String p1)
      Retrieves the centralized log message from LogMessages.properties.
      java.lang.String getLogMessage​(java.lang.String msgID, java.lang.String p1, java.lang.String p2)
      Retrieves the centralized log message from LogMessages.properties.
      java.lang.String getLogMessage​(java.lang.String msgID, java.lang.String p1, java.lang.String p2, java.lang.String p3)
      Retrieves the centralized log message from LogMessages.properties.
      java.lang.String getLogMessage​(java.lang.String msgID, java.lang.String p1, java.lang.String p2, java.lang.String p3, java.lang.String p4)
      Retrieves the centralized log message from LogMessages.properties.
      java.lang.String getLogMessage​(java.lang.String msgID, java.lang.String p1, java.lang.String p2, java.lang.String p3, java.lang.String p4, java.lang.String p5)
      Retrieves the centralized log message from LogMessages.properties.
      java.lang.String getLogMessage​(java.lang.String msgID, java.lang.String p1, java.lang.String p2, java.lang.String p3, java.lang.String p4, java.lang.String p5, java.lang.String p6)
      Retrieves the centralized log message from LogMessages.properties.
      java.lang.String getLogMessage​(java.lang.String msgID, java.lang.String p1, java.lang.String p2, java.lang.String p3, java.lang.String p4, java.lang.String p5, java.lang.String p6, java.lang.String p7)
      Retrieves the centralized log message from LogMessages.properties.
      java.lang.String getLogMessage​(java.lang.String msgID, java.lang.String p1, java.lang.String p2, java.lang.String p3, java.lang.String p4, java.lang.String p5, java.lang.String p6, java.lang.String p7, java.lang.String p8)
      Retrieves the centralized log message from LogMessages.properties.
      java.lang.String getLogMessage​(java.lang.String msgID, java.lang.String p1, java.lang.String p2, java.lang.String p3, java.lang.String p4, java.lang.String p5, java.lang.String p6, java.lang.String p7, java.lang.String p8, java.lang.String p9)
      Retrieves the centralized log message from LogMessages.properties.
      java.lang.String getLogMessage​(java.lang.String msgID, java.lang.String p1, java.lang.String p2, java.lang.String p3, java.lang.String p4, java.lang.String p5, java.lang.String p6, java.lang.String p7, java.lang.String p8, java.lang.String p9, java.lang.String p10)
      Retrieves the centralized log message from LogMessages.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)  
    • Method Detail

      • getId

        java.lang.String getId()
        Gets this ID .
        Specified by:
        getId in interface ISubsystem
        Returns:
        CMS engine identifier
      • setId

        void setId​(java.lang.String id)
            throws EBaseException
        Sets the identifier of this subsystem. Should never be called. Returns error.
        Specified by:
        setId in interface ISubsystem
        Parameters:
        id - CMS engine identifier
        Throws:
        EBaseException - failed to set id
      • getPID

        int getPID()
        Retrieves the process id of this server.
        Returns:
        process id of the server
      • getCSState

        int getCSState()
      • setCSState

        void setCSState​(int mode)
      • isPreOpMode

        boolean isPreOpMode()
      • isRunningMode

        boolean isRunningMode()
      • getInstanceDir

        java.lang.String getInstanceDir()
        Retrieves the instance roort path of this server.
        Returns:
        instance directory path name
      • getCurrentDate

        java.util.Date getCurrentDate()
        Returns a server wide system time. Plugins should call this method to retrieve system time.
        Returns:
        current time
      • getStartupTime

        long getStartupTime()
        Retrieves time server started up.
        Returns:
        last startup time
      • isInRunningState

        boolean isInRunningState()
        Is the server in running state. After server startup, the server will be initialization state first. After the initialization state, the server will be in the running state.
        Returns:
        true if the server is in the running state
      • getSubsystemNames

        java.util.Enumeration<java.lang.String> getSubsystemNames()
        Returns the names of all the registered subsystems.
        Returns:
        a list of string-based subsystem names
      • getSubsystems

        java.util.Enumeration<ISubsystem> getSubsystems()
        Returns all the registered subsystems.
        Returns:
        a list of ISubsystem-based subsystems
      • setSubsystemEnabled

        void setSubsystemEnabled​(java.lang.String id,
                                 boolean enabled)
                          throws EBaseException
        Set whether the given subsystem is enabled.
        Parameters:
        id - The subsystem ID.
        enabled - Whether the subsystem is enabled
        Throws:
        EBaseException
      • getSubsystem

        ISubsystem getSubsystem​(java.lang.String name)
        Retrieves the registered subsytem with the given name.
        Parameters:
        name - subsystem name
        Returns:
        subsystem of the given name
      • debug

        void debug​(byte[] data)
        Puts data of an byte array into the debug file.
        Parameters:
        data - byte array to be recorded in the debug file
      • debug

        void debug​(java.lang.String msg)
        Puts a message into the debug file.
        Parameters:
        msg - debugging message
      • debug

        void debug​(int level,
                   java.lang.String msg)
        Puts a message into the debug file.
        Parameters:
        level - 0-10
        msg - debugging message
      • debug

        void debug​(java.lang.Throwable e)
        Puts an exception into the debug file.
        Parameters:
        e - exception
      • debugOn

        boolean debugOn()
        Checks if the debug mode is on or not.
        Returns:
        true if debug mode is on
      • debugStackTrace

        void debugStackTrace()
        Puts the current stack trace in the debug file.
      • traceHashKey

        void traceHashKey​(java.lang.String type,
                          java.lang.String key)
        Dump name/value pair debug information to debug file
      • traceHashKey

        void traceHashKey​(java.lang.String type,
                          java.lang.String key,
                          java.lang.String val)
      • traceHashKey

        void traceHashKey​(java.lang.String type,
                          java.lang.String key,
                          java.lang.String val,
                          java.lang.String def)
      • getPKCS7

        byte[] getPKCS7​(java.util.Locale locale,
                        IRequest req)
      • getUserMessage

        java.lang.String getUserMessage​(java.util.Locale locale,
                                        java.lang.String msgID)
        Retrieves the localized user message from UserMessages.properties.
        Parameters:
        locale - end-user locale
        msgID - message id defined in UserMessages.properties
        Returns:
        localized user message
      • getUserMessage

        java.lang.String getUserMessage​(java.util.Locale locale,
                                        java.lang.String msgID,
                                        java.lang.String[] p)
        Retrieves the localized user message from UserMessages.properties.
        Parameters:
        locale - end-user locale
        msgID - message id defined in UserMessages.properties
        p - an array of parameters
        Returns:
        localized user message
      • getUserMessage

        java.lang.String getUserMessage​(java.util.Locale locale,
                                        java.lang.String msgID,
                                        java.lang.String p1)
        Retrieves the localized user message from UserMessages.properties.
        Parameters:
        locale - end-user locale
        msgID - message id defined in UserMessages.properties
        p1 - 1st parameter
        Returns:
        localized user message
      • getUserMessage

        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.
        Parameters:
        locale - end-user locale
        msgID - message id defined in UserMessages.properties
        p1 - 1st parameter
        p2 - 2nd parameter
        Returns:
        localized user message
      • getUserMessage

        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.
        Parameters:
        locale - end-user locale
        msgID - message id defined in UserMessages.properties
        p1 - 1st parameter
        p2 - 2nd parameter
        p3 - 3rd parameter
        Returns:
        localized user message
      • getLogMessage

        java.lang.String getLogMessage​(java.lang.String msgID)
        Retrieves the centralized log message from LogMessages.properties.
        Parameters:
        msgID - message id defined in LogMessages.properties
        Returns:
        localized log message
      • getLogMessage

        java.lang.String getLogMessage​(java.lang.String msgID,
                                       java.lang.Object[] p)
        Retrieves the centralized log message from LogMessages.properties.
        Parameters:
        msgID - message id defined in LogMessages.properties
        p - an array of parameters
        Returns:
        localized log message
      • getLogMessage

        java.lang.String getLogMessage​(java.lang.String msgID,
                                       java.lang.String p1)
        Retrieves the centralized log message from LogMessages.properties.
        Parameters:
        msgID - message id defined in LogMessages.properties
        p1 - 1st parameter
        Returns:
        localized log message
      • getLogMessage

        java.lang.String getLogMessage​(java.lang.String msgID,
                                       java.lang.String p1,
                                       java.lang.String p2)
        Retrieves the centralized log message from LogMessages.properties.
        Parameters:
        msgID - message id defined in LogMessages.properties
        p1 - 1st parameter
        p2 - 2nd parameter
        Returns:
        localized log message
      • getLogMessage

        java.lang.String getLogMessage​(java.lang.String msgID,
                                       java.lang.String p1,
                                       java.lang.String p2,
                                       java.lang.String p3)
        Retrieves the centralized log message from LogMessages.properties.
        Parameters:
        msgID - message id defined in LogMessages.properties
        p1 - 1st parameter
        p2 - 2nd parameter
        p3 - 3rd parameter
        Returns:
        localized log message
      • getLogMessage

        java.lang.String getLogMessage​(java.lang.String msgID,
                                       java.lang.String p1,
                                       java.lang.String p2,
                                       java.lang.String p3,
                                       java.lang.String p4)
        Retrieves the centralized log message from LogMessages.properties.
        Parameters:
        msgID - message id defined in LogMessages.properties
        p1 - 1st parameter
        p2 - 2nd parameter
        p3 - 3rd parameter
        p4 - 4th parameter
        Returns:
        localized log message
      • getLogMessage

        java.lang.String getLogMessage​(java.lang.String msgID,
                                       java.lang.String p1,
                                       java.lang.String p2,
                                       java.lang.String p3,
                                       java.lang.String p4,
                                       java.lang.String p5)
        Retrieves the centralized log message from LogMessages.properties.
        Parameters:
        msgID - message id defined in LogMessages.properties
        p1 - 1st parameter
        p2 - 2nd parameter
        p3 - 3rd parameter
        p4 - 4th parameter
        p5 - 5th parameter
        Returns:
        localized log message
      • getLogMessage

        java.lang.String getLogMessage​(java.lang.String msgID,
                                       java.lang.String p1,
                                       java.lang.String p2,
                                       java.lang.String p3,
                                       java.lang.String p4,
                                       java.lang.String p5,
                                       java.lang.String p6)
        Retrieves the centralized log message from LogMessages.properties.
        Parameters:
        msgID - message id defined in LogMessages.properties
        p1 - 1st parameter
        p2 - 2nd parameter
        p3 - 3rd parameter
        p4 - 4th parameter
        p5 - 5th parameter
        p6 - 6th parameter
        Returns:
        localized log message
      • getLogMessage

        java.lang.String getLogMessage​(java.lang.String msgID,
                                       java.lang.String p1,
                                       java.lang.String p2,
                                       java.lang.String p3,
                                       java.lang.String p4,
                                       java.lang.String p5,
                                       java.lang.String p6,
                                       java.lang.String p7)
        Retrieves the centralized log message from LogMessages.properties.
        Parameters:
        msgID - message id defined in LogMessages.properties
        p1 - 1st parameter
        p2 - 2nd parameter
        p3 - 3rd parameter
        p4 - 4th parameter
        p5 - 5th parameter
        p6 - 6th parameter
        p7 - 7th parameter
        Returns:
        localized log message
      • getLogMessage

        java.lang.String getLogMessage​(java.lang.String msgID,
                                       java.lang.String p1,
                                       java.lang.String p2,
                                       java.lang.String p3,
                                       java.lang.String p4,
                                       java.lang.String p5,
                                       java.lang.String p6,
                                       java.lang.String p7,
                                       java.lang.String p8)
        Retrieves the centralized log message from LogMessages.properties.
        Parameters:
        msgID - message id defined in LogMessages.properties
        p1 - 1st parameter
        p2 - 2nd parameter
        p3 - 3rd parameter
        p4 - 4th parameter
        p5 - 5th parameter
        p6 - 6th parameter
        p7 - 7th parameter
        p8 - 8th parameter
        Returns:
        localized log message
      • getLogMessage

        java.lang.String getLogMessage​(java.lang.String msgID,
                                       java.lang.String p1,
                                       java.lang.String p2,
                                       java.lang.String p3,
                                       java.lang.String p4,
                                       java.lang.String p5,
                                       java.lang.String p6,
                                       java.lang.String p7,
                                       java.lang.String p8,
                                       java.lang.String p9)
        Retrieves the centralized log message from LogMessages.properties.
        Parameters:
        msgID - message id defined in LogMessages.properties
        p1 - 1st parameter
        p2 - 2nd parameter
        p3 - 3rd parameter
        p4 - 4th parameter
        p5 - 5th parameter
        p6 - 6th parameter
        p7 - 7th parameter
        p8 - 8th parameter
        p9 - 9th parameter
        Returns:
        localized log message
      • getLogMessage

        java.lang.String getLogMessage​(java.lang.String msgID,
                                       java.lang.String p1,
                                       java.lang.String p2,
                                       java.lang.String p3,
                                       java.lang.String p4,
                                       java.lang.String p5,
                                       java.lang.String p6,
                                       java.lang.String p7,
                                       java.lang.String p8,
                                       java.lang.String p9,
                                       java.lang.String p10)
        Retrieves the centralized log message from LogMessages.properties.
        Parameters:
        msgID - message id defined in LogMessages.properties
        p1 - 1st parameter
        p2 - 2nd parameter
        p3 - 3rd parameter
        p4 - 4th parameter
        p5 - 5th parameter
        p6 - 6th parameter
        p7 - 7th parameter
        p8 - 8th parameter
        p9 - 9th parameter
        p10 - 10th parameter
        Returns:
        localized log message
      • createCRLIssuingPointRecord

        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.
        Returns:
        issuing record
      • getCRLIssuingPointRecordName

        java.lang.String getCRLIssuingPointRecordName()
        Retrieves the default CRL issuing point record name.
        Returns:
        CRL issuing point record name
      • createRepositoryRecord

        IRepositoryRecord createRepositoryRecord()
        Creates a repository record in the internal database.
        Returns:
        repository record
      • getEncodedCert

        java.lang.String getEncodedCert​(java.security.cert.X509Certificate cert)
        Retrieves the certifcate in MIME-64 encoded format with header and footer.
        Parameters:
        cert - certificate
        Returns:
        base-64 format certificate
      • getBoundConnection

        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)
                                                 throws netscape.ldap.LDAPException
        Throws:
        netscape.ldap.LDAPException
      • getSharedTokenClass

        ISharedToken getSharedTokenClass​(java.lang.String configName)
        Retrieves the named SharedToken class
        Returns:
        named shared token class
      • getPasswordChecker

        IPasswordCheck getPasswordChecker()
        Retrieves the password check.
        Returns:
        default password checker
      • putPasswordCache

        void putPasswordCache​(java.lang.String tag,
                              java.lang.String pw)
        Puts a password entry into the single-sign on cache.
        Parameters:
        tag - password tag
        pw - password
      • getServerCertNickname

        java.lang.String getServerCertNickname()
        Retrieves the nickname of the server's server certificate.
        Returns:
        nickname of the server certificate
      • setServerCertNickname

        void setServerCertNickname​(java.lang.String tokenName,
                                   java.lang.String nickName)
        Sets the nickname of the server's server certificate.
        Parameters:
        tokenName - name of token where the certificate is located
        nickName - name of server certificate
      • setServerCertNickname

        void setServerCertNickname​(java.lang.String newName)
        Sets the nickname of the server's server certificate.
        Parameters:
        newName - new nickname of server certificate
      • getEEHost

        java.lang.String getEEHost()
        Retrieves the host name of the server's secure end entity service.
        Returns:
        host name of end-entity service
      • getEENonSSLHost

        java.lang.String getEENonSSLHost()
        Retrieves the host name of the server's non-secure end entity service.
        Returns:
        host name of end-entity non-secure service
      • getEENonSSLIP

        java.lang.String getEENonSSLIP()
        Retrieves the IP address of the server's non-secure end entity service.
        Returns:
        ip address of end-entity non-secure service
      • getEENonSSLPort

        java.lang.String getEENonSSLPort()
        Retrieves the port number of the server's non-secure end entity service.
        Returns:
        port of end-entity non-secure service
      • getEESSLHost

        java.lang.String getEESSLHost()
        Retrieves the host name of the server's secure end entity service.
        Returns:
        port of end-entity secure service
      • getEESSLIP

        java.lang.String getEESSLIP()
        Retrieves the IP address of the server's secure end entity service.
        Returns:
        ip address of end-entity secure service
      • getEESSLPort

        java.lang.String getEESSLPort()
        Retrieves the port number of the server's secure end entity service.
        Returns:
        port of end-entity secure service
      • getEEClientAuthSSLPort

        java.lang.String getEEClientAuthSSLPort()
        Retrieves the port number of the server's client auth secure end entity service.
        Returns:
        port of end-entity client auth secure service
      • getAgentHost

        java.lang.String getAgentHost()
        Retrieves the host name of the server's agent service.
        Returns:
        host name of agent service
      • getAgentIP

        java.lang.String getAgentIP()
        Retrieves the IP address of the server's agent service.
        Returns:
        ip address of agent service
      • getAgentPort

        java.lang.String getAgentPort()
        Retrieves the port number of the server's agent service.
        Returns:
        port of agent service
      • getAdminHost

        java.lang.String getAdminHost()
        Retrieves the host name of the server's administration service.
        Returns:
        host name of administration service
      • getAdminIP

        java.lang.String getAdminIP()
        Retrieves the IP address of the server's administration service.
        Returns:
        ip address of administration service
      • getAdminPort

        java.lang.String getAdminPort()
        Retrieves the port number of the server's administration service.
        Returns:
        port of administration service
      • getMailNotification

        IMailNotification getMailNotification()
        Retrieves the email notification handler.
        Returns:
        email notification
      • getResender

        IResender getResender​(IAuthority authority,
                              java.lang.String nickname,
                              java.lang.String clientCiphers,
                              IRemoteAuthority remote,
                              int interval)
        Retrieves the request sender for use with connector.
        Parameters:
        authority - local authority
        nickname - nickname of the client certificate
        remote - remote authority
        interval - timeout interval
        Returns:
        resender
      • disableRequests

        void disableRequests()
        Blocks all new incoming requests.
      • terminateRequests

        void terminateRequests()
        Terminates all requests that are currently in process.
      • areRequestsDisabled

        boolean areRequestsDisabled()
        Checks to ensure that all new incoming requests have been blocked. This method is used for reentrancy protection.

        Returns:
        true or false
      • createFileConfigStore

        IConfigStore createFileConfigStore​(java.lang.String path)
                                    throws EBaseException
        Create configuration file.
        Parameters:
        path - configuration path
        Returns:
        configuration store
        Throws:
        EBaseException - failed to create file
      • createArgBlock

        IArgBlock createArgBlock()
        Creates argument block.
      • createArgBlock

        IArgBlock createArgBlock​(java.lang.String realm,
                                 java.util.Hashtable<java.lang.String,​java.lang.String> httpReq)
        Creates argument block.
      • createArgBlock

        IArgBlock createArgBlock​(java.util.Hashtable<java.lang.String,​java.lang.String> httpReq)
        Creates argument block.
      • isRevoked

        boolean isRevoked​(java.security.cert.X509Certificate[] certificates)
        Checks against the local certificate repository to see if the certificates are revoked.
        Parameters:
        certificates - certificates
        Returns:
        true if certificate is revoked in the local certificate repository
      • setListOfVerifiedCerts

        void setListOfVerifiedCerts​(int size,
                                    long interval,
                                    long unknownStateInterval)
        Sets list of verified certificates
        Parameters:
        size - size of verified certificates list
        interval - interval in which certificate is not recheck against local certificate repository
        unknownStateInterval - interval in which certificate may not recheck against local certificate repository
      • forceShutdown

        void forceShutdown()
        Performs graceful shutdown of CMS. Subsystems are shutdown in reverse order. Exceptions are ignored.
      • autoShutdown

        void autoShutdown()
        graceful shutdown, same as forceShutdown, but allowing option to restart
      • checkForAndAutoShutdown

        void checkForAndAutoShutdown()
      • setConfigSDSessionId

        void setConfigSDSessionId​(java.lang.String id)
      • getConfigSDSessionId

        java.lang.String getConfigSDSessionId()
      • getServerStatus

        java.lang.String getServerStatus()
      • sleepOneMinute

        void sleepOneMinute()
      • isExcludedLdapAttrsEnabled

        boolean isExcludedLdapAttrsEnabled()
      • isExcludedLdapAttr

        boolean isExcludedLdapAttr​(java.lang.String key)