com.hybris.yprofile.consent.services

Interface ConsentService

All Known Implementing Classes:

DefaultConsentService

public interface ConsentService

ConsentService interface. Service is responsible to generate and provide the consent reference.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANONYMOUS_CONSENTS Cookie for anonymous user
static java.lang.String	CONSENT_GIVEN Expected consent value
static java.lang.String	PROFILE_CONSENT Consent code for Profile
static java.lang.String	PROFILE_CONSENT_GIVEN Cookie and Session attribute key
static java.lang.String	USER_CONSENTS Session attribute for logged in users

Method Summary

Modifier and Type	Method and Description
void	generateConsentReference(HttpServletRequest request, HttpServletResponse response) Generates the consent reference for the user and stores it both in a cookie and in the session
void	generateConsentReference(HttpServletRequest request, HttpServletResponse response, boolean shouldGenerateConsentReference) Generates the consent reference for the user and stores it both in a cookie and in the session
<any>	generateConsentReferenceForUser(java.lang.String userId) Executes the rest call to the consent service to get the consent reference for a given user
java.lang.String	getConsentReferenceFromCookie(java.lang.String siteId, HttpServletRequest request) Fetches the consent reference from cookie
java.lang.String	getConsentReferenceFromSession() Fetches the consent reference from session
boolean	isProfileTrackingConsentGiven(HttpServletRequest request) Checks if the user (logged In or Anonymous) has granted the consent to allow profile tracking
boolean	isProfileTrackingConsentGivenForAnonymousUser(java.util.Optional<Cookie> anonymousConsentCookie) Checks if the Anonymous User has granted the consent to allow profile tracking The consents for Anonymous Users are stored in a Cookie
boolean	isProfileTrackingConsentGivenForLoggedInUser() Checks if the Log In User has granted the consent to allow profile tracking The consents for Log In Users are stored in Session
void	setProfileConsentCookie(HttpServletRequest request, HttpServletResponse response, boolean consent) Saves the profile consent separately in a cookie and session attribute

Field Detail

USER_CONSENTS

static final java.lang.String USER_CONSENTS

Session attribute for logged in users

See Also:

Constant Field Values

ANONYMOUS_CONSENTS

static final java.lang.String ANONYMOUS_CONSENTS

Cookie for anonymous user

See Also:

Constant Field Values

PROFILE_CONSENT

static final java.lang.String PROFILE_CONSENT

Consent code for Profile

See Also:

Constant Field Values

CONSENT_GIVEN

static final java.lang.String CONSENT_GIVEN

Expected consent value

See Also:

Constant Field Values

PROFILE_CONSENT_GIVEN

static final java.lang.String PROFILE_CONSENT_GIVEN

Cookie and Session attribute key

See Also:

Constant Field Values

Method Detail

isProfileTrackingConsentGiven

boolean isProfileTrackingConsentGiven(HttpServletRequest request)

Checks if the user (logged In or Anonymous) has granted the consent to allow profile tracking

Parameters:

request - the http request

Returns:

true or false

isProfileTrackingConsentGivenForLoggedInUser

boolean isProfileTrackingConsentGivenForLoggedInUser()

Checks if the Log In User has granted the consent to allow profile tracking The consents for Log In Users are stored in Session

Returns:

true or false

setProfileConsentCookie

void setProfileConsentCookie(HttpServletRequest request,
                             HttpServletResponse response,
                             boolean consent)

Saves the profile consent separately in a cookie and session attribute

Parameters:

request - http request

response - http reponse

consent - true or false

isProfileTrackingConsentGivenForAnonymousUser

boolean isProfileTrackingConsentGivenForAnonymousUser(java.util.Optional<Cookie> anonymousConsentCookie)

Checks if the Anonymous User has granted the consent to allow profile tracking The consents for Anonymous Users are stored in a Cookie

Parameters:

anonymousConsentCookie -

Returns:

true or false

generateConsentReferenceForUser

<any> generateConsentReferenceForUser(java.lang.String userId)

Executes the rest call to the consent service to get the consent reference for a given user

Parameters:

userId - the user id

Returns:

the consent service response

generateConsentReference

void generateConsentReference(HttpServletRequest request,
                              HttpServletResponse response)

Generates the consent reference for the user and stores it both in a cookie and in the session

Parameters:

request - Http request

response - Http response with the consent reference cookie

generateConsentReference

void generateConsentReference(HttpServletRequest request,
                              HttpServletResponse response,
                              boolean shouldGenerateConsentReference)

Generates the consent reference for the user and stores it both in a cookie and in the session

Parameters:

request - Http request

response - Http response with the consent reference cookie

shouldGenerateConsentReference - should generate consent reference

getConsentReferenceFromSession

java.lang.String getConsentReferenceFromSession()

Fetches the consent reference from session

Returns:

consent reference

getConsentReferenceFromCookie

java.lang.String getConsentReferenceFromCookie(java.lang.String siteId,
                                               HttpServletRequest request)

Fetches the consent reference from cookie

Parameters:

siteId - base site identifier

request - http request

Returns:

consent reference