Package com.microstrategy.web.admin
Class AdminServersList
- java.lang.Object
-
- com.microstrategy.utils.config.AbstractConfigurationElement
-
- com.microstrategy.utils.config.AbstractConfigurationElementList
-
- com.microstrategy.web.admin.AdminServersList
-
- All Implemented Interfaces:
ConfigurationElement
,ConfigurationElementList
,ConfigurationFile
,java.lang.Cloneable
public class AdminServersList extends AbstractConfigurationElementList
This class defines a list of AdminServer objects.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.utils.config.AbstractConfigurationElement
AbstractConfigurationElement.FilteredList
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ATT_SERVER_COUNT
static java.lang.String
NODE_SERVERS
-
Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElementList
ATT_VERSION
-
Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElement
ATT_CONFIG_SRC, ATT_DELETED, ATT_POSITION, ATT_PROTOTYPE, ATT_USE_DEFAULT
-
-
Constructor Summary
Constructors Constructor Description AdminServersList()
AdminServersList(org.w3c.dom.Document doc)
Class constructor.AdminServersList(org.w3c.dom.Node root)
Class constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ConfigurationElement
get(java.lang.Object key)
AdminServer
getAdminServer(java.lang.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.protected void
initDefaultAttributes()
This method can be overridden to set default values for attributes.ConfigurationElement
remove(java.lang.Object key)
Removes an element from the collectionvoid
save(java.lang.String fileContents, java.lang.String fileName)
Save all the information regarding the list of AdminServers (Intelligence Servers) to disk.-
Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElementList
clear, clone, get, getFilteredList, getKey, getKeyAttribute, getList, getValues, getVersion, init, isEmpty, put, put, registerElementInList, setVersion, size, sort
-
Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElement
addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, delete, deltas, deltas, equalAtts, equalElements, equalNodeValues, equals, equalsIncludingDeletedElements, exportAttributesToXML, exportElementsToXML, exportNodeValueToXML, getAttribute, getAttributes, getBoolAttribute, getChildKey, getConfigSrc, getDTDFileName, getElement, getElement, getElements, getFileLoader, getIntAttribute, getIntAttribute, getKey, getLineNumber, getList, getNextKey, getNodeName, getNodeValue, getNodeValue, getOrCreateElement, getParent, getPosition, getPrototype, getRegisteredClass, getSelfInitPath, getSource, getStrAttribute, getUseDefault, getXMLParserParameters, getXMLSerializerParameters, hashCode, hashCodeAtts, hashCodeElements, hashCodeNodeValues, hasRegisteredClass, initAttributesFromXML, initElementFromXML, initElementsFromXML, initFromFile, initFromResource, initFromXML, initFromXML, initNodeValueFromXML, initPrototype, isActive, isCustomized, isDeleted, isDirty, isInSource, isKeyAttribute, load, mergeChanges, newChildInstance, newSource, original, populate, printAttributes, printElements, printNodeValue, refreshLists, registerClass, registerElement, registerElement, registerElementList, reload, reloadPrototype, removeAttribute, removeDefaults, replaceList, restore, save, save, saveChangesAs, saveConfig, saveFlatXML, saveNode, saveSource, setAttribute, setBoolAttribute, setChildOriginals, setConfigSrc, setCustomized, setElement, setFileLoader, setIntAttribute, setKey, setLineNumber, setNodeName, setNodeValue, setPosition, setPrototype, setSelfInitPath, setStrAttribute, setUseDefault, setUseValidation, throwConfigParseException, toString, toXML, toXML, toXML, toXML, useNodeValue, useValidation
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.microstrategy.utils.config.ConfigurationElement
getAttribute, getAttributes, getElement, getElements, getKey, getNodeName, getStrAttribute, initFromXML, reload, toXML
-
-
-
-
Field Detail
-
NODE_SERVERS
public static final java.lang.String NODE_SERVERS
- See Also:
- Constant Field Values
-
ATT_SERVER_COUNT
public static final java.lang.String ATT_SERVER_COUNT
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
AdminServersList
public AdminServersList()
-
AdminServersList
public AdminServersList(org.w3c.dom.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.
-
AdminServersList
public AdminServersList(org.w3c.dom.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
-
-
Method Detail
-
initDefaultAttributes
protected void initDefaultAttributes()
Description copied from class:AbstractConfigurationElement
This method can be overridden to set default values for attributes. Simply extend this method and callAbstractConfigurationElement.setAttribute(java.lang.String, java.lang.Object)
- Overrides:
initDefaultAttributes
in classAbstractConfigurationElement
- Since:
- MicroStrategy Web 9.0.0
-
getAdminServer
public AdminServer getAdminServer(java.lang.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.
-
getServerCount
public int getServerCount()
Determine the number of Intelligence Servers represented in this AdminServersList object.- Returns:
- The count of Intelligence Servers.
-
save
public void save(java.lang.String fileContents, java.lang.String fileName) throws WebAppRuntimeException
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.- Throws:
WebAppRuntimeException
-
remove
public ConfigurationElement remove(java.lang.Object key)
Description copied from class:AbstractConfigurationElementList
Removes an element from the collection- Specified by:
remove
in interfaceConfigurationElementList
- Overrides:
remove
in classAbstractConfigurationElementList
- Parameters:
key
- the key of the object to remove- Returns:
- the ConfigurationElement object removed from the collection
- Since:
- MicroStrategy Web 9.0.0
-
get
public ConfigurationElement get(java.lang.Object key)
- Specified by:
get
in interfaceConfigurationElementList
- Overrides:
get
in classAbstractConfigurationElementList
- Parameters:
key
- the key of the object to return- Returns:
- An object of the collection with the given Key
-
-