Skip navigation links

com.bharosa.vcrypt.customercare.intf
Interface VCryptCC

public interface VCryptCC

Provides methods for Customer Care Functionality. This inteface provides functionality specific to customer care only. Some other customer care funcationality overlaps with Auth API is from VCryptAuth

Field Summary

static String	REQ_ACTION_COUNT
static String	REQ_CANCEL_TEMP_ALLOW
static String	REQ_FINAL_AUTH_STATUS
static String	REQ_RESET_CHALLENGE_FAILURE_COUNTERS
static String	REQ_RESET_USER
static String	REQ_RULES_DATA
static String	REQ_RULES_DATA_LAST_SESSION
static String	REQ_TEMP_ALLOW

Method Summary

VCryptResponse	cancelAllTemporaryAllows(String customerId) Cancels all the unused temporary for the user.
VCryptIntResponse	getActionCount(String requestId, String customerId, Integer actionEnumId) Get the action count for the given actionEnumId, consult your configuration for available action enums The property [rule.action.enum.<actionName>.incrementCacheCounter] is to be set to true to increment the counter for the action corresponding to <actionName>.
VCryptIntResponse	getFinalAuthStatus(String requestId, String userId) Return the final authentication status of an user given the user id of the user.
VCryptSessionRuleData	getRulesData(String requestId) Return all the rules excuted for the given session Id, provides basic information of what rules got triggered.
VCryptSessionRuleData	getRulesDataForLastSession(String customerId) Return all the rules excuted for the given customerId for past session, provides basic information of what rules got triggered.
VCryptResponse	resetChallengeFailureCounters(String requestId, String customerId, Long questionId) Reset Challenge failure counters for the given customerid
VCryptResponse	resetUser(String customerId) Reset all profiles set for the user.
VCryptResponse	setTemporaryAllow(String customerId, int tempAllowType, Date expirationDate) This call sets a temporary allow for the user.

Field Detail

REQ_FINAL_AUTH_STATUS

static final String REQ_FINAL_AUTH_STATUS

See Also:

Constant Field Values

REQ_RULES_DATA_LAST_SESSION

static final String REQ_RULES_DATA_LAST_SESSION

See Also:

Constant Field Values

REQ_RULES_DATA

static final String REQ_RULES_DATA

See Also:

Constant Field Values

REQ_TEMP_ALLOW

static final String REQ_TEMP_ALLOW

See Also:

Constant Field Values

REQ_CANCEL_TEMP_ALLOW

static final String REQ_CANCEL_TEMP_ALLOW

See Also:

Constant Field Values

REQ_RESET_USER

static final String REQ_RESET_USER

See Also:

Constant Field Values

REQ_RESET_CHALLENGE_FAILURE_COUNTERS

static final String REQ_RESET_CHALLENGE_FAILURE_COUNTERS

See Also:

Constant Field Values

REQ_ACTION_COUNT

static final String REQ_ACTION_COUNT

See Also:

Constant Field Values

Method Detail

getFinalAuthStatus

VCryptIntResponse getFinalAuthStatus(String requestId,
                                     String userId)

Return the final authentication status of an user given the user id of the user. This method can only go back upto 30 days.

Parameters:

requestId - requestId for tracking purpose

userId - unique identifier to the user, can't be null

Returns:

VCryptIntResponse auth status, -1 if no data, Check for VCryptIntResponse.getResponse().isSuccess() to see if the request is succesful before using the value

setTemporaryAllow

VCryptResponse setTemporaryAllow(String customerId,
                                 int tempAllowType,
                                 Date expirationDate)

This call sets a temporary allow for the user.

Parameters:

customerId - Id of the customer

tempAllowType - Type of the temporary allow. The User Defined Enum for this type is customercare.case.tempallow.level.enum

expirationDate - Expiration date if the tempAllowType is "userset". Otherwise it can be null or empty.

Returns:

The response from the server

cancelAllTemporaryAllows

VCryptResponse cancelAllTemporaryAllows(String customerId)

Cancels all the unused temporary for the user.

Parameters:

customerId - Customer Id of the user

Returns:

The response from the server

resetUser

VCryptResponse resetUser(String customerId)

Reset all profiles set for the user. This includes registration, questions, images and phrases

selected or assigned to the user

Parameters:

customerId - Customer Id of the user.

Returns:

The response from the server.

resetChallengeFailureCounters

VCryptResponse resetChallengeFailureCounters(String requestId,
                                             String customerId,
                                             Long questionId)

Reset Challenge failure counters for the given customerid

Parameters:

requestId - to track the request

customerId - external customer id required and used to identify customer uniquely, it is not login Id

questionId - optional, if sent, failure counters for the given question id are reset

Returns:

The response from the server. check isSuccess() for success

getRulesData

VCryptSessionRuleData getRulesData(String requestId)

Return all the rules excuted for the given session Id, provides basic information of what rules got triggered. Doesn't provide complete hierarchy information. Rules execution data is persisted asynchrously and may not be available immediately.

Parameters:

requestId - sessionId

Returns:

VCryptSessionRuleData

getRulesDataForLastSession

VCryptSessionRuleData getRulesDataForLastSession(String customerId)

Return all the rules excuted for the given customerId for past session, provides basic information of what rules got triggered. Doesn't provide complete hierarchy information. Rules execution data is persisted asynchrously and may not be available immediately.

Parameters:

customerId - Customer Id of the user.

Returns:

VCryptSessionRuleData

getActionCount

VCryptIntResponse getActionCount(String requestId,
                                 String customerId,
                                 Integer actionEnumId)

Get the action count for the given actionEnumId, consult your configuration for available action enums The property [rule.action.enum.<actionName>.incrementCacheCounter] is to be set to true to increment the counter for the action corresponding to <actionName>. If it is not set or set to false, the method returns successfully, the value which is present in the cache, but this value may not reflect the exact action count.

Parameters:

requestId - requestId for logging and tracing with client requests in case of errors

customerId - unique identifier to the user, required

actionEnumId - actionEnum, required, rule.action.enum to be counted

Returns:

VCryptIntResponse with int count if action count enum is enabled Check for VCryptIntResponse.getResponse().isSuccess() to see if the request is succesful before using the value Few possibe <nl>VCryptResponse.INVALID_DATA, if actionEnumId is null <nl>VCryptResponse.APPLICATION_ERROR, if cache count is not enabled for the specified enum, contact application support <nl>VCryptResponse.UNEXPECTED_ERROR, in case of unexpected error, contact application support

Skip navigation links