|
Oracle Fusion Middleware Java API Reference for Oracle Adaptive Access Manager Release 11g (11.1.1) E15864-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface VCryptAuth
Provides various methods for authenticating PIN/passwords using VCrypt system
Field Summary | |
---|---|
static java.lang.String |
IMAGE_STATUS |
static java.lang.String |
PHRASE_STATUS |
static java.lang.String |
QUESTION_STATUS |
static java.lang.String |
REQ_ADD_QUESTIONS |
static java.lang.String |
REQ_AUTH_QUESTION |
static java.lang.String |
REQ_AUTH_QUESTION_CSR |
static java.lang.String |
REQ_GET_CAPTION |
static java.lang.String |
REQ_GET_IMAGE |
static java.lang.String |
REQ_GET_IMAGE_AND_CAPTION |
static java.lang.String |
REQ_GET_IMAGE_AND_LOCALIZED_CAPTION |
static java.lang.String |
REQ_GET_LOCALIZED_CAPTION |
static java.lang.String |
REQ_GET_PREF_DELIVERY_CHANNEL |
static java.lang.String |
REQ_GET_USER |
static java.lang.String |
REQ_SET_GROUP_AUTH_MODE |
static java.lang.String |
REQ_SET_IMAGE_AND_CAPTION |
Method Summary | |
---|---|
VCryptResponse |
addQuestion(java.lang.String requestId, java.lang.String customerId, VCryptQuestion question) Adds a new question for the specified user |
VCryptResponse |
addQuestion(java.lang.String customerId, VCryptQuestion question) Adds a new question for the specified user |
VCryptResponse |
addQuestions(java.lang.String requestId, java.lang.String customerId, VCryptQuestion[] questions) Add questions to the customer Expects the number of questions to be exactly equal to the required number of questions Calling this method will delete any previously existing quesions Success indicates adding all questions, failure means none of the questions are added. |
VCryptResponse |
addQuestions(java.lang.String customerId, VCryptQuestion[] questions) Add questions to the customer Expects the number of questions to be exactly equal to the required number of questions Calling this method will delete any previously existing quesions Success indicates adding all questions, failure means none of the questions are added. |
VCryptAuthResult |
authenticatePassword(java.lang.String customerId, java.lang.String password, int authSessionType, int clientType, java.lang.String clientVersion, java.lang.String ipAddress, int fingerPrintType, java.lang.String fingerPrint) Method to athenticate password |
VCryptAuthResult |
authenticatePin(java.lang.String customerId, java.lang.String pin, java.lang.Long authSessionId, int authSessionType, int clientType, java.lang.String clientVersion, java.lang.String ipAddress, int fingerPrintType, java.lang.String fingerPrint) Method to athenticate pin |
VCryptAuthResult |
authenticateQuestion(java.lang.String requestId, java.lang.Integer challengeChannel, java.lang.String customerId, java.lang.String answer) Method for authenticate question/answer |
VCryptAuthResult |
authenticateQuestion(java.lang.String customerId, java.lang.String answer) Method for authenticate question/answer |
VCryptAuthResult |
authenticateQuestionForCSR(java.lang.String requestId, java.lang.Integer challengeChannel, java.lang.String customerId, java.lang.String answer) Method for authenticate question/answer for customer care |
VCryptAuthResult |
authenticateQuestionForCSR(java.lang.String customerId, java.lang.String answer) Method for authenticate question/answer for CSR policy |
VCryptAuthResult |
authenticateSlider(java.lang.String customerId, java.lang.String pin, java.util.Vector displacements, java.util.Map authStats, java.lang.Long authSessionId, java.lang.String ipAddress, int fingerPrintType, java.lang.String fingerPrint) This method authenticates the PIN entered by the user using the slider. |
VCryptAuthResult |
authenticateSlider(java.lang.String customerId, java.util.Vector displacements, java.util.Map authStats, java.lang.Long authSessionId, java.lang.String ipAddress, int fingerPrintType, java.lang.String fingerPrint) This method authenticates the PIN entered by the user using the slider. |
VCryptAuthUser |
createUser(VCryptAuthUser user) This creates an user in the Authentication database. |
boolean |
deleteAllSignOnQuestions(java.lang.String customerId) Delete all sign on questions for the given user |
boolean |
deleteQuestion(java.lang.String customerId, VCryptQuestion question) Deletes the question for the specified user |
VCryptWheel |
genWheel(int length, int sets, java.lang.Long previousAuthSessionId, int authSessionType, int clientType, java.lang.String clientVersion, java.lang.String ipAddress, int fingerPrintType, java.lang.String fingerPrint) This method generates a new wheel with creating the VCryptAuthSession object. |
VCryptQuestion[] |
getAllMappedSignOnQuestions(java.lang.String customerId) Get user questions |
java.lang.String |
getCaption(java.lang.String customerId) Gets the caption for the user |
java.lang.String |
getImage(java.lang.String customerId) Gets the imagePath for the user |
java.lang.String[] |
getImageAndCaption(java.lang.String customerId) Gets the image path and caption for the user |
java.lang.Object[] |
getImageAndLocalizedCaption(java.lang.String customerId) |
VCryptLocalizedString |
getLocalizedCaption(java.lang.String customerId) |
VCryptQuestion |
getSecretQuestion(java.lang.String customerId) Gets a secret question for the user |
VCryptQuestion |
getSecretQuestionForCSR(java.lang.String customerId) Gets a secret question for the user for CSR policy |
VCryptQuestion[][] |
getSignOnQuestions(java.lang.String customerId) Gets all the secret questions available for the user. |
VCryptQuestion[][] |
getSignOnQuestions(java.lang.String customerId, VCryptLocale aLocale) |
VCryptAuthUser |
getUser(java.lang.String customerId) Return the user details without the password and pin for the given customer and group |
int |
getUserAuthMode(java.lang.String customerId) Gets the authMode for the user |
VCryptAuthUser |
getUserByLoginId(java.lang.String loginId) This returns the user details without the password and pin. |
VCryptAuthUser |
getUserByLoginId(java.lang.String loginId, java.lang.String groupName) Return the user details without the password and pin for the given customer and group |
int |
getUserStatus(java.lang.String customerId) Gets the status for the user |
VCryptQuestion |
moveToNextSecretQuestion(java.lang.String customerId) Move the current secret question for the user to next |
boolean |
setCaption(java.lang.String customerId, java.lang.String caption) Sets a new caption for the specified user |
boolean |
setCaption(java.lang.String customerId, VCryptLocalizedString caption) |
boolean |
setGroupUsersAuthMode(java.lang.String groupName, int authMode) Set authmode of customerGroupId users to authMode
Uses batch updates and failure is not guaranteed to leave the system in old auth mode as failure may occur in later batch, after initial batches are saved. |
boolean |
setImage(java.lang.String customerId, java.lang.String imagePath) Sets a new image for the specified user |
boolean |
setImageAndCaption(java.lang.String customerId, java.lang.String imagePath, java.lang.String caption) This sets the Image and caption for the user. |
boolean |
setImageAndCaption(java.lang.String customerId, java.lang.String imagePath, VCryptLocalizedString caption) |
boolean |
setPassword(java.lang.String customerId, java.lang.String password, int passwordStatus) Sets a new password for the specified user |
boolean |
setPIN(java.lang.String customerId, java.lang.String PIN, int pinStatus) Sets a new PIN for the specified user |
VCryptAuthUser |
setUser(VCryptAuthUser user) This updates the AuthUser |
boolean |
setUserAuthMode(java.lang.String customerId, int authMode) Sets a authMode for the specified user |
boolean |
setUserStatus(java.lang.String customerId, int status) Sets a status for the specified user |
Field Detail |
---|
static final java.lang.String REQ_GET_CAPTION
static final java.lang.String REQ_GET_PREF_DELIVERY_CHANNEL
static final java.lang.String REQ_GET_IMAGE
static final java.lang.String REQ_GET_IMAGE_AND_CAPTION
static final java.lang.String REQ_SET_IMAGE_AND_CAPTION
static final java.lang.String REQ_SET_GROUP_AUTH_MODE
static final java.lang.String REQ_ADD_QUESTIONS
static final java.lang.String REQ_GET_USER
static final java.lang.String REQ_AUTH_QUESTION_CSR
static final java.lang.String REQ_AUTH_QUESTION
static final java.lang.String REQ_GET_LOCALIZED_CAPTION
static final java.lang.String REQ_GET_IMAGE_AND_LOCALIZED_CAPTION
static final java.lang.String QUESTION_STATUS
static final java.lang.String IMAGE_STATUS
static final java.lang.String PHRASE_STATUS
Method Detail |
---|
VCryptAuthUser getUser(java.lang.String customerId)
customerId
- of the user.VCryptAuthUser
value. If the user is not valid, then all the values in the object is is null. Any unexpected error, Null is returned.VCryptAuthUser getUserByLoginId(java.lang.String loginId, java.lang.String groupName)
loginId
- of the user.groupName
- groupNameVCryptAuthUser
value. If the user is not valid, then all the values in the object is is null. Any unexpected error, Null is returned.VCryptAuthUser getUserByLoginId(java.lang.String loginId)
loginId
- of the user.VCryptAuthUser
value. If the user is not valid, then all the values in the object is is nullVCryptAuthUser createUser(VCryptAuthUser user)
user
- Auth userVCryptAuthUser setUser(VCryptAuthUser user)
user
- From the attributes in the map, it will only update the name/values which are given in this list.VCryptAuthResult authenticatePassword(java.lang.String customerId, java.lang.String password, int authSessionType, int clientType, java.lang.String clientVersion, java.lang.String ipAddress, int fingerPrintType, java.lang.String fingerPrint)
customerId
- The customerId used by the user.password
- The raw password entered by the user.authSessionType
- Reason for authenticationclientType
- Client type used.clientVersion
- Client versionipAddress
- IP address of the user device.fingerPrintType
- Type of finger printingfingerPrint
- Finger printVCryptAuthResult authenticatePin(java.lang.String customerId, java.lang.String pin, java.lang.Long authSessionId, int authSessionType, int clientType, java.lang.String clientVersion, java.lang.String ipAddress, int fingerPrintType, java.lang.String fingerPrint)
customerId
- The customerId used by the user.pin
- The raw pin entered by the user.authSessionId
- Authentication sessionIdauthSessionType
- Reason for authenticationclientType
- Client type used.clientVersion
- Client versionipAddress
- IP address of the user device.fingerPrintType
- Type of finger printingfingerPrint
- Finger printVCryptWheel genWheel(int length, int sets, java.lang.Long previousAuthSessionId, int authSessionType, int clientType, java.lang.String clientVersion, java.lang.String ipAddress, int fingerPrintType, java.lang.String fingerPrint)
length
- of the wheelsets
- number of setspreviousAuthSessionId
- previous authentication session id (if available)authSessionType
- What type of authentication session this is. It could be login, in-session, pin reset, etc.clientType
- what type of client is used for authenticationclientVersion
- what is the version of the clientipAddress
- IP address of the user device.fingerPrintType
- Type of finger printingfingerPrint
- Finger printVCryptWheel
valueVCryptAuthResult authenticateSlider(java.lang.String customerId, java.util.Vector displacements, java.util.Map authStats, java.lang.Long authSessionId, java.lang.String ipAddress, int fingerPrintType, java.lang.String fingerPrint)
customerId
- CustomerId used by the userdisplacements
- Displacement of the markerauthStats
- Hash map of user input metrics, like time taken, etc.authSessionId
- The Id of the auth sessionipAddress
- IP address of the user device.fingerPrintType
- Type of finger printingfingerPrint
- Finger printVCryptAuthResult
valueVCryptAuthResult authenticateSlider(java.lang.String customerId, java.lang.String pin, java.util.Vector displacements, java.util.Map authStats, java.lang.Long authSessionId, java.lang.String ipAddress, int fingerPrintType, java.lang.String fingerPrint)
customerId
- CustomerId used by the userpin
- a String
valuedisplacements
- Displacement of the markerauthStats
- Hash map of user input metrics, like time taken, etc.authSessionId
- The session Id for this authenticationipAddress
- IP address of the user device.fingerPrintType
- Type of finger printingfingerPrint
- Finger printVCryptAuthResult
valueboolean setPIN(java.lang.String customerId, java.lang.String PIN, int pinStatus)
customerId
- user login IdPIN
- New PIN to setpinStatus
- Status of the PIN, like one time, etc.boolean setPassword(java.lang.String customerId, java.lang.String password, int passwordStatus)
customerId
- user login Idpassword
- New password to setpasswordStatus
- Status of the Password, like one time, etc.boolean setImage(java.lang.String customerId, java.lang.String imagePath)
customerId
- user login IdimagePath
- Path to the image fileboolean setCaption(java.lang.String customerId, java.lang.String caption)
customerId
- user login Idcaption
- New caption to setboolean setCaption(java.lang.String customerId, VCryptLocalizedString caption)
boolean setImageAndCaption(java.lang.String customerId, java.lang.String imagePath, java.lang.String caption)
customerId
- user customerIdimagePath
- Path to the image filecaption
- Caption to set for userboolean
valueboolean setImageAndCaption(java.lang.String customerId, java.lang.String imagePath, VCryptLocalizedString caption)
boolean setUserAuthMode(java.lang.String customerId, int authMode)
customerId
- user login IdauthMode
- New authMode to setboolean setGroupUsersAuthMode(java.lang.String groupName, int authMode)
customerGroupId
users to authMode
Uses batch updates and failure is not guaranteed to leave the system in old auth mode as failure may occur in later batch, after initial batches are saved.
groupName
- customerGroupId of the usersauthMode
- new Auth modeboolean setUserStatus(java.lang.String customerId, int status)
customerId
- user login Idstatus
- New status to setjava.lang.String getImage(java.lang.String customerId)
customerId
- user login Idjava.lang.String getCaption(java.lang.String customerId)
customerId
- user login IdVCryptLocalizedString getLocalizedCaption(java.lang.String customerId)
java.lang.String[] getImageAndCaption(java.lang.String customerId)
customerId
- user login Idjava.lang.Object[] getImageAndLocalizedCaption(java.lang.String customerId)
int getUserAuthMode(java.lang.String customerId)
customerId
- user login Idint getUserStatus(java.lang.String customerId)
customerId
- user login IdVCryptQuestion[][] getSignOnQuestions(java.lang.String customerId)
customerId
- The login id of the user to authenticateVCryptQuestion[][] getSignOnQuestions(java.lang.String customerId, VCryptLocale aLocale)
VCryptQuestion[] getAllMappedSignOnQuestions(java.lang.String customerId)
customerId
- customer IdVCryptQuestion
, null incase of invalid users and unexpected errosboolean deleteAllSignOnQuestions(java.lang.String customerId)
customerId
- customer idVCryptResponse addQuestion(java.lang.String customerId, VCryptQuestion question)
customerId
- user login Idquestion
- New question to be added. Overrides if the same question is already set for this user.VCryptResponse addQuestion(java.lang.String requestId, java.lang.String customerId, VCryptQuestion question)
requestId
- Bharosa Request IdcustomerId
- user login Idquestion
- New question to be added. Overrides if the same question is already set for this user.VCryptResponse addQuestions(java.lang.String customerId, VCryptQuestion[] questions)
customerId
- user login Idquestions
- New questions to be added. Overrides if the same question is already set for this user.VCryptResponse addQuestions(java.lang.String requestId, java.lang.String customerId, VCryptQuestion[] questions)
requestId
- Bharosa Request IdcustomerId
- customerIdquestions
- Questionboolean deleteQuestion(java.lang.String customerId, VCryptQuestion question)
customerId
- user login Idquestion
- The question to be deletedVCryptQuestion getSecretQuestion(java.lang.String customerId)
customerId
- The login id of the user to authenticateVCryptQuestion getSecretQuestionForCSR(java.lang.String customerId)
customerId
- The login id of the user to authenticateVCryptQuestion moveToNextSecretQuestion(java.lang.String customerId)
customerId
- The login id of the user to authenticateVCryptAuthResult authenticateQuestion(java.lang.String customerId, java.lang.String answer)
customerId
- The login id of the user to authenticateanswer
- the answer given by the userVCryptAuthResult authenticateQuestion(java.lang.String requestId, java.lang.Integer challengeChannel, java.lang.String customerId, java.lang.String answer)
requestId
- requestIdchallengeChannel
- IBharosaConstants.ENUM_CHALLENGE_CHANNELcustomerId
- The login id of the user to authenticateanswer
- The answer given by the userVCryptAuthResult authenticateQuestionForCSR(java.lang.String requestId, java.lang.Integer challengeChannel, java.lang.String customerId, java.lang.String answer)
requestId
- requestIdchallengeChannel
- IBharosaConstants.ENUM_CHALLENGE_CHANNELcustomerId
- The login id of the user to authenticateanswer
- The answer given by the userVCryptAuthResult authenticateQuestionForCSR(java.lang.String customerId, java.lang.String answer)
customerId
- The login id of the user to authenticateanswer
- the answer given by the user
|
Oracle Fusion Middleware Java API Reference for Oracle Adaptive Access Manager Release 11g (11.1.1) E15864-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |