Package com.microstrategy.web.tasks
Class UserServicesTask
- java.lang.Object
-
- com.microstrategy.web.tasks.AbstractBaseTask
-
- com.microstrategy.web.tasks.UserServicesTask
-
- All Implemented Interfaces:
Task
public class UserServicesTask extends AbstractBaseTask
ThisTask
returns information about all top level user groups or users/user groups matching certain name pattern in a system.
-
-
Field Summary
Fields Modifier and Type Field Description protected static java.lang.String
BLK_SEARCH_RESULT
protected static java.lang.String
BLK_USER_ENTITY
protected TaskParameterMetadata
blockBegin
protected TaskParameterMetadata
blockCount
protected static java.lang.String
BLP_ENTITY_IS_GROUP
protected static java.lang.String
BLP_SEARCH_RESULT_BLOCK_BEGIN
protected static java.lang.String
BLP_SEARCH_RESULT_BLOCK_COUNT
protected static java.lang.String
BLP_SEARCH_RESULT_ITEMS
protected static java.lang.String
BLP_SEARCH_RESULT_NAME_WILDCARDS
protected static java.lang.String
BLP_SEARCH_RESULT_SEARCH_PATTERN
protected static java.lang.String
BLP_SEARCH_RESULT_TOTAL_SIZE
protected static java.lang.String
BLP_WEBOBJECTINFO_ABBREVIATION
protected static java.lang.String
BLP_WEBOBJECTINFO_DESC
protected static java.lang.String
BLP_WEBOBJECTINFO_DSSID
protected static java.lang.String
BLP_WEBOBJECTINFO_NAME
protected static java.lang.String
BLP_WEBOBJECTINFO_SUBTYPE
protected static java.lang.String
BLP_WEBOBJECTINFO_TYPE
protected TaskParameterMetadata
nameWildcards
protected static java.lang.String
PARAM_NAME_BLOCK_BEGIN
protected static java.lang.String
PARAM_NAME_BLOCK_COUNT
protected static java.lang.String
PARAM_NAME_NAME_WILDCARDS
protected static java.lang.String
PARAM_NAME_SEARCH_PATTERN
protected static java.lang.String
PARAM_NAME_TOPGROUPS_ONLY
protected TaskParameterMetadata
searchPattern
protected static java.lang.String
TASK_DESC
protected TaskParameterMetadata
topGroupsOnly
protected static java.lang.String
USER_GROUP_SYSTEM_FOLDER_ID
-
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, objectIDParam, OTHER_CONTENT_KEY_LAYOUTS, PARAM_NAME_EXEC_FLAGS, PARAM_NAME_MAX_WAIT, PARAM_NAME_MESSAGE_ID, PARAM_NAME_OBJECT_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 UserServicesTask()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
buildEntityInfo(WebObjectInfo object, Block woiBlock)
protected void
checkUserPrivilege(WebIServerSession session)
protected WebFolder
getTopUserGroups(WebIServerSession wiss, WebObjectSource wos)
protected void
includeItemsInfo(Block result, WebFolder wf)
protected int
includeItemsInfoNoTgOnly(Block iResult, WebFolder iWebFolder, WebIServerSession iProjectSession, java.lang.String iPattern)
void
processRequest(TaskRequestContext context, TaskOutput taskOutput)
The default implementation of this method of processRequest gets the Primary Content from the TaskOutput and invokes theAbstractBaseTask.processRequest(TaskRequestContext, MarkupOutput)
version.protected WebFolder
searchForUsers(WebIServerSession wiss, java.lang.String pattern, int blockBegin, int blockCount, boolean useWildcard)
protected void
setSearchFolder(WebIServerSession iProjectSession, WebSearch iWebSearch)
-
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
-
-
-
-
Field Detail
-
TASK_DESC
protected static final java.lang.String TASK_DESC
- See Also:
- Constant Field Values
-
PARAM_NAME_SEARCH_PATTERN
protected static final java.lang.String PARAM_NAME_SEARCH_PATTERN
- See Also:
- Constant Field Values
-
PARAM_NAME_NAME_WILDCARDS
protected static final java.lang.String PARAM_NAME_NAME_WILDCARDS
- See Also:
- Constant Field Values
-
PARAM_NAME_BLOCK_COUNT
protected static final java.lang.String PARAM_NAME_BLOCK_COUNT
- See Also:
- Constant Field Values
-
PARAM_NAME_BLOCK_BEGIN
protected static final java.lang.String PARAM_NAME_BLOCK_BEGIN
- See Also:
- Constant Field Values
-
PARAM_NAME_TOPGROUPS_ONLY
protected static final java.lang.String PARAM_NAME_TOPGROUPS_ONLY
- See Also:
- Constant Field Values
-
BLK_SEARCH_RESULT
protected static final java.lang.String BLK_SEARCH_RESULT
- See Also:
- Constant Field Values
-
BLP_SEARCH_RESULT_SEARCH_PATTERN
protected static java.lang.String BLP_SEARCH_RESULT_SEARCH_PATTERN
-
BLP_SEARCH_RESULT_NAME_WILDCARDS
protected static java.lang.String BLP_SEARCH_RESULT_NAME_WILDCARDS
-
BLP_SEARCH_RESULT_BLOCK_BEGIN
protected static java.lang.String BLP_SEARCH_RESULT_BLOCK_BEGIN
-
BLP_SEARCH_RESULT_BLOCK_COUNT
protected static java.lang.String BLP_SEARCH_RESULT_BLOCK_COUNT
-
BLP_SEARCH_RESULT_TOTAL_SIZE
protected static java.lang.String BLP_SEARCH_RESULT_TOTAL_SIZE
-
BLP_SEARCH_RESULT_ITEMS
protected static java.lang.String BLP_SEARCH_RESULT_ITEMS
-
BLK_USER_ENTITY
protected static final java.lang.String BLK_USER_ENTITY
- See Also:
- Constant Field Values
-
BLP_ENTITY_IS_GROUP
protected static java.lang.String BLP_ENTITY_IS_GROUP
-
BLP_WEBOBJECTINFO_ABBREVIATION
protected static final java.lang.String BLP_WEBOBJECTINFO_ABBREVIATION
- See Also:
- Constant Field Values
-
BLP_WEBOBJECTINFO_DESC
protected static final java.lang.String BLP_WEBOBJECTINFO_DESC
- See Also:
- Constant Field Values
-
BLP_WEBOBJECTINFO_DSSID
protected static final java.lang.String BLP_WEBOBJECTINFO_DSSID
- See Also:
- Constant Field Values
-
BLP_WEBOBJECTINFO_NAME
protected static final java.lang.String BLP_WEBOBJECTINFO_NAME
- See Also:
- Constant Field Values
-
BLP_WEBOBJECTINFO_SUBTYPE
protected static final java.lang.String BLP_WEBOBJECTINFO_SUBTYPE
- See Also:
- Constant Field Values
-
BLP_WEBOBJECTINFO_TYPE
protected static final java.lang.String BLP_WEBOBJECTINFO_TYPE
- See Also:
- Constant Field Values
-
USER_GROUP_SYSTEM_FOLDER_ID
protected static final java.lang.String USER_GROUP_SYSTEM_FOLDER_ID
- See Also:
- Constant Field Values
-
topGroupsOnly
protected TaskParameterMetadata topGroupsOnly
-
blockBegin
protected TaskParameterMetadata blockBegin
-
blockCount
protected TaskParameterMetadata blockCount
-
searchPattern
protected TaskParameterMetadata searchPattern
-
nameWildcards
protected TaskParameterMetadata nameWildcards
-
-
Method Detail
-
processRequest
public void processRequest(TaskRequestContext context, TaskOutput taskOutput) throws TaskException
Description copied from class:AbstractBaseTask
The default implementation of this method of processRequest gets the Primary Content from the TaskOutput and invokes theAbstractBaseTask.processRequest(TaskRequestContext, MarkupOutput)
version.- Specified by:
processRequest
in interfaceTask
- Overrides:
processRequest
in classAbstractBaseTask
- Parameters:
context
- TheTaskRequestContext
object that maintains the state of the request.taskOutput
- TheTaskOutput
that contains the output generated by the Task.- Throws:
TaskException
- If the Task was unable to satisfy the request.- See Also:
Task.processRequest(TaskRequestContext, TaskOutput)
-
buildEntityInfo
protected void buildEntityInfo(WebObjectInfo object, Block woiBlock)
-
checkUserPrivilege
protected void checkUserPrivilege(WebIServerSession session) throws TaskException
- Throws:
TaskException
-
includeItemsInfo
protected void includeItemsInfo(Block result, WebFolder wf) throws TaskConfigurationException
- Throws:
TaskConfigurationException
-
includeItemsInfoNoTgOnly
protected int includeItemsInfoNoTgOnly(Block iResult, WebFolder iWebFolder, WebIServerSession iProjectSession, java.lang.String iPattern) throws TaskConfigurationException
- Throws:
TaskConfigurationException
-
searchForUsers
protected WebFolder searchForUsers(WebIServerSession wiss, java.lang.String pattern, int blockBegin, int blockCount, boolean useWildcard) throws WebObjectsException
- Throws:
WebObjectsException
-
setSearchFolder
protected void setSearchFolder(WebIServerSession iProjectSession, WebSearch iWebSearch) throws WebObjectsException
- Throws:
WebObjectsException
-
getTopUserGroups
protected WebFolder getTopUserGroups(WebIServerSession wiss, WebObjectSource wos) throws WebObjectsException
- Throws:
WebObjectsException
-
-