Package com.microstrategy.web.objects

Interface WebDBRole

    • Method Detail

      • getDBMS

        WebDBMS getDBMS()
        Returns the WebDBMS object used by this WebDBRole
        Returns:
        WebDBMS associated with this DBRole
        Since:
        MicroStrategy Web 9.0.0

      • getDBConnectionType

        java.lang.Integer getDBConnectionType()
        Returns the type of DB being accessed.
        Returns:
        integer from EnumDSSXMLDatabaseType
        Since:
        MicroStrategy Web 9.0.0

      • getDBRoleType

        java.lang.Integer getDBRoleType()
        Returns the type of DBRole being accessed.
        Returns:
        integer from EnumDSSXMLDatabaseType
        Since:
        MicroStrategy Web 9.0.0

      • getDBConnectionVersion

        java.lang.Integer getDBConnectionVersion()
        Returns the version of the DB being accessed
        Returns:
        integer from EnumDSSXMLDatabaseVersion
        Since:
        MicroStrategy Web 9.0.0

      • getWalletinfo

        byte[] getWalletinfo()
        Return wallet info in bytes
        Returns:

      • getWalletbinary

        java.util.List<byte[]> getWalletbinary()
        Return wallet file in binary.
        Returns:

      • setWalletbinary

        void setWalletbinary​(java.lang.String walletbinary)
              throws java.lang.IllegalArgumentException
        Set wallet base64 string to binary property
        Parameters:
        walletbinary -
        Throws:
        java.lang.IllegalArgumentException

      • setWalletinfo

        void setWalletinfo​(java.lang.String walletinfo)
            throws java.lang.IllegalArgumentException
        Attach wallet info to instance property
        Parameters:
        walletinfo -
        Throws:
        java.lang.IllegalArgumentException

      • setIsWallet

        void setIsWallet​(java.lang.String iswallet)
          throws java.lang.IllegalArgumentException
        Set "iw" flag on dbrole.
        Parameters:
        iswallet -
        Throws:
        java.lang.IllegalArgumentException

      • setDefaultDBConnection

        void setDefaultDBConnection​(WebDBConnection newConnection)
                     throws java.lang.IllegalArgumentException
        Sets which new connection this DBRole will be using
        Parameters:
        newConnection - WebDBConnection specifying the new connection to be used
        Throws:
        java.lang.IllegalArgumentException
        Since:
        MicroStrategy Web 9.0.0

      • setDefaultDBConnection

        void setDefaultDBConnection​(WebDBConnection newConnection,
                            boolean embed)
        Sets the default DBConnection for this DBRole
        Parameters:
        newConnection - WebDBConnection representing the connection parameters to be used
        embed - boolean true if newConnection should be embedded in this DBRole's definition

      • setDBMS

        void setDBMS​(WebDBMS dbms)
      throws java.lang.IllegalArgumentException
        Associate WebDBMS with this DBRole by object
        Parameters:
        dbms - WebDBMS to assoicate with this DBRole
        Throws:
        java.lang.IllegalArgumentException
        Since:
        MicroStrategy Web 9.0.0

      • setDBConnectionType

        void setDBConnectionType​(int newType)
        Changes the type of DB the DBRole will be connecting to
        Parameters:
        newType - integer representing the type of the new DB to be accessed by this DBRole from EnumDSSXMLDatabaseType
        Since:
        MicroStrategy Web 9.0.0

      • setDBRoleType

        void setDBRoleType​(int newType)
        Changes the type of DB the DBRole will be connecting to
        Parameters:
        newType - integer representing the type of the new DB to be accessed by this DBRoleType from EnumDSSXMLDatabaseType
        Since:
        MicroStrategy Web 9.0.0

      • setDBConnectionVersion

        void setDBConnectionVersion​(int newVersion)
        Set the new DB version type
        Parameters:
        newVersion - integer representing a version type from EnumDSSXMLDatabaseVersion
        Since:
        MicroStrategy Web 9.0.0

      • getIntmdtStoreDBName

        java.lang.String getIntmdtStoreDBName()
        Returns a String containing the name of the DB to store intermediate tables
        Returns:
        String containing the DB name where intermediate tables are stored
        Since:
        MicroStrategy Web 9.0.0

      • getIntmdtStoreTableSpaceName

        java.lang.String getIntmdtStoreTableSpaceName()
        Returns the Table Space name used for intermediate table storage
        Returns:
        String containing the Table Space name
        Since:
        MicroStrategy Web 9.0.0

      • getPrimaryDBInstance

        WebDBRole getPrimaryDBInstance()
        Returns the primary DB instance associated with this DBRole
        Returns:
        WebDBRole acting as primary DBInstance for this DBRole
        Since:
        MicroStrategy Web 9.0.0

      • getDataMartDBInstance

        WebDBRole getDataMartDBInstance()
        Returns a WebDBRole pointing to a DB that this DBRole is pointing to. Used for Data Mart optimization
        Returns:
        WebDBRole pointint to same DB this DBRole is pointing to
        Since:
        MicroStrategy Web 9.0.0

      • setIntmdtStoreDBName

        void setIntmdtStoreDBName​(java.lang.String newName)
        Sets the prefix to be used for table names in this DBRole
        Parameters:
        newName - String containing the new prefix
        Since:
        MicroStrategy Web 9.0.0

      • setIntmdtStoreTableSpaceName

        void setIntmdtStoreTableSpaceName​(java.lang.String newName)
        Sets the new Table Space name for intermediate table storage
        Parameters:
        newName - String containing new Table Space name
        Since:
        MicroStrategy Web 9.0.0

      • setPrimaryDBInstance

        void setPrimaryDBInstance​(WebDBRole primary)
        Sets the primary DBInstance for this DBRole
        Parameters:
        primary - WebDBRole pointing to new primary DBInstance
        Since:
        MicroStrategy Web 9.0.0

      • setDataMartDBInstance

        void setDataMartDBInstance​(WebDBRole instance)
                    throws java.lang.IllegalArgumentException
        Sets the DBInstance that points to the same DB as this DBRole. Used for Data Mart optimization
        Parameters:
        instance - WebDBRole pointing to the new Data Mart DBInstance
        Throws:
        java.lang.IllegalArgumentException
        Since:
        MicroStrategy Web 9.0.0

      • setTablePrefix

        void setTablePrefix​(java.lang.String newPrefix)
             throws WebObjectsException,
                    java.lang.IllegalArgumentException
        Set the value of prefix in WebTableSource. Based on the prefix value will search in Table source folder. If result not found then, it will create a new WebTableSource and it will set same name as prefix and will save to Table source folder. If there is already WebTableSource based on prefix search, then it would update setTableSource(WebTableSource).
        Parameters:
        newPrefix - Prefix value.
        Throws:
        WebObjectsException
        java.lang.IllegalArgumentException

      • getPriorityConnectionCount

        java.lang.Integer getPriorityConnectionCount​(int type)
        Set the number of connections to the DB reserved for specified priority jobs
        Parameters:
        type - Integer from EnumXmlPriorityType depicting what priority will be set
        Returns:
        Integer number of connections allowed for the specified priority
        Since:
        MicroStrategy Web 9.0.0

      • setPriorityConnectionCount

        void setPriorityConnectionCount​(int type,
                                int newCount)
                         throws java.lang.IllegalArgumentException
        Set the number of connections to the DB reserved for specified priority jobs
        Parameters:
        type - Integer from EnumXmlPriorityType depicting what priority will be set
        newCount - Integer number of connections allowed for the specified priority
        Throws:
        java.lang.IllegalArgumentException
        Since:
        MicroStrategy Web 9.0.0

      • toStringFull

        java.lang.String toStringFull​(java.lang.String prefix)
        Returns:
        String containing as much textual information about DBRole as possible
        Since:
        MicroStrategy Web 9.0.0

      • getMaxDBConnections

        java.lang.Integer getMaxDBConnections()
        Returns:
        integer maximum number of physical connections allowed
        Since:
        MicroStrategy Web 9.0.0

      • getMaxDBCost

        java.lang.Integer getMaxDBCost()
        Returns:
        integer Maximum query load allowed
        Since:
        MicroStrategy Web 9.0.0

      • setMaxDBConnections

        void setMaxDBConnections​(int conns)
        Parameters:
        conns - integer specifying Maximum number of physical connections allowed
        Since:
        MicroStrategy Web 9.0.0

      • setMaxDBCost

        void setMaxDBCost​(int cost)
        Parameters:
        cost - integer Maximum query load allowed
        Since:
        MicroStrategy Web 9.0.0

      • setForDataImport

        void setForDataImport​(boolean isForDataImport)
        Set whether this DBRole will be used for DataImport
        Parameters:
        isForDataImport - boolean

      • isForDataImport

        boolean isForDataImport()
        Return whether the DBRole will be used for DataImport
        Returns:
        boolean whether the DBRole is to be used for DataImport

      • useWallet

        boolean useWallet()
        Return boolean value indicating if current dbrole has wallet or not.
        Returns:

      • getIconData

        java.lang.String getIconData()

      • setIconData

        void setIconData​(java.lang.String _iconData)

      • setDBRoleSubType

        void setDBRoleSubType​(int subType)

      • genGetDBRoleConnectionStringXML

        java.lang.String genGetDBRoleConnectionStringXML​(java.lang.String sessionId,
                                                 java.lang.String objectId)

      • isManaged

        boolean isManaged()

      • setScriptId

        void setScriptId​(java.lang.String scriptId)
        set or modify the script id attached to the DBRole

      • getScriptId

        java.lang.String getScriptId()
        returns the script id attached to DBRole

      • setModified

        void setModified()
        Expose setModified for its embedded DBConnection and embedded DBLogin in DBConnection. To be moved to Object Info if Web SDK is to support more embedded object cases.