Class WebObjectsFactory


  • public final class WebObjectsFactory
    extends java.lang.Object
    WebObjectsFactory is the factory class for the Web Objects API. This is the entry point for any operation which uses the Web Objects. When creating a new factory instance, it should be initialized with setMessagesManager(MessagesManager) to ensure underlying messages may be correctly localized. Since 9.0.2, if users need to get the proper css for a specific browser, they should set the browser type through setBrowserType(int). If they want to use proper locale, they should set the message through setMessagesManager(MessagesManager);
    Since:
    MicroStrategy Web 7.3.1 or earlier
    • Method Detail

      • getInstance

        public static WebObjectsFactory getInstance()
        Returns an instance of the WebObjectsFactory object. This is the only way to obtain the factory object.
        Returns:
        A WebObjectsFactory instance, which can be used to construct the other Web Objects.
      • getIServerSession

        public WebIServerSession getIServerSession()
        Returns a WebIServerSession object, which can be used to create and set the session ID on the factory and all objects created from it.
        Returns:
        The WebIServerSession object which represents the session information which all objects derived from the factory will use.
      • getMDUpdateSource

        public WebMDUpdateSource getMDUpdateSource()
        Returns a WebMDUpdateSource object, which can be used to update all or portions of the metadata
        Returns:
        the WebClusterSource object
        Since:
        MicroStrategy Web 9.0.0
      • getEncryptionKeysSource

        public WebEncryptionKeysSource getEncryptionKeysSource()
        Returns a WebEncryptionKeysSource object, which can be used to re-encrypt the mstr env
        Returns:
        the WebEncryptionKeysSource object
        Since:
        MicroStrategy Web 10.2
      • checkUserPrivilege

        public boolean checkUserPrivilege​(int privilegeType)
                                   throws WebObjectsException
        Checks if the user has the particular privelege type
        Parameters:
        privilegeType - integer value specifying the type of privilege that is to be checked This is a value from the enumeration EnumDSSXMLPrivilegeTypes
        Returns:
        boolean value indicating if the specific privilege is available
        Throws:
        WebObjectsException
      • getLicenseSource

        public LicenseSource getLicenseSource()
        Returns a LicenseSource object, which can be used for retrieving licensing information.
        Returns:
        A new LicenseSource object.
        Since:
        MicroStrategy Web 7.5.2
      • getRWSource

        public RWSource getRWSource()
        Returns a RWSource object, which can be used for RW-related operations.
        Returns:
        A RWSource object.
        Since:
        MicroStrategy Web 8.0.0
      • getIServerSessionList

        public WebIServerSessionList getIServerSessionList()
        Since:
        MicroStrategy Web 8.0.1
      • getMonitorSource

        public MonitorSource getMonitorSource​(int type)
        Returns a type specific MonitorSource object, which can be used for retrieving monitoring information.
        Parameters:
        type - the monitoring type, a value from EnumWebMonitorType
        Returns:
        A MonitorSource object.
        Since:
        MicroStrategy Web 9.0.0
      • getObjectLockSource

        public ObjectLockSource getObjectLockSource()
        Since:
        MicroStrategy Web 9.0.0
      • setMessagesManager

        public void setMessagesManager​(MessagesManager msgs)
      • setBrowserType

        public void setBrowserType​(int brwType)
        Set the browser type (@link EnumBrowserType)
        Parameters:
        brwType -
      • getBrowserType

        public int getBrowserType()
      • getDescriptor

        public java.lang.String getDescriptor​(java.lang.String key,
                                              java.lang.String defaultValue)