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

protected final String	CLASS_INPUT	This field is deprecated. This property is not used anymore by the transform.
protected final String	CLASS_MESSAGE	This field is deprecated. This property is not used anymore by the transform.
protected WebComponent	_bean	Instance of `WebComponent` being transformed.
protected ComponentBlock	_componentBlock
protected String	_cssPrefix	Property corresponding to the value of the `cssPrefix` formal parameter
protected String	_imgBlank	Field that containts the URL location of a blank image (used as the source of most <IMG> tags as the real URL is specified through css).
protected String	_imgWait	This field is deprecated. This value is not used anymore by the Transform as the wait image is included using css.
protected MarkupOutput	_selfOutput	This field is deprecated. this field is no longer used since partial update blocks are now generated via `ComponentBlock`
protected MarkupOutput	_subOutput	This field is deprecated. this field is no longer used since partial update blocks are now generated via `ComponentBlock`
public FormalParameter	appliesTo	This parameter informs the javascript the id of the bone the actions of this component applies to.
public FormalParameter	contextMenus	This formal parameter is used by the Transform to identify the context-menus definition.
public FormalParameter	cssFile	CSS file that includes the style definition.
public FormalParameter	cssPrefix	Prefix to append to all css class names.
public FormalParameter	debugErrorFlags	Indicates which extra debug information to include in case of an error.
public FormalParameter	debugFlags	Indicates which debug information to include.
public FormalParameter	dragMode	Indicates the drag mode that the component to render will have.
public FormalParameter	extraInput	Indicates any extra inputs to be included in the forms generated by the transform.
public FormalParameter	extraUrl	Indicates any extra parameters to be included in the links generated by the transform.
public FormalParameter	globalCssErrorMessage	This field is deprecated. The css class to use cannot be controlled through a formal parameter anymore.
public FormalParameter	globalCssErrorTitle	This field is deprecated. The css class to use cannot be controlled through a formal parameter anymore.
public FormalParameter	height	Indicates the default height of the component.
public FormalParameter	iframeEnabled	Indicates whether the transform supports iframe manipulations.
public FormalParameter	imgWait	This field is deprecated. This value is not used anymore by the Transform as the wait image is included using css.
protected int	indent	This field is deprecated. Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
public FormalParameter	initialIndent	This field is deprecated. Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
protected boolean	isDHTML	This field is deprecated. Use `isDhtml()`.
public FormalParameter	orientation	Indicates the orientation the dialog to render will have.
public FormalParameter	orientationsAllowed	Indicates the orientation modes allowed for the dialog to render.
public FormalParameter	partialIframeUpdate	This formal parameter specifies whether we should replace the whole contentst of the div shell (outerHTML) or the just the inner contents (innerHTML) of that shell div for the transform when the iframe update is going on.
public FormalParameter	processingButtonsFlags	Indicates which buttons to include on the wait page.
public FormalParameter	processingInfoFlags	Indicates which information to include on the wait page.
public FormalParameter	resizeLevel	Indicates whether the component can be resized vertically/horizontally or both or none.
public FormalParameter	scriptClass	Holds the name of the javaScript class (if any) to be associated with the component.
public FormalParameter	type	This parameter is used when the output of this Transform generates a corresponding Microstrategy bone in the page, and it informs the javascript the type of bone it is.
public FormalParameter	useDHTML	Indicates whether to use DHTML on the output.
public FormalParameter	width	Indicates the default width of the component.

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

void	addFormalParam(FormalParameterImpl formal) This method is used to add a `FormalParameterImpl` object to the transform.
boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
static List<Integer>	getEvents(RequestKeys rkeys) Determines event(s) triggered from the request keys.
FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
String	getID() Returns the unique name of the component to be used as the ID for its shell
MarkupOutput	getPreview() Produces a preview output for this transform.
boolean	isPreviewAvailable() Returns true if this transform supports preview functionality, false otherwise.
boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
FormalParameterImpl	removeFormalParam(String name) Removes the formal parameter with the given name from the formal parameters collection.
void	setAnnotation(FormalParameter fp, FormalParameterAnnotation fpa) Used for internal housekeeping.
void	setDeprecated(FormalParameter fp, String desc) Used for internal housekeeping.
boolean	supports(Class type) Returns true if the transform supports objects of specified type.
boolean	supports(Transformable data) Returns true if the transform supports the specified data object.

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

abstract boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
abstract String	getDescription() Returns a textual description of the transform.
abstract FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
abstract String	getID() Returns the unique name of the component to be used as the ID for its shell
abstract MarkupOutput	getPreview() This method is deprecated. This feature is not used
abstract Class	getSupportedBeanType() Returns a root class/interface supported by this transform.
abstract boolean	isPreviewAvailable() This method is deprecated. This feature is not used
abstract boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
abstract boolean	supports(Class beanClass) Returns true if the transform supports objects of specified type.
abstract boolean	supports(Transformable data) Returns true if the transform supports the specified data object.
abstract void	transform(Transformable data, MarkupOutput transOut) Transforms the data object and appends result to the transOut.