Package Thor.API.Operations

Interface tcUnauthenticatedOperationsIntf

All Superinterfaces:

tcUtilityOperationsIntf

public interface tcUnauthenticatedOperationsIntf
extends tcUtilityOperationsIntf

Method Summary

Modifier and Type	Method	Description
int	canUserLogin(String psUser, String psPassword)	Deprecated.
void	changePasswordForUser(String psUserID, String psOldPassword, String psNewPassword, String psConfirmPassword)	Deprecated.
List	getAttributes()	Returns a list of all form management related attributes.
String[]	getChallengeValuesForUser(String psUserID)	This method return String array of Defined questions.
String	getColumnCode(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.
String	getPropertyValue(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.
String[]	getSystemChallenges()	Deprecated.
HashMap	getUserPasswordPolicyDescription(String msUserId)	This method returns password policy description in hashmap that is applicable on 'Xellerate User' object
void	login(String psUser, String psPassword)	Deprecated.
boolean	resetForgottenPassword(String psUserID, Map poQuesAns, String psPassword)	The number of questions answered correctly reset the password
void	setChallengeValuesForUser(String psUserID, String psPassword, Map phQuestionAnswer)	Deprecated.
void	signatureLogin(String psUser, String psSignature)	Deprecated.

Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf

close, getName, setCountry, setLanguage, setVariant

Method Details

getChallengeValuesForUser

String[] getChallengeValuesForUser(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(String psUserID,
 Map poQuesAns,
 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

String getPropertyValue(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

String[] getSystemChallenges()
                      throws tcAPIException,
tcInvalidLookupException,
tcAPIException

Deprecated.

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. <br/ >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. <br/ >NOTE: This method is not supported.

Returns:

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

Throws:

tcAPIException

getAttributes

List getAttributes()
            throws tcAPIException,
tcAPIException

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

Returns:

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

Throws:

tcAPIException

changePasswordForUser

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

Deprecated.

Change password The API is being unsupported with immediate effect Alternatives: End user : AuthenticatedSelfService:changePassword Admin : UserManager:changePassword

Parameters:

psUserID -

psOldPassword -

psNewPassword -

psConfirmPassword -

Throws:

tcAPIException

tcPasswordIncorrectException

tcPasswordMismatchException

tcPasswordPolicyException

tcUserAccountInvalidException

tcUserAccountDisabledException

tcUserAccountInvalidException

tcUserAccountDisabledException

tcPasswordIncorrectException

tcPasswordMismatchException

tcPasswordPolicyException

tcAPIException

See Also:

• end user: AuthenticatedSelfService:changePassword (char[] oldPwd, char[] newPwd, char[] confirmPwd)
• admin:UserManager: (String userID, char[] password, boolean isUserLogin)

setChallengeValuesForUser

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

Deprecated.

Set the challenge questions and answers for the logged in user. This API is unsupported with immediate effect Alternative End User : AuthenticatedSelfService:setChallengeValues System Admin : UserManager:setUserChallengeValues

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

See Also:

• enduser : AuthenticatedSelfService:setChallengeValues(Map<String, Object> quesAnsMap)
• sysadmin : UserManager:setUserChallengeValues

getColumnCode

String getColumnCode(String psColumnName)
              throws tcAPIException,
tcAPIException

Returns the column code of the given column name. <br/ >NOTE: This method is not supported.

Parameters:

psColumnName - Column name whose code is to be retrieved

Returns:

String

Throws:

tcAPIException

tcAPIException

canUserLogin

int canUserLogin(String psUser,
 String psPassword)
          throws tcAPIException,
tcAPIException

Deprecated.

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(String psUser,
 String psPassword)
    throws com.thortech.xl.security.tcLoginException,
tcAPIException

Deprecated.

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

com.thortech.xl.security.tcLoginException

tcAPIException

signatureLogin

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

Deprecated.

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

com.thortech.xl.security.tcLoginException

tcAPIException

getUserPasswordPolicyDescription

HashMap getUserPasswordPolicyDescription(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

tcAPIException