public interface

AdminBean

implements AppComponent
com.microstrategy.web.admin.beans.AdminBean

Class Overview

This is the administrator bean which is used by various transforms to render the connected servers, render unconnected servers, render security details and render server properties.

Summary

Constants
String USHER_TOKEN_STR
[Expand]
Inherited Constants
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract void afterSave(Map pValues, PreferencesException ex)
This will be invoked after we set new values for the Intelligence Server properties or after we change the default properties.
abstract void createAdminServersFile(AdminServersList _adminServerList)
Create the AdminServers.xml file from the list of admin server objects passed to it (AdminServersList).
abstract AdminServersList getAdminServersList()
Retrievees the list of the Intelligence Servers present on this web server.
abstract WebClusterAdmin getClusterAdmin()
Returns the cluster administrator.The WebClusterAdmin is an interface from which a user can connect to or disconnect from an Intelligence Server Cluster, monitor the Intelligence Server Clusters the API is currently connecting to, monitor the connection pool used to connect the API and the Intelligence Servers and set the connection pool size to tune the performance.
abstract Enumeration getClusters()
This method returns a collection of Intelligence Server Clusters representing all clusters that the API is connected to.
abstract boolean getConnectedServer()
Determines if the Intelligence Server is connected.
abstract boolean getDisConnectedServer()
Determines if the Intelligence Server is unconnected.
abstract boolean getNewServer()
Determines if the Intelligence Server is is being newly added or if it is already present in the list of Intelligence Servers present on the web server.
abstract WebException getServerError()
abstract String getServerErrorMessge()
abstract String getServerName()
Returns the name of the Intelligence Server.
abstract Map<Integer, String> getServerSettings()
abstract boolean getShowConnectedServers()
Determines if we need to show the list of connected Intelligence Servers on the Administrator page.
abstract boolean getShowDefaultProperties()
Determines if we are rendering the default properties for all the Intelligence Servers.
abstract boolean getShowSSOTrustCreation()
abstract boolean getShowServerProperties()
Determines if we are rendering the properties for a particular Intelligence Servers.
abstract boolean getShowUnConnectedServers()
Determines if we need to show the list of unconnected Intelligence Servers on the Administrator page.
abstract boolean getShowUsherConfig()
abstract String getStyle()
The style from the list of styles in the Style Catalog which will be used to transform this bean.
abstract File getTokenFile()
Retrieve the token file for trust relationship saved in Web Server side.
abstract WebException getTrustCreationError()
abstract boolean hasValidationErrors()
Determines if there were any validation errors while changing either the default properties or the properties for a particular Intelligence Server.
abstract boolean isTokenExists()
Determine if there is a trust relationship between Web Server and Intelligence Server which is set in method setServerName.
abstract boolean isValidPreference(String name)
Determine if the value of a Intelligence Server property being modified is valid or invalid.
abstract AdminServersList loadAdminServersFile()
Method to load the Intelligence Servers present in the admin servers xml file into java objects.
abstract void setConnectedServer(boolean value)
Used to determine if changing/rendering the properties of a connected Intelligence Server.
abstract void setDisConnectedServer(boolean value)
Used to determine if changing/rendering the properties of a unconnected Intelligence Server.
abstract void setNewServer(boolean value)
Set this value to true if the Intelligence Server is is being newly added to the list of Intelligence Servers present on the web server.
abstract void setServerError(WebException exception)
abstract void setServerName(String value)
Sets the name of the Intelligence Server.
abstract void setShowConnectedServers(boolean value)
Set to true if we need to show the list of connected Intelligence Servers on the Administrator page.
abstract void setShowDefaultProperties(boolean value)
Used to determine if we are rendering the default properties for all the Intelligence Servers.
abstract void setShowSSOTrustCreation(boolean show)
abstract void setShowServerProperties(boolean value)
Used to determine if we are rendering the properties for one particular Intelligence Servers.
abstract void setShowUnConnectedServers(boolean value)
Set to true if we need to show the list of unconnected Intelligence Servers on the Administrator page.
abstract void setShowUsherConfig(boolean value)
abstract void setStyle(String newValue)
Set the style name from the list of styles in the Style Catalog which will be used to transform this bean.
abstract void setTrustCreationError(WebException exception)
[Expand]
Inherited Methods
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Constants

public static final String USHER_TOKEN_STR

Constant Value: "*******************************************************************"

Public Methods

public abstract void afterSave (Map pValues, PreferencesException ex)

This will be invoked after we set new values for the Intelligence Server properties or after we change the default properties. This will be used to handle validation errors while updating properties.

Parameters
pValues A map of all the name-value pairs for properties which we tried to change/update.
ex An Exception thrown if there were any validation errors while changing/updating properties. This exception object contains information about the name of the property/properties which had an error and the error description.

public abstract void createAdminServersFile (AdminServersList _adminServerList)

Create the AdminServers.xml file from the list of admin server objects passed to it (AdminServersList).

Parameters
_adminServerList The list of Admin Server objects from which to create the file.

public abstract AdminServersList getAdminServersList ()

Retrievees the list of the Intelligence Servers present on this web server. It will return all the Intelligence Servers present in the AdminServers.xml file.

Returns
  • The list of Intelligence Servers present on the web server.

public abstract WebClusterAdmin getClusterAdmin ()

Returns the cluster administrator.The WebClusterAdmin is an interface from which a user can connect to or disconnect from an Intelligence Server Cluster, monitor the Intelligence Server Clusters the API is currently connecting to, monitor the connection pool used to connect the API and the Intelligence Servers and set the connection pool size to tune the performance.

public abstract Enumeration getClusters ()

This method returns a collection of Intelligence Server Clusters representing all clusters that the API is connected to.

Returns
  • The cluster collection.
Throws
WebObjectsException Signals an error condition while getting the clusters.

public abstract boolean getConnectedServer ()

Determines if the Intelligence Server is connected. This information is used while changing/rendering the properties of the Intelligence Server.

Returns
  • true if the Intelligence Server is connected.

public abstract boolean getDisConnectedServer ()

Determines if the Intelligence Server is unconnected. This information is used while changing/rendering the properties of the Intelligence Server.

Returns
  • true if the Intelligence Server is not connected.

public abstract boolean getNewServer ()

Determines if the Intelligence Server is is being newly added or if it is already present in the list of Intelligence Servers present on the web server. This information is used while changing/rendering the properties of the Intelligence Server.

Returns
  • true if the Intelligence Server is being newly added.

public abstract WebException getServerError ()

public abstract String getServerErrorMessge ()

public abstract String getServerName ()

Returns the name of the Intelligence Server. This will be used on the properties page to display the name of the Intelligence Server whose properties are being rendered.

Returns
  • The name of the Intelligence Server.

public abstract Map<Integer, String> getServerSettings ()

public abstract boolean getShowConnectedServers ()

Determines if we need to show the list of connected Intelligence Servers on the Administrator page.

Returns
  • true if we need to show the list of connected Intelligence Servers on the Administrator page.

public abstract boolean getShowDefaultProperties ()

Determines if we are rendering the default properties for all the Intelligence Servers.

Returns
  • true if we are rendering the default properties for all the Intelligence Servers.

public abstract boolean getShowSSOTrustCreation ()

public abstract boolean getShowServerProperties ()

Determines if we are rendering the properties for a particular Intelligence Servers.

Returns
  • true if we are rendering the properties for a particular Intelligence Servers.

public abstract boolean getShowUnConnectedServers ()

Determines if we need to show the list of unconnected Intelligence Servers on the Administrator page.

Returns
  • true if we need to show the list of unconnected Intelligence Servers on the Administrator page.

public abstract boolean getShowUsherConfig ()

public abstract String getStyle ()

The style from the list of styles in the Style Catalog which will be used to transform this bean.

Returns
  • The name of the style from the list of styles in the Style Catalog which will be used to transform this bean.

public abstract File getTokenFile ()

Retrieve the token file for trust relationship saved in Web Server side.

Returns
  • The token file.

public abstract WebException getTrustCreationError ()

public abstract boolean hasValidationErrors ()

Determines if there were any validation errors while changing either the default properties or the properties for a particular Intelligence Server. Even if one of the properties was invalid, this method will return a true.

Returns
  • true if there were validation errors while changing the properites of Intelligence Server.

public abstract boolean isTokenExists ()

Determine if there is a trust relationship between Web Server and Intelligence Server which is set in method setServerName.

Returns
  • true if there is a trust relationship exists.

public abstract boolean isValidPreference (String name)

Determine if the value of a Intelligence Server property being modified is valid or invalid.

Parameters
name The name of the property which is being modified.
Returns
  • true if the property value being modified is valid.

public abstract AdminServersList loadAdminServersFile ()

Method to load the Intelligence Servers present in the admin servers xml file into java objects.

Returns
  • The AdminServersList objects.

public abstract void setConnectedServer (boolean value)

Used to determine if changing/rendering the properties of a connected Intelligence Server.

Parameters
value Set to true if we are changing/rendering the proeprties of a connected Intelligence Server.

public abstract void setDisConnectedServer (boolean value)

Used to determine if changing/rendering the properties of a unconnected Intelligence Server.

Parameters
value Set to true if we are changing/rendering the proeprties of a unconnected Intelligence Server.

public abstract void setNewServer (boolean value)

Set this value to true if the Intelligence Server is is being newly added to the list of Intelligence Servers present on the web server.

Parameters
value Set to true if the Intelligence Server is is being newly added.

public abstract void setServerError (WebException exception)

public abstract void setServerName (String value)

Sets the name of the Intelligence Server. This will be used on the properties page to display the name of the Intelligence Server whose properties are being rendered.

Parameters
value The name of the Intelligence Server.

public abstract void setShowConnectedServers (boolean value)

Set to true if we need to show the list of connected Intelligence Servers on the Administrator page.

Parameters
value Set this to true if we need to show the list of connected Intelligence Servers on the Administrator page.

public abstract void setShowDefaultProperties (boolean value)

Used to determine if we are rendering the default properties for all the Intelligence Servers.

Parameters
value Set to true if we are rendering the default properties for all the Intelligence Servers.

public abstract void setShowSSOTrustCreation (boolean show)

public abstract void setShowServerProperties (boolean value)

Used to determine if we are rendering the properties for one particular Intelligence Servers.

Parameters
value Set to true if we are rendering the properties for one particular Intelligence Servers.

public abstract void setShowUnConnectedServers (boolean value)

Set to true if we need to show the list of unconnected Intelligence Servers on the Administrator page.

Parameters
value Set this to true if we need to show the list of unconnected Intelligence Servers on the Administrator page.

public abstract void setShowUsherConfig (boolean value)

public abstract void setStyle (String newValue)

Set the style name from the list of styles in the Style Catalog which will be used to transform this bean.

Parameters
newValue The name of the style from the list of styles in the Style Catalog which will be used to transform this bean.

public abstract void setTrustCreationError (WebException exception)