Package com.microstrategy.web.tasks

Class GetDBInstancesTask

java.lang.Object

com.microstrategy.web.tasks.AbstractBaseTask

com.microstrategy.web.tasks.AbstractArchitectTask

com.microstrategy.web.tasks.GetDBInstancesTask

All Implemented Interfaces:

Task

public class GetDBInstancesTask
extends AbstractArchitectTask

Field Summary

Fields

Modifier and Type	Field	Description
protected static int	DATA_IMPORT_DATABASE_INSTANCE_SUBTYPE
protected static int	OAUTH_DATABASE_INSTANCE_SUBTYPE
protected WebDBRole	primaryDBR
protected static int	SEARCH_OBJECT_FLAGS

Fields inherited from class com.microstrategy.web.tasks.AbstractBaseTask

compressOutput, CONTENT_TYPE_BINARY, CONTENT_TYPE_HTML, CONTENT_TYPE_JSON, CONTENT_TYPE_JSON_ALL, CONTENT_TYPE_JSON_D, CONTENT_TYPE_JSON_P, CONTENT_TYPE_XML, CONTENT_TYPE_XML_ANF, DEFAULT_MAX_WAIT, DEFAULT_POLLING_FREQ, execFlagsParam, INDEFINITE_MAX_WAIT, maxWaitParam, metadata, mPrivileges, msgIDParam, OTHER_CONTENT_KEY_LAYOUTS, PARAM_NAME_EXEC_FLAGS, PARAM_NAME_MAX_WAIT, PARAM_NAME_MESSAGE_ID, PARAM_NAME_POLLING_FREQ, PARAM_NAME_RESULT_FLAGS, PARAM_NAME_SESSION_ID, PARAM_NAME_SESSION_STATE, PARAM_NAME_STATE_ID, pollingFreqParam, PREFERENCE_DEFAULT_MAX_WAIT_IN_TASK, resultFlagsParam, sessionIDParam, sessionStateParam, stateIDParam

Constructor Summary

Constructors

Constructor	Description
GetDBInstancesTask()

Method Summary

Modifier and Type	Method	Description
protected void	buildResponse(MarkupOutput mo, TaskRequestContext context, WebIServerSession ses, java.util.List<WebDBRole> roles, boolean terse, java.lang.String vldbProps, boolean ignoreEmbedded)
boolean	checkInFilter(int valToCheck, int[] filters, int[] excludeFilters)
protected boolean	checkRights(WebIServerSession session, WebObjectSource os, WebDBRole dbRole, int rightsToCheck)
protected boolean	checkRoleAccess(WebIServerSession session, WebObjectSource os, WebDBRole dbRole)
protected boolean	checkShared(WebIServerSession iSession, WebDBRole iDbRole, java.lang.String iEveryoneId)
java.lang.String	eraseArguments(java.lang.String connstr, java.lang.String regex, java.lang.String replacement)
java.lang.String	eraseSensitiveArguments(java.lang.String connstr)
java.util.List<WebDBRole>	getAllDBRoles(WebIServerSession session, boolean isDI, boolean ro, java.lang.String typeFilters, java.lang.String versionFilters, java.lang.String typeExcludeFilters, java.lang.String versionExcludeFilters)
Block	getResponse(WebIServerSession ses, java.util.List<WebDBRole> roles, boolean terse, java.lang.String vldbProps, boolean ignoreEmbedded, java.lang.String eid)
Block	getResponse(WebIServerSession ses, java.util.List<WebDBRole> roles, boolean terse, java.lang.String vldbProps, boolean ignoreEmbedded, java.lang.String eid, boolean isSimplified, boolean requireDbVersion)
protected java.lang.String	getSearchFolderId(WebIServerSession iSession)
java.util.List<WebDBRole>	getSingleDBRole(WebIServerSession session, java.lang.String id)
int[]	processFilters(java.lang.String filters)
void	processRequest(TaskRequestContext context, MarkupOutput markupOutput)	The default implementation of this version of processRequest is empty.

Methods inherited from class com.microstrategy.web.tasks.AbstractArchitectTask

checkUserPrivilege, getRequestTimeout

Methods inherited from class com.microstrategy.web.tasks.AbstractBaseTask

addExecFlagsParam, addJuilLayouts, addMaxWaitParam, addMaxWaitParam, addMessageIDParam, addObjectIDParam, addParameterMetadata, addParameterMetadata, addParameterMetadata, addPollingFrequencyParam, addPollingFrequencyParam, addResultFlagsParam, addSessionIDParam, addSessionStateParam, addStateIDParam, checkForRequiredParameters, destroy, getCompressOutput, getID, getMetadata, getPrivileges, getSysDefaultPreferenceValue, init, newRequestContext, processRequest, retrieveUploadedFile, setCompressOutput, setDescription, setID, setMetadata, setPrivileges, validateContentType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SEARCH_OBJECT_FLAGS

protected static final int SEARCH_OBJECT_FLAGS

See Also:

Constant Field Values

DATA_IMPORT_DATABASE_INSTANCE_SUBTYPE

protected static final int DATA_IMPORT_DATABASE_INSTANCE_SUBTYPE

See Also:

Constant Field Values

OAUTH_DATABASE_INSTANCE_SUBTYPE

protected static final int OAUTH_DATABASE_INSTANCE_SUBTYPE

See Also:

Constant Field Values

primaryDBR

protected WebDBRole primaryDBR

Constructor Detail

GetDBInstancesTask

public GetDBInstancesTask()

Method Detail

processRequest

public void processRequest(TaskRequestContext context,
                           MarkupOutput markupOutput)
                    throws TaskException

Description copied from class: AbstractBaseTask

The default implementation of this version of processRequest is empty. Task implementators may override either version of processRequest.

Specified by:

processRequest in interface Task

Overrides:

processRequest in class AbstractBaseTask

Parameters:

context - The TaskRequestContext object that maintains the state of the request.

markupOutput - The MarkupOutput that records the contents of the Task response.

Throws:

TaskException - If the Task was unable to satisfy the request.

See Also:

Task.processRequest(TaskRequestContext, MarkupOutput)

checkRoleAccess

protected boolean checkRoleAccess(WebIServerSession session,
                                  WebObjectSource os,
                                  WebDBRole dbRole)
                           throws WebObjectsException

Throws:

WebObjectsException

checkRights

protected boolean checkRights(WebIServerSession session,
                              WebObjectSource os,
                              WebDBRole dbRole,
                              int rightsToCheck)
                       throws WebObjectsException

Throws:

WebObjectsException

checkInFilter

public boolean checkInFilter(int valToCheck,
                             int[] filters,
                             int[] excludeFilters)

processFilters

public int[] processFilters(java.lang.String filters)

getAllDBRoles

public java.util.List<WebDBRole> getAllDBRoles(WebIServerSession session,
                                               boolean isDI,
                                               boolean ro,
                                               java.lang.String typeFilters,
                                               java.lang.String versionFilters,
                                               java.lang.String typeExcludeFilters,
                                               java.lang.String versionExcludeFilters)
                                        throws TaskException

Throws:

TaskException

getSearchFolderId

protected java.lang.String getSearchFolderId(WebIServerSession iSession)
                                      throws WebObjectsException

Throws:

WebObjectsException

getSingleDBRole

public java.util.List<WebDBRole> getSingleDBRole(WebIServerSession session,
                                                 java.lang.String id)
                                          throws TaskException

Throws:

TaskException

buildResponse

protected void buildResponse(MarkupOutput mo,
                             TaskRequestContext context,
                             WebIServerSession ses,
                             java.util.List<WebDBRole> roles,
                             boolean terse,
                             java.lang.String vldbProps,
                             boolean ignoreEmbedded)
                      throws TaskException

Throws:

TaskException

getResponse

public Block getResponse(WebIServerSession ses,
                         java.util.List<WebDBRole> roles,
                         boolean terse,
                         java.lang.String vldbProps,
                         boolean ignoreEmbedded,
                         java.lang.String eid)
                  throws WebObjectsException

Throws:

WebObjectsException

getResponse

public Block getResponse(WebIServerSession ses,
                         java.util.List<WebDBRole> roles,
                         boolean terse,
                         java.lang.String vldbProps,
                         boolean ignoreEmbedded,
                         java.lang.String eid,
                         boolean isSimplified,
                         boolean requireDbVersion)
                  throws WebObjectsException

Throws:

WebObjectsException

checkShared

protected boolean checkShared(WebIServerSession iSession,
                              WebDBRole iDbRole,
                              java.lang.String iEveryoneId)

eraseArguments

public java.lang.String eraseArguments(java.lang.String connstr,
                                       java.lang.String regex,
                                       java.lang.String replacement)

eraseSensitiveArguments

public java.lang.String eraseSensitiveArguments(java.lang.String connstr)