Summary: Constants | Inherited Constants | Methods | Inherited Methods | [Expand All]

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

abstract AppContext	getAppContext() This method returns the application context object associated with this component.
abstract String	getDescriptor(String key) Retrieve the descriptor when the key is a string
abstract String	getDescriptor(int key) Retrieve the descriptor when the key is an integer value...
abstract EventManager	getEventManager() This method returns the application EventManager used to generates events.
abstract String	getExtraInput() Get any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract String	getExtraUrl() Get any extra url information to be used when generating link information on the transforms associated with this instance.
abstract int	getLeft() Get the left position where the bean should be displayed by the transform if applicable
abstract int	getResultFilterMode()
abstract int	getTop() Get the top position where the bean should be displayed by the transform if applicable
abstract boolean	isDialog() Returns true if this bean should be treated as a dialog
abstract boolean	isForcedChildrenStateSaving() Return whether the state will be save despite it's open or closed state.
abstract boolean	isModal() Retrieves the modal state of the bean
abstract boolean	isModalOpen() indicates whether there is a Modal AppComponent open in the hierarchy
abstract boolean	isOpen() Retrieves the open/close state of the bean
abstract void	setExtraInput(String newValue) Set any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract void	setExtraUrl(String newValue) Set any extra url information to be used when generating link information on the transforms associated with this instance.
abstract void	setForcedChildrenStateSaving(boolean value) Forces the bean state to be save despite it's open or closed state.
abstract void	setHasJustOpened(boolean value) Sets whether the component has just been opened.
abstract void	setIsDialog(boolean value) Sets the bean to its dialog mode.
abstract void	setIsModal(boolean value) Sets the bean to its modal mode.
abstract void	setIsOpen(boolean value) Sets the bean to its enabled mode, meaning the editor will be visible to the user
abstract void	setLeft(int x) Set the left position where the bean should be displayed by the transform if applicable.
abstract void	setTop(int y) Set the top position where the bean should be displayed by the transform if applicable.

From interface com.microstrategy.web.beans.Transformable

From interface com.microstrategy.web.beans.WebComponent

abstract void	addChild(String key, WebComponent child) adds a child WebComponent instance on the current WebComponent.
abstract void	addChildStateInfo(ParameterBuilder paramBldr) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	addChildStateInfo(ParameterBuilder paramBldr, int howMuchState) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	collectData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
abstract void	collectMinimalData() This is similar to `collectData()` except data collected is minimal.
abstract MarkupOutput	generateOutput() This is the generic method to ask the WebComponent to generate some output for the client.
abstract BeanContext	getBeanContext() Returns an instance of `BeanContext`.
abstract WebComponent	getChild(String key) Returns the child WebComponent instance specified by the key.
abstract WebComponent	getChild(int index) Returns the child WebComponent instance specified by the index.
abstract WebComponent	getChildByClass(Class className) Returns the child WebComponent instance specified by the class.
abstract WebComponent	getChildByType(int childType) Returns the child WebComponent instance specified by the component type(`EnumWebTransformableType`).
abstract int	getChildCount() Returns the total number of children on the current WebComponent.
abstract void	getChildrenByClass(Class className, HashList retList, boolean recursive) Returns a collection of children specified by the class name
abstract int	getDefaultStateLevel() Returns the default state level for the WebComponent.
abstract WebFeatures	getFeaturesManager() Return the WebFeatures implementation associated with this WebComponent
abstract int	getMaximumStateLevel() Returns the maximum state level that is supported by the WebComponent.
abstract String	getName() Returns the name of the current WebComponent.
abstract int	getOutputFormat() Returns the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract WebComponent	getParent() Returns the parent WebComponent of the current WebComponent.
abstract String	getPath() Returns the path from the root WebComponent to the current WebComponent.
abstract int	getPersistMode() Returns the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract Set	getRenderingFilter() returns the rendering filter.
abstract WebComponent	getRoot() Returns the root of the current WebComponent.
abstract WebComponent	getTargetBean() Get the target bean associated with this instance
abstract String	getTargetBeanPath()
abstract WebEvent	getWebEvent(int event, boolean recurse) Returns the `WebEvent` instance with the specified event ID.
abstract WebEvent	getWebEvent(int event) Returns the `WebEvent` instance with the specified event ID.
abstract WebEventHandler	getWebEventHandler() Returns the `WebEventHandler` instance associated with the current WebComponent.
abstract int	getXMLStatus() This method returns the `EnumRequestStatus` status of the current Component.
abstract boolean	handleRequest(RequestKeys keys) Handles a request.
abstract boolean	hasChanged() Verifies the state of the component has changed
abstract boolean	hasJustOpened() Verifies if the component has just been opened.
abstract void	initBean() Initialize the component after it's created and its properties initialized
abstract void	invalidateChildrenState() Invalidates the cached URL and hidden INPUT states of all the components, including the current component, along the path to the root component.
abstract boolean	isBeanContextEmpty() Verifies if a bean context exists for the current WebComponent.
abstract boolean	isFeatureAvailable(String featureID) Verifies the feature provided is accesible based on the properties of this WebComponent
abstract void	prepareForReuse() If a Web Component instance is going to be reused across different requests, this API serves as a notifier to the component to do the necessary cleanup.
abstract WebComponent	removeChild(String key) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	removeChild(WebComponent component) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	searchChild(String key) Returns the child WebComponent instance specified by the key.
abstract void	setBeanContext(BeanContext beanContext, boolean propagate) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setBeanContext(BeanContext beanContext) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setChanged(boolean value) Sets the changed state of the component.
abstract void	setChanged(boolean value, boolean forceRecurse) Sets the changed state of the component
abstract void	setDefaultStateLevel(int stateLevel) Sets the default state level for the WebComponent.
abstract void	setFeaturesManager(WebFeatures featuresManager) Associate a WebFeatures implementation with this WebComponent
abstract void	setName(String name) Sets the name on the current WebComponent.
abstract void	setOutputFormat(int outputFormat) Sets the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract void	setParent(WebComponent parent) Sets the parent WebComponent of the current WebComponent.
abstract void	setPersistMode(int persistFlag) Sets the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract void	setRenderingFilter(Set renderingFilter) Sets the list of beans to render.
abstract void	setTargetBean(WebComponent bean) Set the target bean that will be associated with this instance.
abstract void	setTargetBeanPath(String beanName) Define the base bean for this instance.
abstract void	setWebEventHandler(WebEventHandler handler) Sets a `WebEventHandler` on this component.

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.

Interfaces

Classes

AdminBean

Class Overview

Summary

Constants

public static final String USHER_TOKEN_STR

Public Methods

public abstract void afterSave (Map pValues, PreferencesException ex)

Parameters

public abstract void createAdminServersFile (AdminServersList _adminServerList)

Parameters

public abstract AdminServersList getAdminServersList ()

Returns

public abstract WebClusterAdmin getClusterAdmin ()

public abstract Enumeration getClusters ()

Returns

Throws

public abstract boolean getConnectedServer ()

Returns

public abstract boolean getDisConnectedServer ()

Returns

public abstract boolean getNewServer ()

Returns

public abstract WebException getServerError ()

public abstract String getServerErrorMessge ()

public abstract String getServerName ()

Returns

public abstract Map<Integer, String> getServerSettings ()

public abstract boolean getShowConnectedServers ()

Returns

public abstract boolean getShowDefaultProperties ()

Returns

public abstract boolean getShowSSOTrustCreation ()

public abstract boolean getShowServerProperties ()

Returns

public abstract boolean getShowUnConnectedServers ()

Returns

public abstract boolean getShowUsherConfig ()

public abstract String getStyle ()

Returns

public abstract File getTokenFile ()

Returns

public abstract WebException getTrustCreationError ()

public abstract boolean hasValidationErrors ()

Returns

public abstract boolean isTokenExists ()

Returns

public abstract boolean isValidPreference (String name)

Parameters

Returns

public abstract AdminServersList loadAdminServersFile ()

Returns

public abstract void setConnectedServer (boolean value)

Parameters

public abstract void setDisConnectedServer (boolean value)

Parameters

public abstract void setNewServer (boolean value)

Parameters

public abstract void setServerError (WebException exception)

public abstract void setServerName (String value)

Parameters

public abstract void setShowConnectedServers (boolean value)

Parameters

public abstract void setShowDefaultProperties (boolean value)

Parameters

public abstract void setShowSSOTrustCreation (boolean show)

public abstract void setShowServerProperties (boolean value)

Parameters

public abstract void setShowUnConnectedServers (boolean value)

Parameters

public abstract void setShowUsherConfig (boolean value)

public abstract void setStyle (String newValue)

Parameters

public abstract void setTrustCreationError (WebException exception)