Package com.microstrategy.web.admin.beans

Class AdminServersHelper

  • public final class AdminServersHelper
extends java.lang.Object
    AdminServersHelper Provides utility functions used in connecting/disconnecting admin servers
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Field Detail

      • MANUAL_START_MODE

        public static final java.lang.String MANUAL_START_MODE
        See Also:
        Constant Field Values

      • DEFAULT_START_MODE

        public static final java.lang.String DEFAULT_START_MODE
        See Also:
        Constant Field Values

      • MIN_ISERVER_VERSION

        public static final java.lang.String MIN_ISERVER_VERSION
        Denotes the complete minimal iServer's version supported by this application:
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • PROPERTY_CONNECTMODE

        public static final java.lang.String PROPERTY_CONNECTMODE
        See Also:
        Constant Field Values

      • PROPERTY_INI_POOL

        public static final java.lang.String PROPERTY_INI_POOL
        See Also:
        Constant Field Values

      • PROPERTY_KEEP_ALIVE

        public static final java.lang.String PROPERTY_KEEP_ALIVE
        See Also:
        Constant Field Values

      • PROPERTY_LOAD_BALANCE_FACTOR

        public static final java.lang.String PROPERTY_LOAD_BALANCE_FACTOR
        See Also:
        Constant Field Values

      • PROPERTY_MAX_POOL

        public static final java.lang.String PROPERTY_MAX_POOL
        See Also:
        Constant Field Values

      • PROPERTY_REQUEST_TIMEOUT

        public static final java.lang.String PROPERTY_REQUEST_TIMEOUT
        See Also:
        Constant Field Values

      • PROPERTY_BUSY_TIMEOUT

        public static final java.lang.String PROPERTY_BUSY_TIMEOUT
        See Also:
        Constant Field Values

      • PROPERTY_DEFAULT_LOGIN_MODE

        public static final java.lang.String PROPERTY_DEFAULT_LOGIN_MODE
        See Also:
        Constant Field Values

      • PROPERTY_DEFAULT_WEB_LOGIN_MODE

        public static final java.lang.String PROPERTY_DEFAULT_WEB_LOGIN_MODE
        See Also:
        Constant Field Values

      • PROPERTY_ENABLED_LOGIN_MODE

        public static final java.lang.String PROPERTY_ENABLED_LOGIN_MODE
        See Also:
        Constant Field Values

      • PROPERTY_ENABLED_WEB_LOGIN_MODE

        public static final java.lang.String PROPERTY_ENABLED_WEB_LOGIN_MODE
        See Also:
        Constant Field Values

      • PROPERTY_PROJECT_LIST_LOGIN_REQUIRED

        public static final java.lang.String PROPERTY_PROJECT_LIST_LOGIN_REQUIRED
        See Also:
        Constant Field Values

      • PROPERTY_USE_ENCRYPTION

        public static final java.lang.String PROPERTY_USE_ENCRYPTION
        See Also:
        Constant Field Values

      • PROPERTY_SSL_VALIDATE

        public static final java.lang.String PROPERTY_SSL_VALIDATE
        See Also:
        Constant Field Values

      • PROPERTY_CUSTOMIZATION_MODE

        public static final java.lang.String PROPERTY_CUSTOMIZATION_MODE
        See Also:
        Constant Field Values

      • PROPERTY_CONNECTION_FAILURE_TOLERANCE

        public static final java.lang.String PROPERTY_CONNECTION_FAILURE_TOLERANCE
        See Also:
        Constant Field Values

      • PROPERTY_MINIMUM_ISERVER_VERSION

        public static final java.lang.String PROPERTY_MINIMUM_ISERVER_VERSION
        See Also:
        Constant Field Values

      • PROPERTY_SHOW_LOGIN_PAGE_AFTER_LOGOUT

        public static final java.lang.String PROPERTY_SHOW_LOGIN_PAGE_AFTER_LOGOUT
        Since:
        MicroStrategy Web 8.0.2
        See Also:
        Constant Field Values

      • PROPERTY_TRUSTED_AUTH_PROVIDER

        public static final java.lang.String PROPERTY_TRUSTED_AUTH_PROVIDER
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • PROPERTY_OFFICE_LOCATION

        public static final java.lang.String PROPERTY_OFFICE_LOCATION
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • PROPERTY_APPEND_LOCALE_PATH

        public static final java.lang.String PROPERTY_APPEND_LOCALE_PATH
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • PROPERTY_SHOW_OFFICE_LINK

        public static final java.lang.String PROPERTY_SHOW_OFFICE_LINK
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • PROPERTY_USE_IE_EDGE_MODE

        public static final java.lang.String PROPERTY_USE_IE_EDGE_MODE
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • PROPERTY_PREVENT_BROWSER_CACHING

        public static final java.lang.String PROPERTY_PREVENT_BROWSER_CACHING
        See Also:
        Constant Field Values

      • PROPERTY_USE_COOKIES

        public static final java.lang.String PROPERTY_USE_COOKIES
        See Also:
        Constant Field Values

      • PROPERTY_ALLOW_HTML_ON_PRINT_HEADER

        public static final java.lang.String PROPERTY_ALLOW_HTML_ON_PRINT_HEADER
        See Also:
        Constant Field Values

      • PROPERTY_ALLOW_HTML_ON_OBJECT_DESC

        public static final java.lang.String PROPERTY_ALLOW_HTML_ON_OBJECT_DESC
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values

      • PROPERTY_ALLOW_HTML_ON_METRIC_VALUES

        public static final java.lang.String PROPERTY_ALLOW_HTML_ON_METRIC_VALUES
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • PROPERTY_ALLOW_HTML_ON_PROJECT_DESC

        public static final java.lang.String PROPERTY_ALLOW_HTML_ON_PROJECT_DESC
        Since:
        MicroStrategy Web 8.0.1
        See Also:
        Constant Field Values

      • PROPERTY_ALLOW_JS_ON_RS_HYPERLINKS

        public static final java.lang.String PROPERTY_ALLOW_JS_ON_RS_HYPERLINKS
        Since:
        MicroStrategy Web 8.1.0
        See Also:
        Constant Field Values

      • PROPERTY_ALLOW_HTML_ON_PROMPT_DESC

        public static final java.lang.String PROPERTY_ALLOW_HTML_ON_PROMPT_DESC
        Since:
        MicroStrategy Web 8.0.1
        See Also:
        Constant Field Values

      • PROPERTY_ENCODE_EXPORT_RESULTS

        public static final java.lang.String PROPERTY_ENCODE_EXPORT_RESULTS
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • PROPERTY_USE_SESSION_COOKIE

        public static final java.lang.String PROPERTY_USE_SESSION_COOKIE
        See Also:
        Constant Field Values

      • PROPERTY_INCLUDE_SESSION_URL

        public static final java.lang.String PROPERTY_INCLUDE_SESSION_URL
        See Also:
        Constant Field Values

      • PROPERTY_ALLOW_SEAMLESS_LOGIN

        public static final java.lang.String PROPERTY_ALLOW_SEAMLESS_LOGIN
        See Also:
        Constant Field Values

      • PROPERTY_DIAGNOSTIC_TYPE

        public static final java.lang.String PROPERTY_DIAGNOSTIC_TYPE
        See Also:
        Constant Field Values

      • PROPERTY_DIAGNOSTIC_FILE_LOCATION

        public static final java.lang.String PROPERTY_DIAGNOSTIC_FILE_LOCATION
        See Also:
        Constant Field Values

      • PROPERTY_ALLOW_CHANGE_P

        public static final java.lang.String PROPERTY_ALLOW_CHANGE_P
        See Also:
        Constant Field Values

      • PROPERTY_RECORD_LOGGING_LEVEL

        public static final java.lang.String PROPERTY_RECORD_LOGGING_LEVEL
        See Also:
        Constant Field Values

      • PROPERTY_VIEW_LOGGING_LEVEL

        public static final java.lang.String PROPERTY_VIEW_LOGGING_LEVEL
        See Also:
        Constant Field Values

      • PROPERTY_STATISTICS_MODE

        public static final java.lang.String PROPERTY_STATISTICS_MODE
        See Also:
        Constant Field Values

      • PROPERTY_STATISTICS_FILE

        public static final java.lang.String PROPERTY_STATISTICS_FILE
        See Also:
        Constant Field Values

      • PROPERTY_ENCODE_TOOLTIPS

        public static final java.lang.String PROPERTY_ENCODE_TOOLTIPS
        See Also:
        Constant Field Values

      • PROPERTY_ALLOW_HTML_ON_NO_DATA_RETURNED_DESC

        public static final java.lang.String PROPERTY_ALLOW_HTML_ON_NO_DATA_RETURNED_DESC
        See Also:
        Constant Field Values

      • PROPERTY_RENDER_EXCEPTION_INFO

        public static final java.lang.String PROPERTY_RENDER_EXCEPTION_INFO
        Since:
        MicroStrategy Web 8.1.1
        See Also:
        Constant Field Values

      • PROPERTY_RENDER_REQUEST_INFO

        public static final java.lang.String PROPERTY_RENDER_REQUEST_INFO
        Since:
        MicroStrategy Web 8.1.1
        See Also:
        Constant Field Values

      • PROPERTY_STATISTICS_USER

        public static final java.lang.String PROPERTY_STATISTICS_USER
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • PROPERTY_AUTO_EXPAND_HIERARCHY_PREORION_BEHAVIOR

        public static final java.lang.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
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • PROPERTY_SHOW_BACKWARDS_COMPATIBILITY_SWITCH_IN_PROMPT_EDITOR

        public static final java.lang.String PROPERTY_SHOW_BACKWARDS_COMPATIBILITY_SWITCH_IN_PROMPT_EDITOR
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • PROPERTY_ALLOW_LEGACY_ISERVERS

        public static final java.lang.String PROPERTY_ALLOW_LEGACY_ISERVERS
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • PROPERTY_ALLOW_AUTOCOMPLETE

        public static final java.lang.String PROPERTY_ALLOW_AUTOCOMPLETE
        Since:
        MicroStrategy Web 7.5.3
        See Also:
        Constant Field Values

      • PROPERTY_STATISTICS_ADVANCED_LOGGER

        public static final java.lang.String PROPERTY_STATISTICS_ADVANCED_LOGGER
        Since:
        MicroStrategy Web 8.0.2
        See Also:
        Constant Field Values

      • PROPERTY_ALLOW_ADMIN_APPLY_ALL_PROJECTS

        public static final java.lang.String PROPERTY_ALLOW_ADMIN_APPLY_ALL_PROJECTS
        Since:
        MicroStrategy Web 8.0.2
        See Also:
        Constant Field Values

      • PROPERTY_VALUE_YES

        public static final java.lang.String PROPERTY_VALUE_YES
        See Also:
        Constant Field Values

      • PROPERTY_VALUE_NO

        public static final java.lang.String PROPERTY_VALUE_NO
        See Also:
        Constant Field Values

      • PROPERTY_VALUE_DISABLE_COOKIES

        @Deprecated
public static final int PROPERTY_VALUE_DISABLE_COOKIES
        Deprecated.
        cookieless mode is not secure and should not be used.
        See Also:
        Constant Field Values

      • PROPERTY_VALUE_TEMP_COOKIES

        @Deprecated
public static final int PROPERTY_VALUE_TEMP_COOKIES
        Deprecated.
        this choice is deprecated. Always use permanent cookies for permanent settings in cookie mode.
        See Also:
        Constant Field Values

      • PROPERTY_VALUE_FIXED_COOKIES

        public static final int PROPERTY_VALUE_FIXED_COOKIES
        See Also:
        Constant Field Values

      • PROPERTY_VALUE_STATISTICS_ADVANCED_LOGGER_DISABLED

        public static final java.lang.String PROPERTY_VALUE_STATISTICS_ADVANCED_LOGGER_DISABLED
        Since:
        MicroStrategy Web 8.0.2
        See Also:
        Constant Field Values

      • PROPERTY_VALUE_STATISTICS_ADVANCED_LOGGER_XMLAPI

        public static final java.lang.String PROPERTY_VALUE_STATISTICS_ADVANCED_LOGGER_XMLAPI
        Since:
        MicroStrategy Web 8.0.2
        See Also:
        Constant Field Values

      • PROPERTY_VALUE_STATISTICS_ADVANCED_LOGGER_OTHER

        public static final java.lang.String PROPERTY_VALUE_STATISTICS_ADVANCED_LOGGER_OTHER
        Since:
        MicroStrategy Web 8.0.2
        See Also:
        Constant Field Values

      • PROPERTY_VALUE_STATISTICS_ADVANCED_LOGGER_SESSION

        public static final java.lang.String PROPERTY_VALUE_STATISTICS_ADVANCED_LOGGER_SESSION
        Since:
        MicroStrategy Web 10.8.0
        See Also:
        Constant Field Values

      • PROPERTY_SAVE_TEMP_SETTINGS_IN_COOKIES

        public static final java.lang.String PROPERTY_SAVE_TEMP_SETTINGS_IN_COOKIES
        Since:
        MicroStrategy Web 8.0.2
        See Also:
        Constant Field Values

      • PROPERTY_PROJECT_SORTING

        public static final java.lang.String PROPERTY_PROJECT_SORTING
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • PROPERTY_SERVER_SORTING

        public static final java.lang.String PROPERTY_SERVER_SORTING
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • PROPERTY_SHOW_ABOUT_PAGE_INFO

        @Deprecated
public static final java.lang.String PROPERTY_SHOW_ABOUT_PAGE_INFO
        Deprecated.
        In MicroStrategy Web 11.0 The support for this preference no longer exists
        Since:
        MicroStrategy Web 9.0.2
        See Also:
        Constant Field Values

      • PROPERTY_ALLOW_LOGIN_BY_URL

        public static final java.lang.String PROPERTY_ALLOW_LOGIN_BY_URL
        Property to control whether bypass the uid/pwd in URL or not
        Since:
        MicroStrategy Web 9.0.2
        See Also:
        Constant Field Values

      • PROPERTY_VALUE_SORTING_NONE

        public static final java.lang.String PROPERTY_VALUE_SORTING_NONE
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • PROPERTY_VALUE_SORTING_DEFAULT

        public static final java.lang.String PROPERTY_VALUE_SORTING_DEFAULT
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • PROPERTY_VALUE_SORTING_NAME

        public static final java.lang.String PROPERTY_VALUE_SORTING_NAME
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • PROPERTY_VALUE_SORTING_DESCRIPTION

        public static final java.lang.String PROPERTY_VALUE_SORTING_DESCRIPTION
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • PROPERTY_DISABLE_ONDEMAND_DRILLING

        public static final java.lang.String PROPERTY_DISABLE_ONDEMAND_DRILLING
        Property to disable ondemand drilling.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • PROPERTY_SHOW_FILTER_ON_SELECTIONS_CHECKS

        public static final java.lang.String PROPERTY_SHOW_FILTER_ON_SELECTIONS_CHECKS
        Property to enable check boxes on filter on selections
        Since:
        MicroStrategy Web 9.0.1
        See Also:
        Constant Field Values

      • PROPERTY_CREATE_NEW_SESSION

        public static final java.lang.String PROPERTY_CREATE_NEW_SESSION
        Property to control whether need create new http session or not when login
        Since:
        MicroStrategy Web 9.0.3
        See Also:
        Constant Field Values

      • PROPERTY_USE_OIVM

        public static final java.lang.String PROPERTY_USE_OIVM
        Property to control whether use optimized-interactive-view-mode or not
        Since:
        MicroStrategy Web 9.0.3
        See Also:
        Constant Field Values

      • PROPERTY_OVERRIDE_ISEREVER_ERRORS

        public static final java.lang.String PROPERTY_OVERRIDE_ISEREVER_ERRORS
        Since:
        MicroStrategy Web 9.4.0
        See Also:
        Constant Field Values

      • PROPERTY_INCLUDE_TIMESTAMP_IN_ERROR

        public static final java.lang.String PROPERTY_INCLUDE_TIMESTAMP_IN_ERROR
        Since:
        MicroStrategy Web 9.4.0
        See Also:
        Constant Field Values

      • PROPERTY_EXCLUDE_TIMESTAMP_IN_ERROR

        public static final java.lang.String PROPERTY_EXCLUDE_TIMESTAMP_IN_ERROR
        Since:
        MicroStrategy Web 9.4.0
        See Also:
        Constant Field Values

      • PROPERTY_HELP_URL

        public static final java.lang.String PROPERTY_HELP_URL
        Property to indicate the url of the help system when help location is not local
        See Also:
        Constant Field Values

      • PROPERTY_USER_HELP_PAGE

        public static final java.lang.String PROPERTY_USER_HELP_PAGE
        See Also:
        Constant Field Values

      • PROPERTY_HELP_LOCATION

        public static final java.lang.String PROPERTY_HELP_LOCATION
        Property to indicate whether the help system entry point should be local or a URL
        See Also:
        Constant Field Values

      • PROPERTY_VALUE_LOCATION_LOCAL

        public static final java.lang.String PROPERTY_VALUE_LOCATION_LOCAL
        See Also:
        Constant Field Values

      • PROPERTY_VALUE_LOCATION_REMOTE

        public static final java.lang.String PROPERTY_VALUE_LOCATION_REMOTE
        See Also:
        Constant Field Values

      • PROPERTY_SALESFORCE_CLIENT_ID

        public static final java.lang.String PROPERTY_SALESFORCE_CLIENT_ID
        See Also:
        Constant Field Values

      • PROPERTY_SALESFORCE_CLIENT_SECRET

        public static final java.lang.String PROPERTY_SALESFORCE_CLIENT_SECRET
        See Also:
        Constant Field Values

      • PROPERTY_SALESFORCE_REDIRECT_URL

        public static final java.lang.String PROPERTY_SALESFORCE_REDIRECT_URL
        See Also:
        Constant Field Values

      • PROPERTY_ENABLE_FACEBOOK_LOGIN

        public static final java.lang.String PROPERTY_ENABLE_FACEBOOK_LOGIN
        See Also:
        Constant Field Values

      • PROPERTY_FORCE_PARAMETER_VALIDATION

        public static final java.lang.String PROPERTY_FORCE_PARAMETER_VALIDATION
        See Also:
        Constant Field Values

      • PROPERTY_FORCE_CONTENT_TYPE_VALIDATION

        public static final java.lang.String PROPERTY_FORCE_CONTENT_TYPE_VALIDATION
        See Also:
        Constant Field Values

      • PROPERTY_ENABLE_PROXY

        public static final java.lang.String PROPERTY_ENABLE_PROXY
        Since:
        MicroStrategy Web 9.3.0
        See Also:
        Constant Field Values

      • PROPERTY_X_FRAME_OPTIONS

        public static final java.lang.String PROPERTY_X_FRAME_OPTIONS
        See Also:
        Constant Field Values

      • PROPERTY_ENABLE_FRAME_BREAKING

        public static final java.lang.String PROPERTY_ENABLE_FRAME_BREAKING
        See Also:
        Constant Field Values

      • PROPERTY_VALUE_DENY

        public static final java.lang.String PROPERTY_VALUE_DENY
        See Also:
        Constant Field Values

      • PROPERTY_VALUE_SAMEORIGIN

        public static final java.lang.String PROPERTY_VALUE_SAMEORIGIN
        See Also:
        Constant Field Values

      • PROPERTY_ENABLE_HTTP_PROXY

        public static final java.lang.String PROPERTY_ENABLE_HTTP_PROXY
        See Also:
        Constant Field Values

      • PROPERTY_HTTP_PROXY_SERVER_ADDRESS

        public static final java.lang.String PROPERTY_HTTP_PROXY_SERVER_ADDRESS
        See Also:
        Constant Field Values

      • PROPERTY_HTTP_PROXY_PORT

        public static final java.lang.String PROPERTY_HTTP_PROXY_PORT
        See Also:
        Constant Field Values

      • PROPERTY_INCLUDE_TIMESTAMP

        public static final java.lang.String PROPERTY_INCLUDE_TIMESTAMP
        Determines whether to show time stamp in the I server error message
        Since:
        MicroStrategy Web 9.3.1
        See Also:
        Constant Field Values

      • PROPERTY_CUSTOM_ERROR_MESSAGE

        public static final java.lang.String PROPERTY_CUSTOM_ERROR_MESSAGE
        Determines the custom error message which needs to be displayed on error
        See Also:
        Constant Field Values

      • PROPERTY_CUSTOM_ERROR_MESSAGE_DESC_ID

        public static final java.lang.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."
        See Also:
        Constant Field Values

      • PROPERTY_OVERRIDE_ISERVER_ERROR_MESSAGE

        public static final java.lang.String PROPERTY_OVERRIDE_ISERVER_ERROR_MESSAGE
        Determines if the preference is set to override the message generated by Iserver
        See Also:
        Constant Field Values

      • PROPERTY_MAX_MESSAGES_IDS_IN_COOKIE

        public static final java.lang.String PROPERTY_MAX_MESSAGES_IDS_IN_COOKIE
        See Also:
        Constant Field Values

      • PROPERTY_ENABLE_FENCING

        public static final java.lang.String PROPERTY_ENABLE_FENCING
        Since:
        MicroStrategy Web 10.9.0
        See Also:
        Constant Field Values

      • PROPERTY_USE_DEPRECATED_FEATURES

        public static final java.lang.String PROPERTY_USE_DEPRECATED_FEATURES
        Since:
        MicroStrategy Web 11.0.0
        See Also:
        Constant Field Values

      • PROPERTY_IDENTITY_TOKEN_SECRET_KEY

        public static final java.lang.String PROPERTY_IDENTITY_TOKEN_SECRET_KEY
        Since:
        MicroStrategy Web 11.0.0
        See Also:
        Constant Field Values

      • PROPERTY_HIDE_EMBED_IMAGES_OPTION

        public static final java.lang.String PROPERTY_HIDE_EMBED_IMAGES_OPTION
        Since:
        MicroStrategy Web 11.3.0
        See Also:
        Constant Field Values

      • PROPERTY_ENCRYPTION_ENABLED

        public static final java.lang.String PROPERTY_ENCRYPTION_ENABLED
        Since:
        MicroStrategy Web 11.3.3
        See Also:
        Constant Field Values

      • PROPERTY_COOKIE_SAME_SITE

        public static final java.lang.String PROPERTY_COOKIE_SAME_SITE
        See Also:
        Constant Field Values

      • PROPERTY_COOKIE_HTTP_ONLY

        public static final java.lang.String PROPERTY_COOKIE_HTTP_ONLY
        See Also:
        Constant Field Values

      • PROPERTY_COOKIE_SECURE

        public static final java.lang.String PROPERTY_COOKIE_SECURE
        See Also:
        Constant Field Values

    • Method Detail

      • getInstance

        public static AdminServersHelper getInstance()
        Since:
        MicroStrategy Web 8.0.1

      • connectIServers

        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.

      • connectIServers

        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.
        Since:
        MicroStrategy Web 9.0.0

      • setIServerTimeouts

        public static void setIServerTimeouts​(java.lang.String requestTimeOut,
                                      java.lang.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.

      • setIServerConnectionFailureTolerance

        public static void setIServerConnectionFailureTolerance​(java.lang.String tolerance)

      • checkIServerVersion

        public static void checkIServerVersion​(java.lang.String name,
                                       int port)
                                throws WebAppException,
                                       WebObjectsException
        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
        Since:
        MicroStrategy Web 8.0.0

      • checkIServerName

        public static void checkIServerName​(java.lang.String name)
                             throws WebAppException
        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
        Since:
        MicroStrategy Web 8.0.0

      • setIServerProperties

        public static void setIServerProperties​(java.lang.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.

      • getRequestServerName

        public static java.lang.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.

      • getMinimumIServerVersion

        public static java.lang.String getMinimumIServerVersion()
        Try to retrieve the minimum IServer version from the sys_defaults.xml config file, if not set, return the default IServer version #MIN_ISERVER_VERSION
        Returns:
        the minimum IServer version

      • updateConnectedServersList

        public void updateConnectedServersList​(AdminServersList adminServersList)
        Since:
        MicroStrategy Web 8.0.1

      • scheduleIServerConnect

        @Deprecated
public void scheduleIServerConnect​(java.lang.String pollingFrequency,
                                   org.w3c.dom.Document serverList)
        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.

      • scheduleIServerConnect

        public void scheduleIServerConnect​(java.lang.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.
        Since:
        MicroStrategy Web 9.0.0

      • getUserPrefApplyOptions

        public static java.lang.String[][] getUserPrefApplyOptions​(java.lang.String serverName,
                                                           java.lang.String projectName,
                                                           AbstractAppTransform transform)
        Since:
        MicroStrategy Web 8.0.2

      • getApplyOptions

        public static HashList<java.lang.String,​java.lang.String> getApplyOptions​(java.lang.String serverName,
                                                                                java.lang.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

      • ensureServersAreConnected

        public static void ensureServersAreConnected()
        Since:
        MicroStrategy Web 8.0.2