Skip navigation links

com.bharosa.vcrypt.tracker.intf
Interface VCryptTracker

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 String	REQUEST_CREATE_TRANSACTION
static String	REQUEST_TRACKER_INIT
static String	REQUEST_UPDATE_TRANSACTION

Method Summary

VCryptResponse	clearSafeDeviceList(String requestId) Clear safe device list of the user associated with this request
<any>	createOAAMSession(String requestId, Date requestTime, OAAMUserData user, OAAMIPData ip, List<OAAMDeviceFingerprintData> fingerprintDataList, OAAMSessionData sessionData) This function will replace updateLog.
<any>	createOrUpdateEntities(EntityData[] entityRequestData, boolean isReplaceEntity, int commitBatchSize, String requestId) Creates or updates entities.
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
String	generateOTP(String requestId, String challengeType, String appId) Deprecated.
NameValueProfile	getNameValueProfile(String entityDefKey, Long entityId, String requestId) Deprecated.
<any>	getOTPCode(String requestId, String challengeType, Boolean overwriteIfExists) Method to get the OTP Code based on the challenge type.
<any>	getOTPCode(String requestId, String appId, String challengeType, Boolean overwriteIfExists) Method to get the OTP Code based on the challenge type.
<any>	getUserDevices(GetUserDevicesRequestData request) Retrieves the devices associated with a user. If the request is null or if the request.userId is null, returns error code of INVALID_DATA.
CookieSet	handleTrackerRequest(String requestId, Date requestTime, String remoteIPAddr, String remoteHost, String secureCookie, int secureClientType, String secureClientVersion, String digitalSigCookie, int digitalClientType, String digitalClientVersion, int fingerPrintType, String fingerPrint, int fingerPrintType2, String fingerPrint2) This creates the signatures required to finger print the device.
CookieSet	handleTrackerRequest(String requestId, String remoteIPAddr, String remoteHost, String secureCookie, int secureClientType, String secureClientVersion, String digitalCookie, int digitalClientType, String digitalClientVersion, int fingerPrintType, String fingerPrint, int fingerPrintType2, String fingerPrint2) This creates the signatures required to finger print the device.
VCryptResponse	handleTransactionLog(String requestId, Date requestTime, Integer status, Map[] contextMap) Deprecated. Will be removed in future releases, use createTransaction
VCryptResponse	handleTransactionLog(String requestId, Date requestTime, Map[] contextMap) Deprecated. Will be removed in future releases, use createTransaction
VCryptResponse	handleTransactionLog(String requestId, Map[] contextMap) Deprecated. Will be removed in future releases, use createTransaction
VCryptResponse	incrementChallengeCounter(String requestId, String challengeType)
VCryptResponse	init(String requestId) Initialize or warmup server.
VCryptBooleanResponse	IsDeviceMarkedSafe(String requestId) Checks to see the device associated with this requiest is safe
boolean	markDeviceSafe(String requestId, boolean isSafe) This marks the device as safe for the user.
VCryptResponse	processPatternAnalysis(String requestId, long transactionId, int status, String transactionType) Method to trigger the pattern data processing for auto-learning.
NameValueProfile	refreshNameValueProfile(NameValueProfile profile) Deprecated.
VCryptResponse	resetChallengeCounter(String requestId, String challengeType)
NameValueProfile	saveNameValueProfile(NameValueProfile profile) Deprecated.
<any>	searchEntityByKey(EntityData entityData) Finds entity on the basis of its key attributes
VCryptResponse	setUserDevices(String userId, UserDevice[] devices) Modifies devices associated with a user.
VCryptResponse	updateAuthStatus(String requestId, Date requestTime, int resultStatus, int clientType, String clientVersion) Updates User node log auth status
VCryptResponse	updateAuthStatus(String requestId, Date requestTime, int resultStatus, int clientType, String clientVersion, boolean analyzePatterns) Updates User node log auth status
VCryptResponse	updateAuthStatus(String requestId, int resultStatus, int clientType, String clientVersion) Deprecated. use updateAuthStatus(String requestId, OAAMSessionData sessionData);
VCryptResponse	updateAuthStatus(String requestId, int resultStatus, int clientType, String clientVersion, boolean analyzePatterns) Updates User node log auth status
VCryptResponse	updateAuthStatus(String requestId, OAAMSessionData sessionData) This function will replace the updateAuthStatus method with other signatures.
CookieSet	updateLog(String requestId, Date requestTime, String remoteIPAddr, String remoteHost, String secureCookie, String digitalCookie, String groupId, String userId, String loginId, boolean isSecure, int result, int clientType, String clientVersion, int fingerPrintType, String fingerPrint, int fingerPrintType2, String fingerPrint2) Updates the user node log.
CookieSet	updateLog(String requestId, String remoteIPAddr, String remoteHost, String secureCookie, String digitalCookie, String groupId, String userId, String loginId, boolean isSecure, int result, int clientType, String clientVersion, int fingerPrintType, String fingerPrint, int digFingerPrintType, 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(String requestId, Date requestTime, long transactionId, int status) Deprecated. Will be removed in future releases, use updateTransaction
VCryptResponse	updateTransactionStatus(String requestId, Date requestTime, long transactionId, int status, Map[] contextMap) Deprecated. Will be removed in future releases, use updateTransaction
VCryptResponse	updateTransactionStatus(String requestId, Date requestTime, long transactionId, int status, Map[] contextMap, boolean analyzePatterns) Deprecated. Will be removed in future releases, use updateTransaction
VCryptResponse	updateTransactionStatus(String requestId, long transactionId, int status) Deprecated. Will be removed in future releases, use updateTransaction
VCryptResponse	updateTransactionStatus(String requestId, long transactionId, int status, boolean analyzePatterns) Deprecated. Will be removed in future releases, use updateTransaction
VCryptResponse	updateTransactionStatus(String requestId, long transactionId, int status, Map[] contextMap) Deprecated. Will be removed in future releases, use updateTransaction
<any>	validateOTPCode(String requestId, String challengeType, String otpcode) Method to validate OTPCode for the given request identifier and challenge type.
<any>	validateOTPCode(String requestId, String appId, String challengeType, String otpcode) Method to validate OTPCode for the given request identifier and challenge type.

Field Detail

REQUEST_TRACKER_INIT

static final String REQUEST_TRACKER_INIT

See Also:

Constant Field Values

REQUEST_UPDATE_TRANSACTION

static final String REQUEST_UPDATE_TRANSACTION

See Also:

Constant Field Values

REQUEST_CREATE_TRANSACTION

static final String REQUEST_CREATE_TRANSACTION

See Also:

Constant Field Values

Method Detail

init

VCryptResponse init(String requestId)

Initialize or warmup server. Will load necessary caches. Call this method when appserver is first started.

Parameters:

requestId - Request

Returns:

VCryptResponse object

handleTrackerRequest

CookieSet handleTrackerRequest(String requestId,
                               String remoteIPAddr,
                               String remoteHost,
                               String secureCookie,
                               int secureClientType,
                               String secureClientVersion,
                               String digitalCookie,
                               int digitalClientType,
                               String digitalClientVersion,
                               int fingerPrintType,
                               String fingerPrint,
                               int fingerPrintType2,
                               String fingerPrint2)

This creates the signatures required to finger print the device.

Parameters:

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 browser

secureClientType - 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.

Returns:

a CookieSet value

handleTrackerRequest

CookieSet handleTrackerRequest(String requestId,
                               Date requestTime,
                               String remoteIPAddr,
                               String remoteHost,
                               String secureCookie,
                               int secureClientType,
                               String secureClientVersion,
                               String digitalSigCookie,
                               int digitalClientType,
                               String digitalClientVersion,
                               int fingerPrintType,
                               String fingerPrint,
                               int fingerPrintType2,
                               String fingerPrint2)

This creates the signatures required to finger print the device. This method takes the requestTime as input.

Parameters:

requestId - This it the id for the request

requestTime - Time when this request was made. Used by simulator.

remoteIPAddr - The IP from where the request came in

remoteHost - The host name from where the request came in

secureCookie - The secure cookie

secureClientType - secure cookie client type

secureClientVersion - version of the secure cookie client

digitalSigCookie - The digital signature cookie

digitalClientType - digital cookie client type

digitalClientVersion - version of the digital cookie client

fingerPrintType - Type of finger printing

fingerPrint - Finger print

fingerPrintType2 - This in case the same request can have multipe finger prints. Like flash request.

fingerPrint2 - The second finger print value

Returns:

a CookieSet value

handleTransactionLog

VCryptResponse handleTransactionLog(String requestId,
                                    Map[] contextMap)

Deprecated. Will be removed in future releases, use createTransaction

This creates the signatures required to finger print the device.

Parameters:

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 contextMap

Returns:

VCryptResponse to see if the request is successfully processed.

See Also:

createTransaction(com.bharosa.vcrypt.tracker.data.TransactionCreateRequestData)

handleTransactionLog

VCryptResponse handleTransactionLog(String requestId,
                                    Date requestTime,
                                    Map[] contextMap)

Deprecated. Will be removed in future releases, use createTransaction

This creates the signatures required to finger print the transaction

Parameters:

requestId - This it the id for the request

requestTime - Time for this transaction

contextMap - array of context data maps

Returns:

VCryptResponse

See Also:

createTransaction(com.bharosa.vcrypt.tracker.data.TransactionCreateRequestData)

handleTransactionLog

VCryptResponse handleTransactionLog(String requestId,
                                    Date requestTime,
                                    Integer status,
                                    Map[] contextMap)

Deprecated. Will be removed in future releases, use createTransaction

This creates the signatures required to finger print the transaction

Parameters:

requestId - This it the id for the request

requestTime - Time for this transaction

status - transaction status for this transaction

contextMap - array of context data maps

Returns:

VCryptResponse

See Also:

createTransaction(com.bharosa.vcrypt.tracker.data.TransactionCreateRequestData)

updateTransactionStatus

VCryptResponse updateTransactionStatus(String requestId,
                                       long transactionId,
                                       int status)

Deprecated. Will be removed in future releases, use updateTransaction

Update given transaction status.

Parameters:

requestId - Request Identifier

transactionId - Transaction Id to be updated. See #handleTrackerRequest, #handleTransactionLog

status - New Status

Returns:

VCryptResponse

See Also:

updateTransaction(com.bharosa.vcrypt.tracker.data.TransactionUpdateRequestData)

updateTransactionStatus

VCryptResponse updateTransactionStatus(String requestId,
                                       long transactionId,
                                       int status,
                                       boolean analyzePatterns)

Deprecated. Will be removed in future releases, use updateTransaction

Update given transaction status.

AnalyzePatterns param is used by auto-learning.

Parameters:

requestId - Request Identifier

transactionId - Transaction Id to be updated. See #handleTrackerRequest, #handleTransactionLog

status - New Status

analyzePatterns - Boolean to indicate if the pattern analysis should be done.

When passed in as true the pattern analysis is done for this transaction.

Returns:

VCryptResponse

See Also:

updateTransaction(com.bharosa.vcrypt.tracker.data.TransactionUpdateRequestData)

updateTransactionStatus

VCryptResponse updateTransactionStatus(String requestId,
                                       Date requestTime,
                                       long transactionId,
                                       int status)

Deprecated. Will be removed in future releases, use updateTransaction

Update given transaction status.

Parameters:

requestId - Request Identifier

requestTime - Time of the update

transactionId - Transaction Id to be updated. See #handleTrackerRequest, #handleTransactionLog

status - New Status

Returns:

VCryptResponse

See Also:

updateTransaction(com.bharosa.vcrypt.tracker.data.TransactionUpdateRequestData)

updateTransactionStatus

VCryptResponse updateTransactionStatus(String requestId,
                                       long transactionId,
                                       int status,
                                       Map[] contextMap)

Deprecated. Will be removed in future releases, use updateTransaction

Update given transaction status.

Parameters:

requestId - Request Identifier

transactionId - Transaction Id to be updated. See #handleTrackerRequest, #handleTransactionLog

status - New Status

contextMap - array of contextMap

Returns:

VCryptResponse

See Also:

updateTransaction(com.bharosa.vcrypt.tracker.data.TransactionUpdateRequestData)

updateTransactionStatus

VCryptResponse updateTransactionStatus(String requestId,
                                       Date requestTime,
                                       long transactionId,
                                       int status,
                                       Map[] contextMap)

Deprecated. Will be removed in future releases, use updateTransaction

Update given transaction status.

Parameters:

requestId - Request Identifier

requestTime - Time of the update

transactionId - Transaction Id to be updated. See #handleTrackerRequest, #handleTransactionLog

status - New Status

contextMap - array of contextMap

Returns:

VCryptResponse

See Also:

updateTransaction(com.bharosa.vcrypt.tracker.data.TransactionUpdateRequestData)

updateTransactionStatus

VCryptResponse updateTransactionStatus(String requestId,
                                       Date requestTime,
                                       long transactionId,
                                       int status,
                                       Map[] contextMap,
                                       boolean analyzePatterns)

Deprecated. Will be removed in future releases, use updateTransaction

Update given transaction status.

AnalyzePatterns param is used by auto-learning.

Parameters:

requestId - Request Identifier

requestTime - Time of the update

transactionId - Transaction Id to be updated. See #handleTrackerRequest, #handleTransactionLog

status - New Status

contextMap - array of contextMap

analyzePatterns - Boolean to indicate if the pattern analysis should be done.

Returns:

VCryptResponse

See Also:

updateTransaction(com.bharosa.vcrypt.tracker.data.TransactionUpdateRequestData)

updateLog

CookieSet updateLog(String requestId,
                    String remoteIPAddr,
                    String remoteHost,
                    String secureCookie,
                    String digitalCookie,
                    String groupId,
                    String userId,
                    String loginId,
                    boolean isSecure,
                    int result,
                    int clientType,
                    String clientVersion,
                    int fingerPrintType,
                    String fingerPrint,
                    int digFingerPrintType,
                    String digFingerPrint)

Updates the user node log. And if required, it creates the CookieSet also.

Parameters:

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 browser

digitalCookie - The Digital cookie. Can be flash cookie

groupId - 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 printing

digFingerPrint - Digital fingerprint

Returns:

a CookieSet value

updateLog

CookieSet updateLog(String requestId,
                    Date requestTime,
                    String remoteIPAddr,
                    String remoteHost,
                    String secureCookie,
                    String digitalCookie,
                    String groupId,
                    String userId,
                    String loginId,
                    boolean isSecure,
                    int result,
                    int clientType,
                    String clientVersion,
                    int fingerPrintType,
                    String fingerPrint,
                    int fingerPrintType2,
                    String fingerPrint2)

Updates the user node log. And if required, it creates the CookieSet also.

Parameters:

requestId - requestId for the request

requestTime - Time when this request was make. Used primarily by the simulator

remoteIPAddr - The IP from where the request came in

remoteHost - The host name from where the request came in

secureCookie - The secure cookie

digitalCookie - the secure cookie, can be flash cookie

groupId - the groupId of this user.

userId - id of the user

loginId - the loginId used by the user for login in

isSecure - whether this node is secure and can be registered

result - The authentication result.

clientType - the type of the client used for authentication

clientVersion - the version of the client

fingerPrintType - Type of finger printing

fingerPrint - Finger print

fingerPrintType2 - Type of the Digital finger printing

fingerPrint2 - Digital fingerprint

Returns:

a CookieSet value

createOAAMSession

<any> createOAAMSession(String requestId,
                        Date requestTime,
                        OAAMUserData user,
                        OAAMIPData ip,
                        List<OAAMDeviceFingerprintData> fingerprintDataList,
                        OAAMSessionData sessionData)

This function will replace updateLog. It should be used to create OAAM session information. This API should be used only once for creating the OAAM session. If it is used more than one time with the same request number error will be returned.

Parameters:

requestId - requestId for the request. If not populated will be generated in the server and returned in the response.

requestTime - The date-time stamp on the request. (If not populated then will be generated in the server)

user - User Data associated with this session.

ip - IP Address data assocuated with this session.

fingerprintDataList - List of device fingerprints.

sessionData - Session data associated with this session.

Returns:

a VCryptObjectResponse that contains CookieSet

updateAuthStatus

VCryptResponse updateAuthStatus(String requestId,
                                OAAMSessionData sessionData)

This function will replace the updateAuthStatus method with other signatures. It is used to update the authentication status for the given request. All the params should have valid values for this function to work correctly.

Parameters:

requestId - It is a mandatory attribute and without this being a proper valid value, the function will return error.

sessionData - Session data that needs to be updated for this request.

Returns:

Returns a response code based on the results of the processing.

updateAuthStatus

VCryptResponse updateAuthStatus(String requestId,
                                int resultStatus,
                                int clientType,
                                String clientVersion)

Deprecated. use updateAuthStatus(String requestId, OAAMSessionData sessionData);

Updates User node log auth status

Parameters:

requestId - request Id

resultStatus - 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.

Returns:

VCryptResponse

updateAuthStatus

VCryptResponse updateAuthStatus(String requestId,
                                int resultStatus,
                                int clientType,
                                String clientVersion,
                                boolean analyzePatterns)

Updates User node log auth status

AnalyzePatterns param is used by auto-learning.

Parameters:

requestId - request Id

resultStatus - 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.

Returns:

VCryptResponse

Since:

10.1.4.5

updateAuthStatus

VCryptResponse updateAuthStatus(String requestId,
                                Date requestTime,
                                int resultStatus,
                                int clientType,
                                String clientVersion,
                                boolean analyzePatterns)

Updates User node log auth status

AnalyzePatterns param is used by auto-learning.

Parameters:

requestId - request Id

requestTime - Time of update

resultStatus - The authentication result. This is the enumeration value of the authentication result.

clientType - client Type

clientVersion - version of the client

analyzePatterns - Boolean to indicate if the pattern analysis should be done.

Returns:

VCryptResponse to see if the request is successfully processed.

updateAuthStatus

VCryptResponse updateAuthStatus(String requestId,
                                Date requestTime,
                                int resultStatus,
                                int clientType,
                                String clientVersion)

Updates User node log auth status

Parameters:

requestId - request Id

requestTime - Time of update

resultStatus - The authentication result. This is the enumeration value of the authentication result.

clientType - client Type

clientVersion - version of the client

Returns:

VCryptResponse to see if the request is successfully processed.

processPatternAnalysis

VCryptResponse processPatternAnalysis(String requestId,
                                      long transactionId,
                                      int status,
                                      String transactionType)

Method to trigger the pattern data processing for auto-learning.

This method does not do any other activity other than auto-learning pattern analysis.

Parameters:

requestId - Request Identifier

transactionId - Transaction Id to be updated. See #handleTrackerRequest, #handleTransactionLog

status - New Status

transactionType - 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.

Returns:

VCryptResponse to see if the request is successfully processed.

Since:

10.1.4.5

markDeviceSafe

boolean markDeviceSafe(String requestId,
                       boolean isSafe)

This marks the device as safe for the user.

Parameters:

requestId - requestId for the request

isSafe - is this device safe for the user

Returns:

status of the operation

IsDeviceMarkedSafe

VCryptBooleanResponse IsDeviceMarkedSafe(String requestId)

Checks to see the device associated with this requiest is safe

Parameters:

requestId - requesId

Returns:

VCryptBooleanResponse, Check VCryptBooleanResponse.getRepsonse() to see if the request is successfully processed.

clearSafeDeviceList

VCryptResponse clearSafeDeviceList(String requestId)

Clear safe device list of the user associated with this request

Parameters:

requestId - requesId

Returns:

VCryptResponse to see if the request is successfully processed.

createTransaction

VCryptResponse createTransaction(TransactionCreateRequestData transactionCreateRequestData)

API To create a Transaction

Parameters:

transactionCreateRequestData - requestId / Session Id, required

Returns:

VCryptResponse make sure to check isSuccess

Since:

10.1.4.5.1

createTransactions

VCryptResponse[] createTransactions(TransactionCreateRequestData[] transactionCreateRequestData)

API To create a Transactions in bulk Return response object for each create request

Parameters:

transactionCreateRequestData - requestId / Session Id, required

Returns:

VCryptResponse Array of response objects. Each request will have corresponding response. Check isSuccess on each response object

Since:

10.1.4.5.2

updateTransaction

VCryptResponse updateTransaction(TransactionUpdateRequestData transactionUpdateRequestData)

API to update previously created Transaction Updates given transaction

Parameters:

transactionUpdateRequestData - update Request

Returns:

VCryptResponse make sure to check isSuccess

Since:

10.1.4.5.1

updateTransactions

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

Parameters:

transactionUpdateRequestData - array of update Request object

Returns:

VCryptResponse Array of response objects. Each request will have corresponding response. Check isSuccess on each response object

Since:

10.1.4.5.2

getNameValueProfile

NameValueProfile getNameValueProfile(String entityDefKey,
                                     Long entityId,
                                     String requestId)

Deprecated.

Returns the NameValueProfile for an entity and request.

Parameters:

entityDefKey -

entityId -

requestId -

Returns:

NameValueProfile

saveNameValueProfile

NameValueProfile saveNameValueProfile(NameValueProfile profile)

Deprecated.

Saves the changes made to the profile.

Parameters:

profile -

Returns:

the refreshed NameValueProfile

refreshNameValueProfile

NameValueProfile refreshNameValueProfile(NameValueProfile profile)

Deprecated.

Resets the values of the profile to the latest from the database.

Parameters:

profile -

Returns:

the refreshed NameValueProfile

generateOTP

@Deprecated
String generateOTP(String requestId,
                              String challengeType,
                              String appId)

Deprecated.

resetChallengeCounter

VCryptResponse resetChallengeCounter(String requestId,
                                     String challengeType)

Parameters:

challengeType - challenge type

Returns:

success ore failure

incrementChallengeCounter

VCryptResponse incrementChallengeCounter(String requestId,
                                         String challengeType)

Parameters:

challengeType - challenge type

Returns:

success ore failure

getOTPCode

<any> getOTPCode(String requestId,
                 String appId,
                 String challengeType,
                 Boolean overwriteIfExists)

Method to get the OTP Code based on the challenge type.

This method can be called 'n' number of time to get OTP Code for given request identifier. If there is no OTP Code exists for the given request identifier then new OTPCode will be generated If OTP Code exists for the given request identifier and overwriteIfexists is true then new OTPCode will be generated If OTP Code exists and OTP Code is not expired, then same OTP Code will be returned by renewing the expiry else new OTP Code will be returned. The OTP Code can be retrieved from the VCryptObjectResponse object as follows String otpCode = (String) vcryptResponseObj.getObject();

Parameters:

requestId - Request Identifier

appId - Application Id. This is used to lookup challenge type properties based on application identification.

challengeType - Challenge type. This should be one of the OTP enabled enumeration element of Enumeration 'bharosa.uio.>appId<.challenge.type.enum'

overwriteIfExists - If overwriteIfExists is true then new OTP Code will be returned by, ignoring the presence of any existing OTPCode for the given request identifier else existing OTPCode will be returned if exists else new one will be generated.

Returns:

VCryptObjectResponse On successful response, OTPCode will be returned or failure error message with reason will be returned

getOTPCode

<any> getOTPCode(String requestId,
                 String challengeType,
                 Boolean overwriteIfExists)

Method to get the OTP Code based on the challenge type.

This method can be called 'n' number of time to get OTP Code for given request identifier. If there is no OTP Code exists for the given request identifier then new OTPCode will be generated If OTP Code exists for the given request identifier and overwriteIfexists is true then new OTPCode will be generated If OTP Code exists and OTP Code is not expired, then same OTP Code will be returned by renewing the expiry else new OTP Code will be returned. The OTP Code can be retrieved from the VCryptObjectResponse object as follows String otpCode = (String) vcryptResponseObj.getObject();

Parameters:

requestId - Request Identifier

challengeType - Challenge type. This should be one of the OTP enabled enumeration element of Enumeration 'bharosa.uio.default.challenge.type.enum'

overwriteIfExists - If overwriteIfExists is true then new OTP Code will be returned by, ignoring the presence of any existing OTPCode for the given request identifier else existing OTPCode will be returned if exists else new one will be generated.

Returns:

VCryptObjectResponse On successful response, OTPCode will be returned or failure error message with reason will be returned

validateOTPCode

<any> validateOTPCode(String requestId,
                      String appId,
                      String challengeType,
                      String otpcode)

Method to validate OTPCode for the given request identifier and challenge type.

This method can be called 'n' number of time to validate the OTP Code for given request identifier. If the OTPCode exists and not expired and given OTP Code matches the existing OTP Code then returns response with OTP_CODE_MATCHED value If the OTPCode exists and not expired and given OTP Code does not matches the existing OTP Code then returns response with OTP_CODE_NOT_MATCHED value If the OTPCode exists and expired then returns response with OTP_CODE_EXPIRED value If the OTPCode does not exists then returns OTP_CODE_DOESNOT_EXISTS The OTP validation result can be retrieved from the VCryptObjectResponse object as follows TrackerAPIUtil.OTPValidationResult otpCode = (TrackerAPIUtil.OTPValidationResult) vcryptResponseObj.getObject();

Parameters:

requestId - Request identifier

appId - Application Id. This is used to lookup challenge type properties based on application identification.

challengeType - Challenge type. This should be one of the OTP enabled enumeration element of Enumeratioin 'bharosa.uio.default.challenge.type.enum'

otpcode - OTP Code to validate

Returns:

VCryptObjectResponse On successful response, OTP_CODE_MATCHED/OTP_CODE_NOT_MATCHED/OTP_CODE_EXPIRED/OTP_CODE_DOESNOT_EXISTS will be returned or failure error message with reason will be returned

validateOTPCode

<any> validateOTPCode(String requestId,
                      String challengeType,
                      String otpcode)

Method to validate OTPCode for the given request identifier and challenge type.

This method can be called 'n' number of time to validate the OTP Code for given request identifier. If the OTPCode exists and not expired and given OTP Code matches the existing OTP Code then returns response with OTP_CODE_MATCHED value If the OTPCode exists and not expired and given OTP Code does not matches the existing OTP Code then returns response with OTP_CODE_NOT_MATCHED value If the OTPCode exists and expired then returns response with OTP_CODE_EXPIRED value If the OTPCode does not exists then returns OTP_CODE_DOESNOT_EXISTS The OTP validation result can be retrieved from the VCryptObjectResponse object as follows TrackerAPIUtil.OTPValidationResult otpCode = (TrackerAPIUtil.OTPValidationResult) vcryptResponseObj.getObject();

Parameters:

requestId - Request identifier

challengeType - Challenge type. This should be one of the OTP enabled enumeration element of Enumeratioin 'bharosa.uio.default.challenge.type.enum'

otpcode - OTP Code to validate

Returns:

VCryptObjectResponse On successful response, OTP_CODE_MATCHED/OTP_CODE_NOT_MATCHED/OTP_CODE_EXPIRED/OTP_CODE_DOESNOT_EXISTS will be returned or failure error message with reason will be returned

createOrUpdateEntities

<any> createOrUpdateEntities(EntityData[] entityRequestData,
                             boolean isReplaceEntity,
                             int commitBatchSize,
                             String requestId)

Creates or updates entities.

Parameters:

entityRequestData - : array of EntityData objects. An EntityData object contains the information required to create one entity. See EntityData.java for more details

isReplaceEntity - : flag to determine replacement or merging of attributes on updation of entity. Default value : FALSE which denotes merge.

commitBatchSize - : determines the number of entities which have to be comitted together.Default and Min value = 1

requestId - : Value to identify the session.The value will be sent by client.If the client does not set this value then we generate a dummy number

Returns:

VCryptObjectResponse: SUCCESS on successful execution of API(there is no db or connection error) and at least one entity is created. ERROR if no entity is created. On SUCCESS : response.getObject() returns Array object containing VCryptObjectResponse for individual entities. Each such response object contains Entity object on SUCCESS and Error message on ERROR

searchEntityByKey

<any> searchEntityByKey(EntityData entityData)

Finds entity on the basis of its key attributes

Parameters:

entityData - : EntityData object with entityName and entityDataMap containing key(s) and value(s) of primary key attributes of the entity to be searched based on the id scheme

Returns:

VCryptObjectResponse : containing Entity object which is the entity object on SUCCESS or error message on ERROR

getUserDevices

<any> getUserDevices(GetUserDevicesRequestData request)

Retrieves the devices associated with a user.
If the request is null or if the request.userId is null, returns error code of INVALID_DATA. If the request.status, request.fromIndex, or request.toIndex are missing or invalid, defaults to SECURE, 0, and 50, respectively. If request.userId does not map to a valid VTUser record, returns error code of INVALID_DATA. For any other errors, returns error code of UNEXPECTED_ERROR.

Parameters:

request - Filter criteria for the search, contains userId, whether to limit to secure/unsecure devices, and paging parameters.

Returns:

VCryptObjectResponse containing a GetUserDevicesResultData with a list of UserDevice on SUCCESS, or error message on ERROR.

Since:

11.1.2.2.0

setUserDevices

VCryptResponse setUserDevices(String userId,
                              UserDevice[] devices)

Modifies devices associated with a user. This method can be used to toggle the isSecure flag and to set the friendly name for the device. This method will either succeed or fail. If any device cannot be updated, no devices will be updated. If the userId is null or does not map to a valid VTUser record, returns error code of INVALID_DATA. If devices is null or empty, returns error code of INVALID_DATA. If any of the devices have a vtUserMapId that does not map to a valid VTUserDeviceMap, returns an error code of INVALID_DATA, and no changes are made. If any of the devices are associated with a user other than the one specified, returns an error code of INVALID_DATA, and no changes are made. If any of the elements of the devices array are null, they are ignored and the non-null elements are updated. For any other errors, returns error code of UNEXPECTED_ERROR.

Parameters:

userId - The user id for the devices.

devices - The devices to be updated.

Returns:

VCryptResponse indicating SUCCESS or ERROR, with error message in case of ERROR.

Since:

11.1.2.2.0

Skip navigation links