public class

AdminServer

extends AbstractConfigurationElement
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.web.admin.AdminServer

Class Overview

A AdminServer class instance represents the information regarding an Intelligence Server. All the details required to add an Intelligence Server can be found here

Summary

Constants
String ATT_CONNECTED
String ATT_NAME
String NODE_SERVER
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
AdminServer()
Class constructor.
AdminServer(Node root)
Class constructor.
Public Methods
boolean getConnected()
Determine if the Intelligence Server represented by this object is connected.
Object getKey()
Default implementation for getKey().
String getName()
Method to return the name of the Intelligence Server which is represented by this object.
void setConnected(boolean connected)
Set the connected property to true if the Intelligence Server represented by this object is connected.
void setName(String serverName)
Set the name of the Intelligence Server which is represented by this object.
Protected Methods
String getKeyAttribute()
This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.
void initDefaultAttributes()
This method can be overridden to set default values for attributes.
[Expand]
Inherited Methods
From class com.microstrategy.utils.config.AbstractConfigurationElement
From class java.lang.Object
From interface com.microstrategy.utils.config.ConfigurationElement
From interface com.microstrategy.utils.config.ConfigurationFile

Constants

public static final String ATT_CONNECTED

Constant Value: "conn"

public static final String ATT_NAME

Constant Value: "name"

public static final String NODE_SERVER

Constant Value: "server"

Public Constructors

public AdminServer ()

Class constructor. Initializes a new -empty- instance of the AdminServer class.

public AdminServer (Node root)

Class constructor. Initializes an AdminServer instance based on the information included on the XML Node

Parameters
root Node instance representing the Admin Server information.

Public Methods

public boolean getConnected ()

Determine if the Intelligence Server represented by this object is connected.

Returns
  • true if the the Intelligence Server is connected

public Object getKey ()

Default implementation for getKey(). It assumes a single attribute can be used to uniquely identify this element among its siblings; the attribute to use is specified by the getKeyAttribute() method.

Returns
  • If getKeyAttribute() is empty returns null, otherwise it returns the value of the given attribute.

public String getName ()

Method to return the name of the Intelligence Server which is represented by this object.

Returns
  • the server name

public void setConnected (boolean connected)

Set the connected property to true if the Intelligence Server represented by this object is connected.

Parameters
connected boolean value set to true indicating that the Intelligence Server represented by this object is connected.

public void setName (String serverName)

Set the name of the Intelligence Server which is represented by this object.

Parameters
serverName the new name of the server

Protected Methods

protected String getKeyAttribute ()

This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.

protected void initDefaultAttributes ()

This method can be overridden to set default values for attributes. Simply extend this method and call setAttribute(String, Object)