Class ConnectedServersTransform

    • Field Detail

      • connectedLevelFlag

        public FormalParameter connectedLevelFlag
        Deprecated.
        Usage of level flags have been deprecated in favor of the layout-definition files. To change the elements visible for this transform modify the corresponding layout.xml
        Specifies what information is displayed for each Connected Server.
        The information may include server name, connect mode, maximum pool size, modify link and other information. Multiple fields may be displayed at the same time. Which fields to show is indicated by a bitwise flag.
        Allowed Values:
        • Cluster Number = 1
        • Server Name = 2
        • Connect Mode = 4
        • Loaded Projects = 8
        • Busy = 16
        • Free = 32
        • Maximum pool size = 64
        • Action Column (Disconnect) = 128
        • Properties (Modify Link) = 256
        • Show every thing = 4095

        Usage:
        For example, if you want to specify server name and connect mode only, then you would specify (2 + 4 = 6).
      • _connectedLevelFlag

        protected int _connectedLevelFlag
        Deprecated.
        Usage of level flags have been deprecated in favor of the layout-definition files. To change the elements visible for this transform modify the corresponding layout.xml
      • imgIconHomeRed

        public FormalParameter imgIconHomeRed
        Name of the image used to indicate the home icon.
        Clicking on this image would take the user to the Microstrategy Web Home page. This page is the projects page.
      • cssTable

        protected java.lang.String cssTable
      • cssHeader

        protected java.lang.String cssHeader
      • cssHeading

        protected java.lang.String cssHeading
      • cssNoServers

        protected java.lang.String cssNoServers
      • cssServerName

        protected java.lang.String cssServerName
      • cssOtherDetails

        protected java.lang.String cssOtherDetails
      • cssSubmitButton

        protected java.lang.String cssSubmitButton
      • cssHR

        protected java.lang.String cssHR
      • _imgIconHomeRed

        protected java.lang.String _imgIconHomeRed
      • CONN_COLUMN_CLUSTER

        public static final int CONN_COLUMN_CLUSTER
        Deprecated.
        Usage of level flags have been deprecated in favor of the layout-definition files. To change the elements visible for this transform modify the corresponding layout.xml
        See Also:
        Constant Field Values
      • CONN_COLUMN_NAME

        public static final int CONN_COLUMN_NAME
        Deprecated.
        Usage of level flags have been deprecated in favor of the layout-definition files. To change the elements visible for this transform modify the corresponding layout.xml
        See Also:
        Constant Field Values
      • CONN_COLUMN_CONNMODE

        public static final int CONN_COLUMN_CONNMODE
        Deprecated.
        Usage of level flags have been deprecated in favor of the layout-definition files. To change the elements visible for this transform modify the corresponding layout.xml
        See Also:
        Constant Field Values
      • CONN_COLUMN_LOADED

        public static final int CONN_COLUMN_LOADED
        Deprecated.
        Usage of level flags have been deprecated in favor of the layout-definition files. To change the elements visible for this transform modify the corresponding layout.xml
        See Also:
        Constant Field Values
      • CONN_COLUMN_BUSY

        public static final int CONN_COLUMN_BUSY
        Deprecated.
        Usage of level flags have been deprecated in favor of the layout-definition files. To change the elements visible for this transform modify the corresponding layout.xml
        See Also:
        Constant Field Values
      • CONN_COLUMN_FREE

        public static final int CONN_COLUMN_FREE
        Deprecated.
        Usage of level flags have been deprecated in favor of the layout-definition files. To change the elements visible for this transform modify the corresponding layout.xml
        See Also:
        Constant Field Values
      • CONN_COLUMN_MAXPOOL

        public static final int CONN_COLUMN_MAXPOOL
        Deprecated.
        Usage of level flags have been deprecated in favor of the layout-definition files. To change the elements visible for this transform modify the corresponding layout.xml
        See Also:
        Constant Field Values
      • CONN_COLUMN_ACTION

        public static final int CONN_COLUMN_ACTION
        Deprecated.
        Usage of level flags have been deprecated in favor of the layout-definition files. To change the elements visible for this transform modify the corresponding layout.xml
        See Also:
        Constant Field Values
      • CONN_COLUMN_PROPERTIES

        public static final int CONN_COLUMN_PROPERTIES
        Deprecated.
        Usage of level flags have been deprecated in favor of the layout-definition files. To change the elements visible for this transform modify the corresponding layout.xml
        See Also:
        Constant Field Values
      • CONN_COLUMN_ALL

        public static final int CONN_COLUMN_ALL
        Deprecated.
        Usage of level flags have been deprecated in favor of the layout-definition files. To change the elements visible for this transform modify the corresponding layout.xml
        See Also:
        Constant Field Values
      • FP_CONNECTED_LEVEL_FLAG

        public static final java.lang.String FP_CONNECTED_LEVEL_FLAG
        Deprecated.
        Usage of level flags have been deprecated in favor of the layout-definition files. To change the elements visible for this transform modify the corresponding layout.xml
        See Also:
        Constant Field Values
      • FP_ICON_HOME_IMAGE

        public static final java.lang.String FP_ICON_HOME_IMAGE
        See Also:
        Constant Field Values
    • Constructor Detail

      • ConnectedServersTransform

        public ConnectedServersTransform()
        Default empty constructor. Initialize formal parameters.
    • Method Detail

      • getAdminBean

        protected AdminBean getAdminBean()
        Returns the current AdminBean
        Returns:
        this AdminBean
      • getDescription

        public java.lang.String getDescription()
        Returns the textual description of the transform
        Specified by:
        getDescription in interface Transform
        Returns:
        the textual description of the transform
      • initializeTransform

        public void initializeTransform​(Transformable data)
        This method initialize the private and protected fields of the transform. It also invokes the initializeImages and initializeCss methods.
        Specified by:
        initializeTransform in interface AppTransform
        Overrides:
        initializeTransform in class AbstractAppTransform
        Parameters:
        data - The data (bean) that this transform is going to transform.
      • initializeCss

        public void initializeCss()
        Initializes the Css Class Strings to be used by this transform.
        Overrides:
        initializeCss in class AbstractAppTransform
      • renderHomeLink

        public void renderHomeLink​(MarkupOutput out)
        Renders a link to Microstrategy Web home page:
        Parameters:
        out - MarkupOutput
        Since:
        MicroStrategy Web 9.0.0
      • renderConnectedServersTitle

        public void renderConnectedServersTitle​(MarkupOutput out)
        Render the connected servers title
        Since:
        MicroStrategy Web 9.0.0
      • renderEmptyList

        public void renderEmptyList​(MarkupOutput out)
        Method used when there are no connected servers. Shows the message: "No MicroStrategy Servers are currently connected."
        Since:
        MicroStrategy Web 9.0.0
      • renderConfigureServersLink

        public void renderConfigureServersLink​(MarkupOutput out)
        Since:
        MicroStrategy Web 9.0.0
      • renderServerList

        public void renderServerList​(MarkupOutput out)
        Method used when there are connected servers. Generates a list view of the connected-servers.
        Since:
        MicroStrategy Web 9.0.0
      • generateHeaders

        protected void generateHeaders​(TableTag table)
        Generates the row with the titles for the columns in the given TableTag
        Since:
        MicroStrategy Web 9.0.0
      • generateHeader

        protected void generateHeader​(RowTag tr,
                                      java.lang.String header)
        Generates a single header.
        Since:
        MicroStrategy Web 9.0.0
      • generateRows

        protected void generateRows​(TableTag table)
        Generates the rows with the connected servers list in the given TableTag
        Since:
        MicroStrategy Web 9.0.0
      • getClusterNodes

        public java.util.Enumeration getClusterNodes​(WebCluster cluster)
        Returns an enumeration of WebClusterNode interfaces that are in the cluster.
        Parameters:
        cluster - The WebCluster from where nodes should be retrieved. Typically a member of the AdminBean.getClusters()
        Since:
        MicroStrategy Web 9.0.0
      • renderIcon

        public void renderIcon​(MarkupOutput out,
                               WebCluster cluster)
        Render the HTML corresponding to the icon of the cluster
        Parameters:
        out -
        cluster -
        Since:
        MicroStrategy Web 9.0.0
      • renderClusterName

        public void renderClusterName​(MarkupOutput out,
                                      WebCluster cluster)
        For a single cluster, renders its position within the clusters collection.
        Since:
        MicroStrategy Web 9.0.0
      • renderClusterIndex

        public void renderClusterIndex​(MarkupOutput out,
                                       WebCluster cluster)
        For a single cluster, renders its position within the clusters collection.
        Since:
        MicroStrategy Web 9.0.0
      • renderServerName

        public void renderServerName​(MarkupOutput out,
                                     WebClusterNode clusterNode)
        For a single cluster node, renders the corresponding intelligence server name.
        Since:
        MicroStrategy Web 9.0.0
      • renderServerConnectionMode

        public void renderServerConnectionMode​(MarkupOutput out,
                                               WebClusterNode clusterNode)
        For a single cluster node, renders whether Microstrategy Web is configured to automatically connect to it as soon as it's available.
        Since:
        MicroStrategy Web 9.0.0
      • renderServerLoad

        public void renderServerLoad​(MarkupOutput out,
                                     WebClusterNode clusterNode)
        For a single cluster node, renders it's current load.
        Since:
        MicroStrategy Web 9.0.0
      • renderServerBusyConnections

        public void renderServerBusyConnections​(MarkupOutput out,
                                                WebClusterNode clusterNode)
        For a single cluster node, renders the number of busy connections.
        Since:
        MicroStrategy Web 9.0.0
      • renderServerFreeConnections

        public void renderServerFreeConnections​(MarkupOutput out,
                                                WebClusterNode clusterNode)
        For a single cluster node, renders the number of free connections.
        Since:
        MicroStrategy Web 9.0.0
      • renderServerConnectionPoolSize

        public void renderServerConnectionPoolSize​(MarkupOutput out,
                                                   WebClusterNode clusterNode)
        For a single cluster node, renders the current connection pool size.
        Since:
        MicroStrategy Web 9.0.0
      • renderDisconnectServer

        public void renderDisconnectServer​(MarkupOutput out,
                                           WebClusterNode clusterNode)
        For a single cluster node, renders the button to disconnect from this server.
        Since:
        MicroStrategy Web 9.0.0
      • renderModifyServerProperties

        public void renderModifyServerProperties​(MarkupOutput out,
                                                 WebClusterNode clusterNode)
        For a single cluster node, renders a link to modify server properties.
        Since:
        MicroStrategy Web 9.0.0
      • renderServerAdminLink

        public void renderServerAdminLink​(MarkupOutput out,
                                          WebClusterNode clusterNode)
        For a single cluster node, renders a link to modify server properties.
        Since:
        MicroStrategy Web 9.0.0
      • isClusterListEmpty

        public boolean isClusterListEmpty()
        Returns true if the clusters list is empty.
        Since:
        MicroStrategy Web 9.0.0
      • hasNextCluster

        public boolean hasNextCluster​(WebCluster cluster)
        Helper method for the layout to determine if there are more clusters to render
        Since:
        MicroStrategy Web 9.0.0
      • hasNextServer

        public boolean hasNextServer​(WebClusterNode clusterNode)
        Helper method for the layout to determine if there are more servers to render
        Since:
        MicroStrategy Web 9.0.0
      • getServerName

        public java.lang.String getServerName​(WebClusterNode clusterNode)
        For the given cluster node, returns the corresponding intelligence server name.
        Since:
        MicroStrategy Web 9.0.0
      • isAutoConnect

        public boolean isAutoConnect​(WebClusterNode clusterNode)
        For the given cluster node, returns true if Microstrategy Web is configured to automatically connect to it as soon as it's available.
        Since:
        MicroStrategy Web 9.0.0
      • getServerFreeConnections

        public int getServerFreeConnections​(WebClusterNode clusterNode)
        For the given cluster node, returns the number of free connections.
        Since:
        MicroStrategy Web 9.0.0
      • getServerBusyConnections

        public int getServerBusyConnections​(WebClusterNode clusterNode)
        For the given cluster node, returns the number of busy connections.
        Since:
        MicroStrategy Web 9.0.0
      • getServerPoolSize

        public int getServerPoolSize​(WebClusterNode clusterNode)
        For the given cluster node, returns the current connection pool size.
        Since:
        MicroStrategy Web 9.0.0
      • getServerLoad

        public int getServerLoad​(WebClusterNode clusterNode)
        For the given cluster node, returns it's current load.
        Since:
        MicroStrategy Web 9.0.0
      • isFirstClusterNode

        public boolean isFirstClusterNode​(WebCluster cluster,
                                          WebClusterNode clusterNode)
        Returns true if the cluster node is the first one within the given cluster.
        Since:
        MicroStrategy Web 9.0.0
      • getClusterName

        public java.lang.String getClusterName​(WebCluster cluster)
        For the given cluster, returns its name. The name is calculated as the concatenation of all the servers in the cluster, separated by "/"
        Since:
        MicroStrategy Web 9.0.0
      • getClusterCSS

        public java.lang.String getClusterCSS​(WebCluster cluster)
        Return the css class name that belongns to the current cluster
        Parameters:
        cluster -
        Returns:
        css class name
        Since:
        MicroStrategy Web 9.0.0
      • getClusterIndex

        public int getClusterIndex​(WebCluster cluster)
        For the given cluster, returns its position within the clusters collection.
        Since:
        MicroStrategy Web 9.0.0
      • getClusterSize

        public int getClusterSize​(WebCluster cluster)
        For the given cluster, returns its size.
        Since:
        MicroStrategy Web 9.0.0
      • getConnectMode

        public java.lang.String getConnectMode​(WebClusterNode clusterNode)
        For the given cluster node, returns the connection mode stored in the sys default Preferences.
        Since:
        MicroStrategy Web 9.0.0
      • getOpenServerAdmin

        public WebEvent getOpenServerAdmin​(WebClusterNode clusterNode)
        Returns the event to open the desktop page for server-admin.
        Since:
        MicroStrategy Web 9.0.0
      • getOpenHomeEvent

        public WebEvent getOpenHomeEvent()
        Returns the open-home event. This event will take you back to the home page for the given portal.
        Since:
        MicroStrategy Web 9.0.0
      • getDisconnectServerEvent

        public WebEvent getDisconnectServerEvent​(WebClusterNode clusterNode)
        Returns the event to use to disconnect the given server.
        Since:
        MicroStrategy Web 9.0.0
      • getModifyServerProperties

        public WebEvent getModifyServerProperties​(WebClusterNode clusterNode)
        Returns the event to use to open the modify server properties page/dialog.
        Since:
        MicroStrategy Web 9.0.0
      • generateAnchorForWeb

        public AnchorTag generateAnchorForWeb​(WebEvent event)
        This method will return an AnchorTag whose target-base is not to current controller (e.g. mstrWebAdmin), but the Microstrategy Web main controller. This can be used to create links that point back to the main applicaiton.
        Since:
        MicroStrategy Web 9.0.0
      • generateAnchorForServerAdmin

        public AnchorTag generateAnchorForServerAdmin​(WebEvent event)
        This method will return an AnchorTag whose target-base is not to current controller (e.g. mstrWebAdmin), but the iServer Administration controller. This can be used to create links that point to this portal.
        Since:
        MicroStrategy Web 9.0.0
      • generateAnchorForWebAdmin

        public AnchorTag generateAnchorForWebAdmin​(WebEvent event)
        Since:
        MicroStrategy Web 9.0.0