Package com.microstrategy.web.admin

Class AdminServer

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.web.admin.AdminServer

All Implemented Interfaces:

ConfigurationElement, ConfigurationFile, java.lang.Cloneable

public class AdminServer
extends AbstractConfigurationElement

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

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_CONNECTED
static java.lang.String	ATT_NAME
static java.lang.String	NODE_SERVER

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
AdminServer()	Class constructor.
AdminServer(org.w3c.dom.Node root)	Class constructor.

Method Summary

Modifier and Type	Method	Description
boolean	getConnected()	Determine if the Intelligence Server represented by this object is connected.
java.lang.Object	getKey()	Default implementation for getKey().
protected java.lang.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.
java.lang.String	getName()	Method to return the name of the Intelligence Server which is represented by this object.
protected void	initDefaultAttributes()	This method can be overridden to set default values for attributes.
void	setConnected(boolean connected)	Set the connected property to true if the Intelligence Server represented by this object is connected.
void	setName(java.lang.String serverName)	Set the name of the Intelligence Server which is represented by this object.

Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, clone, delete, deltas, deltas, equalAtts, equalElements, equalNodeValues, equals, equalsIncludingDeletedElements, exportAttributesToXML, exportElementsToXML, exportNodeValueToXML, getAttribute, getAttributes, getBoolAttribute, getChildKey, getConfigSrc, getDTDFileName, getElement, getElement, getElements, getFileLoader, getIntAttribute, getIntAttribute, 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

Field Detail

ATT_NAME

public static final java.lang.String ATT_NAME

See Also:

Constant Field Values

ATT_CONNECTED

public static final java.lang.String ATT_CONNECTED

See Also:

Constant Field Values

NODE_SERVER

public static final java.lang.String NODE_SERVER

See Also:

Constant Field Values

Constructor Detail

AdminServer

public AdminServer()

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

AdminServer

public AdminServer(org.w3c.dom.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.

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 call AbstractConfigurationElement.setAttribute(java.lang.String, java.lang.Object)

Overrides:

initDefaultAttributes in class AbstractConfigurationElement

Since:

MicroStrategy Web 9.0.0

getName

public java.lang.String getName()

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

Returns:

the server name

setName

public void setName(java.lang.String serverName)

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

Parameters:

serverName - the new name of the server

getConnected

public boolean getConnected()

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

Returns:

true if the the Intelligence Server is connected

setConnected

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.

getKeyAttribute

protected java.lang.String getKeyAttribute()

Description copied from class: AbstractConfigurationElement

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.

Specified by:

getKeyAttribute in class AbstractConfigurationElement

Since:

MicroStrategy Web 9.0.0

getKey

public java.lang.Object getKey()

Description copied from class: AbstractConfigurationElement

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.

Specified by:

getKey in interface ConfigurationElement

Overrides:

getKey in class AbstractConfigurationElement

Returns:

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

Since:

MicroStrategy Web 9.0.0