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	CONSENT_WITHDRAWN 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	deleteConsentReferenceInConsentServiceAndInUserModel(UserModel userModel, java.lang.String baseSiteId) Deletes the consent reference when the user revokes the consent for profile or user closes the account
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
void	removeConsentReferenceCookieAndSession(HttpServletResponse response) removes the consent reference cookie
void	saveConsentReferenceInSessionAndCurrentUserModel(HttpServletRequest request) It gets the consent reference stored in a cookie (generated by ProfileTag) and saves it in the session and in the user model (for logged In users) for further events
void	setProfileConsentCookieAndSession(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

CONSENT_WITHDRAWN

static final java.lang.String CONSENT_WITHDRAWN

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

setProfileConsentCookieAndSession

void setProfileConsentCookieAndSession(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

saveConsentReferenceInSessionAndCurrentUserModel

void saveConsentReferenceInSessionAndCurrentUserModel(HttpServletRequest request)

It gets the consent reference stored in a cookie (generated by ProfileTag) and saves it in the session and in the user model (for logged In users) for further events

Parameters:

request - Http request

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

getConsentReferenceFromSession

java.lang.String getConsentReferenceFromSession()

Fetches the consent reference from session

Returns:

consent reference

deleteConsentReferenceInConsentServiceAndInUserModel

void deleteConsentReferenceInConsentServiceAndInUserModel(UserModel userModel,
                                                          java.lang.String baseSiteId)

Deletes the consent reference when the user revokes the consent for profile or user closes the account

Parameters:

userModel - the user

baseSiteId - the base site id

removeConsentReferenceCookieAndSession

void removeConsentReferenceCookieAndSession(HttpServletResponse response)

removes the consent reference cookie

Parameters:

response - http response