Package com.microstrategy.web.objects.admin.serverconfig

Interface IntelligenceServerInstance

  • All Superinterfaces:
    ServerInstance
    public interface IntelligenceServerInstance
extends ServerInstance
    This interface represents a server instance object which is for an Intelligence Server. This interface extends the ServerInstance interface, and contains Intelligence Server-specific methods. Note that any changes made to the properties on this interface will not take place until the save method is called on the parent ServerInstance interface.
    Since:
    MicroStrategy Web 7.5.0

    • Method Detail

      • getMDLogin

        java.lang.String getMDLogin()
        Returns the metadata login set on the instance.
        Returns:
        The metadata login set on the instance.

      • setMDLogin

        void setMDLogin​(java.lang.String mdL,
                java.lang.String mdP)
        This method will set the login and password for the metadata to use for this server instance.
        Parameters:
        mdL - The metadata login.
        mdP - The metadata password.

      • getMDDataSourceName

        java.lang.String getMDDataSourceName()
        Returns the current metadata data source name(DSN) of the instance.
        Returns:
        The data source name for the metadata.

      • setMDDataSourceName

        void setMDDataSourceName​(java.lang.String mdDSN)
        Sets the data source name(DSN) of the metadata for the instance.
        Parameters:
        mdDSN - The data source name of the metadata which should be set on the instance.

      • getMDODBCSettings

        java.lang.String getMDODBCSettings()
        Returns the current values of additional ODBC settings (other than the DSN) which are used for the metadata connection for the current instance.
        Returns:
        The current additional ODBC settings string.

      • setMDODBCSettings

        void setMDODBCSettings​(java.lang.String mdODBCSettings)
        Sets an additional set of ODBC settings (other than the DSN) which will be used when this instance is connecting to the metadata.
        Parameters:
        mdODBCSettings - The new ODBC settings string to use.

      • getMDTablePrefix

        java.lang.String getMDTablePrefix()
        Returns the metadata table prefix to use for the server instance.
        Returns:
        The current metadata table prefix for the server instance.

      • setMDTablePrefix

        void setMDTablePrefix​(java.lang.String mdTablePrefix)
        Sets the metadata table prefix of the server instance.
        Parameters:
        mdTablePrefix - The metadata table prefix to use for the server instance.

      • getMDTempTablePrefix

        java.lang.String getMDTempTablePrefix()
        Returns the current setting for the metadata temp table prefix of the server instance.
        Returns:
        The metadata temp table prefix of the server instance.

      • setMDTempTablePrefix

        void setMDTempTablePrefix​(java.lang.String mdTempTablePrefix)
        Sets the metadata temp table prefix on the server instance.
        Parameters:
        mdTempTablePrefix - The temp table prefix to use for the server instance.

      • getServerDefName

        java.lang.String getServerDefName()
        Returns the name of the server definition object associated with the instance.
        Returns:
        The name of the server definition object associated with the instance.

      • setServerDefName

        void setServerDefName​(java.lang.String name)
        Sets the Server Definition object to associate with the server instance.
        Parameters:
        name - The name of the server definition object to set in the server instance.

      • getTCPPortNumber

        int getTCPPortNumber()
        Returns the port number set on the server instance.
        Returns:
        The current port number that the server instance will use.

      • setTCPPortNumber

        void setTCPPortNumber​(int tcpPortNumber)
        Sets the port number of the server instance.
        Parameters:
        tcpPortNumber - The port number the server instance should use when starting.

      • getRestPortNumber

        java.lang.Integer getRestPortNumber()
        Returns the rest port number set on the rest server instance.
        Returns:
        The rest port number that the rest server instance will use.

      • setRestPortNumber

        void setRestPortNumber​(int restPortNumber)
        Sets the rest port number of the rest server instance.
        Parameters:
        restPortNumber - The rest port number the rest server instance should use when starting.

      • getRestApiPath

        java.lang.String getRestApiPath()
        Returns the rest api path set on the rest server instance.
        Returns:
        The rest api path that the rest server instance will use.

      • setRestApiPath

        void setRestApiPath​(java.lang.String restApiPath)
        Sets the rest api path of the rest server instance.
        Parameters:
        restApiPath - The rest api path the rest server should use.

      • getCertificatePath

        java.lang.String getCertificatePath()
        Returns the SSL Certificate Path

      • setCertificatePath

        void setCertificatePath​(java.lang.String certPath)
        Sets the SSL Certificate Path

      • getKeyPath

        java.lang.String getKeyPath()
        Returns the SSL Key Path

      • setKeyPath

        void setKeyPath​(java.lang.String keyPath)
        Sets the SSL Key Path

      • getSSLPort

        int getSSLPort()
        Returns the SSL Port

      • setSSLPort

        void setSSLPort​(int SSLPort)
        Sets the SSL Port

      • getSSLCCPort

        int getSSLCCPort()
        Returns the SSL Port

      • setSSLCCPort

        void setSSLCCPort​(int SSLCCPort)
        Sets the SSL Port

      • getVerifyCertificate

        int getVerifyCertificate()
        Returns the SSL Verify Certificate

      • setVerifyCertificate

        void setVerifyCertificate​(int verifyCert)
        Sets the SSL Verify Certificate

      • setCertificateKeyPassword

        void setCertificateKeyPassword​(java.lang.String certKeyP)
        Sets the SSL Certificate Key Password

      • getCACertificatePath

        java.lang.String getCACertificatePath()
        Returns the SSL CA Certificate

      • setCACertificatePath

        void setCACertificatePath​(java.lang.String CACertificatePath)
        Sets the SSL CA Certificate

      • getProcessorAffinityMask

        int getProcessorAffinityMask()
        Deprecated.
        use getSerializedAffinity() instead. This method no longer works
        Returns the current setting of the processor affinity mask of the server instance.
        Returns:
        The current processor affinity mask of the instance.

      • setProcessorAffinityMask

        void setProcessorAffinityMask​(int mask)
        Deprecated.
        use setProcessorAffinityMask(String) instead. This menthod no longer works
        Sets the processor affinity mask of the server instance.
        Parameters:
        mask - The processor affinity mask to set on the instance.

      • isPerformanceMonitoringEnabled

        boolean isPerformanceMonitoringEnabled()
        Returns whether performance monitoring is enabled on an Intelligence Server which uses the instance. If this is turned off, then all performance monitoring on the Intelligence Server will be disabled - both logging and live monitoring.
        Returns:
        Whether performance monitoring is enabled on the server.
        Since:
        MicroStrategy Web 7.5.2

      • setPerformanceMonitoringEnabled

        void setPerformanceMonitoringEnabled​(boolean isEnabled)
        Sets whether performance monitoring is enabled on an Intelligence Server which uses the instance. If this is turned off, then all performance monitoring on the Intelligence Server will be disabled - both logging and live monitoring.
        Parameters:
        isEnabled - The new setting for performance monitoring on the Intelligence Server.
        Since:
        MicroStrategy Web 7.5.2

      • isProcessorAffinitySupported

        boolean isProcessorAffinitySupported()
        Returns whether the Intelligence Server supports processor affinity.
        Returns:
        True if the server supports processor affinity, false otherwise.
        Since:
        MicroStrategy Web 7.5.2

      • getSerializedAffinity

        java.lang.String getSerializedAffinity()
        Returns the current setting of the processor affinity mask of the server instance.
        Returns:
        The current processor affinity mask of the instance.
        Since:
        MicroStrategy Web 9.0.1

      • setProcessorAffinityMask

        void setProcessorAffinityMask​(java.lang.String mask)
        Sets the processor affinity mask of the server instance.
        Parameters:
        mask - The processor affinity mask to set on the instance.
        Since:
        MicroStrategy Web 9.0.1

      • setODBCCharacterEncoding

        void setODBCCharacterEncoding​(int encoding)
        Set the type of character encoding used by the ODBC driver for this server instance
        Parameters:
        encoding - int from EnumDSSXMLCharacterEncoding