com.stellent.cis.client.api.scs.user
Interface ISCSUserAPI

All Superinterfaces:

ICommandAPI

public interface ISCSUserAPI
extends ICommandAPI

The command API implementation of the user commands. This implementation can be accessed directly via the ICommandFacade class, using the API name user, with the following syntax:

 ISCSUserAPI commandAPI =
       (ISCSUserAPI)m_commandFacade.getCommandAPI ("user", m_commandFacade.getCommandTypeForName ("active"));
 

Field Summary

static java.lang.String

API_CATEGORY Category for this Command API

Method Summary

ISCSUserAccount	_createAccount() Create a new user account object.
ISCSUserRole	_createRole() Create a new user role object.
ISCSUserObject	_createUser() Create a new user object.
ISCSUserAlias	_createUserAlias() Create a new user alias object.
ISCSUserAliasMapping	_createUserAliasMapping() Create a new user alias mapping object.
ISCSUserAttributeInfo	_createUserAttributeInfo() Create a new user attribute info object.
ISCSUserAliasActionResponse	createAlias(ISCSContext SCSContext, ISCSUserAlias alias) Command that creates a new alias.
ISCSUserAliasActionResponse	createAlias(ISCSContext SCSContext, ISCSUserAlias alias, java.util.List users) Command that creates a new alias.
ISCSUserAliasActionResponse	createAlias(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSUserAlias alias) Command that creates a new alias.
ISCSUserAliasActionResponse	createAlias(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSUserAlias alias, java.util.List users) Command that creates a new alias.
ISCSUserRoleActionResponse	createRole(ISCSContext SCSContext, ISCSUserRole userRole) Add a role to the content server system.
ISCSUserRoleActionResponse	createRole(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSUserRole userRole) Add a role to the content server system.
ISCSUserActionResponse	createUser(ISCSContext SCSContext, ISCSUserObject userObject) Create a new user in the content server.
ISCSUserActionResponse	createUser(ISCSContext SCSContext, ISCSUserObject userObject, ISCSUserAttributeInfo userAttributeInfo) Create a new user in the content server.
ISCSUserActionResponse	createUser(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSUserObject userObject) Create a new user in the content server.
ISCSUserActionResponse	createUser(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSUserObject userObject, ISCSUserAttributeInfo userAttributeInfo) Create a new user in the content server.
ISCSUserAliasActionResponse	deleteAlias(ISCSContext SCSContext, java.lang.String name) Command that deletes an existing alias.
ISCSUserAliasActionResponse	deleteAlias(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String name) Command that deletes an existing alias.
ISCSUserRoleActionResponse	deleteRole(ISCSContext SCSContext, java.lang.String roleName) Delete a user role from the content server.
ISCSUserRoleActionResponse	deleteRole(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String roleName) Delete a user role from the content server.
ISCSServerResponse	deleteSearchQuery(ISCSContext SCSContext, java.lang.String queryTitle) Removes search queries for a users PNE on the content server.
ISCSServerResponse	deleteSearchQuery(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String queryTitle) Removes search queries for a users PNE on the content server.
ISCSUserActionResponse	deleteUser(ISCSContext SCSContext, java.lang.String userName) Delete a user from the content server.
ISCSUserActionResponse	deleteUser(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String userName) Delete a user from the content server.
ISCSUserAliasActionResponse	editAlias(ISCSContext SCSContext, ISCSUserAlias alias) Command that modifies an existing alias.
ISCSUserAliasActionResponse	editAlias(ISCSContext SCSContext, ISCSUserAlias alias, java.util.List users) Command that modifies an existing alias.
ISCSUserAliasActionResponse	editAlias(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSUserAlias alias) Command that modifies an existing alias.
ISCSUserAliasActionResponse	editAlias(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSUserAlias alias, java.util.List users) Command that modifies an existing alias.
ISCSUserRoleActionResponse	editRole(ISCSContext SCSContext, ISCSUserRole userRole) Edit the user role information.
ISCSUserRoleActionResponse	editRole(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSUserRole userRole) Edit the user role information.
ISCSUserActionResponse	editUser(ISCSContext SCSContext, ISCSUserObject userObject) Command that modifies an existing user.
ISCSUserActionResponse	editUser(ISCSContext SCSContext, ISCSUserObject userObject, ISCSUserAttributeInfo userAttributeInfo) Command that modifies an existing user.
ISCSUserActionResponse	editUser(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSUserObject userObject) Command that modifies an existing user.
ISCSUserActionResponse	editUser(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSUserObject userObject, ISCSUserAttributeInfo userAttributeInfo) Command that modifies an existing user.
ICISAPIObjectFactory	getObjectFactory() Retrieve the object factory associated with this API
ISCSUserPNEResponse	getPNEData(ISCSContext SCSContext) Retrieves the users PNE data binder which contains personal saved information, such as query parameters and query strings.
ISCSUserPNEResponse	getPNEData(ISCSRequestModifier requestModifier, ISCSContext SCSContext) Retrieves the users PNE data binder which contains personal saved information, such as query parameters and query strings.
ISCSUserListAliasesResponse	listAliases(ISCSContext SCSContext) List the available aliases in the content server.
ISCSUserListAliasesResponse	listAliases(ISCSRequestModifier requestModifier, ISCSContext SCSContext) List the available aliases in the content server.
ISCSRoleListResponse	listRoles(ISCSContext SCSContext) List the available roles in the content server.
ISCSRoleListResponse	listRoles(ISCSRequestModifier requestModifier, ISCSContext SCSContext) List the available roles in the content server.
ISCSUserListResponse	listUsers(ISCSContext SCSContext) List the available users in the content server.
ISCSUserListResponse	listUsers(ISCSRequestModifier requestModifier, ISCSContext SCSContext) List the available users in the content server.
ISCSQueryUserAttributesResponse	queryUserAttributes(ISCSContext SCSContext, java.lang.String userName) Returns user attributes for a specific user.
ISCSQueryUserAttributesResponse	queryUserAttributes(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String userName) Returns user attributes for a specific user.
ISCSUserActionResponse	registerUser(ISCSContext SCSContext, ISCSUserObject userObject) Command that registers a user.
ISCSUserActionResponse	registerUser(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSUserObject userObject) Command that registers a user.
ISCSServerResponse	saveSearchQuery(ISCSContext SCSContext, java.lang.String queryTitle, java.lang.String queryText) Save a search query to the users PNE on the content server.
ISCSServerResponse	saveSearchQuery(ISCSContext SCSContext, java.lang.String queryTitle, java.lang.String queryText, java.lang.String queryDescription) Save a search query to the users PNE on the content server.
ISCSServerResponse	saveSearchQuery(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String queryTitle, java.lang.String queryText) Save a search query to the users PNE on the content server.
ISCSServerResponse	saveSearchQuery(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String queryTitle, java.lang.String queryText, java.lang.String queryDescription) Save a search query to the users PNE on the content server.
ISCSCredentialValidateResponse	validateCredentials(ISCSContext SCSContext, java.lang.String userName, java.lang.String password) Validate user crendentials against the content server.
ISCSCredentialValidateResponse	validateCredentials(ISCSContext SCSContext, java.lang.String userName, java.lang.String password, boolean retrieveAccounts, boolean retrieveExtendedInfo) Validate user crendentials against the content server.
ISCSCredentialValidateResponse	validateCredentials(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String userName, java.lang.String password) Validate user crendentials against the content server.
ISCSCredentialValidateResponse	validateCredentials(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String userName, java.lang.String password, boolean retrieveAccounts, boolean retrieveExtendedInfo) Validate user crendentials against the content server.

Field Detail

API_CATEGORY

static final java.lang.String API_CATEGORY

Category for this Command API

See Also:

Constant Field Values

Method Detail

getObjectFactory

ICISAPIObjectFactory getObjectFactory()

Retrieve the object factory associated with this API

listRoles

ISCSRoleListResponse listRoles(ISCSContext SCSContext)
                               throws CommandException

List the available roles in the content server.

Parameters:

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: PING_SERVER"

listRoles

ISCSRoleListResponse listRoles(ISCSRequestModifier requestModifier,
                               ISCSContext SCSContext)
                               throws CommandException

List the available roles in the content server.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: PING_SERVER"

listUsers

ISCSUserListResponse listUsers(ISCSContext SCSContext)
                               throws CommandException

List the available users in the content server.

Parameters:

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_USERS"

listUsers

ISCSUserListResponse listUsers(ISCSRequestModifier requestModifier,
                               ISCSContext SCSContext)
                               throws CommandException

List the available users in the content server.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_USERS"

getPNEData

ISCSUserPNEResponse getPNEData(ISCSContext SCSContext)
                               throws CommandException

Retrieves the users PNE data binder which contains personal saved information, such as query parameters and query strings.

Parameters:

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: PING_SERVER"

getPNEData

ISCSUserPNEResponse getPNEData(ISCSRequestModifier requestModifier,
                               ISCSContext SCSContext)
                               throws CommandException

Retrieves the users PNE data binder which contains personal saved information, such as query parameters and query strings.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: PING_SERVER"

deleteSearchQuery

ISCSServerResponse deleteSearchQuery(ISCSContext SCSContext,
                                     java.lang.String queryTitle)
                                     throws CommandException

Removes search queries for a users PNE on the content server.

Parameters:

SCSContext - the context object representing the current user

queryTitle - the title of the query

Throws:

CommandException

See Also:

"Content Server Documentation for: SAVE_USER_TOPICS"

deleteSearchQuery

ISCSServerResponse deleteSearchQuery(ISCSRequestModifier requestModifier,
                                     ISCSContext SCSContext,
                                     java.lang.String queryTitle)
                                     throws CommandException

Removes search queries for a users PNE on the content server.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

queryTitle - the title of the query

Throws:

CommandException

See Also:

"Content Server Documentation for: SAVE_USER_TOPICS"

saveSearchQuery

ISCSServerResponse saveSearchQuery(ISCSContext SCSContext,
                                   java.lang.String queryTitle,
                                   java.lang.String queryText)
                                   throws CommandException

Save a search query to the users PNE on the content server.

Parameters:

SCSContext - the context object representing the current user

queryTitle - the title of the query

queryText - the query string

Throws:

CommandException

See Also:

"Content Server Documentation for: SAVE_USER_TOPICS"

saveSearchQuery

ISCSServerResponse saveSearchQuery(ISCSRequestModifier requestModifier,
                                   ISCSContext SCSContext,
                                   java.lang.String queryTitle,
                                   java.lang.String queryText)
                                   throws CommandException

Save a search query to the users PNE on the content server.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

queryTitle - the title of the query

queryText - the query string

Throws:

CommandException

See Also:

"Content Server Documentation for: SAVE_USER_TOPICS"

saveSearchQuery

ISCSServerResponse saveSearchQuery(ISCSContext SCSContext,
                                   java.lang.String queryTitle,
                                   java.lang.String queryText,
                                   java.lang.String queryDescription)
                                   throws CommandException

Save a search query to the users PNE on the content server.

Parameters:

SCSContext - the context object representing the current user

queryTitle - the title of the query

queryText - the query string

queryDescription - the query description

Throws:

CommandException

See Also:

"Content Server Documentation for: SAVE_USER_TOPICS"

saveSearchQuery

ISCSServerResponse saveSearchQuery(ISCSRequestModifier requestModifier,
                                   ISCSContext SCSContext,
                                   java.lang.String queryTitle,
                                   java.lang.String queryText,
                                   java.lang.String queryDescription)
                                   throws CommandException

Save a search query to the users PNE on the content server.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

queryTitle - the title of the query

queryText - the query string

queryDescription - the query description

Throws:

CommandException

See Also:

"Content Server Documentation for: SAVE_USER_TOPICS"

queryUserAttributes

ISCSQueryUserAttributesResponse queryUserAttributes(ISCSContext SCSContext,
                                                    java.lang.String userName)
                                                    throws CommandException

Returns user attributes for a specific user.

Parameters:

SCSContext - the context object representing the current user

userName - the user name

Throws:

CommandException

See Also:

"Content Server Documentation for: QUERY_USER_ATTRIBUTES"

queryUserAttributes

ISCSQueryUserAttributesResponse queryUserAttributes(ISCSRequestModifier requestModifier,
                                                    ISCSContext SCSContext,
                                                    java.lang.String userName)
                                                    throws CommandException

Returns user attributes for a specific user.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

userName - the user name

Throws:

CommandException

See Also:

"Content Server Documentation for: QUERY_USER_ATTRIBUTES"

createAlias

ISCSUserAliasActionResponse createAlias(ISCSContext SCSContext,
                                        ISCSUserAlias alias)
                                        throws CommandException

Command that creates a new alias.

Parameters:

SCSContext - the context object representing the current user

alias - the alias object

Throws:

CommandException

See Also:

"Content Server Documentation for: ADD_ALIAS"

createAlias

ISCSUserAliasActionResponse createAlias(ISCSRequestModifier requestModifier,
                                        ISCSContext SCSContext,
                                        ISCSUserAlias alias)
                                        throws CommandException

Command that creates a new alias.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

alias - the alias object

Throws:

CommandException

See Also:

"Content Server Documentation for: ADD_ALIAS"

createAlias

ISCSUserAliasActionResponse createAlias(ISCSContext SCSContext,
                                        ISCSUserAlias alias,
                                        java.util.List users)
                                        throws CommandException

Command that creates a new alias.

Parameters:

SCSContext - the context object representing the current user

alias - the alias object

users - a list of Strings containing the users to add to this alias

Throws:

CommandException

See Also:

"Content Server Documentation for: ADD_ALIAS"

createAlias

ISCSUserAliasActionResponse createAlias(ISCSRequestModifier requestModifier,
                                        ISCSContext SCSContext,
                                        ISCSUserAlias alias,
                                        java.util.List users)
                                        throws CommandException

Command that creates a new alias.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

alias - the alias object

users - a list of Strings containing the users to add to this alias

Throws:

CommandException

See Also:

"Content Server Documentation for: ADD_ALIAS"

createRole

ISCSUserRoleActionResponse createRole(ISCSContext SCSContext,
                                      ISCSUserRole userRole)
                                      throws CommandException

Add a role to the content server system.

Parameters:

SCSContext - the context object representing the current user

userRole - the user role object

Throws:

CommandException

See Also:

"Content Server Documentation for: ADD_ROLE"

createRole

ISCSUserRoleActionResponse createRole(ISCSRequestModifier requestModifier,
                                      ISCSContext SCSContext,
                                      ISCSUserRole userRole)
                                      throws CommandException

Add a role to the content server system.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

userRole - the user role object

Throws:

CommandException

See Also:

"Content Server Documentation for: ADD_ROLE"

createUser

ISCSUserActionResponse createUser(ISCSContext SCSContext,
                                  ISCSUserObject userObject)
                                  throws CommandException

Create a new user in the content server.

Parameters:

SCSContext - the context object representing the current user

userObject - The user object

Throws:

CommandException

See Also:

"Content Server Documentation for: ADD_USER"

createUser

ISCSUserActionResponse createUser(ISCSRequestModifier requestModifier,
                                  ISCSContext SCSContext,
                                  ISCSUserObject userObject)
                                  throws CommandException

Create a new user in the content server.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

userObject - The user object

Throws:

CommandException

See Also:

"Content Server Documentation for: ADD_USER"

createUser

ISCSUserActionResponse createUser(ISCSContext SCSContext,
                                  ISCSUserObject userObject,
                                  ISCSUserAttributeInfo userAttributeInfo)
                                  throws CommandException

Create a new user in the content server.

Parameters:

SCSContext - the context object representing the current user

userObject - The user object

userAttributeInfo - the user attribute info

Throws:

CommandException

See Also:

"Content Server Documentation for: ADD_USER"

createUser

ISCSUserActionResponse createUser(ISCSRequestModifier requestModifier,
                                  ISCSContext SCSContext,
                                  ISCSUserObject userObject,
                                  ISCSUserAttributeInfo userAttributeInfo)
                                  throws CommandException

Create a new user in the content server.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

userObject - The user object

userAttributeInfo - the user attribute info

Throws:

CommandException

See Also:

"Content Server Documentation for: ADD_USER"

deleteAlias

ISCSUserAliasActionResponse deleteAlias(ISCSContext SCSContext,
                                        java.lang.String name)
                                        throws CommandException

Command that deletes an existing alias. The most likely errors are when the alias is being used in the workflow or when the system is unable to delete the alias or the user.

Parameters:

SCSContext - the context object representing the current user

name - the name of the alias

Throws:

CommandException

See Also:

"Content Server Documentation for: DELETE_ALIAS"

deleteAlias

ISCSUserAliasActionResponse deleteAlias(ISCSRequestModifier requestModifier,
                                        ISCSContext SCSContext,
                                        java.lang.String name)
                                        throws CommandException

Command that deletes an existing alias. The most likely errors are when the alias is being used in the workflow or when the system is unable to delete the alias or the user.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

name - the name of the alias

Throws:

CommandException

See Also:

"Content Server Documentation for: DELETE_ALIAS"

deleteRole

ISCSUserRoleActionResponse deleteRole(ISCSContext SCSContext,
                                      java.lang.String roleName)
                                      throws CommandException

Delete a user role from the content server.

Parameters:

SCSContext - the context object representing the current user

roleName - the role name

Throws:

CommandException

See Also:

"Content Server Documentation for: DELETE_ROLE"

deleteRole

ISCSUserRoleActionResponse deleteRole(ISCSRequestModifier requestModifier,
                                      ISCSContext SCSContext,
                                      java.lang.String roleName)
                                      throws CommandException

Delete a user role from the content server.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

roleName - the role name

Throws:

CommandException

See Also:

"Content Server Documentation for: DELETE_ROLE"

deleteUser

ISCSUserActionResponse deleteUser(ISCSContext SCSContext,
                                  java.lang.String userName)
                                  throws CommandException

Delete a user from the content server.

Parameters:

SCSContext - the context object representing the current user

userName - the user name

Throws:

CommandException

See Also:

"Content Server Documentation for: DELETE_USER"

deleteUser

ISCSUserActionResponse deleteUser(ISCSRequestModifier requestModifier,
                                  ISCSContext SCSContext,
                                  java.lang.String userName)
                                  throws CommandException

Delete a user from the content server.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

userName - the user name

Throws:

CommandException

See Also:

"Content Server Documentation for: DELETE_USER"

editAlias

ISCSUserAliasActionResponse editAlias(ISCSContext SCSContext,
                                      ISCSUserAlias alias)
                                      throws CommandException

Command that modifies an existing alias. Note: Editing an alias will delete all existing data (Description and Users) from the alias. To retain existing data, you must include the existing data along with any new data.

Parameters:

SCSContext - the context object representing the current user

alias - the alias object

Throws:

CommandException

See Also:

"Content Server Documentation for: EDIT_ALIAS"

editAlias

ISCSUserAliasActionResponse editAlias(ISCSRequestModifier requestModifier,
                                      ISCSContext SCSContext,
                                      ISCSUserAlias alias)
                                      throws CommandException

Command that modifies an existing alias. Note: Editing an alias will delete all existing data (Description and Users) from the alias. To retain existing data, you must include the existing data along with any new data.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

alias - the alias object

Throws:

CommandException

See Also:

"Content Server Documentation for: EDIT_ALIAS"

editAlias

ISCSUserAliasActionResponse editAlias(ISCSContext SCSContext,
                                      ISCSUserAlias alias,
                                      java.util.List users)
                                      throws CommandException

Command that modifies an existing alias. Note: Editing an alias will delete all existing data (Description and Users) from the alias. To retain existing data, you must include the existing data along with any new data.

Parameters:

SCSContext - the context object representing the current user

alias - the alias object

users - a list of Strings containing the users to add to this alias

Throws:

CommandException

See Also:

"Content Server Documentation for: EDIT_ALIAS"

editAlias

ISCSUserAliasActionResponse editAlias(ISCSRequestModifier requestModifier,
                                      ISCSContext SCSContext,
                                      ISCSUserAlias alias,
                                      java.util.List users)
                                      throws CommandException

Command that modifies an existing alias. Note: Editing an alias will delete all existing data (Description and Users) from the alias. To retain existing data, you must include the existing data along with any new data.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

alias - the alias object

users - a list of Strings containing the users to add to this alias

Throws:

CommandException

See Also:

"Content Server Documentation for: EDIT_ALIAS"

editRole

ISCSUserRoleActionResponse editRole(ISCSContext SCSContext,
                                    ISCSUserRole userRole)
                                    throws CommandException

Edit the user role information.

Parameters:

SCSContext - the context object representing the current user

userRole - the user role object

Throws:

CommandException

See Also:

"Content Server Documentation for: EDIT_ROLE"

editRole

ISCSUserRoleActionResponse editRole(ISCSRequestModifier requestModifier,
                                    ISCSContext SCSContext,
                                    ISCSUserRole userRole)
                                    throws CommandException

Edit the user role information.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

userRole - the user role object

Throws:

CommandException

See Also:

"Content Server Documentation for: EDIT_ROLE"

editUser

ISCSUserActionResponse editUser(ISCSContext SCSContext,
                                ISCSUserObject userObject)
                                throws CommandException

Command that modifies an existing user.
Note: Editing a user will delete all existing user attributes (role and account permissions). To retain existing attributes, you must include the existing attributes along with any new or changed data. If user attributes are not defined, the user will belong to no roles or accounts, and will become a guest in the system.

Parameters:

SCSContext - the context object representing the current user

userObject - The user object

Throws:

CommandException

See Also:

"Content Server Documentation for: EDIT_USER"

editUser

ISCSUserActionResponse editUser(ISCSRequestModifier requestModifier,
                                ISCSContext SCSContext,
                                ISCSUserObject userObject)
                                throws CommandException

Command that modifies an existing user.
Note: Editing a user will delete all existing user attributes (role and account permissions). To retain existing attributes, you must include the existing attributes along with any new or changed data. If user attributes are not defined, the user will belong to no roles or accounts, and will become a guest in the system.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

userObject - The user object

Throws:

CommandException

See Also:

"Content Server Documentation for: EDIT_USER"

editUser

ISCSUserActionResponse editUser(ISCSContext SCSContext,
                                ISCSUserObject userObject,
                                ISCSUserAttributeInfo userAttributeInfo)
                                throws CommandException

Command that modifies an existing user.
Note: Editing a user will delete all existing user attributes (role and account permissions). To retain existing attributes, you must include the existing attributes along with any new or changed data. If user attributes are not defined, the user will belong to no roles or accounts, and will become a guest in the system.

Parameters:

SCSContext - the context object representing the current user

userObject - The user object

userAttributeInfo - the user attribute info

Throws:

CommandException

See Also:

"Content Server Documentation for: EDIT_USER"

editUser

ISCSUserActionResponse editUser(ISCSRequestModifier requestModifier,
                                ISCSContext SCSContext,
                                ISCSUserObject userObject,
                                ISCSUserAttributeInfo userAttributeInfo)
                                throws CommandException

Command that modifies an existing user.
Note: Editing a user will delete all existing user attributes (role and account permissions). To retain existing attributes, you must include the existing attributes along with any new or changed data. If user attributes are not defined, the user will belong to no roles or accounts, and will become a guest in the system.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

userObject - The user object

userAttributeInfo - the user attribute info

Throws:

CommandException

See Also:

"Content Server Documentation for: EDIT_USER"

listAliases

ISCSUserListAliasesResponse listAliases(ISCSContext SCSContext)
                                        throws CommandException

List the available aliases in the content server.

Parameters:

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_ALIASES"

listAliases

ISCSUserListAliasesResponse listAliases(ISCSRequestModifier requestModifier,
                                        ISCSContext SCSContext)
                                        throws CommandException

List the available aliases in the content server.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_ALIASES"

registerUser

ISCSUserActionResponse registerUser(ISCSContext SCSContext,
                                    ISCSUserObject userObject)
                                    throws CommandException

Command that registers a user. If only the user name parameter is provided, the new user will be a local user with the guest role and a blank password.

Parameters:

SCSContext - the context object representing the current user

userObject - the user object

Throws:

CommandException

See Also:

"Content Server Documentation for: REGISTER_USER"

registerUser

ISCSUserActionResponse registerUser(ISCSRequestModifier requestModifier,
                                    ISCSContext SCSContext,
                                    ISCSUserObject userObject)
                                    throws CommandException

Command that registers a user. If only the user name parameter is provided, the new user will be a local user with the guest role and a blank password.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

userObject - the user object

Throws:

CommandException

See Also:

"Content Server Documentation for: REGISTER_USER"

validateCredentials

ISCSCredentialValidateResponse validateCredentials(ISCSContext SCSContext,
                                                   java.lang.String userName,
                                                   java.lang.String password)
                                                   throws CommandException

Validate user crendentials against the content server. Also, will retrieve extended information about a user. Note: user only authenticated if the password property is set; set to null to skip the authenticate process.

Parameters:

SCSContext - the context object representing the current user

userName - the username of the user to authenticate

password - the password of the user to authenticate, set to null to perform no authentication

Throws:

CommandException

See Also:

"Content Server Documentation for: CHECK_USER_CREDENTIALS"

validateCredentials

ISCSCredentialValidateResponse validateCredentials(ISCSRequestModifier requestModifier,
                                                   ISCSContext SCSContext,
                                                   java.lang.String userName,
                                                   java.lang.String password)
                                                   throws CommandException

Validate user crendentials against the content server. Also, will retrieve extended information about a user. Note: user only authenticated if the password property is set; set to null to skip the authenticate process.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

userName - the username of the user to authenticate

password - the password of the user to authenticate, set to null to perform no authentication

Throws:

CommandException

See Also:

"Content Server Documentation for: CHECK_USER_CREDENTIALS"

validateCredentials

ISCSCredentialValidateResponse validateCredentials(ISCSContext SCSContext,
                                                   java.lang.String userName,
                                                   java.lang.String password,
                                                   boolean retrieveAccounts,
                                                   boolean retrieveExtendedInfo)
                                                   throws CommandException

Validate user crendentials against the content server. Also, will retrieve extended information about a user. Note: user only authenticated if the password property is set; set to null to skip the authenticate process.

Parameters:

SCSContext - the context object representing the current user

userName - the username of the user to authenticate

password - the password of the user to authenticate, set to null to perform no authentication

retrieveAccounts - if true retrieves the user accounts

retrieveExtendedInfo - if true retrieves extended user information (full name, e-mail address, locale, and user type)

Throws:

CommandException

See Also:

"Content Server Documentation for: CHECK_USER_CREDENTIALS"

validateCredentials

ISCSCredentialValidateResponse validateCredentials(ISCSRequestModifier requestModifier,
                                                   ISCSContext SCSContext,
                                                   java.lang.String userName,
                                                   java.lang.String password,
                                                   boolean retrieveAccounts,
                                                   boolean retrieveExtendedInfo)
                                                   throws CommandException

Validate user crendentials against the content server. Also, will retrieve extended information about a user. Note: user only authenticated if the password property is set; set to null to skip the authenticate process.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

userName - the username of the user to authenticate

password - the password of the user to authenticate, set to null to perform no authentication

retrieveAccounts - if true retrieves the user accounts

retrieveExtendedInfo - if true retrieves extended user information (full name, e-mail address, locale, and user type)

Throws:

CommandException

See Also:

"Content Server Documentation for: CHECK_USER_CREDENTIALS"

_createUser

ISCSUserObject _createUser()

Create a new user object.

Returns:

a new user object

_createUserAttributeInfo

ISCSUserAttributeInfo _createUserAttributeInfo()

Create a new user attribute info object.

Returns:

a new user attribute info object

_createRole

ISCSUserRole _createRole()

Create a new user role object.

Returns:

a new user role object

_createAccount

ISCSUserAccount _createAccount()

Create a new user account object.

Returns:

a new user account object

_createUserAlias

ISCSUserAlias _createUserAlias()

Create a new user alias object.

Returns:

a new alias object

_createUserAliasMapping

ISCSUserAliasMapping _createUserAliasMapping()

Create a new user alias mapping object.

Returns:

a new alias mapping object