public final class

AdminServersHelper

extends Object
java.lang.Object
   ↳ com.microstrategy.web.admin.beans.AdminServersHelper

Class Overview

AdminServersHelper Provides utility functions used in connecting/disconnecting admin servers

Summary

Constants
String AUTO_START_MODE
String DEFAULT_START_MODE
String MANUAL_START_MODE
int MIN_ISERVER_MAJOR_VERSION Denotes the complete minimal iServer's major version supported by this application:
int MIN_ISERVER_MINOR_VERSION Denotes the complete minimal iServer's major version supported by this application:
String MIN_ISERVER_VERSION Denotes the complete minimal iServer's version supported by this application:
String PROPERTY_ALLOW_ADMIN_APPLY_ALL_PROJECTS
String PROPERTY_ALLOW_AUTOCOMPLETE
String PROPERTY_ALLOW_CHANGE_PASSWORD
String PROPERTY_ALLOW_HTML_ON_METRIC_VALUES
String PROPERTY_ALLOW_HTML_ON_NO_DATA_RETURNED_DESC
String PROPERTY_ALLOW_HTML_ON_OBJECT_DESC
String PROPERTY_ALLOW_HTML_ON_PRINT_HEADER
String PROPERTY_ALLOW_HTML_ON_PROJECT_DESC
String PROPERTY_ALLOW_HTML_ON_PROMPT_DESC
String PROPERTY_ALLOW_JS_ON_RS_HYPERLINKS
String PROPERTY_ALLOW_LEGACY_ISERVERS
String PROPERTY_ALLOW_LOGIN_BY_URL Property to control whether bypass the uid/pwd in URL or not
String PROPERTY_ALLOW_SEAMLESS_LOGIN
String PROPERTY_APPEND_LOCALE_PATH
String PROPERTY_AUTO_EXPAND_HIERARCHY_PREORION_BEHAVIOR Determines whether aunto expand hierarchy in prompt should use orion behavior or should compatible with 8.0 behavior
String PROPERTY_BUSY_TIMEOUT
String PROPERTY_CONNECTION_FAILURE_TOLERANCE
String PROPERTY_CONNECTION_USE_FLASH_PROFILER whether to Profile Analysis and Documents in Flash Mode.
String PROPERTY_CONNECTMODE
String PROPERTY_CREATE_NEW_SESSION Property to control whether need create new http session or not when login
String PROPERTY_CUSTOMIZATION_MODE
String PROPERTY_CUSTOM_ERROR_MESSAGE Determines the custom error message which needs to be displayed on error
String PROPERTY_CUSTOM_ERROR_MESSAGE_DESC_ID Determines the error message which needs to be displayed on error.
String PROPERTY_DEFAULT_LOGIN_MODE
String PROPERTY_DEFAULT_WEB_LOGIN_MODE
String PROPERTY_DIAGNOSTIC_FILE_LOCATION
String PROPERTY_DIAGNOSTIC_TYPE
String PROPERTY_DISABLE_ONDEMAND_DRILLING Property to disable ondemand drilling.
String PROPERTY_ENABLED_LOGIN_MODE
String PROPERTY_ENABLED_WEB_LOGIN_MODE
String PROPERTY_ENABLE_FACEBOOK_LOGIN
String PROPERTY_ENABLE_FENCING
String PROPERTY_ENABLE_FRAME_BREAKING
String PROPERTY_ENABLE_HTTP_PROXY
String PROPERTY_ENABLE_PROXY
String PROPERTY_ENCODE_EXPORT_RESULTS
String PROPERTY_ENCODE_TOOLTIPS
String PROPERTY_EXCLUDE_TIMESTAMP_IN_ERROR
String PROPERTY_FORCE_CONTENT_TYPE_VALIDATION
String PROPERTY_FORCE_PARAMETER_VALIDATION
String PROPERTY_HELP_LOCATION Property to indicate whether the help system entry point should be local or a URL
String PROPERTY_HELP_URL Property to indicate the url of the help system when help location is not local
String PROPERTY_HTTP_PROXY_PORT
String PROPERTY_HTTP_PROXY_SERVER_ADDRESS
String PROPERTY_IDENTITY_TOKEN_SECRET_KEY
String PROPERTY_IFRAME
String PROPERTY_INCLUDE_SESSION_URL
String PROPERTY_INCLUDE_TIMESTAMP Determines whether to show time stamp in the I server error message
String PROPERTY_INCLUDE_TIMESTAMP_IN_ERROR
String PROPERTY_INI_POOL
String PROPERTY_KEEP_ALIVE
String PROPERTY_LOAD_BALANCE_FACTOR
String PROPERTY_MAX_MESSAGES_IDS_IN_COOKIE
String PROPERTY_MAX_POOL
String PROPERTY_OFFICE_LOCATION
String PROPERTY_OVERRIDE_CSRF_CHECK_FAIL Used to allow users to authorize a request when the random token check fails
String PROPERTY_OVERRIDE_ISEREVER_ERRORS
String PROPERTY_OVERRIDE_ISERVER_ERROR_MESSAGE Determines if the preference is set to override the message generated by Iserver
String PROPERTY_PORT
String PROPERTY_PREVENT_BROWSER_CACHING
String PROPERTY_PROJECT_LIST_LOGIN_REQUIRED
String PROPERTY_PROJECT_SORTING
String PROPERTY_RECORD_LOGGING_LEVEL
String PROPERTY_RENDER_EXCEPTION_INFO
String PROPERTY_RENDER_REQUEST_INFO
String PROPERTY_REQUEST_TIMEOUT
String PROPERTY_SALESFORCE_CLIENT_ID
String PROPERTY_SALESFORCE_CLIENT_SECRET
String PROPERTY_SALESFORCE_REDIRECT_URL
String PROPERTY_SAVE_TEMP_SETTINGS_IN_COOKIES
String PROPERTY_SERVER_SORTING
String PROPERTY_SHOW_ABOUT_PAGE_INFO This constant is deprecated. In MicroStrategy Web 11.0 The support for this preference no longer exists
String PROPERTY_SHOW_BACKWARDS_COMPATIBILITY_SWITCH_IN_PROMPT_EDITOR
String PROPERTY_SHOW_FILTER_ON_SELECTIONS_CHECKS Property to enable check boxes on filter on selections
String PROPERTY_SHOW_LOGIN_PAGE_AFTER_LOGOUT
String PROPERTY_SHOW_OFFICE_LINK
String PROPERTY_SSL_VALIDATE
String PROPERTY_STATISTICS_ADVANCED_LOGGER
String PROPERTY_STATISTICS_FILE
String PROPERTY_STATISTICS_MODE
String PROPERTY_STATISTICS_USER
String PROPERTY_TRUSTED_AUTH_PROVIDER
String PROPERTY_USER_HELP_PAGE
String PROPERTY_USE_COOKIES
String PROPERTY_USE_DEPRECATED_FEATURES
String PROPERTY_USE_ENCRYPTION
String PROPERTY_USE_IE_EDGE_MODE
String PROPERTY_USE_OIVM Property to control whether use optimized-interactive-view-mode or not
String PROPERTY_USE_SESSION_COOKIE
String PROPERTY_VALUE_DENY
int PROPERTY_VALUE_DISABLE_COOKIES This constant is deprecated. cookieless mode is not secure and should not be used.
int PROPERTY_VALUE_FIXED_COOKIES
String PROPERTY_VALUE_LOCATION_LOCAL
String PROPERTY_VALUE_LOCATION_REMOTE
String PROPERTY_VALUE_NO
String PROPERTY_VALUE_SAMEORIGIN
String PROPERTY_VALUE_SORTING_DEFAULT
String PROPERTY_VALUE_SORTING_DESCRIPTION
String PROPERTY_VALUE_SORTING_NAME
String PROPERTY_VALUE_SORTING_NONE
String PROPERTY_VALUE_STATISTICS_ADVANCED_LOGGER_DISABLED
String PROPERTY_VALUE_STATISTICS_ADVANCED_LOGGER_OTHER
String PROPERTY_VALUE_STATISTICS_ADVANCED_LOGGER_SESSION
String PROPERTY_VALUE_STATISTICS_ADVANCED_LOGGER_XMLAPI
int PROPERTY_VALUE_TEMP_COOKIES This constant is deprecated. this choice is deprecated. Always use permanent cookies for permanent settings in cookie mode.
String PROPERTY_VALUE_YES
String PROPERTY_VIEW_LOGGING_LEVEL
String PROPERTY_X_FRAME_OPTIONS
Public Methods
static void checkIServerName(String name)
Checks if the version of an iServer can be used with the current version of Web.
static void checkIServerVersion(WebIServerSession session)
static void checkIServerVersion(String name, int port)
Checks if the version of an iServer can be used with the current version of Web.
static void connectIServers(AppContext context)
This method will go through all the Intelligent Servers present on the web server and will automatically connect to all those servers which are set to be in AUTO connect mode.
static void connectIServers(AdminServersList adminServersList)
This method will go through all the Intelligent Servers present on the web server and will automatically connect to all those servers which are set to be in AUTO connect mode.
static void ensureServersAreConnected()
static HashList<String, String> getApplyOptions(String serverName, String projectName, AbstractAppTransform transform)
Convenience method that returns the options use by the preferences transforms to indicate whether the changes will apply to the current project, or to all the projects in the current Intelligent Server.
static AdminServersHelper getInstance()
static String getRequestServerName(AppContext app)
Retrieves the name of the web server which hosts this application.
static String[][] getUserPrefApplyOptions(String serverName, String projectName, AbstractAppTransform transform)
void scheduleIServerConnect(String pollingFrequency, Document serverList)
This method is deprecated. replaced by scheduleIServerConnect(String, AppContext)
void scheduleIServerConnect(String pollingFrequency, AppContext context)
This method will schedule a task which will automatically look for the Intelligent servers present on this web server, and if they are in AUTO mode, it will connect to those Intelligent servers.
static void setIServerConnectionFailureTolerance(String tolerance)
static void setIServerProperties(String serverName)
Set the values for some Intelligent server properties like max pool size, keep alive connection and load balacne factor.
static void setIServerTimeouts(String requestTimeOut, String serverBusyTimeOut)
Set the Intelligent server timeouts on the webapi instance.
void updateConnectedServersList(AdminServersList adminServersList)
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String AUTO_START_MODE

Constant Value: "auto"

public static final String DEFAULT_START_MODE

Constant Value: "manual"

public static final String MANUAL_START_MODE

Constant Value: "manual"

public static final int MIN_ISERVER_MAJOR_VERSION

Denotes the complete minimal iServer's major version supported by this application:

Constant Value: 10 (0x0000000a)

public static final int MIN_ISERVER_MINOR_VERSION

Denotes the complete minimal iServer's major version supported by this application:

Constant Value: 11 (0x0000000b)

public static final String MIN_ISERVER_VERSION

Denotes the complete minimal iServer's version supported by this application:

Constant Value: "10.11.0000.0000"

public static final String PROPERTY_ALLOW_ADMIN_APPLY_ALL_PROJECTS

Constant Value: "allowAdminApplyAllProjects"

public static final String PROPERTY_ALLOW_AUTOCOMPLETE

Constant Value: "autocomplete"

public static final String PROPERTY_ALLOW_CHANGE_PASSWORD

Constant Value: "changePwd"

public static final String PROPERTY_ALLOW_HTML_ON_METRIC_VALUES

Constant Value: "allowHTMLOnMetricValues"

public static final String PROPERTY_ALLOW_HTML_ON_NO_DATA_RETURNED_DESC

Constant Value: "allowHTMLOnNoDataReturnedDesc"

public static final String PROPERTY_ALLOW_HTML_ON_OBJECT_DESC

Constant Value: "allowHTMLOnObjectDesc"

public static final String PROPERTY_ALLOW_HTML_ON_PRINT_HEADER

Constant Value: "allowHTMLOnPrintHeaders"

public static final String PROPERTY_ALLOW_HTML_ON_PROJECT_DESC

Constant Value: "allowHTMLOnProjectDesc"

public static final String PROPERTY_ALLOW_HTML_ON_PROMPT_DESC

Constant Value: "allowHTMLOnPromptDesc"

public static final String PROPERTY_ALLOW_JS_ON_RS_HYPERLINKS

Constant Value: "allowRSDHyperlinkJavaScript"

public static final String PROPERTY_ALLOW_LEGACY_ISERVERS

Constant Value: "allowLegacyIServers"

public static final String PROPERTY_ALLOW_LOGIN_BY_URL

Property to control whether bypass the uid/pwd in URL or not

Constant Value: "allowLoginByUrl"

public static final String PROPERTY_ALLOW_SEAMLESS_LOGIN

Constant Value: "allowSeamlessLogin"

public static final String PROPERTY_APPEND_LOCALE_PATH

Constant Value: "appendLocalePath"

public static final String PROPERTY_AUTO_EXPAND_HIERARCHY_PREORION_BEHAVIOR

Determines whether aunto expand hierarchy in prompt should use orion behavior or should compatible with 8.0 behavior

Constant Value: "autoExpandHierarchyPreOrionBehavior"

public static final String PROPERTY_BUSY_TIMEOUT

Constant Value: "serverBusyTimeOut"

public static final String PROPERTY_CONNECTION_FAILURE_TOLERANCE

Constant Value: "initConnectionPoolFailureTolerance"

public static final String PROPERTY_CONNECTION_USE_FLASH_PROFILER

whether to Profile Analysis and Documents in Flash Mode. Used for debugging.

Constant Value: "profileFlashDocs"

public static final String PROPERTY_CONNECTMODE

Constant Value: "connectmode"

public static final String PROPERTY_CREATE_NEW_SESSION

Property to control whether need create new http session or not when login

Constant Value: "createNewSession"

public static final String PROPERTY_CUSTOMIZATION_MODE

Constant Value: "customizationMode"

public static final String PROPERTY_CUSTOM_ERROR_MESSAGE

Determines the custom error message which needs to be displayed on error

Constant Value: "customErrorMessage"

public static final String PROPERTY_CUSTOM_ERROR_MESSAGE_DESC_ID

Determines the error message which needs to be displayed on error. Currently, the code corresponds to descriptor "A server error was encountered. Please contact your system administrator."

Constant Value: "customErrorMessageDescriptorId"

public static final String PROPERTY_DEFAULT_LOGIN_MODE

Constant Value: "defaultloginmode"

public static final String PROPERTY_DEFAULT_WEB_LOGIN_MODE

Constant Value: "defaultwebloginmode"

public static final String PROPERTY_DIAGNOSTIC_FILE_LOCATION

Constant Value: "diagnosticFileLocation"

public static final String PROPERTY_DIAGNOSTIC_TYPE

Constant Value: "diagnosticType"

public static final String PROPERTY_DISABLE_ONDEMAND_DRILLING

Property to disable ondemand drilling.

Constant Value: "disableOndemandDrilling"

public static final String PROPERTY_ENABLED_LOGIN_MODE

Constant Value: "enabledloginmode"

public static final String PROPERTY_ENABLED_WEB_LOGIN_MODE

Constant Value: "enabledwebloginmode"

public static final String PROPERTY_ENABLE_FACEBOOK_LOGIN

Constant Value: "enableFacebookLogin"

public static final String PROPERTY_ENABLE_FENCING

Constant Value: "enableFencing"

public static final String PROPERTY_ENABLE_FRAME_BREAKING

Constant Value: "enableFrameBreaking"

public static final String PROPERTY_ENABLE_HTTP_PROXY

Constant Value: "enableHttpProxy"

public static final String PROPERTY_ENABLE_PROXY

Constant Value: "enableProxy"

public static final String PROPERTY_ENCODE_EXPORT_RESULTS

Constant Value: "encodeExportResults"

public static final String PROPERTY_ENCODE_TOOLTIPS

Constant Value: "encodeTooltips"

public static final String PROPERTY_EXCLUDE_TIMESTAMP_IN_ERROR

Constant Value: "0"

public static final String PROPERTY_FORCE_CONTENT_TYPE_VALIDATION

Constant Value: "forceContentTypeValidation"

public static final String PROPERTY_FORCE_PARAMETER_VALIDATION

Constant Value: "forceParameterValidation"

public static final String PROPERTY_HELP_LOCATION

Property to indicate whether the help system entry point should be local or a URL

Constant Value: "helpLocation"

public static final String PROPERTY_HELP_URL

Property to indicate the url of the help system when help location is not local

Constant Value: "helpUrl"

public static final String PROPERTY_HTTP_PROXY_PORT

Constant Value: "httpProxyServerPort"

public static final String PROPERTY_HTTP_PROXY_SERVER_ADDRESS

Constant Value: "httpProxyServerAddress"

public static final String PROPERTY_IDENTITY_TOKEN_SECRET_KEY

Constant Value: "identityTokenSecretKey"

public static final String PROPERTY_IFRAME

Constant Value: "iframe"

public static final String PROPERTY_INCLUDE_SESSION_URL

Constant Value: "includeSessionUrl"

public static final String PROPERTY_INCLUDE_TIMESTAMP

Determines whether to show time stamp in the I server error message

Constant Value: "includeTimeStamp"

public static final String PROPERTY_INCLUDE_TIMESTAMP_IN_ERROR

Constant Value: "1"

public static final String PROPERTY_INI_POOL

Constant Value: "ini_pool"

public static final String PROPERTY_KEEP_ALIVE

Constant Value: "keep_alive"

public static final String PROPERTY_LOAD_BALANCE_FACTOR

Constant Value: "load_balance_factor"

public static final String PROPERTY_MAX_MESSAGES_IDS_IN_COOKIE

Constant Value: "MaxMessageIdsInCookie"

public static final String PROPERTY_MAX_POOL

Constant Value: "max_pool"

public static final String PROPERTY_OFFICE_LOCATION

Constant Value: "officeLocation"

public static final String PROPERTY_OVERRIDE_CSRF_CHECK_FAIL

Used to allow users to authorize a request when the random token check fails

Constant Value: "allowRandNumUserOverride"

public static final String PROPERTY_OVERRIDE_ISEREVER_ERRORS

Constant Value: "1"

public static final String PROPERTY_OVERRIDE_ISERVER_ERROR_MESSAGE

Determines if the preference is set to override the message generated by Iserver

Constant Value: "overrideIServerErrorMessage"

public static final String PROPERTY_PORT

Constant Value: "port"

public static final String PROPERTY_PREVENT_BROWSER_CACHING

Constant Value: "preventBrowserCaching"

public static final String PROPERTY_PROJECT_LIST_LOGIN_REQUIRED

Constant Value: "loginFirst"

public static final String PROPERTY_PROJECT_SORTING

Constant Value: "projectSorting"

public static final String PROPERTY_RECORD_LOGGING_LEVEL

Constant Value: "recordDiagnosticLevel"

public static final String PROPERTY_RENDER_EXCEPTION_INFO

Constant Value: "renderExceptionInfo"

public static final String PROPERTY_RENDER_REQUEST_INFO

Constant Value: "renderRequestInfo"

public static final String PROPERTY_REQUEST_TIMEOUT

Constant Value: "requestTimeOut"

public static final String PROPERTY_SALESFORCE_CLIENT_ID

Constant Value: "sfClientID"

public static final String PROPERTY_SALESFORCE_CLIENT_SECRET

Constant Value: "sfClientSecret"

public static final String PROPERTY_SALESFORCE_REDIRECT_URL

Constant Value: "sfRedirectURL"

public static final String PROPERTY_SAVE_TEMP_SETTINGS_IN_COOKIES

Constant Value: "saveTempSettingsInCookies"

public static final String PROPERTY_SERVER_SORTING

Constant Value: "serverSorting"

public static final String PROPERTY_SHOW_ABOUT_PAGE_INFO

This constant is deprecated.
In MicroStrategy Web 11.0 The support for this preference no longer exists

Constant Value: "showAboutPageInfo"

public static final String PROPERTY_SHOW_BACKWARDS_COMPATIBILITY_SWITCH_IN_PROMPT_EDITOR

Constant Value: "showBackwardsCompatibilitySwitch"

public static final String PROPERTY_SHOW_FILTER_ON_SELECTIONS_CHECKS

Property to enable check boxes on filter on selections

Constant Value: "showFilterOnSelectionCheckBox"

public static final String PROPERTY_SHOW_LOGIN_PAGE_AFTER_LOGOUT

Constant Value: "showLoginPageAfterLogout"

public static final String PROPERTY_SHOW_OFFICE_LINK

Constant Value: "showOfficeLink"

public static final String PROPERTY_SSL_VALIDATE

Constant Value: "sslValidate"

public static final String PROPERTY_STATISTICS_ADVANCED_LOGGER

Constant Value: "advLogger"

public static final String PROPERTY_STATISTICS_FILE

Constant Value: "statisticsFile"

public static final String PROPERTY_STATISTICS_MODE

Constant Value: "statisticsMode"

public static final String PROPERTY_STATISTICS_USER

Constant Value: "statisticsUser"

public static final String PROPERTY_TRUSTED_AUTH_PROVIDER

Constant Value: "trustedAuthProvider"

public static final String PROPERTY_USER_HELP_PAGE

Constant Value: "userHelpPage"

public static final String PROPERTY_USE_COOKIES

Constant Value: "useCookies"

public static final String PROPERTY_USE_DEPRECATED_FEATURES

Constant Value: "useDeprecatedFeatures"

public static final String PROPERTY_USE_ENCRYPTION

Constant Value: "useEncryption"

public static final String PROPERTY_USE_IE_EDGE_MODE

Constant Value: "useIEEdgeMode"

public static final String PROPERTY_USE_OIVM

Property to control whether use optimized-interactive-view-mode or not

Constant Value: "useOivm"

public static final String PROPERTY_USE_SESSION_COOKIE

Constant Value: "useSessionCookie"

public static final String PROPERTY_VALUE_DENY

Constant Value: "1"

public static final int PROPERTY_VALUE_DISABLE_COOKIES

This constant is deprecated.
cookieless mode is not secure and should not be used.

Constant Value: 1 (0x00000001)

public static final int PROPERTY_VALUE_FIXED_COOKIES

Constant Value: 4 (0x00000004)

public static final String PROPERTY_VALUE_LOCATION_LOCAL

Constant Value: "0"

public static final String PROPERTY_VALUE_LOCATION_REMOTE

Constant Value: "1"

public static final String PROPERTY_VALUE_NO

Constant Value: "0"

public static final String PROPERTY_VALUE_SAMEORIGIN

Constant Value: "2"

public static final String PROPERTY_VALUE_SORTING_DEFAULT

Constant Value: "1"

public static final String PROPERTY_VALUE_SORTING_DESCRIPTION

Constant Value: "3"

public static final String PROPERTY_VALUE_SORTING_NAME

Constant Value: "2"

public static final String PROPERTY_VALUE_SORTING_NONE

Constant Value: "0"

public static final String PROPERTY_VALUE_STATISTICS_ADVANCED_LOGGER_DISABLED

Constant Value: "0"

public static final String PROPERTY_VALUE_STATISTICS_ADVANCED_LOGGER_OTHER

Constant Value: "2"

public static final String PROPERTY_VALUE_STATISTICS_ADVANCED_LOGGER_SESSION

Constant Value: "3"

public static final String PROPERTY_VALUE_STATISTICS_ADVANCED_LOGGER_XMLAPI

Constant Value: "1"

public static final int PROPERTY_VALUE_TEMP_COOKIES

This constant is deprecated.
this choice is deprecated. Always use permanent cookies for permanent settings in cookie mode.

Constant Value: 2 (0x00000002)

public static final String PROPERTY_VALUE_YES

Constant Value: "1"

public static final String PROPERTY_VIEW_LOGGING_LEVEL

Constant Value: "viewDiagnosticLevel"

public static final String PROPERTY_X_FRAME_OPTIONS

Constant Value: "xFrameOptions"

Public Methods

public static void checkIServerName (String name)

Checks if the version of an iServer can be used with the current version of Web. In case it won't, it throws an WebAppException. This versin requires an iServer version 8 or higher.

Parameters
name server's name
Throws
WebAppException
WebAppException

public static void checkIServerVersion (WebIServerSession session)

Throws
WebAppException
WebObjectsException

public static void checkIServerVersion (String name, int port)

Checks if the version of an iServer can be used with the current version of Web. In case it won't, it throws an WebAppException. This version requires an iServer version 8 or higher.

Parameters
name server's name
port server's port
Throws
WebAppException
WebObjectsException
WebAppException
WebObjectsException

public static void connectIServers (AppContext context)

This method will go through all the Intelligent Servers present on the web server and will automatically connect to all those servers which are set to be in AUTO connect mode.

Parameters
context The list of all the Intelligent Servers present on the web server are obtained via the AppContext.

public static void connectIServers (AdminServersList adminServersList)

This method will go through all the Intelligent Servers present on the web server and will automatically connect to all those servers which are set to be in AUTO connect mode.

Parameters
adminServersList The list of all the Intelligent Servers present on the web server.

public static void ensureServersAreConnected ()

public static HashList<String, String> getApplyOptions (String serverName, String projectName, AbstractAppTransform transform)

Convenience method that returns the options use by the preferences transforms to indicate whether the changes will apply to the current project, or to all the projects in the current Intelligent Server.

Parameters
serverName The name of the Intelligent Server
projectName The name of the MicroStrategy project
transform A Transform reference to gain access to localized strings
Returns
  • HashList

public static AdminServersHelper getInstance ()

public static String getRequestServerName (AppContext app)

Retrieves the name of the web server which hosts this application. The name is retrived from the servlet request object.

Parameters
app The application context for this application.
Returns
  • the name of the web server hosting the application.

public static String[][] getUserPrefApplyOptions (String serverName, String projectName, AbstractAppTransform transform)

public void scheduleIServerConnect (String pollingFrequency, Document serverList)

This method is deprecated.
replaced by scheduleIServerConnect(String, AppContext)

This method will schedule a task which will automatically look for the Intelligent servers present on this web server, and if they are in AUTO mode, it will connect to those Intelligent servers. This task will keep recurring after a fixed interval of time.

Parameters
pollingFrequency The frequency at which the task will look for all the AUTO mode Intelligent servers. This value is specified in milli seconds.
serverList The list of all the Intelligent servers present on this web server is obtained from the AppContext.

public void scheduleIServerConnect (String pollingFrequency, AppContext context)

This method will schedule a task which will automatically look for the Intelligent servers present on this web server, and if they are in AUTO mode, it will connect to those Intelligent servers. This task will keep recurring after a fixed interval of time.

Parameters
pollingFrequency The frequency at which the task will look for all the AUTO mode Intelligent servers. This value is specified in milli seconds.
context The list of all the Intelligent servers present on this web server is obtained from the AppContext.

public static void setIServerConnectionFailureTolerance (String tolerance)

public static void setIServerProperties (String serverName)

Set the values for some Intelligent server properties like max pool size, keep alive connection and load balacne factor. These values are set on the Intelligent server connection and are read from the preferences for that Intelligent server.

Parameters
serverName The Intelligent server on which we are supposed to set the properties.

public static void setIServerTimeouts (String requestTimeOut, String serverBusyTimeOut)

Set the Intelligent server timeouts on the webapi instance. This includes the request time out and the server busy time out.

Parameters
requestTimeOut The request time out
serverBusyTimeOut The server busy time out.

public void updateConnectedServersList (AdminServersList adminServersList)