|
Oracle Adaptive Access Manager Java API Reference 11.1.1 E15864-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface VCryptTracker
This interface provides methods for finger printing the device and also updating the tracker database with authentication status and transaction logs.
Field Summary | |
---|---|
static java.lang.String |
REQUEST_CREATE_TRANSACTION |
static java.lang.String |
REQUEST_TRACKER_INIT |
static java.lang.String |
REQUEST_UPDATE_TRANSACTION |
Method Summary | |
---|---|
VCryptResponse |
clearSafeDeviceList(java.lang.String requestId) Clear safe device list of the user associated with this request |
VCryptResponse |
createTransaction(TransactionCreateRequestData transactionCreateRequestData) API To create a Transaction |
VCryptResponse[] |
createTransactions(TransactionCreateRequestData[] transactionCreateRequestData) API To create a Transactions in bulk Return response object for each create request |
NameValueProfile |
getNameValueProfile(java.lang.String entityDefKey, java.lang.Long extEntityId, java.lang.String requestId) Returns the NameValueProfile for an entity and request. |
CookieSet |
handleTrackerRequest(java.lang.String requestId, java.util.Date requestTime, java.lang.String remoteIPAddr, java.lang.String remoteHost, java.lang.String secureCookie, int secureClientType, java.lang.String secureClientVersion, java.lang.String digitalSigCookie, int digitalClientType, java.lang.String digitalClientVersion, int fingerPrintType, java.lang.String fingerPrint, int fingerPrintType2, java.lang.String fingerPrint2) This creates the signatures required to finger print the device. |
CookieSet |
handleTrackerRequest(java.lang.String requestId, java.lang.String remoteIPAddr, java.lang.String remoteHost, java.lang.String secureCookie, int secureClientType, java.lang.String secureClientVersion, java.lang.String digitalCookie, int digitalClientType, java.lang.String digitalClientVersion, int fingerPrintType, java.lang.String fingerPrint, int fingerPrintType2, java.lang.String fingerPrint2) This creates the signatures required to finger print the device. |
VCryptResponse |
handleTransactionLog(java.lang.String requestId, java.util.Date requestTime, java.lang.Integer status, java.util.Map[] contextMap) Deprecated. Will be removed in future releases, use createTransaction |
VCryptResponse |
handleTransactionLog(java.lang.String requestId, java.util.Date requestTime, java.util.Map[] contextMap) Deprecated. Will be removed in future releases, use createTransaction |
VCryptResponse |
handleTransactionLog(java.lang.String requestId, java.util.Map[] contextMap) Deprecated. Will be removed in future releases, use createTransaction |
VCryptResponse |
incrementChallengeCounter(java.lang.String requestId, java.lang.String challengeType) |
VCryptResponse |
init(java.lang.String requestId) Initialize or warmup server. |
VCryptBooleanResponse |
IsDeviceMarkedSafe(java.lang.String requestId) Checks to see the device associated with this requiest is safe |
boolean |
markDeviceSafe(java.lang.String requestId, boolean isSafe) This marks the device as safe for the user. |
VCryptResponse |
processPatternAnalysis(java.lang.String requestId, long transactionId, int status, java.lang.String transactionType) Method to trigger the pattern data processing for auto-learning. |
NameValueProfile |
refreshNameValueProfile(NameValueProfile profile) Resets the values of the profile to the latest from the database. |
VCryptResponse |
resetChallengeCounter(java.lang.String requestId, java.lang.String challengeType) |
NameValueProfile |
saveNameValueProfile(NameValueProfile profile) Saves the changes made to the profile. |
VCryptResponse |
updateAuthStatus(java.lang.String requestId, java.util.Date requestTime, int resultStatus, int clientType, java.lang.String clientVersion) Updates User node log auth status |
VCryptResponse |
updateAuthStatus(java.lang.String requestId, java.util.Date requestTime, int resultStatus, int clientType, java.lang.String clientVersion, boolean analyzePatterns) Updates User node log auth status |
VCryptResponse |
updateAuthStatus(java.lang.String requestId, int resultStatus, int clientType, java.lang.String clientVersion) Updates User node log auth status |
VCryptResponse |
updateAuthStatus(java.lang.String requestId, int resultStatus, int clientType, java.lang.String clientVersion, boolean analyzePatterns) Updates User node log auth status |
CookieSet |
updateLog(java.lang.String requestId, java.util.Date requestTime, java.lang.String remoteIPAddr, java.lang.String remoteHost, java.lang.String secureCookie, java.lang.String digitalCookie, java.lang.String groupId, java.lang.String userId, java.lang.String loginId, boolean isSecure, int result, int clientType, java.lang.String clientVersion, int fingerPrintType, java.lang.String fingerPrint, int fingerPrintType2, java.lang.String fingerPrint2) Updates the user node log. |
CookieSet |
updateLog(java.lang.String requestId, java.lang.String remoteIPAddr, java.lang.String remoteHost, java.lang.String secureCookie, java.lang.String digitalCookie, java.lang.String groupId, java.lang.String userId, java.lang.String loginId, boolean isSecure, int result, int clientType, java.lang.String clientVersion, int fingerPrintType, java.lang.String fingerPrint, int digFingerPrintType, java.lang.String digFingerPrint) Updates the user node log. |
VCryptResponse |
updateTransaction(TransactionUpdateRequestData transactionUpdateRequestData) API to update previously created Transaction Updates given transaction |
VCryptResponse[] |
updateTransactions(TransactionUpdateRequestData[] transactionUpdateRequestData) API to update Transactions in bulk If there are errors in any update, will proceed with next transaction and return response for each request |
VCryptResponse |
updateTransactionStatus(java.lang.String requestId, java.util.Date requestTime, long transactionId, int status) Deprecated. Will be removed in future releases, use updateTransaction |
VCryptResponse |
updateTransactionStatus(java.lang.String requestId, java.util.Date requestTime, long transactionId, int status, java.util.Map[] contextMap) Deprecated. Will be removed in future releases, use updateTransaction |
VCryptResponse |
updateTransactionStatus(java.lang.String requestId, java.util.Date requestTime, long transactionId, int status, java.util.Map[] contextMap, boolean analyzePatterns) Deprecated. Will be removed in future releases, use updateTransaction |
VCryptResponse |
updateTransactionStatus(java.lang.String requestId, long transactionId, int status) Deprecated. Will be removed in future releases, use updateTransaction |
VCryptResponse |
updateTransactionStatus(java.lang.String requestId, long transactionId, int status, boolean analyzePatterns) Deprecated. Will be removed in future releases, use updateTransaction |
VCryptResponse |
updateTransactionStatus(java.lang.String requestId, long transactionId, int status, java.util.Map[] contextMap) Deprecated. Will be removed in future releases, use updateTransaction |
Field Detail |
---|
static final java.lang.String REQUEST_TRACKER_INIT
static final java.lang.String REQUEST_UPDATE_TRANSACTION
static final java.lang.String REQUEST_CREATE_TRANSACTION
Method Detail |
---|
VCryptResponse init(java.lang.String requestId)
requestId
- RequestCookieSet handleTrackerRequest(java.lang.String requestId, java.lang.String remoteIPAddr, java.lang.String remoteHost, java.lang.String secureCookie, int secureClientType, java.lang.String secureClientVersion, java.lang.String digitalCookie, int digitalClientType, java.lang.String digitalClientVersion, int fingerPrintType, java.lang.String fingerPrint, int fingerPrintType2, java.lang.String fingerPrint2)
requestId
- This it the id for the login session. The same Id should be used for all the calls to Bharosa API for the login session.remoteIPAddr
- The IP from where the request came in. This is extracted from the HTTP request.remoteHost
- The host name from where the request came in. This is optional.secureCookie
- The secure cookie. This is passed only if it is received from the browsersecureClientType
- secure cookie client type. This is an enum value defined to identify the client used for authentication.secureClientVersion
- version of the secure cookie client. This is an optional parameter to specify the version of the client used.digitalCookie
- The digital signature cookie. This could be the flash cookie. This parameter is sent only it is sent by the browser.digitalClientType
- digital cookie client type. The type of flash client used. If not available, please use the value 0.digitalClientVersion
- version of the digital cookie client. The version of the flash client.fingerPrintType
- Type of finger printing. The value for defined in the properties file.fingerPrint
- Finger print. If it is browser characteristics, then the header is parsed into this string. This is the name value representation of the browser header information.fingerPrintType2
- This in case the same request can have multipe finger prints. Like flash request. The value is defined in the properties file.fingerPrint2
- The second finger print value. If it is from the flash, then it is passed as it is. This is an optional parameter.CookieSet
valueCookieSet handleTrackerRequest(java.lang.String requestId, java.util.Date requestTime, java.lang.String remoteIPAddr, java.lang.String remoteHost, java.lang.String secureCookie, int secureClientType, java.lang.String secureClientVersion, java.lang.String digitalSigCookie, int digitalClientType, java.lang.String digitalClientVersion, int fingerPrintType, java.lang.String fingerPrint, int fingerPrintType2, java.lang.String fingerPrint2)
requestId
- This it the id for the requestrequestTime
- Time when this request was made. Used by simulator.remoteIPAddr
- The IP from where the request came inremoteHost
- The host name from where the request came insecureCookie
- The secure cookiesecureClientType
- secure cookie client typesecureClientVersion
- version of the secure cookie clientdigitalSigCookie
- The digital signature cookiedigitalClientType
- digital cookie client typedigitalClientVersion
- version of the digital cookie clientfingerPrintType
- Type of finger printingfingerPrint
- Finger printfingerPrintType2
- This in case the same request can have multipe finger prints. Like flash request.fingerPrint2
- The second finger print valueCookieSet
valueVCryptResponse handleTransactionLog(java.lang.String requestId, java.util.Map[] contextMap)
requestId
- This it the id for the login session. The same Id should be used for all the calls to Bharosa API for the login session.contextMap
- array of contextMapcreateTransaction(com.bharosa.vcrypt.tracker.data.TransactionCreateRequestData)
VCryptResponse handleTransactionLog(java.lang.String requestId, java.util.Date requestTime, java.util.Map[] contextMap)
requestId
- This it the id for the requestrequestTime
- Time for this transactioncontextMap
- array of context data mapscreateTransaction(com.bharosa.vcrypt.tracker.data.TransactionCreateRequestData)
VCryptResponse handleTransactionLog(java.lang.String requestId, java.util.Date requestTime, java.lang.Integer status, java.util.Map[] contextMap)
requestId
- This it the id for the requestrequestTime
- Time for this transactionstatus
- transaction status for this transactioncontextMap
- array of context data mapscreateTransaction(com.bharosa.vcrypt.tracker.data.TransactionCreateRequestData)
VCryptResponse updateTransactionStatus(java.lang.String requestId, long transactionId, int status)
requestId
- Request IdentifiertransactionId
- Transaction Id to be updated. See #handleTrackerRequest, #handleTransactionLogstatus
- New StatusupdateTransaction(com.bharosa.vcrypt.tracker.data.TransactionUpdateRequestData)
VCryptResponse updateTransactionStatus(java.lang.String requestId, long transactionId, int status, boolean analyzePatterns)
AnalyzePatterns param is used by auto-learning.
requestId
- Request IdentifiertransactionId
- Transaction Id to be updated. See #handleTrackerRequest, #handleTransactionLogstatus
- New StatusanalyzePatterns
- Boolean to indicate if the pattern analysis should be done.
When passed in as true the pattern analysis is done for this transaction.
updateTransaction(com.bharosa.vcrypt.tracker.data.TransactionUpdateRequestData)
VCryptResponse updateTransactionStatus(java.lang.String requestId, java.util.Date requestTime, long transactionId, int status)
requestId
- Request IdentifierrequestTime
- Time of the updatetransactionId
- Transaction Id to be updated. See #handleTrackerRequest, #handleTransactionLogstatus
- New StatusupdateTransaction(com.bharosa.vcrypt.tracker.data.TransactionUpdateRequestData)
VCryptResponse updateTransactionStatus(java.lang.String requestId, long transactionId, int status, java.util.Map[] contextMap)
requestId
- Request IdentifiertransactionId
- Transaction Id to be updated. See #handleTrackerRequest, #handleTransactionLogstatus
- New StatuscontextMap
- array of contextMapupdateTransaction(com.bharosa.vcrypt.tracker.data.TransactionUpdateRequestData)
VCryptResponse updateTransactionStatus(java.lang.String requestId, java.util.Date requestTime, long transactionId, int status, java.util.Map[] contextMap)
requestId
- Request IdentifierrequestTime
- Time of the updatetransactionId
- Transaction Id to be updated. See #handleTrackerRequest, #handleTransactionLogstatus
- New StatuscontextMap
- array of contextMapupdateTransaction(com.bharosa.vcrypt.tracker.data.TransactionUpdateRequestData)
VCryptResponse updateTransactionStatus(java.lang.String requestId, java.util.Date requestTime, long transactionId, int status, java.util.Map[] contextMap, boolean analyzePatterns)
AnalyzePatterns param is used by auto-learning.
requestId
- Request IdentifierrequestTime
- Time of the updatetransactionId
- Transaction Id to be updated. See #handleTrackerRequest, #handleTransactionLogstatus
- New StatuscontextMap
- array of contextMapanalyzePatterns
- Boolean to indicate if the pattern analysis should be done.updateTransaction(com.bharosa.vcrypt.tracker.data.TransactionUpdateRequestData)
CookieSet updateLog(java.lang.String requestId, java.lang.String remoteIPAddr, java.lang.String remoteHost, java.lang.String secureCookie, java.lang.String digitalCookie, java.lang.String groupId, java.lang.String userId, java.lang.String loginId, boolean isSecure, int result, int clientType, java.lang.String clientVersion, int fingerPrintType, java.lang.String fingerPrint, int digFingerPrintType, java.lang.String digFingerPrint)
requestId
- This it the id for the login session. The same Id should be used for all the calls to Bharosa API for the login session.remoteIPAddr
- The IP from where the request came in. This is extracted from the HTTP request.remoteHost
- The host name from where the request came in. This is optional.secureCookie
- The secure cookie. This is passed only if it is received from the browserdigitalCookie
- The Digital cookie. Can be flash cookiegroupId
- the groupId of this user. This is the primary group to which this user belongs to.userId
- id of the user. This is the primary key id of the user. It should be null for user who are invalid.loginId
- the loginId used by the user for login in. This is mandatory parameter.isSecure
- whether this node is secure and can be registered. This is to indicate the login is from a secure or registered device. If there is no concept of device, then send false value for this parameter.result
- The authentication result. This is the enumeration value of the authentication result.clientType
- This is an enum value defined to identify the client type used for authentication.clientVersion
- the version of the client. This is an optional parameter to specify the version of the client used.fingerPrintType
- Type of finger printing. The value for defined in the properties file.fingerPrint
- If it is browser characteristics, then the header is parsed into this string. This is the name value representation of the browser header information.digFingerPrintType
- Type of the Digital finger printingdigFingerPrint
- Digital fingerprintCookieSet
valueCookieSet updateLog(java.lang.String requestId, java.util.Date requestTime, java.lang.String remoteIPAddr, java.lang.String remoteHost, java.lang.String secureCookie, java.lang.String digitalCookie, java.lang.String groupId, java.lang.String userId, java.lang.String loginId, boolean isSecure, int result, int clientType, java.lang.String clientVersion, int fingerPrintType, java.lang.String fingerPrint, int fingerPrintType2, java.lang.String fingerPrint2)
requestId
- requestId for the requestrequestTime
- Time when this request was make. Used primarily by the simulatorremoteIPAddr
- The IP from where the request came inremoteHost
- The host name from where the request came insecureCookie
- The secure cookiedigitalCookie
- the secure cookie, can be flash cookiegroupId
- the groupId of this user.userId
- id of the userloginId
- the loginId used by the user for login inisSecure
- whether this node is secure and can be registeredresult
- The authentication result.clientType
- the type of the client used for authenticationclientVersion
- the version of the clientfingerPrintType
- Type of finger printingfingerPrint
- Finger printfingerPrintType2
- Type of the Digital finger printingfingerPrint2
- Digital fingerprintCookieSet
valueVCryptResponse updateAuthStatus(java.lang.String requestId, int resultStatus, int clientType, java.lang.String clientVersion)
requestId
- request IdresultStatus
- The authentication result. This is the enumeration value of the authentication result.clientType
- This is an enum value defined to identify the client type used for authentication.clientVersion
- Optional parameter to specify the version of the client used.VCryptResponse updateAuthStatus(java.lang.String requestId, int resultStatus, int clientType, java.lang.String clientVersion, boolean analyzePatterns)
AnalyzePatterns param is used by auto-learning.
requestId
- request IdresultStatus
- The authentication result. This is the enumeration value of the authentication result.clientType
- This is an enum value defined to identify the client type used for authentication.clientVersion
- Optional parameter to specify the version of the client used.analyzePatterns
- Boolean to indicate if the pattern analysis should be done.
When passed in as true the pattern analysis is done for this transaction.
VCryptResponse updateAuthStatus(java.lang.String requestId, java.util.Date requestTime, int resultStatus, int clientType, java.lang.String clientVersion, boolean analyzePatterns)
AnalyzePatterns param is used by auto-learning.
requestId
- request IdrequestTime
- Time of updateresultStatus
- The authentication result. This is the enumeration value of the authentication result.clientType
- client TypeclientVersion
- version of the clientanalyzePatterns
- Boolean to indicate if the pattern analysis should be done.VCryptResponse updateAuthStatus(java.lang.String requestId, java.util.Date requestTime, int resultStatus, int clientType, java.lang.String clientVersion)
requestId
- request IdrequestTime
- Time of updateresultStatus
- The authentication result. This is the enumeration value of the authentication result.clientType
- client TypeclientVersion
- version of the clientVCryptResponse processPatternAnalysis(java.lang.String requestId, long transactionId, int status, java.lang.String transactionType)
This method does not do any other activity other than auto-learning pattern analysis.
requestId
- Request IdentifiertransactionId
- Transaction Id to be updated. See #handleTrackerRequest, #handleTransactionLogstatus
- New StatustransactionType
- String that indicates the type of transaction. Has to be "auth" for authentication type. For other types it can be "bill_pay, ....",; basically the type name of the transaction.boolean markDeviceSafe(java.lang.String requestId, boolean isSafe)
requestId
- requestId for the requestisSafe
- is this device safe for the userVCryptBooleanResponse IsDeviceMarkedSafe(java.lang.String requestId)
requestId
- requesIdVCryptResponse clearSafeDeviceList(java.lang.String requestId)
requestId
- requesIdVCryptResponse createTransaction(TransactionCreateRequestData transactionCreateRequestData)
transactionCreateRequestData
- requestId / Session Id, requiredVCryptResponse[] createTransactions(TransactionCreateRequestData[] transactionCreateRequestData)
transactionCreateRequestData
- requestId / Session Id, requiredVCryptResponse updateTransaction(TransactionUpdateRequestData transactionUpdateRequestData)
transactionUpdateRequestData
- update RequestVCryptResponse[] updateTransactions(TransactionUpdateRequestData[] transactionUpdateRequestData)
transactionUpdateRequestData
- array of update Request objectNameValueProfile getNameValueProfile(java.lang.String entityDefKey, java.lang.Long extEntityId, java.lang.String requestId)
entityDefKey
-extEntityId
-requestId
-NameValueProfile saveNameValueProfile(NameValueProfile profile)
profile
-NameValueProfile refreshNameValueProfile(NameValueProfile profile)
profile
-VCryptResponse resetChallengeCounter(java.lang.String requestId, java.lang.String challengeType)
challengeType
- challenge typeVCryptResponse incrementChallengeCounter(java.lang.String requestId, java.lang.String challengeType)
challengeType
- challenge type
|
Oracle Adaptive Access Manager Java API Reference 11.1.1 E15864-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |