Package com.microstrategy.web.objects
Class WebObjectsFactory
- java.lang.Object
-
- com.microstrategy.web.objects.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 withsetMessagesManager(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 throughsetBrowserType(int)
. If they want to use proper locale, they should set the message throughsetMessagesManager(MessagesManager)
;- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
checkUserPrivilege(int privilegeType)
Checks if the user has the particular privelege typeprotected boolean
checkUserPrivilege(int privilegeType, WebIServerSession session)
WebAssociatedScheduleSource
getAssociatedScheduleSource()
int
getBrowserType()
WebClusterAdmin
getClusterAdmin()
Returns theWebClusterAdmin
objectWebClusterSource
getClusterSource()
Returns aWebClusterSource
object, which can be used for retrievingWebClusterMembership
.java.lang.String
getDescriptor(java.lang.String key, java.lang.String defaultValue)
WebDocumentSource
getDocumentSource()
Returns aWebDocumentSource
object, which can be used for document-related operations.WebElementSource
getElementSourceObject()
Returns aWebElementSource
object, which can be used for element browsing.WebEncryptionKeysSource
getEncryptionKeysSource()
Returns aWebEncryptionKeysSource
object, which can be used to re-encrypt the mstr envjava.lang.String
getFlexSettingsXml()
WebInboxSource
getInboxSource()
Returns aWebInboxSource
object, which can be used for inbox-related operations.static WebObjectsFactory
getInstance()
Returns an instance of the WebObjectsFactory object.WebIServerSession
getIServerSession()
Returns aWebIServerSession
object, which can be used to create and set the session ID on the factory and all objects created from it.WebIServerSessionList
getIServerSessionList()
LicenseSource
getLicenseSource()
Returns aLicenseSource
object, which can be used for retrieving licensing information.WebMDUpdateSource
getMDUpdateSource()
Returns aWebMDUpdateSource
object, which can be used to update all or portions of the metadataMonitorSource
getMonitorSource(int type)
Returns a type specificMonitorSource
object, which can be used for retrieving monitoring information.ObjectLockSource
getObjectLockSource()
WebObjectSource
getObjectSource()
Returns aWebObjectSource
object, which can be used for object-related operations.WebProjectSource
getProjectSource()
Returns aWebProjectSource
object, which can be used for retrieving project information.WebReportSource
getReportSource()
Returns aWebReportSource
object, which can be used for report-related operations.int
getResolvedAnalysisQuota()
RWSource
getRWSource()
Returns aRWSource
object, which can be used for RW-related operations.WebScheduleSource
getScheduleSource()
Returns aWebScheduleSource
object, which can be used for scheduling-related operations.WebSubscriptionsSource
getSubscriptionsSource()
Returns theWebSubscriptionsSource
object that can be used to access all other objects needed for supporting Narrowcast functionalityjava.lang.String
getUserPrivilegeXml()
void
setBrowserType(int brwType)
Set the browser type (@linkEnumBrowserType
)void
setMessagesManager(MessagesManager msgs)
-
-
-
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.
-
getObjectSource
public WebObjectSource getObjectSource()
Returns aWebObjectSource
object, which can be used for object-related operations.- Returns:
- A
WebObjectSource
object.
-
getScheduleSource
public WebScheduleSource getScheduleSource()
Returns aWebScheduleSource
object, which can be used for scheduling-related operations.- Returns:
- A
WebScheduleSource
object.
-
getAssociatedScheduleSource
public WebAssociatedScheduleSource getAssociatedScheduleSource()
-
getReportSource
public WebReportSource getReportSource()
Returns aWebReportSource
object, which can be used for report-related operations.- Returns:
- A
WebReportSource
object.
-
getElementSourceObject
public WebElementSource getElementSourceObject()
Returns aWebElementSource
object, which can be used for element browsing.- Returns:
- A new
WebElementSource
object.
-
getIServerSession
public WebIServerSession getIServerSession()
Returns aWebIServerSession
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.
-
getDocumentSource
public WebDocumentSource getDocumentSource()
Returns aWebDocumentSource
object, which can be used for document-related operations.- Returns:
- A
WebDocumentSource
object.
-
getInboxSource
public WebInboxSource getInboxSource()
Returns aWebInboxSource
object, which can be used for inbox-related operations.- Returns:
- A
WebInboxSource
object.
-
getSubscriptionsSource
public WebSubscriptionsSource getSubscriptionsSource()
Returns theWebSubscriptionsSource
object that can be used to access all other objects needed for supporting Narrowcast functionality- Returns:
- the
WebSubscriptionsSource
object
-
getProjectSource
public WebProjectSource getProjectSource()
Returns aWebProjectSource
object, which can be used for retrieving project information.- Returns:
- A new
WebProjectSource
object.
-
getClusterSource
public WebClusterSource getClusterSource()
Returns aWebClusterSource
object, which can be used for retrievingWebClusterMembership
.- Returns:
- the WebClusterSource object
- Since:
- MicroStrategy Web 9.0.0
-
getMDUpdateSource
public WebMDUpdateSource getMDUpdateSource()
Returns aWebMDUpdateSource
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 aWebEncryptionKeysSource
object, which can be used to re-encrypt the mstr env- Returns:
- the WebEncryptionKeysSource object
- Since:
- MicroStrategy Web 10.2
-
getClusterAdmin
public WebClusterAdmin getClusterAdmin()
Returns theWebClusterAdmin
object- Returns:
- the
WebClusterAdmin
object
-
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 enumerationEnumDSSXMLPrivilegeTypes
- Returns:
- boolean value indicating if the specific privilege is available
- Throws:
WebObjectsException
-
checkUserPrivilege
protected boolean checkUserPrivilege(int privilegeType, WebIServerSession session) throws WebObjectsException
- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 9.0.0
-
getUserPrivilegeXml
public java.lang.String getUserPrivilegeXml() throws WebObjectsException
- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 8.1.1
-
getFlexSettingsXml
public java.lang.String getFlexSettingsXml() throws WebObjectsException
- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 8.1.1
-
getLicenseSource
public LicenseSource getLicenseSource()
Returns aLicenseSource
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 aRWSource
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 specificMonitorSource
object, which can be used for retrieving monitoring information.- Parameters:
type
- the monitoring type, a value fromEnumWebMonitorType
- 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 (@linkEnumBrowserType
)- Parameters:
brwType
-
-
getBrowserType
public int getBrowserType()
-
getDescriptor
public java.lang.String getDescriptor(java.lang.String key, java.lang.String defaultValue)
-
getResolvedAnalysisQuota
public int getResolvedAnalysisQuota() throws WebObjectsException
- Throws:
WebObjectsException
-
-