Skip navigation links

Thor.API.Operations
Interface tcUnauthenticatedOperationsIntf

All Superinterfaces:

tcUtilityOperationsIntf

public interface tcUnauthenticatedOperationsIntf

extends tcUtilityOperationsIntf

Method Summary

int	canUserLogin(java.lang.String psUser, java.lang.String psPassword) Validates if a user with given credentials (User Name and Password) can login.
void	changePasswordForUser(java.lang.String psUserID, java.lang.String psOldPassword, java.lang.String psNewPassword, java.lang.String psConfirmPassword) Change password
java.lang.String	createRegistrationRequest(java.util.Map poAttributes, java.util.Map poQnA) Creates a request to register a user.
java.util.List	getAttributes() Returns a list of all form management related attributes.
java.lang.String[]	getChallengeValuesForUser(java.lang.String psUserID) This method return String array of Defined questions.
java.lang.String	getColumnCode(java.lang.String psColumnName) Returns the column code of the given column name.
com.thortech.xl.util.metadata.ProfileMetaData	getProfileMetaData() Returns meta data related to user profile management.
java.lang.String	getPropertyValue(java.lang.String psKeyword) This class will retrieve the property value of the keyword passed as a parameter.
com.thortech.xl.util.metadata.RegistrationMetaData	getRegistrationMetaData() Returns meta data related to user self registration.
java.lang.String[][]	getRegistrationRequestHistory(java.lang.String psRequestID) Retrieves the history of a user self registration request.
java.lang.String[]	getSystemChallenges() Retrieving System Challenge Questions.
java.util.HashMap	getUserPasswordPolicyDescription(java.lang.String msUserId) This method returns password policy description in hashmap that is applicable on 'Xellerate User' object
void	login(java.lang.String psUser, java.lang.String psPassword) This method logins the user with the given username and password
boolean	resetForgottenPassword(java.lang.String psUserID, java.util.Map poQuesAns, java.lang.String psPassword) The number of questions answered correctly reset the password
void	setChallengeValuesForUser(java.lang.String psUserID, java.lang.String psPassword, java.util.Map phQuestionAnswer) Set the challenge questions and answers for the logged in user.
void	signatureLogin(java.lang.String psUser, java.lang.String psSignature) This method logins the user with the given username and signature string

Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf

close, getName, setCountry, setLanguage, setVariant

Method Detail

getChallengeValuesForUser

java.lang.String[] getChallengeValuesForUser(java.lang.String psUserID)
                                             throws tcAPIException,
                                                    tcUserAccountDisabledException,
                                                    tcUserAccountInvalidException,
                                                    tcAPIException

This method return String array of Defined questions.

Parameters:

psUserID -

Returns:

String[]

Throws:

tcAPIException

tcUserAccountDisabledException

tcUserAccountInvalidException

tcUserAccountInvalidException

tcUserAccountDisabledException

tcAPIException

resetForgottenPassword

boolean resetForgottenPassword(java.lang.String psUserID,
                               java.util.Map poQuesAns,
                               java.lang.String psPassword)
                               throws tcAPIException,
                                      tcUserAccountDisabledException,
                                      tcUserAccountInvalidException,
                                      tcNumberOfChallengesMismatchException,
                                      tcQuestionsNotDefinedException,
                                      tcPasswordIncorrectException,
                                      tcPasswordMismatchException,
                                      tcPasswordPolicyException,
                                      tcPasswordResetAttemptsExceededException,
                                      tcUserAlreadyLoggedInException,
                                      tcAPIException

The number of questions answered correctly reset the password

Parameters:

psUserID - userId

poQuesAns - Questions nas answers.

psPassword - Passowrd

Returns:

boolean

Throws:

tcAPIException

tcUserAccountDisabledException

tcUserAccountInvalidException

tcNumberOfChallengesMismatchException

tcQuestionsNotDefinedException

tcPasswordIncorrectException

tcPasswordMismatchException

tcPasswordPolicyException

tcPasswordResetAttemptsExceededException

tcUserAlreadyLoggedInException

tcUserAccountInvalidException

tcUserAccountDisabledException

tcNumberOfChallengesMismatchException

tcQuestionsNotDefinedException

tcPasswordIncorrectException

tcPasswordMismatchException

tcPasswordPolicyException

tcPasswordResetAttemptsExceededException

tcAPIException

getPropertyValue

java.lang.String getPropertyValue(java.lang.String psKeyword)
                                  throws tcAPIException,
                                         tcPropertyNotFoundException,
                                         tcDuplicatePropertyException,
                                         tcAPIException

This class will retrieve the property value of the keyword passed as a parameter.

Parameters:

psKeyword - is the name of the keywork to find the value

Returns:

the value of the keyword passed as parameter

Throws:

tcAPIException

tcPropertyNotFoundException

tcDuplicatePropertyException

tcPropertyNotFoundException

tcDuplicatePropertyException

tcAPIException

getSystemChallenges

java.lang.String[] getSystemChallenges()
                                       throws tcAPIException,
                                              tcInvalidLookupException,
                                              tcAPIException

Retrieving System Challenge Questions.

Returns:

String[]

Throws:

tcAPIException

tcInvalidLookupException

tcInvalidLookupException

tcAPIException

getRegistrationMetaData

com.thortech.xl.util.metadata.RegistrationMetaData getRegistrationMetaData()
                                                                           throws tcAPIException,
                                                                                  tcAPIException

Returns meta data related to user self registration.
NOTE: This method is not supported.

Returns:

A RegistrationMetaData object containing the meta data related to user self registation.

Throws:

tcAPIException

getProfileMetaData

com.thortech.xl.util.metadata.ProfileMetaData getProfileMetaData()
                                                                 throws tcAPIException,
                                                                        tcAPIException

Returns meta data related to user profile management.
NOTE: This method is not supported.

Returns:

A ProfileMetaData object containing the meta data information related to user profile management.

Throws:

tcAPIException

getAttributes

java.util.List getAttributes()
                             throws tcAPIException,
                                    tcAPIException

Returns a list of all form management related attributes.
NOTE: This method is not supported.

Returns:

A List of Attribute objects or null, if no form management attributes have been defined.

Throws:

tcAPIException

createRegistrationRequest

java.lang.String createRegistrationRequest(java.util.Map poAttributes,
                                           java.util.Map poQnA)
                                           throws tcDuplicateSelfRegistrationException,
                                                  tcRequiredDataMissingException,
                                                  tcChallengeInfoException,
                                                  tcOrganizationNotFoundException,
                                                  tcInvalidManagerException,
                                                  tcDuplicateUserException,
                                                  tcAPIException,
                                                  tcAPIException

Creates a request to register a user.
NOTE: This method is not supported.

Parameters:

poAttributes - A collection of attributes describing to the user's profile, specified as Name-Value pairs. The attribute names are defined by the form management meta-data.

poQnA - A collection of Challenge questions, specified as Question-Answer pairs.

Returns:

Request ID, which can be used for tracking the request

Throws:

tcDuplicateSelfRegistrationException

tcRequiredDataMissingException

tcChallengeInfoException

tcOrganizationNotFoundException

tcInvalidManagerException

tcDuplicateUserException

tcAPIException

tcChallengeInfoException

tcRequiredDataMissingException

tcDuplicateSelfRegistrationException

tcOrganizationNotFoundException

tcInvalidManagerException

tcDuplicateUserException

tcAPIException - an error code of DOBJ.USR_PASSWORD_DOES_NOT_MATCH_POLICY might be set within this exception. If that's the case, one or many password policy rules were not met for password field in the form.

getRegistrationRequestHistory

java.lang.String[][] getRegistrationRequestHistory(java.lang.String psRequestID)
                                                   throws tcRequestInvalidException,
                                                          tcAPIException,
                                                          tcAPIException

Retrieves the history of a user self registration request. It returns the various status updates that a self registration request has gone through and the corresponding status update times.
NOTE: This method is not supported.

Parameters:

psRequestID - Request ID returned when creating the request

Returns:

A table where each row contains the following information

• Request Number
• Creation Time
• Request Priority
• Request Status
• Status Update Time

The number of rows in the table corresponds to the number of status updates that the specified user self registration request has gone through.

Throws:

tcRequestInvalidException

tcAPIException

tcAPIException

changePasswordForUser

void changePasswordForUser(java.lang.String psUserID,
                           java.lang.String psOldPassword,
                           java.lang.String psNewPassword,
                           java.lang.String psConfirmPassword)
                           throws tcAPIException,
                                  tcPasswordIncorrectException,
                                  tcPasswordMismatchException,
                                  tcPasswordPolicyException,
                                  tcUserAccountInvalidException,
                                  tcUserAccountDisabledException,
                                  tcAPIException

Change password

Parameters:

psUserID -

psOldPassword -

psNewPassword -

psConfirmPassword -

Throws:

tcAPIException

tcPasswordIncorrectException

tcPasswordMismatchException

tcPasswordPolicyException

tcUserAccountInvalidException

tcUserAccountDisabledException

tcUserAccountInvalidException

tcUserAccountDisabledException

tcPasswordIncorrectException

tcPasswordMismatchException

tcPasswordPolicyException

tcAPIException

setChallengeValuesForUser

void setChallengeValuesForUser(java.lang.String psUserID,
                               java.lang.String psPassword,
                               java.util.Map phQuestionAnswer)
                               throws tcNumberOfChallengesMismatchException,
                                      tcAPIException,
                                      tcInvalidQuestionException,
                                      tcUserAccountInvalidException,
                                      tcUserAccountDisabledException,
                                      tcPropertyNotFoundException,
                                      tcDuplicatePropertyException,
                                      tcInvalidLookupException,
                                      tcPasswordResetAttemptsExceededException,
                                      tcLoginAttemptsExceededException,
                                      tcPasswordIncorrectException,
                                      tcAPIException

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

Parameters:

psUserID - the user key to set the challenge question and answers

psPassword - is the password for the user to set his/her Q&A

phQuestionAnswer - is the database to use

Throws:

tcNumberOfChallengesMismatchException

tcAPIException

tcInvalidQuestionException

tcUserAccountInvalidException

tcUserAccountDisabledException

tcPropertyNotFoundException

tcDuplicatePropertyException

tcInvalidLookupException

tcPasswordResetAttemptsExceededException

tcLoginAttemptsExceededException

tcPasswordIncorrectException

tcNumberOfChallengesMismatchException

tcAPIException

tcInvalidQuestionException

tcUserAccountInvalidException

tcUserAccountDisabledException

tcPasswordResetAttemptsExceededException

tcLoginAttemptsExceededException

getColumnCode

java.lang.String getColumnCode(java.lang.String psColumnName)
                               throws tcAPIException,
                                      tcAPIException

Returns the column code of the given column name.
NOTE: This method is not supported.

Parameters:

psColumnName - Column name whose code is to be retrieved

Returns:

String

Throws:

tcAPIException

tcAPIException

canUserLogin

int canUserLogin(java.lang.String psUser,
                 java.lang.String psPassword)
                 throws tcAPIException,
                        tcAPIException

Validates if a user with given credentials (User Name and Password) can login. Return value indicates if the user can login or why the user can't login. NOTE: This method only checks if a given user can login but does not actually login the user
NOTE: This method is not supported.

Parameters:

psUser - User Login to validate

psPassword - Password to validate

Returns:

Indicates if the user with the given credentials can successfully log in or not. If not, the return value indicates the reason why the user can't be logged in.

Throws:

tcAPIException

login

void login(java.lang.String psUser,
           java.lang.String psPassword)
           throws com.thortech.xl.security.tcLoginException,
                  tcAPIException

This method logins the user with the given username and password

Parameters:

psUser - the username

psPassword - the password

Throws:

tcLoginException - Exception raise if the user cannot login successfully

tcAPIException

signatureLogin

void signatureLogin(java.lang.String psUser,
                    java.lang.String psSignature)
                    throws com.thortech.xl.security.tcLoginException,
                           tcAPIException

This method logins the user with the given username and signature string

Parameters:

psUser - the username

psPassword - the password

Throws:

tcLoginException - Exception raise if the user cannot login successfully

tcAPIException

getUserPasswordPolicyDescription

java.util.HashMap getUserPasswordPolicyDescription(java.lang.String msUserId)
                                                   throws tcAPIException,
                                                          tcAPIException

This method returns password policy description in hashmap that is applicable on 'Xellerate User' object

Returns:

hashmap containing password policy description

Throws:

com.thortech.xl.dataaccess.tcDataSetException

tcAPIException

Skip navigation links