tcUnauthenticatedOperationsIntf (Oracle Fusion Middleware Java API Reference for Oracle Identity Governance)

All Superinterfaces:: tcUtilityOperationsIntf

public interface tcUnauthenticatedOperationsIntf
extends tcUtilityOperationsIntf

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`canUserLogin(java.lang.String psUser, java.lang.String psPassword)` Deprecated.
`void`	`changePasswordForUser(java.lang.String psUserID, java.lang.String psOldPassword, java.lang.String psNewPassword, java.lang.String psConfirmPassword)` Deprecated.
`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[]`	`getSystemChallenges()` Deprecated.
`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)` Deprecated.
`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)` Deprecated.
`void`	`signatureLogin(java.lang.String psUser, java.lang.String psSignature)` Deprecated.

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

Deprecated.

Retrieving System Challenge Questions.

Returns:: String[]
Throws:: tcAPIException; tcInvalidLookupException; tcInvalidLookupException; tcAPIException
See Also:: PasswordMgmtService:getApplicableDefaultChallengeQuestions

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

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

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

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 quesAnsMap), sysadmin : UserManager:setUserChallengeValues

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
```
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

See Also:

OIMClient:login

login
```
void login(java.lang.String psUser,
           java.lang.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

tcAPIException

See Also:

OIMClient:login

signatureLogin
```
void signatureLogin(java.lang.String psUser,
                    java.lang.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

tcAPIException

See Also:

with signature as password

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

Interface tcUnauthenticatedOperationsIntf

Method Summary

Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf

Method Detail

getChallengeValuesForUser

resetForgottenPassword

getPropertyValue

getSystemChallenges

getRegistrationMetaData

getProfileMetaData

getAttributes

changePasswordForUser

setChallengeValuesForUser

getColumnCode

canUserLogin

login

signatureLogin

getUserPasswordPolicyDescription