public class

AdminServersList

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

Class Overview

This class defines a list of AdminServer objects.

Summary

Constants
String ATT_SERVER_COUNT
String NODE_SERVERS
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElementList
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
AdminServersList()
AdminServersList(Node root)
Class constructor.
AdminServersList(Document doc)
Class constructor.
Public Methods
ConfigurationElement get(Object key)
AdminServer getAdminServer(String serverName)
Method to determine the AdminServer Object that corresponds to the Intelligence Server name specified.
int getServerCount()
Determine the number of Intelligence Servers represented in this AdminServersList object.
ConfigurationElement remove(Object key)
Removes an element from the collection
void save(String fileContents, String fileName)
Save all the information regarding the list of AdminServers (Intelligence Servers) to disk.
Protected Methods
void initDefaultAttributes()
This method can be overridden to set default values for attributes.
[Expand]
Inherited Methods
From class com.microstrategy.utils.config.AbstractConfigurationElementList
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.ConfigurationElementList
From interface com.microstrategy.utils.config.ConfigurationFile

Constants

public static final String ATT_SERVER_COUNT

Constant Value: "serverCount"

public static final String NODE_SERVERS

Constant Value: "servers"

Public Constructors

public AdminServersList ()

public AdminServersList (Node root)

Class constructor. Creates a new instance of the AdminServersList, initializing it with the information provided on an xml Node.

Parameters
root Node instance representing the information regarding admin servers list.

public AdminServersList (Document doc)

Class constructor. Creates a new instance of the AdminServersList, initializing it with the information provided on an xml Document.

Parameters
doc DOM Document with information to initialize this class

Public Methods

public ConfigurationElement get (Object key)

Parameters
key the key of the object to return
Returns
  • An object of the collection with the given Key

public AdminServer getAdminServer (String serverName)

Method to determine the AdminServer Object that corresponds to the Intelligence Server name specified.

Parameters
serverName The name of the Intelligence Server for which we want the AdminServer object.
Returns
  • AdminServer The object representation corresponding to the name of the Intelligence Server specified as an argument.

public int getServerCount ()

Determine the number of Intelligence Servers represented in this AdminServersList object.

Returns
  • The count of Intelligence Servers.

public ConfigurationElement remove (Object key)

Removes an element from the collection

Parameters
key the key of the object to remove
Returns
  • the ConfigurationElement object removed from the collection

public void save (String fileContents, String fileName)

Save all the information regarding the list of AdminServers (Intelligence Servers) to disk.

Parameters
fileContents The string representation of the all the Admin Servers information.
fileName The name of the file(along with path information) where we want to store the information.

Protected Methods

protected void initDefaultAttributes ()

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