tcUserOperationsIntf (Thor.API.Operations Javadoc)

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Thor.API.Operations
Interface tcUserOperationsIntf

public interface tcUserOperationsIntf

Method Summary
`boolean`	`canResourceBeProvisioned(long userKey, long objectKey)` Determines if a resource can be provisioned to a user or not.
`void`	`changeFromServiceAccount(long plObjectInstanceForUserKey)` Changes a service account to a regular account.
`void`	`changePasswordforSelf(java.lang.String psOldPwd, java.lang.String psNewPwd, java.lang.String psConfirmPwd)` Changes the password of the current user.
`void`	`changePasswordForSelf(java.lang.String psOldPwd, java.lang.String psNewPwd, java.lang.String psConfirmPwd)` Changes the password of the current user.
`void`	`changeToServiceAccount(long plObjectInstanceForUserKey)` Changes a regular account to a service account.
`boolean`	`compareChallengeValuesForSelf(java.util.Map phQuestionAnswer)` Compares the questions/answers entered by the user against the ones stored in the database
`long`	`createUser(java.util.Map phMapping)` Creates a user in Xellerate with the specified attributes.
`void`	`deleteProxies(long userKey)` This method deletes all the proxies setup for the given user.
`void`	`deleteUser(long plUserKey)` Delete a user in Xellerate.
`void`	`deleteUsers(long[] paUserKeys)` Deletes users in Xellerate.
`void`	`disableAppForUser(long plUserKey, long plObjectInstanceForUserKey)` Disables the object instance for the specified user.
`void`	`disableAppsForUser(long plUserKey, long[] paObjectInstancesForUserKey)` Disables the object instances for the specified user.
`void`	`disableUser(long plUserKey)` Disable a user in Xellerate.
`void`	`disableUsers(long[] paUserKeys)` Disable users in Xellerate.
`void`	`enableAppForUser(long plUserKey, long plObjectInstanceForUserKey)` Enables the object instance for the specified user.
`void`	`enableAppsForUser(long plUserKey, long[] paObjectInstancesForUserKey)` Enables the object instances for the specified user.
`void`	`enableUser(long plUserKey)` Enable a user in Xellerate.
`void`	`enableUsers(long[] paUserKeys)` Enable users in Xellerate.
`Thor.API.tcResultSet`	`findAllUsers(java.util.Map phAttributeList)` Returns a list of users that match the provided attribute list.
`Thor.API.tcResultSet`	`findAllUsersFiltered(java.util.Map phAttributeList, java.lang.String[] pasFieldList)` Returns a list of users that match the provided attribute list.
`Thor.API.tcResultSet`	`findUsers(java.util.Map phAttributeList)` Returns a list of users that match the provided attribute list.
`Thor.API.tcResultSet`	`findUsers(java.util.Map phAttributeList, java.lang.String permission)` Returns a list of users that match the provided attribute list.
`Thor.API.tcResultSet`	`findUsers(java.util.Map phAttributeList, java.lang.String permission, java.lang.String[] status)` Returns a list of users that match the provided attribute list and status.
`Thor.API.tcResultSet`	`findUsersFiltered(java.util.Map phAttributeList, java.lang.String[] pasFieldList)` Returns a list of users that match the provided attribute list.
`Thor.API.tcResultSet`	`findUsersFiltered(java.util.Map phAttributeList, java.lang.String[] pasFieldList, int startRow, int pageSize, java.lang.String[] order, boolean ascendingOrder)` Returns a list of users that match the provided attribute list.
`int`	`findUsersFilteredCount(java.util.Map phAttributeList, java.lang.String[] pasFieldList)` Returns a count of users that match the provided attribute list.
`Thor.API.tcResultSet`	`getActiveUsers(java.util.Map attributes)` Returns a list of active users in the system.
`Thor.API.tcResultSet`	`getAvailableObjects(long[] palUserKeys)` Returns a list of resource objects that can be provisioned to a specified list of users
`Thor.API.tcResultSet`	`getAvailableObjects(long[] palUserKeys, java.util.Map attributes)` Returns a list of resource objects that can be provisioned to a specified list of users
`Thor.API.tcResultSet`	`getAvailableObjectsForSelf()` This object returns a resultset of the objects available for the current login user.
`Thor.API.tcResultSet`	`getAvailableObjectsForUser(long[] palUserKeys)` This object returns a resultset of the objects available for the given array of users.
`Thor.API.tcResultSet`	`getChallengeValuesForSelf()` Returns a resultset of the questions and answers
`Thor.API.tcResultSet`	`getEncodedValue(java.lang.String strDecodeVal, java.lang.String strFieldName)` This object returns a resultset of the object available for the given encoded value.
`Thor.API.tcResultSet`	`getGroups(long plUserKey)` Gets a list of all the groups the user is a member of.
`Thor.API.tcResultSet`	`getMenuList(long plUserKey)` Retrieves a list of web application menu items that users have access to based on their group membership.
`Thor.API.tcResultSet`	`getMenuListForSelf()` Retrieves a list of web application menu items for the logged in user.
`Thor.API.tcResultSet`	`getObjectAuthorizationPermissions(long plUserKey)` Returns a list of Objects the user has authorization control over, based on the group membership of the user.
`Thor.API.tcResultSet`	`getObjects(long plUserKey)` Gets a list of all the objects that have been provisioned for a user.
`Thor.API.tcResultSet`	`getObjectsByType(long plUserKey, java.lang.String psObjectType)` Gets a list of all the objects of the specified type that have been provisioned for a user.
`Thor.API.tcResultSet`	`getObjectsByTypeStatus(long plUserKey, java.lang.String psObjectType, java.lang.String psStatus)` Gets a list of all the objects of the specified type that have been provisioned for a user and are in the specified status.
`Thor.API.tcResultSet`	`getProxiedUser(long userKey)` This method will return the detail information of only the current proxied user by the specified user.
`Thor.API.tcResultSet`	`getProxyDetails(long userKey)` This method will return the detail information of the proxy assigned to the specified user.
`Thor.API.tcResultSet`	`getSelfProfile()` Returns the current logon user's profile.
`Thor.API.tcResultSet`	`getSelfProfileFiltered(java.lang.String[] pasFieldList)` Returns the current logon user's profile.
`Thor.API.tcResultSet`	`getUnAssignedGroups(long plUserKey)` Gets a list of all the groups the user is not a member of.
`java.lang.String[]`	`getUserFromObjectInfo(java.lang.String psObjName, java.lang.String psColumnName, java.lang.String psColumnValue)` Locates User Record(s) in Xellerate based on data for a provisioned object.
`boolean`	`isChallengeQuestionsSetForSelf()` Check if challenge questions are set for the current user.
`void`	`moveServiceAccount(long plObjectInstanceForUserKey, long plTargetUserKey)` Moves the service account from its current owner to a new owner.
`long`	`provisionObject(long plUserKey, long plObjectKey)` Provision an object for a user directly without going through a request.
`long`	`provisionObject(long plUserKey, long plObjectKey, boolean pbServiceAccount)` Provision an object for a user directly without going through a request.
`com.thortech.xl.vo.ResourceData`	`provisionResource(long plUserKey, long plObjectKey)` Provision an object for a user directly without going through a request.
`com.thortech.xl.vo.ResourceData`	`provisionResource(long plUserKey, long plObjectKey, boolean pbServiceAccount)` Provision an object for a user directly without going through a request.
`void`	`revokeObject(long plUserKey, long plObjectInstanceForUserKey)` Revokes the provisioning of an object for a user directly without going through a request.
`void`	`revokeObjects(long plUserKey, long[] paObjectInstancesForUserKey)` Revokes the provisioning of an object for a user directly without going through a request.
`void`	`setChallengeValuesForSelf(java.util.Map phQuestionAnswer)` Set the challenge questions and answers for the logged in user.
`long`	`setProxyForUser(long userKey, long proxyUserKey, java.util.Date startDate, java.util.Date endDate)` This new method will set the specified user as a proxy for the specified user.
`void`	`unlockUsers(long[] paUserKeys)` Enable users in Xellerate by unlocking their accounts if they are locked.
`void`	`updateProxyForUser(long pxdKey, java.util.Map attribute)` This new method will update the specified user as a proxy for the specified user.
`void`	`updateUser(Thor.API.tcResultSet poUserResultSet, java.util.Map phAttributeList)` Update a user in Xellerate.

Method Detail

createUser

public long createUser(java.util.Map phMapping)
                throws Thor.API.Exceptions.tcAPIException,
                       Thor.API.Exceptions.tcDuplicateUserException,
                       Thor.API.Exceptions.tcAttributeMissingException,
                       Thor.API.Exceptions.tcInvalidAttributeException,
                       tcAPIException

Creates a user in Xellerate with the specified attributes.

Parameters:: phMapping - An array of mapping objects, each representing an attribute to set in the user. Please note that if the same attribute is specified twice in the array, the later instance found will be used.
Returns:: The User Key of the newly created user.
Throws:: tcAPIException; tcDuplicateUserException; tcAttributeMissingException; tcInvalidAttributeException

deleteUser

public void deleteUser(long plUserKey)
                throws Thor.API.Exceptions.tcAPIException,
                       Thor.API.Exceptions.tcUserNotFoundException,
                       tcAPIException

Delete a user in Xellerate.

Parameters:: plUserKey - The key of the user to delete.
Throws:: tcAPIException; tcUserNotFoundException

deleteUsers

public void deleteUsers(long[] paUserKeys)
                 throws Thor.API.Exceptions.tcAPIException,
                        Thor.API.Exceptions.tcUserNotFoundException,
                        Thor.API.Exceptions.tcBulkException,
                        tcAPIException

Deletes users in Xellerate.

Parameters:: paUserKeys - The array key of the users to delete.
Throws:: tcAPIException; tcUserNotFoundException; tcBulkException

disableUser

public void disableUser(long plUserKey)
                 throws Thor.API.Exceptions.tcAPIException,
                        Thor.API.Exceptions.tcUserNotFoundException,
                        tcAPIException

Disable a user in Xellerate.

Parameters:: plUserKey - The key of the user to disable.
Throws:: tcAPIException; tcUserNotFoundException

disableUsers

public void disableUsers(long[] paUserKeys)
                  throws Thor.API.Exceptions.tcAPIException,
                         Thor.API.Exceptions.tcUserNotFoundException,
                         Thor.API.Exceptions.tcBulkException,
                         tcAPIException

Disable users in Xellerate.

Parameters:: paUserKeys - The key array of the users to disable.
Throws:: tcAPIException; tcUserNotFoundException; tcBulkException

enableUser

public void enableUser(long plUserKey)
                throws Thor.API.Exceptions.tcAPIException,
                       Thor.API.Exceptions.tcUserNotFoundException,
                       tcAPIException

Enable a user in Xellerate.

Parameters:: plUserKey - The key of the user to enable.
Throws:: tcAPIException; tcUserNotFoundException

enableUsers

public void enableUsers(long[] paUserKeys)
                 throws Thor.API.Exceptions.tcAPIException,
                        Thor.API.Exceptions.tcUserNotFoundException,
                        Thor.API.Exceptions.tcBulkException,
                        tcAPIException

Enable users in Xellerate.

Parameters:: paUserKeys - The key array of users to enable.
Throws:: tcAPIException; tcUserNotFoundException; tcBulkException

changePasswordforSelf

public void changePasswordforSelf(java.lang.String psOldPwd,
                                  java.lang.String psNewPwd,
                                  java.lang.String psConfirmPwd)
                           throws Thor.API.Exceptions.tcAPIException,
                                  Thor.API.Exceptions.tcPasswordIncorrectException,
                                  Thor.API.Exceptions.tcPasswordMismatchException,
                                  Thor.API.Exceptions.tcPasswordPolicyException,
                                  tcAPIException

Changes the password of the current user. The following condition should be validated before changing the user's password:

psNewPwd and psConfirmPwd should be the same
psOldPwd should match the current password

Parameters:: psOldPwd - is current user's password; psNewPwd - is the new password to assign to the user; psConfirmPwd - is the confirmed new password. This should match the psNewPwd
Throws:: tcAPIException; tcPasswordIncorrectException - error raise in case password is incorrect; tcPasswordMismatchException - error raise in case password does not match; tcPasswordPolicyException - error if policy attached with passowrd fail.

changePasswordForSelf

public void changePasswordForSelf(java.lang.String psOldPwd,
                                  java.lang.String psNewPwd,
                                  java.lang.String psConfirmPwd)
                           throws Thor.API.Exceptions.tcAPIException,
                                  Thor.API.Exceptions.tcPasswordIncorrectException,
                                  Thor.API.Exceptions.tcPasswordMismatchException,
                                  Thor.API.Exceptions.tcPasswordPolicyException,
                                  tcAPIException

Changes the password of the current user. The following condition should be validated before changing the user's password:

psNewPwd and psConfirmPwd should be the same
psOldPwd should match the current password

Parameters:: psOldPwd - is current user's password; psNewPwd - is the new password to assign to the user; psConfirmPwd - is the confirmed new password. This should match the psNewPwd
Throws:: tcAPIException; tcPasswordIncorrectException; tcPasswordMismatchException; tcPasswordPolicyException

getAvailableObjectsForSelf

public Thor.API.tcResultSet getAvailableObjectsForSelf()
                                                throws Thor.API.Exceptions.tcAPIException,
                                                       tcAPIException

This object returns a resultset of the objects available for the current login user.

Returns:: tcResultSet of the available objects for the current user
Throws:: tcAPIException; tcDataSetException

getAvailableObjectsForUser

public Thor.API.tcResultSet getAvailableObjectsForUser(long[] palUserKeys)
                                                throws Thor.API.Exceptions.tcUserNotFoundException,
                                                       Thor.API.Exceptions.tcAPIException,
                                                       tcAPIException

This object returns a resultset of the objects available for the given array of users.

Parameters:: palUserKeys - an array of user keys to get available objects. If a null or empty array is passed, this function will raise the tcAPIException
Returns:: tcResultSet of the available objects for the current user
Throws:: tcUserNotFoundException; tcAPIException

getAvailableObjects

public Thor.API.tcResultSet getAvailableObjects(long[] palUserKeys)
                                         throws Thor.API.Exceptions.tcUserNotFoundException,
                                                Thor.API.Exceptions.tcAPIException,
                                                tcAPIException

Returns a list of resource objects that can be provisioned to a specified list of users

Parameters:: palUserKeys - an array of user keys
Returns:: a tcResultSet that contains the available objects for the given list of users
Throws:: tcUserNotFoundException; tcAPIException

getAvailableObjects

public Thor.API.tcResultSet getAvailableObjects(long[] palUserKeys,
                                                java.util.Map attributes)
                                         throws Thor.API.Exceptions.tcUserNotFoundException,
                                                Thor.API.Exceptions.tcAPIException,
                                                tcAPIException

Returns a list of resource objects that can be provisioned to a specified list of users

Parameters:: palUserKeys - an array of user keys; attributes - is the attribute map to filter the result set
Returns:: a tcResultSet that contains the available objects for the given list of users
Throws:: tcUserNotFoundException; tcAPIException

getSelfProfile

public Thor.API.tcResultSet getSelfProfile()
                                    throws Thor.API.Exceptions.tcAPIException,
                                           tcAPIException

Returns the current logon user's profile.

Returns:

A tcResultSet that contains user-defined columns as well as the following user-related information:

Organizations.Key
Organizations.Organization Name
Users.AD Reference
Users.Creation Date
Users.Deprovisioned Date
Users.Deprovisioning Date
Users.Disable User
Users.End Date
Users.First Name
Users.Identity
Users.Key
Users.Last Name
Users.Manager Key
Users.Manager Login
Users.Manager First Name
Users.Manager Last Name
Users.Middle Name
Users.Note
Users.Provisioned Date
Users.Provisioning Date
Users.Role
Users.Row Version
Users.Start Date
Users.Status
Users.Update Date
Users.Updated By
Users.User ID
Users.Xellerate Type
Users.Lock User
Users.Email

Throws:

tcAPIException

getSelfProfileFiltered

public Thor.API.tcResultSet getSelfProfileFiltered(java.lang.String[] pasFieldList)
                                            throws Thor.API.Exceptions.tcAPIException,
                                                   tcAPIException

Returns the current logon user's profile. The fields returned in the tcResultSet can be specified.

Parameters:

pasFieldList - The list of fields that is to be returned in the tcResultSet.

Returns:

A tcResultSet that contains the fields specified in pasFieldList. Returned tcResultSet always contains

Users.Key
Users.Row Version

Throws:

tcDataSetException

Thor.API.Exceptions.tcAPIException

findUsers

public Thor.API.tcResultSet findUsers(java.util.Map phAttributeList)
                               throws Thor.API.Exceptions.tcAPIException,
                                      tcAPIException

Returns a list of users that match the provided attribute list.

Parameters:

phAttributeList - A Map of attribute-value pairs with each entry containing criteria to find users. The Map key should contain a String representation of the metadata codes and/or user-defined columns. The metadata codes are listed below in the contents of the returned tcResultSet. The Map value can contain a String representation of the criteria to find the desired requests. Note that the Map values can include wild cards(%).

Returns:

A tcResultSet that contains user-defined columns as well as the following user-related information:

Organizations.Key
Organizations.Organization Name
Users.AD Reference
Users.Creation Date
Users.Deprovisioned Date
Users.Deprovisioning Date
Users.Disable User
Users.End Date
Users.First Name
Users.Identity
Users.Key
Users.Last Name
Users.Manager Key
Users.Manager Login
Users.Manager First Name
Users.Manager Last Name
Users.Middle Name
Users.Note
Users.Provisioned Date
Users.Provisioning Date
Users.Role
Users.Row Version
Users.Start Date
Users.Status
Users.Update Date
Users.Updated By
Users.User ID
Users.Xellerate Type
Users.Lock User
Users.Email

Throws:

tcAPIException

findUsers

public Thor.API.tcResultSet findUsers(java.util.Map phAttributeList,
                                      java.lang.String permission)
                               throws Thor.API.Exceptions.tcAPIException,
                                      tcAPIException

Returns a list of users that match the provided attribute list.

Parameters:

permission - - the value of permission could be Write, Read, or Delete. It return groups based on the permission.

Returns:

A tcResultSet that contains user-defined columns as well as the following user-related information:

Organizations.Key
Organizations.Organization Name
Users.AD Reference
Users.Creation Date
Users.Deprovisioned Date
Users.Deprovisioning Date
Users.Disable User
Users.End Date
Users.First Name
Users.Identity
Users.Key
Users.Last Name
Users.Manager Key
Users.Manager Login
Users.Manager First Name
Users.Manager Last Name
Users.Middle Name
Users.Note
Users.Provisioned Date
Users.Provisioning Date
Users.Role
Users.Row Version
Users.Start Date
Users.Status
Users.Update Date
Users.Updated By
Users.User ID
Users.Xellerate Type
Users.Lock User
Users.Email

Throws:

tcAPIException

findUsers

public Thor.API.tcResultSet findUsers(java.util.Map phAttributeList,
                                      java.lang.String permission,
                                      java.lang.String[] status)
                               throws Thor.API.Exceptions.tcAPIException,
                                      tcAPIException

Returns a list of users that match the provided attribute list and status.

Parameters:

phAttributeList - attribute-value pairs with each entry containing criteria to find users

permission - - the value of permission could be Write, Read, or Delete. It return groups based on the permission.

status - an array of user statuses to filter

Returns:

A tcResultSet that contains user-defined columns as well as the following user-related information:

Organizations.Key
Organizations.Organization Name
Users.AD Reference
Users.Creation Date
Users.Deprovisioned Date
Users.Deprovisioning Date
Users.Disable User
Users.End Date
Users.First Name
Users.Identity
Users.Key
Users.Last Name
Users.Manager Key
Users.Manager Login
Users.Manager First Name
Users.Manager Last Name
Users.Middle Name
Users.Note
Users.Provisioned Date
Users.Provisioning Date
Users.Role
Users.Row Version
Users.Start Date
Users.Status
Users.Update Date
Users.Updated By
Users.User ID
Users.Xellerate Type
Users.Lock User
Users.Email

Throws:

tcAPIException

findUsersFiltered

public Thor.API.tcResultSet findUsersFiltered(java.util.Map phAttributeList,
                                              java.lang.String[] pasFieldList,
                                              int startRow,
                                              int pageSize,
                                              java.lang.String[] order,
                                              boolean ascendingOrder)
                                       throws Thor.API.Exceptions.tcAPIException,
                                              tcAPIException

Returns a list of users that match the provided attribute list. The fields returned in the tcResultSet can be specified.

Parameters:

pasFieldList - The list of fields that is to be returned in the tcResultSet. This can include user-defined fields as well as any of the following metadata codes:

Organizations.Key
Organizations.Organization Name
Users.AD Reference
Users.Creation Date
Users.Deprovisioned Date
Users.Deprovisioning Date
Users.Disable User
Users.End Date
Users.First Name
Users.Identity
Users.Key
Users.Last Name
Users.Manager Key
Users.Manager Login
Users.Middle Name
Users.Note
Users.Provisioned Date
Users.Provisioning Date
Users.Role
Users.Row Version
Users.Start Date
Users.Status
Users.Update Date
Users.Updated By
Users.User ID
Users.Xellerate Type

startRow - The starting row of the result

pageSize - The page size (how many rows to return)

order - The order in which the result set is based since only a subset of the whole matching set is returned, the caller will not be able to sort accurately with only that subset.

ascendingOrder - - a boolean value if the sorting is to be ascending or descending

Returns:

A tcResultSet that contains the fields specified in pasFieldList.

Throws:

tcAPIException

findUsersFiltered

public Thor.API.tcResultSet findUsersFiltered(java.util.Map phAttributeList,
                                              java.lang.String[] pasFieldList)
                                       throws Thor.API.Exceptions.tcAPIException,
                                              tcAPIException

Returns a list of users that match the provided attribute list. The fields returned in the tcResultSet can be specified.

Parameters:

pasFieldList - The list of fields that is to be returned in the tcResultSet. This can include user-defined fields as well as any of the following metadata codes:

Organizations.Key
Organizations.Organization Name
Users.AD Reference
Users.Creation Date
Users.Deprovisioned Date
Users.Deprovisioning Date
Users.Disable User
Users.End Date
Users.First Name
Users.Identity
Users.Key
Users.Last Name
Users.Manager Key
Users.Manager Login
Users.Middle Name
Users.Note
Users.Provisioned Date
Users.Provisioning Date
Users.Role
Users.Row Version
Users.Start Date
Users.Status
Users.Update Date
Users.Updated By
Users.User ID
Users.Xellerate Type

Returns:

A tcResultSet that contains the fields specified in pasFieldList.

Throws:

tcAPIException

findUsersFilteredCount

public int findUsersFilteredCount(java.util.Map phAttributeList,
                                  java.lang.String[] pasFieldList)
                           throws Thor.API.Exceptions.tcAPIException,
                                  tcAPIException

Returns a count of users that match the provided attribute list. Returns an int holding the number of rows.

Parameters:

pasFieldList - The list of fields that is to be returned in the tcResultSet. This can include user-defined fields as well as any of the following metadata codes:

Organizations.Key
Organizations.Organization Name
Users.AD Reference
Users.Creation Date
Users.Deprovisioned Date
Users.Deprovisioning Date
Users.Disable User
Users.End Date
Users.First Name
Users.Identity
Users.Key
Users.Last Name
Users.Manager Key
Users.Manager Login
Users.Middle Name
Users.Note
Users.Provisioned Date
Users.Provisioning Date
Users.Role
Users.Row Version
Users.Start Date
Users.Status
Users.Update Date
Users.Updated By
Users.User ID
Users.Xellerate Type

Returns:

An int holding the number of rows

Throws:

tcAPIException

getGroups

public Thor.API.tcResultSet getGroups(long plUserKey)
                               throws Thor.API.Exceptions.tcAPIException,
                                      Thor.API.Exceptions.tcUserNotFoundException,
                                      tcAPIException

Gets a list of all the groups the user is a member of.

Parameters:: plUserKey - Value holding the User Key (corresponds to value in the USR_KEY column)
Returns:: A tcResultSet each row holding information about a group the user is a member of.
Throws:: tcAPIException; tcUserNotFoundException

getObjectAuthorizationPermissions

public Thor.API.tcResultSet getObjectAuthorizationPermissions(long plUserKey)
                                                       throws Thor.API.Exceptions.tcAPIException,
                                                              Thor.API.Exceptions.tcUserNotFoundException,
                                                              tcAPIException

Returns a list of Objects the user has authorization control over, based on the group membership of the user.

Parameters:: plUserKey - The key of the user.
Returns:: A tcResultSet containing a list of Objects that the User has authorization permissions for.
Throws:: tcAPIException; tcUserNotFoundException

getObjects

public Thor.API.tcResultSet getObjects(long plUserKey)
                                throws Thor.API.Exceptions.tcAPIException,
                                       Thor.API.Exceptions.tcUserNotFoundException,
                                       tcAPIException

Gets a list of all the objects that have been provisioned for a user.

Parameters:

plUserKey - Value holding the User Key (corresponds to value in the USR_KEY column)

Returns:

A tcResultSet, each row holding information about an object that has been provisioned for a user. The following columns are returned

Users-Object Instance For User.Key
Users-Object Instance For User.Offlined Date
Object Instance.Key
Object Instance.Status
Objects.Key
Objects.Name
Process Instance.Key
Process Instance.Update Date
Process Instance.Status
Process Instance.Descriptive Data
Objects.Object Status.Status
Objects.Object Form Key
Object Instance.Object Form Entries
Objects.Object Form Name
Process.Process Definition.Process Form Key
Process Instance.Process Form Entries
Process.Process Definition.Process Form Name
Users-Object Instance For User.Service Account Flag
Throws:
tcAPIException
tcUserNotFoundException

getObjectsByType

public Thor.API.tcResultSet getObjectsByType(long plUserKey,
                                             java.lang.String psObjectType)
                                      throws Thor.API.Exceptions.tcAPIException,
                                             Thor.API.Exceptions.tcUserNotFoundException,
                                             tcAPIException

Gets a list of all the objects of the specified type that have been provisioned for a user.

Parameters:: plUserKey - Value holding the User Key (corresponds to value in the USR_KEY column); psObjectType - The type of the Object to look for
Returns:: A tcResultSet, each row holding information about an object that has been provisioned for a user.
Throws:: tcAPIException; tcUserNotFoundException

getObjectsByTypeStatus

public Thor.API.tcResultSet getObjectsByTypeStatus(long plUserKey,
                                                   java.lang.String psObjectType,
                                                   java.lang.String psStatus)
                                            throws Thor.API.Exceptions.tcAPIException,
                                                   Thor.API.Exceptions.tcUserNotFoundException,
                                                   tcAPIException

Gets a list of all the objects of the specified type that have been provisioned for a user and are in the specified status.

Parameters:: plUserKey - Value holding the User Key (corresponds to value in the USR_KEY column); psObjectType - The type of the Object to look for; psStatus - String holding the status the objects retrieved should be in
Returns:: A tcResultSet, each row holding information about an object that has been provisioned for a user.
Throws:: tcAPIException; tcUserNotFoundException

getUserFromObjectInfo

public java.lang.String[] getUserFromObjectInfo(java.lang.String psObjName,
                                                java.lang.String psColumnName,
                                                java.lang.String psColumnValue)
                                         throws Thor.API.Exceptions.tcAPIException,
                                                tcAPIException

Locates User Record(s) in Xellerate based on data for a provisioned object.

Parameters:: psObjName - The name of object whose data the user is to be located based on. This corresponds to the name of an object defined in Xellerate.; psColumnName - The descriptive name of the column as specified in the Structure Utility; psColumnValue - The value to search for
Returns:: A List containing the User Keys of the Users found. If no users are found the list will be empty.
Throws:: tcAPIException

provisionObject

public long provisionObject(long plUserKey,
                            long plObjectKey)
                     throws Thor.API.Exceptions.tcAPIException,
                            Thor.API.Exceptions.tcObjectNotFoundException,
                            Thor.API.Exceptions.tcProvisioningNotAllowedException,
                            Thor.API.Exceptions.tcUserNotFoundException,
                            tcAPIException

Provision an object for a user directly without going through a request. The resource is assumed to not be a service account.

Parameters:: plUserKey - The key of the user.; plObjectKey - The key of the object to provision.
Returns:: The Object Instance Key for the provisioning record created
Throws:: tcAPIException; tcObjectNotFoundException; tcProvisioningNotAllowedException; tcUserNotFoundException

provisionObject

public long provisionObject(long plUserKey,
                            long plObjectKey,
                            boolean pbServiceAccount)
                     throws Thor.API.Exceptions.tcAPIException,
                            Thor.API.Exceptions.tcObjectNotFoundException,
                            Thor.API.Exceptions.tcProvisioningNotAllowedException,
                            Thor.API.Exceptions.tcUserNotFoundException,
                            tcAPIException

Provision an object for a user directly without going through a request.

Parameters:: plUserKey - The key of the user.; plObjectKey - The key of the object to provision.; pbServiceAccount - Whether the account is a service account or not. True if it is
Returns:: The Object Instance Key for the provisioning record created
Throws:: tcAPIException; tcObjectNotFoundException; tcProvisioningNotAllowedException; tcUserNotFoundException

provisionResource

public com.thortech.xl.vo.ResourceData provisionResource(long plUserKey,
                                                         long plObjectKey)
                                                  throws Thor.API.Exceptions.tcAPIException,
                                                         Thor.API.Exceptions.tcObjectNotFoundException,
                                                         Thor.API.Exceptions.tcProvisioningNotAllowedException,
                                                         Thor.API.Exceptions.tcUserNotFoundException,
                                                         tcAPIException

Provision an object for a user directly without going through a request. The resource is assumed to not be a service account.

Parameters:: plUserKey - The key of the user.; plObjectKey - The key of the object to provision.
Returns:: The ResourceData which contain obi and oiu key for the provisioning record created
Throws:: tcAPIException; tcObjectNotFoundException; tcProvisioningNotAllowedException; tcUserNotFoundException

provisionResource

public com.thortech.xl.vo.ResourceData provisionResource(long plUserKey,
                                                         long plObjectKey,
                                                         boolean pbServiceAccount)
                                                  throws Thor.API.Exceptions.tcAPIException,
                                                         Thor.API.Exceptions.tcObjectNotFoundException,
                                                         Thor.API.Exceptions.tcProvisioningNotAllowedException,
                                                         Thor.API.Exceptions.tcUserNotFoundException,
                                                         tcAPIException

Provision an object for a user directly without going through a request.

Parameters:: plUserKey - The key of the user.; plObjectKey - The key of the object to provision.; pbServiceAccount - Whether the account is a service account or not. True if it is
Returns:: The ResourceData which contain obi and oiu key for the provisioning record created
Throws:: tcAPIException; tcObjectNotFoundException; tcProvisioningNotAllowedException; tcUserNotFoundException

revokeObject

public void revokeObject(long plUserKey,
                         long plObjectInstanceForUserKey)
                  throws Thor.API.Exceptions.tcAPIException,
                         Thor.API.Exceptions.tcObjectNotFoundException,
                         Thor.API.Exceptions.tcRevocationNotAllowedException,
                         Thor.API.Exceptions.tcUserNotFoundException,
                         tcAPIException

Revokes the provisioning of an object for a user directly without going through a request.

Parameters:: plUserKey - The key of the user.; plObjectInstanceForUserKey - The key of the object instance for a user in the system.
Throws:: tcAPIException; tcObjectNotFoundException; tcRevocationNotAllowedException; tcUserNotFoundException

revokeObjects

public void revokeObjects(long plUserKey,
                          long[] paObjectInstancesForUserKey)
                   throws Thor.API.Exceptions.tcAPIException,
                          Thor.API.Exceptions.tcObjectNotFoundException,
                          Thor.API.Exceptions.tcRevocationNotAllowedException,
                          Thor.API.Exceptions.tcUserNotFoundException,
                          Thor.API.Exceptions.tcBulkException,
                          tcAPIException

Revokes the provisioning of an object for a user directly without going through a request.

Parameters:: plUserKey - The key of the user.; paObjectInstancesForUserKey - The key of the object instance for a user in the system.
Throws:: tcAPIException; tcObjectNotFoundException; tcRevocationNotAllowedException; tcUserNotFoundException; tcBulkException

updateUser

public void updateUser(Thor.API.tcResultSet poUserResultSet,
                       java.util.Map phAttributeList)
                throws Thor.API.Exceptions.tcAPIException,
                       Thor.API.Exceptions.tcUserNotFoundException,
                       tcAPIException

Update a user in Xellerate. Requires a result set to maintain our pessimistic locking mechanism.

Parameters:: poUserResultSet - A result set containing at the minimum the user key and the rowver of the user record to update.; phAttributeList - A map of name-value pairs, each entry holding an attribute-value pair to set/modify for this user. The Attribute names are the String column codes (from the Xellerate metadata). The Attribute Values are the String attributes of the columns to set.
Throws:: tcAPIException; tcUserNotFoundException

enableAppForUser

public void enableAppForUser(long plUserKey,
                             long plObjectInstanceForUserKey)
                      throws Thor.API.Exceptions.tcObjectNotFoundException,
                             Thor.API.Exceptions.tcUserNotFoundException,
                             Thor.API.Exceptions.tcAPIException,
                             tcAPIException

Enables the object instance for the specified user.

Parameters:: plUserKey - The key of the user.; plObjectInstanceForUserKey - The key of the object instance for a user in the system.
Throws:: tcObjectNotFoundException; tcUserNotFoundException; tcAPIException

enableAppsForUser

public void enableAppsForUser(long plUserKey,
                              long[] paObjectInstancesForUserKey)
                       throws Thor.API.Exceptions.tcObjectNotFoundException,
                              Thor.API.Exceptions.tcUserNotFoundException,
                              Thor.API.Exceptions.tcAPIException,
                              Thor.API.Exceptions.tcBulkException,
                              tcAPIException

Enables the object instances for the specified user.

Parameters:: plUserKey - The key of the user.; paObjectInstancesForUserKey - The keys of the object instances for a user in the system.
Throws:: tcObjectNotFoundException; tcUserNotFoundException; tcAPIException; tcBulkException

disableAppForUser

public void disableAppForUser(long plUserKey,
                              long plObjectInstanceForUserKey)
                       throws Thor.API.Exceptions.tcObjectNotFoundException,
                              Thor.API.Exceptions.tcUserNotFoundException,
                              Thor.API.Exceptions.tcAPIException,
                              tcAPIException

Disables the object instance for the specified user.

Parameters:: plUserKey - The key of the user.; plObjectInstanceForUserKey - The key of the object instance for a user in the system.
Throws:: tcObjectNotFoundException; tcUserNotFoundException; tcAPIException

disableAppsForUser

public void disableAppsForUser(long plUserKey,
                               long[] paObjectInstancesForUserKey)
                        throws Thor.API.Exceptions.tcObjectNotFoundException,
                               Thor.API.Exceptions.tcUserNotFoundException,
                               Thor.API.Exceptions.tcAPIException,
                               Thor.API.Exceptions.tcBulkException,
                               tcAPIException

Disables the object instances for the specified user.

Parameters:: plUserKey - The key of the user.; paObjectInstancesForUserKey - The key of the object instances for a user in the system.
Throws:: tcObjectNotFoundException; tcUserNotFoundException; tcAPIException; tcBulkException

getMenuListForSelf

public Thor.API.tcResultSet getMenuListForSelf()
                                        throws Thor.API.Exceptions.tcAPIException,
                                               tcAPIException

Retrieves a list of web application menu items for the logged in user. The menu items retrieved will be based on the user's group membership.

Returns:: a tcResultSet containing a flat list of the user's menu items. Each menu item will have the following naming convention:
<Parent Menu>.<Child Menu>.<Sub Menu(if necessary)>
Throws:: tcAPIException - if any database errors occurred while retrieving list of menu items

getMenuList

public Thor.API.tcResultSet getMenuList(long plUserKey)
                                 throws Thor.API.Exceptions.tcUserNotFoundException,
                                        Thor.API.Exceptions.tcAPIException,
                                        tcAPIException

Retrieves a list of web application menu items that users have access to based on their group membership.

Parameters:: plUserKey - key of the user to retrieve a list of menu items for.
Returns:: a tcResultSet containing a flat list of the user's menu items. Each menu item will have the following naming convention:
<Parent Menu>.<Child Menu>.<Sub Menu(if necessary)>
Throws:: tcUserNotFoundException - if specified user does not exist; tcAPIException - if any database errors occurred while retrieving list of menu items

findAllUsers

public Thor.API.tcResultSet findAllUsers(java.util.Map phAttributeList)
                                  throws Thor.API.Exceptions.tcAPIException,
                                         tcAPIException

Returns a list of users that match the provided attribute list.

Parameters:

Returns:

A tcResultSet that contains user-defined columns as well as the following user-related information:

Organizations.Key
Organizations.Organization Name
Users.AD Reference
Users.Creation Date
Users.Deprovisioned Date
Users.Deprovisioning Date
Users.Disable User
Users.End Date
Users.First Name
Users.Identity
Users.Key
Users.Last Name
Users.Manager Key
Users.Manager Login
Users.Manager First Name
Users.Manager Last Name
Users.Middle Name
Users.Note
Users.Provisioned Date
Users.Provisioning Date
Users.Role
Users.Row Version
Users.Start Date
Users.Status
Users.Update Date
Users.Updated By
Users.User ID
Users.Xellerate Type
Users.Lock User
Users.Email

Throws:

tcAPIException

setChallengeValuesForSelf

public void setChallengeValuesForSelf(java.util.Map phQuestionAnswer)
                               throws Thor.API.Exceptions.tcNumberOfChallengesMismatchException,
                                      Thor.API.Exceptions.tcAPIException,
                                      Thor.API.Exceptions.tcInvalidQuestionException,
                                      tcAPIException

Set the challenge questions and answers for the logged in user.

Parameters:: phQuestionAnswer - A map of questions and answers for the current logged in user.
Throws:: tcNumberOfChallengesMismatchException; tcAPIException; tcInvalidQuestionException

getChallengeValuesForSelf

public Thor.API.tcResultSet getChallengeValuesForSelf()
                                               throws Thor.API.Exceptions.tcAPIException,
                                                      Thor.API.Exceptions.tcQuestionsNotDefinedException,
                                                      tcAPIException

Returns a resultset of the questions and answers

Returns:: tcResultSet of the questions and answers for a user
Throws:: tcAPIException; tcQuestionsNotDefinedException

compareChallengeValuesForSelf

public boolean compareChallengeValuesForSelf(java.util.Map phQuestionAnswer)
                                      throws Thor.API.Exceptions.tcNumberOfChallengesMismatchException,
                                             Thor.API.Exceptions.tcAPIException,
                                             tcAPIException

Compares the questions/answers entered by the user against the ones stored in the database

Parameters:: phQuestionAnswer - A map of questions and answers for the current logged in user.
Returns:: true if all answers are correct to the appropriate questions
Throws:: tcNumberOfChallengesMismatchException; tcAPIException

isChallengeQuestionsSetForSelf

public boolean isChallengeQuestionsSetForSelf()
                                       throws Thor.API.Exceptions.tcAPIException,
                                              tcAPIException

Check if challenge questions are set for the current user.

Returns:: true if challenge questions are set, false otherwise
Throws:: tcAPIException

unlockUsers

public void unlockUsers(long[] paUserKeys)
                 throws Thor.API.Exceptions.tcAPIException,
                        Thor.API.Exceptions.tcUserNotFoundException,
                        Thor.API.Exceptions.tcBulkException,
                        tcAPIException

Enable users in Xellerate by unlocking their accounts if they are locked.

Parameters:: paUserKeys - The array user keys to enable.
Throws:: tcAPIException; tcUserNotFoundException; tcBulkException

getProxyDetails

public Thor.API.tcResultSet getProxyDetails(long userKey)
                                     throws Thor.API.Exceptions.tcAPIException,
                                            Thor.API.Exceptions.tcUserNotFoundException,
                                            tcAPIException

This method will return the detail information of the proxy assigned to the specified user. The proxy information is the current assigned proxy to the user been passed.

Parameters:: userKey - user that is been proxied
Returns:: a result set with information about the proxy user
Throws:: tcAPIException - raised if a error occurred; tcUserNotFoundException - raised if the user key passed is not of a valid user.
Since:: 8.0

deleteProxies

public void deleteProxies(long userKey)
                   throws Thor.API.Exceptions.tcAPIException,
                          Thor.API.Exceptions.tcUserNotFoundException,
                          tcAPIException

This method deletes all the proxies setup for the given user.

Parameters:: userKey - the user key that is been proxied
Throws:: tcAPIException - raised if an error occurred by deleting the proxies; tcUserNotFoundException - raised if the user key is not of a valid user.
Since:: 8.0

setProxyForUser

public long setProxyForUser(long userKey,
                            long proxyUserKey,
                            java.util.Date startDate,
                            java.util.Date endDate)
                     throws Thor.API.Exceptions.tcAPIException,
                            Thor.API.Exceptions.tcUserNotFoundException,
                            Thor.API.Exceptions.tcRecursiveProxyException,
                            tcAPIException

This new method will set the specified user as a proxy for the specified user.

Parameters:: userKey - the user been proxied; proxyUserKey - the user to proxy; startDate - start date to proxy (can be null); endDate - end date of the proxy
Returns:: the proxy id in the table
Throws:: tcAPIException - raised if there is an error setting the proxy; tcUserNotFoundException - if any of the user do not exist in the system.; tcRecursiveProxyException - if there is a recursive proxy
Since:: 8.0

updateProxyForUser

public void updateProxyForUser(long pxdKey,
                               java.util.Map attribute)
                        throws Thor.API.Exceptions.tcAPIException,
                               Thor.API.Exceptions.tcUserNotFoundException,
                               Thor.API.Exceptions.tcRecursiveProxyException,
                               tcAPIException

This new method will update the specified user as a proxy for the specified user.

Parameters:

pxdKey - the proxy key that references the proxy update

attribute - an attribute map of the fields to update:

pxd_orig_usr_key - for the original user
pxd_proxy_key - the current proxy user
pxd_start_date - start date when the proxy takes effect
pxd_end_date - end date when the proxy ends

Throws:

tcAPIException - raised if there is an error setting the proxy

tcUserNotFoundException - if any of the user do not exist in the system.

tcRecursiveProxyException - if there is a recursive proxy

Since:

8.0

getProxiedUser

public Thor.API.tcResultSet getProxiedUser(long userKey)
                                    throws Thor.API.Exceptions.tcAPIException,
                                           Thor.API.Exceptions.tcUserNotFoundException,
                                           tcAPIException

This method will return the detail information of only the current proxied user by the specified user.

Parameters:: userKey - user is the proxy user
Returns:: a result set with information about the proxied user
Throws:: tcAPIException - raised if a error occurred; tcUserNotFoundException - raised if the user key passed is not of a valid user.
Since:: 8.0

moveServiceAccount

public void moveServiceAccount(long plObjectInstanceForUserKey,
                               long plTargetUserKey)
                        throws Thor.API.Exceptions.tcAPIException,
                               tcAPIException

Moves the service account from its current owner to a new owner.

Parameters:: plObjectInstanceForUserKey - The key of the object instance for a user in the system.; plTargetUserKey - The key of the user who shall be the new owner.
Throws:: tcAPIException

changeToServiceAccount

public void changeToServiceAccount(long plObjectInstanceForUserKey)
                            throws Thor.API.Exceptions.tcAPIException,
                                   tcAPIException

Changes a regular account to a service account.

Parameters:: plObjectInstanceForUserKey - The key of the object instance for a user in the system.
Throws:: tcAPIException

changeFromServiceAccount

public void changeFromServiceAccount(long plObjectInstanceForUserKey)
                              throws Thor.API.Exceptions.tcAPIException,
                                     tcAPIException

Changes a service account to a regular account.

Parameters:: plObjectInstanceForUserKey - The key of the object instance for a user in the system.
Throws:: tcAPIException

getUnAssignedGroups

public Thor.API.tcResultSet getUnAssignedGroups(long plUserKey)
                                         throws Thor.API.Exceptions.tcAPIException,
                                                Thor.API.Exceptions.tcUserNotFoundException,
                                                tcAPIException

Gets a list of all the groups the user is not a member of.

Parameters:: plUserKey - Value holding the User Key (corresponds to value in the USR_KEY column)
Returns:: A tcResultSet each row holding information about a group the user is not a member of.
Throws:: tcAPIException; tcUserNotFoundException

canResourceBeProvisioned

public boolean canResourceBeProvisioned(long userKey,
                                        long objectKey)
                                 throws Thor.API.Exceptions.tcAPIException,
                                        Thor.API.Exceptions.tcUserNotFoundException,
                                        Thor.API.Exceptions.tcObjectNotFoundException,
                                        tcAPIException

Determines if a resource can be provisioned to a user or not.

Parameters:: userKey - Value holding the User Key (corresponds to value in the USR_KEY column); objectKey - This is the resource object key
Returns:: A tcResultSet each row holding information about a group the user is not a member of.
Throws:: tcAPIException; tcUserNotFoundException; Thor.API.Exceptions.tcObjectNotFoundException

getEncodedValue

public Thor.API.tcResultSet getEncodedValue(java.lang.String strDecodeVal,
                                            java.lang.String strFieldName)
                                     throws Thor.API.Exceptions.tcAPIException,
                                            tcAPIException

This object returns a resultset of the object available for the given encoded value.

Returns:: tcResultSet of the available objects for the Encoded Value
Throws:: tcUserNotFoundException; tcAPIException

getActiveUsers

public Thor.API.tcResultSet getActiveUsers(java.util.Map attributes)
                                    throws Thor.API.Exceptions.tcAPIException,
                                           tcAPIException

Returns a list of active users in the system. Active user is defined as users that are not disabled or deleted, or do not have an active proxy setup. This API takes permissions into consideration and returns only the users over which the logged in user has read permissions.

Parameters:

attributes - A Map of attribute-value pairs with each entry containing criteria to find active users. The Map key should contain a String representation of the metadata codes. The Map value can contain a String representation of the criteria to find the desired requests. Note that the Map values can include wild cards(*).

Only attributes allowed in the map for filerting are

Users.First Name, User First Name
Users.Last Name, User Last Name
Users.User ID, User Login
Users.Key, User Key

Returns:

A tcResultSet that contains the following information:

Users.Key , User Key
Users.User ID, User Login
Users.First Name, User First Name
Users.Last Name, User Last Name

Throws:

tcAPIException - If an error occurs while querying the user data

findAllUsersFiltered

public Thor.API.tcResultSet findAllUsersFiltered(java.util.Map phAttributeList,
                                                 java.lang.String[] pasFieldList)
                                          throws Thor.API.Exceptions.tcAPIException,
                                                 tcAPIException

Returns a list of users that match the provided attribute list. This API searches through all users defined in the system. The fields returned in the tcResultSet can be specified.

Parameters:

phAttributeList - attribute-value pairs with each entry containing criteria to find users

pasFieldList - The list of fields that is to be returned in the tcResultSet.

Returns:

A tcResultSet that contains the fields specified in pasFieldList. Returned tcResultSet always contains

Users.Key
Users.Row Version

Throws:

Thor.API.Exceptions.tcAPIException

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Thor.API.Operations Interface tcUserOperationsIntf

createUser

deleteUser

deleteUsers

disableUser

disableUsers

enableUser

enableUsers

changePasswordforSelf

changePasswordForSelf

getAvailableObjectsForSelf

getAvailableObjectsForUser

getAvailableObjects

getAvailableObjects

getSelfProfile

getSelfProfileFiltered

findUsers

findUsers

findUsers

findUsersFiltered

findUsersFiltered

findUsersFilteredCount

getGroups

getObjectAuthorizationPermissions

getObjects

getObjectsByType

getObjectsByTypeStatus

getUserFromObjectInfo

provisionObject

provisionObject

provisionResource

provisionResource

revokeObject

revokeObjects

updateUser

enableAppForUser

enableAppsForUser

disableAppForUser

disableAppsForUser

getMenuListForSelf

getMenuList

findAllUsers

setChallengeValuesForSelf

getChallengeValuesForSelf

compareChallengeValuesForSelf

isChallengeQuestionsSetForSelf

unlockUsers

getProxyDetails

deleteProxies

setProxyForUser

updateProxyForUser

getProxiedUser

moveServiceAccount

changeToServiceAccount

changeFromServiceAccount

getUnAssignedGroups

canResourceBeProvisioned

getEncodedValue

getActiveUsers

findAllUsersFiltered

Thor.API.Operations
Interface tcUserOperationsIntf