public class

ConnectedServersTransform

extends AbstractAdminTransform
implements LayoutTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.admin.transforms.AbstractAdminTransform
           ↳ com.microstrategy.web.admin.transforms.ConnectedServersTransform

Class Overview

This transform is used to render all the connected servers on the Administrator page.

Summary

Constants
int CONN_COLUMN_ACTION This constant is 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
int CONN_COLUMN_ALL This constant is 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
int CONN_COLUMN_BUSY This constant is 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
int CONN_COLUMN_CLUSTER This constant is 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
int CONN_COLUMN_CONNMODE This constant is 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
int CONN_COLUMN_FREE This constant is 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
int CONN_COLUMN_LOADED This constant is 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
int CONN_COLUMN_MAXPOOL This constant is 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
int CONN_COLUMN_NAME This constant is 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
int CONN_COLUMN_PROPERTIES This constant is 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
String FP_CONNECTED_LEVEL_FLAG This constant is 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
String FP_ICON_HOME_IMAGE
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected int _connectedLevelFlag This field is 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
protected String _imgIconHomeRed
public FormalParameter connectedLevelFlag This field is 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
protected String cssHR
protected String cssHeader
protected String cssHeading
protected String cssNoServers
protected String cssOtherDetails
protected String cssServerName
protected String cssSubmitButton
protected String cssTable
public FormalParameter imgIconHomeRed Name of the image used to indicate the home icon.
[Expand]
Inherited Fields
From class com.microstrategy.web.admin.transforms.AbstractAdminTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ConnectedServersTransform()
Default empty constructor.
Public Methods
AnchorTag generateAnchorForServerAdmin(WebEvent event)
This method will return an AnchorTag whose target-base is not to current controller (e.g.
AnchorTag generateAnchorForWeb(WebEvent event)
This method will return an AnchorTag whose target-base is not to current controller (e.g.
AnchorTag generateAnchorForWebAdmin(WebEvent event)
String getClusterCSS(WebCluster cluster)
Return the css class name that belongns to the current cluster
int getClusterIndex(WebCluster cluster)
For the given cluster, returns its position within the clusters collection.
String getClusterName(WebCluster cluster)
For the given cluster, returns its name.
Enumeration getClusterNodes(WebCluster cluster)
Returns an enumeration of WebClusterNode interfaces that are in the cluster.
int getClusterSize(WebCluster cluster)
For the given cluster, returns its size.
String getConnectMode(WebClusterNode clusterNode)
For the given cluster node, returns the connection mode stored in the sys default Preferences.
String getDescription()
Returns the textual description of the transform
WebEvent getDisconnectServerEvent(WebClusterNode clusterNode)
Returns the event to use to disconnect the given server.
WebEvent getModifyServerProperties(WebClusterNode clusterNode)
Returns the event to use to open the modify server properties page/dialog.
WebEvent getOpenHomeEvent()
Returns the open-home event.
WebEvent getOpenServerAdmin(WebClusterNode clusterNode)
Returns the event to open the desktop page for server-admin.
int getServerBusyConnections(WebClusterNode clusterNode)
For the given cluster node, returns the number of busy connections.
int getServerFreeConnections(WebClusterNode clusterNode)
For the given cluster node, returns the number of free connections.
int getServerLoad(WebClusterNode clusterNode)
For the given cluster node, returns it's current load.
String getServerName(WebClusterNode clusterNode)
For the given cluster node, returns the corresponding intelligence server name.
int getServerPoolSize(WebClusterNode clusterNode)
For the given cluster node, returns the current connection pool size.
boolean hasNextCluster(WebCluster cluster)
Helper method for the layout to determine if there are more clusters to render
boolean hasNextServer(WebClusterNode clusterNode)
Helper method for the layout to determine if there are more servers to render
void initializeCss()
Initializes the Css Class Strings to be used by this transform.
void initializeImages()
Initialize the images to be used by this transform.
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
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.
boolean isClusterListEmpty()
Returns true if the clusters list is empty.
boolean isFirstClusterNode(WebCluster cluster, WebClusterNode clusterNode)
Returns true if the cluster node is the first one within the given cluster.
void renderClusterIndex(MarkupOutput out, WebCluster cluster)
For a single cluster, renders its position within the clusters collection.
void renderClusterName(MarkupOutput out, WebCluster cluster)
For a single cluster, renders its position within the clusters collection.
void renderConfigureServersLink(MarkupOutput out)
void renderConnectedServersTitle(MarkupOutput out)
Render the connected servers title
void renderDisconnectServer(MarkupOutput out, WebClusterNode clusterNode)
For a single cluster node, renders the button to disconnect from this server.
void renderEmptyList(MarkupOutput out)
Method used when there are no connected servers.
void renderHomeLink(MarkupOutput out)
Renders a link to Microstrategy Web home page:
void renderIcon(MarkupOutput out, WebCluster cluster)
Render the HTML corresponding to the icon of the cluster
void renderModifyServerProperties(MarkupOutput out, WebClusterNode clusterNode)
For a single cluster node, renders a link to modify server properties.
void renderServerAdminLink(MarkupOutput out, WebClusterNode clusterNode)
For a single cluster node, renders a link to modify server properties.
void renderServerBusyConnections(MarkupOutput out, WebClusterNode clusterNode)
For a single cluster node, renders the number of busy connections.
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.
void renderServerConnectionPoolSize(MarkupOutput out, WebClusterNode clusterNode)
For a single cluster node, renders the current connection pool size.
void renderServerFreeConnections(MarkupOutput out, WebClusterNode clusterNode)
For a single cluster node, renders the number of free connections.
void renderServerList(MarkupOutput out)
Method used when there are connected servers.
void renderServerLoad(MarkupOutput out, WebClusterNode clusterNode)
For a single cluster node, renders it's current load.
void renderServerName(MarkupOutput out, WebClusterNode clusterNode)
For a single cluster node, renders the corresponding intelligence server name.
void transformForRequestSuccessful(MarkupOutput out)
Transform when the status of the bean which is transformed by this transform is "Successful".
Protected Methods
void generateHeader(RowTag tr, String header)
Generates a single header.
void generateHeaders(TableTag table)
Generates the row with the titles for the columns in the given TableTag
void generateRows(TableTag table)
Generates the rows with the connected servers list in the given TableTag
AdminBean getAdminBean()
Returns the current AdminBean
[Expand]
Inherited Methods
From class com.microstrategy.web.admin.transforms.AbstractAdminTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Constants

public static final int CONN_COLUMN_ACTION

This constant is 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

Constant Value: 128 (0x00000080)

public static final int CONN_COLUMN_ALL

This constant is 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

Constant Value: 4095 (0x00000fff)

public static final int CONN_COLUMN_BUSY

This constant is 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

Constant Value: 16 (0x00000010)

public static final int CONN_COLUMN_CLUSTER

This constant is 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

Constant Value: 1 (0x00000001)

public static final int CONN_COLUMN_CONNMODE

This constant is 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

Constant Value: 4 (0x00000004)

public static final int CONN_COLUMN_FREE

This constant is 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

Constant Value: 32 (0x00000020)

public static final int CONN_COLUMN_LOADED

This constant is 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

Constant Value: 8 (0x00000008)

public static final int CONN_COLUMN_MAXPOOL

This constant is 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

Constant Value: 64 (0x00000040)

public static final int CONN_COLUMN_NAME

This constant is 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

Constant Value: 2 (0x00000002)

public static final int CONN_COLUMN_PROPERTIES

This constant is 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

Constant Value: 256 (0x00000100)

public static final String FP_CONNECTED_LEVEL_FLAG

This constant is 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

Constant Value: "connectedLevelFlag"

public static final String FP_ICON_HOME_IMAGE

Constant Value: "imgIconHomeRed"

Fields

protected int _connectedLevelFlag

This field is 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

protected String _imgIconHomeRed

public FormalParameter connectedLevelFlag

This field is 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).

protected String cssHR

protected String cssHeader

protected String cssHeading

protected String cssNoServers

protected String cssOtherDetails

protected String cssServerName

protected String cssSubmitButton

protected String cssTable

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.

Public Constructors

public ConnectedServersTransform ()

Default empty constructor. Initialize formal parameters.

Public Methods

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.

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.

public AnchorTag generateAnchorForWebAdmin (WebEvent event)

public String getClusterCSS (WebCluster cluster)

Return the css class name that belongns to the current cluster

Returns
  • css class name

public int getClusterIndex (WebCluster cluster)

For the given cluster, returns its position within the clusters collection.

public 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 "/"

public 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 getClusters()

public int getClusterSize (WebCluster cluster)

For the given cluster, returns its size.

public String getConnectMode (WebClusterNode clusterNode)

For the given cluster node, returns the connection mode stored in the sys default Preferences.

public String getDescription ()

Returns the textual description of the transform

Returns
  • the textual description of the transform

public WebEvent getDisconnectServerEvent (WebClusterNode clusterNode)

Returns the event to use to disconnect the given server.

public WebEvent getModifyServerProperties (WebClusterNode clusterNode)

Returns the event to use to open the modify server properties page/dialog.

public WebEvent getOpenHomeEvent ()

Returns the open-home event. This event will take you back to the home page for the given portal.

public WebEvent getOpenServerAdmin (WebClusterNode clusterNode)

Returns the event to open the desktop page for server-admin.

public int getServerBusyConnections (WebClusterNode clusterNode)

For the given cluster node, returns the number of busy connections.

public int getServerFreeConnections (WebClusterNode clusterNode)

For the given cluster node, returns the number of free connections.

public int getServerLoad (WebClusterNode clusterNode)

For the given cluster node, returns it's current load.

public String getServerName (WebClusterNode clusterNode)

For the given cluster node, returns the corresponding intelligence server name.

public int getServerPoolSize (WebClusterNode clusterNode)

For the given cluster node, returns the current connection pool size.

public boolean hasNextCluster (WebCluster cluster)

Helper method for the layout to determine if there are more clusters to render

public boolean hasNextServer (WebClusterNode clusterNode)

Helper method for the layout to determine if there are more servers to render

public void initializeCss ()

Initializes the Css Class Strings to be used by this transform.

public void initializeImages ()

Initialize the images to be used by this transform.

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform. It also invokes the initializeImages and initializeCss methods.

Parameters
data The data (bean) that this transform is going to transform.

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.

public boolean isClusterListEmpty ()

Returns true if the clusters list is empty.

public boolean isFirstClusterNode (WebCluster cluster, WebClusterNode clusterNode)

Returns true if the cluster node is the first one within the given cluster.

public void renderClusterIndex (MarkupOutput out, WebCluster cluster)

For a single cluster, renders its position within the clusters collection.

public void renderClusterName (MarkupOutput out, WebCluster cluster)

For a single cluster, renders its position within the clusters collection.

public void renderConfigureServersLink (MarkupOutput out)

public void renderConnectedServersTitle (MarkupOutput out)

Render the connected servers title

public void renderDisconnectServer (MarkupOutput out, WebClusterNode clusterNode)

For a single cluster node, renders the button to disconnect from this server.

public void renderEmptyList (MarkupOutput out)

Method used when there are no connected servers. Shows the message: "No MicroStrategy Servers are currently connected."

public void renderHomeLink (MarkupOutput out)

Renders a link to Microstrategy Web home page:

Parameters
out MarkupOutput

public void renderIcon (MarkupOutput out, WebCluster cluster)

Render the HTML corresponding to the icon of the cluster

public void renderModifyServerProperties (MarkupOutput out, WebClusterNode clusterNode)

For a single cluster node, renders a link to modify server properties.

public void renderServerAdminLink (MarkupOutput out, WebClusterNode clusterNode)

For a single cluster node, renders a link to modify server properties.

public void renderServerBusyConnections (MarkupOutput out, WebClusterNode clusterNode)

For a single cluster node, renders the number of busy connections.

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.

public void renderServerConnectionPoolSize (MarkupOutput out, WebClusterNode clusterNode)

For a single cluster node, renders the current connection pool size.

public void renderServerFreeConnections (MarkupOutput out, WebClusterNode clusterNode)

For a single cluster node, renders the number of free connections.

public void renderServerList (MarkupOutput out)

Method used when there are connected servers. Generates a list view of the connected-servers.

public void renderServerLoad (MarkupOutput out, WebClusterNode clusterNode)

For a single cluster node, renders it's current load.

public void renderServerName (MarkupOutput out, WebClusterNode clusterNode)

For a single cluster node, renders the corresponding intelligence server name.

public void transformForRequestSuccessful (MarkupOutput out)

Transform when the status of the bean which is transformed by this transform is "Successful".

Parameters
out Output by this transform

Protected Methods

protected void generateHeader (RowTag tr, String header)

Generates a single header.

protected void generateHeaders (TableTag table)

Generates the row with the titles for the columns in the given TableTag

protected void generateRows (TableTag table)

Generates the rows with the connected servers list in the given TableTag

protected AdminBean getAdminBean ()

Returns the current AdminBean

Returns
  • this AdminBean