Package com.microstrategy.web.admin.beans

Interface AdminBean

  • All Superinterfaces:
    AppComponent, Transformable, WebComponent
    public interface AdminBean
extends AppComponent
    This is the administrator bean which is used by various transforms to render the connected servers, render unconnected servers, render security details and render server properties.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Detail

      • afterSave

        void afterSave​(java.util.Map pValues,
               PreferencesException ex)
        This will be invoked after we set new values for the Intelligence Server properties or after we change the default properties. This will be used to handle validation errors while updating properties.
        Parameters:
        pValues - A map of all the name-value pairs for properties which we tried to change/update.
        ex - An Exception thrown if there were any validation errors while changing/updating properties. This exception object contains information about the name of the property/properties which had an error and the error description.

      • hasValidationErrors

        boolean hasValidationErrors()
        Determines if there were any validation errors while changing either the default properties or the properties for a particular Intelligence Server. Even if one of the properties was invalid, this method will return a true.
        Returns:
        true if there were validation errors while changing the properites of Intelligence Server.

      • loadAdminServersFile

        AdminServersList loadAdminServersFile()
        Method to load the Intelligence Servers present in the admin servers xml file into java objects.
        Returns:
        The AdminServersList objects.

      • isValidPreference

        boolean isValidPreference​(java.lang.String name)
        Determine if the value of a Intelligence Server property being modified is valid or invalid.
        Parameters:
        name - The name of the property which is being modified.
        Returns:
        true if the property value being modified is valid.

      • isTokenExists

        boolean isTokenExists()
        Determine if there is a trust relationship between Web Server and Intelligence Server which is set in method setServerName.
        Returns:
        true if there is a trust relationship exists.
        Since:
        MicroStrategy Web 9.0.0

      • getTokenFile

        java.io.File getTokenFile()
        Retrieve the token file for trust relationship saved in Web Server side.
        Returns:
        The token file.
        Since:
        MicroStrategy Web 9.0.0

      • createAdminServersFile

        void createAdminServersFile​(AdminServersList _adminServerList)
        Create the AdminServers.xml file from the list of admin server objects passed to it (AdminServersList).
        Parameters:
        _adminServerList - The list of Admin Server objects from which to create the file.

      • getAdminServersList

        AdminServersList getAdminServersList()
        Retrievees the list of the Intelligence Servers present on this web server. It will return all the Intelligence Servers present in the AdminServers.xml file.
        Returns:
        The list of Intelligence Servers present on the web server.

      • setShowConnectedServers

        void setShowConnectedServers​(boolean value)
        Set to true if we need to show the list of connected Intelligence Servers on the Administrator page.
        Parameters:
        value - Set this to true if we need to show the list of connected Intelligence Servers on the Administrator page.

      • getShowConnectedServers

        boolean getShowConnectedServers()
        Determines if we need to show the list of connected Intelligence Servers on the Administrator page.
        Returns:
        true if we need to show the list of connected Intelligence Servers on the Administrator page.

      • setShowUnConnectedServers

        void setShowUnConnectedServers​(boolean value)
        Set to true if we need to show the list of unconnected Intelligence Servers on the Administrator page.
        Parameters:
        value - Set this to true if we need to show the list of unconnected Intelligence Servers on the Administrator page.

      • getShowUnConnectedServers

        boolean getShowUnConnectedServers()
        Determines if we need to show the list of unconnected Intelligence Servers on the Administrator page.
        Returns:
        true if we need to show the list of unconnected Intelligence Servers on the Administrator page.

      • setShowDefaultProperties

        void setShowDefaultProperties​(boolean value)
        Used to determine if we are rendering the default properties for all the Intelligence Servers.
        Parameters:
        value - Set to true if we are rendering the default properties for all the Intelligence Servers.

      • getShowDefaultProperties

        boolean getShowDefaultProperties()
        Determines if we are rendering the default properties for all the Intelligence Servers.
        Returns:
        true if we are rendering the default properties for all the Intelligence Servers.

      • setShowServerProperties

        void setShowServerProperties​(boolean value)
        Used to determine if we are rendering the properties for one particular Intelligence Servers.
        Parameters:
        value - Set to true if we are rendering the properties for one particular Intelligence Servers.

      • getShowServerProperties

        boolean getShowServerProperties()
        Determines if we are rendering the properties for a particular Intelligence Servers.
        Returns:
        true if we are rendering the properties for a particular Intelligence Servers.

      • setServerName

        void setServerName​(java.lang.String value)
        Sets the name of the Intelligence Server. This will be used on the properties page to display the name of the Intelligence Server whose properties are being rendered.
        Parameters:
        value - The name of the Intelligence Server.

      • getServerName

        java.lang.String getServerName()
        Returns the name of the Intelligence Server. This will be used on the properties page to display the name of the Intelligence Server whose properties are being rendered.
        Returns:
        The name of the Intelligence Server.

      • setConnectedServer

        void setConnectedServer​(boolean value)
        Used to determine if changing/rendering the properties of a connected Intelligence Server.
        Parameters:
        value - Set to true if we are changing/rendering the proeprties of a connected Intelligence Server.

      • getConnectedServer

        boolean getConnectedServer()
        Determines if the Intelligence Server is connected. This information is used while changing/rendering the properties of the Intelligence Server.
        Returns:
        true if the Intelligence Server is connected.

      • setDisConnectedServer

        void setDisConnectedServer​(boolean value)
        Used to determine if changing/rendering the properties of a unconnected Intelligence Server.
        Parameters:
        value - Set to true if we are changing/rendering the proeprties of a unconnected Intelligence Server.

      • getDisConnectedServer

        boolean getDisConnectedServer()
        Determines if the Intelligence Server is unconnected. This information is used while changing/rendering the properties of the Intelligence Server.
        Returns:
        true if the Intelligence Server is not connected.

      • setNewServer

        void setNewServer​(boolean value)
        Set this value to true if the Intelligence Server is is being newly added to the list of Intelligence Servers present on the web server.
        Parameters:
        value - Set to true if the Intelligence Server is is being newly added.

      • getNewServer

        boolean getNewServer()
        Determines if the Intelligence Server is is being newly added or if it is already present in the list of Intelligence Servers present on the web server. This information is used while changing/rendering the properties of the Intelligence Server.
        Returns:
        true if the Intelligence Server is being newly added.

      • setStyle

        void setStyle​(java.lang.String newValue)
        Set the style name from the list of styles in the Style Catalog which will be used to transform this bean.
        Parameters:
        newValue - The name of the style from the list of styles in the Style Catalog which will be used to transform this bean.

      • getStyle

        java.lang.String getStyle()
        The style from the list of styles in the Style Catalog which will be used to transform this bean.
        Returns:
        The name of the style from the list of styles in the Style Catalog which will be used to transform this bean.

      • getClusterAdmin

        WebClusterAdmin getClusterAdmin()
        Returns the cluster administrator.The WebClusterAdmin is an interface from which a user can connect to or disconnect from an Intelligence Server Cluster, monitor the Intelligence Server Clusters the API is currently connecting to, monitor the connection pool used to connect the API and the Intelligence Servers and set the connection pool size to tune the performance.
        Since:
        MicroStrategy Web 9.0.0

      • getClusters

        java.util.Enumeration getClusters()
                           throws WebObjectsException
        This method returns a collection of Intelligence Server Clusters representing all clusters that the API is connected to.
        Returns:
        The cluster collection.
        Throws:
        WebObjectsException - Signals an error condition while getting the clusters.
        Since:
        MicroStrategy Web 9.0.0

      • getShowSSOTrustCreation

        boolean getShowSSOTrustCreation()
        Since:
        MicroStrategy Web 9.0.0

      • setShowSSOTrustCreation

        void setShowSSOTrustCreation​(boolean show)
        Since:
        MicroStrategy Web 9.0.0

      • getTrustCreationError

        @Deprecated
WebException getTrustCreationError()
        Deprecated.
        Since:
        MicroStrategy Web 9.0.0

      • setTrustCreationError

        @Deprecated
void setTrustCreationError​(WebException exception)
        Deprecated.
        Since:
        MicroStrategy Web 9.0.0

      • getServerErrorMessge

        java.lang.String getServerErrorMessge()

      • setServerError

        void setServerError​(WebException exception)

      • setShowUsherConfig

        void setShowUsherConfig​(boolean value)

      • getShowUsherConfig

        boolean getShowUsherConfig()

      • getServerSettings

        java.util.Map<java.lang.Integer,​java.lang.String> getServerSettings()