com.hybris.yprofile.consent.services

Class DefaultConsentService

java.lang.Object

com.hybris.yprofile.consent.services.DefaultConsentService

All Implemented Interfaces:

ConsentService

public class DefaultConsentService
extends java.lang.Object
implements ConsentService

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

Field Summary

Fields inherited from interface com.hybris.yprofile.consent.services.ConsentService

ANONYMOUS_CONSENTS, CONSENT_GIVEN, CONSENT_WITHDRAWN, PROFILE_CONSENT, PROFILE_CONSENT_GIVEN, USER_CONSENTS

Constructor Summary

Constructors

Constructor and Description
DefaultConsentService()

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
BaseSiteService	getBaseSiteService()
protected ConsentServiceClient	getClient()
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
protected EnhancedCookieGenerator	getCookieGenerator()
protected java.util.Optional<BaseSiteModel>	getCurrentBaseSiteModel()
protected static java.lang.String	getDebugFlagValue(UserModel userModel)
ModelService	getModelService()
ProfileConfigurationService	getProfileConfigurationService()
RetrieveRestClientStrategy	getRetrieveRestClientStrategy()
SessionService	getSessionService()
protected java.lang.String	getSiteId()
UserService	getUserService()
protected boolean	isAnonymousUser()
boolean	isProfileTrackingConsentGiven(HttpServletRequest request) Checks if the user (logged In or Anonymous) has granted the consent to allow profile tracking
protected boolean	isProfileTrackingConsentGivenForAnonymousUser(java.util.Optional<Cookie> anonymousConsentCookie)
protected boolean	isProfileTrackingConsentGivenForLoggedInUser()
protected boolean	isUserSoftLoggedIn()
protected static boolean	isValidConsentReference(java.lang.String consentReferenceId)
protected static void	logError(java.lang.Throwable error)
protected static void	logSuccess(java.util.Optional<RawResponse> rawResponse, java.lang.String message)
protected boolean	profileTrackingConsentForLoggedInUser(java.lang.String consent)
void	removeConsentReferenceCookieAndSession(HttpServletResponse response) removes the consent reference cookie
protected void	resetConsentReferenceForUser(UserModel user)
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
protected void	setAttributeInSession(java.lang.String key, java.lang.Object value)
void	setBaseSiteService(BaseSiteService baseSiteService)
protected void	setConsentReferenceForCurrentUser(java.lang.String consentReferenceId)
void	setCookieGenerator(EnhancedCookieGenerator cookieGenerator)
void	setModelService(ModelService modelService)
void	setProfileConfigurationService(ProfileConfigurationService profileConfigurationService)
void	setProfileConsentCookieAndSession(HttpServletRequest request, HttpServletResponse response, boolean consent) Saves the profile consent separately in a cookie and session attribute
void	setRetrieveRestClientStrategy(RetrieveRestClientStrategy retrieveRestClientStrategy)
void	setSessionService(SessionService sessionService)
void	setUserService(UserService userService)
protected boolean	shouldSendEvent(java.lang.String consentReference, java.lang.String baseSiteId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultConsentService

public DefaultConsentService()

Method Detail

isProfileTrackingConsentGiven

public boolean isProfileTrackingConsentGiven(HttpServletRequest request)

Description copied from interface: ConsentService

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

Specified by:

isProfileTrackingConsentGiven in interface ConsentService

Parameters:

request - the http request

Returns:

true or false

isProfileTrackingConsentGivenForLoggedInUser

protected boolean isProfileTrackingConsentGivenForLoggedInUser()

profileTrackingConsentForLoggedInUser

protected boolean profileTrackingConsentForLoggedInUser(java.lang.String consent)

isAnonymousUser

protected boolean isAnonymousUser()

isUserSoftLoggedIn

protected boolean isUserSoftLoggedIn()

isProfileTrackingConsentGivenForAnonymousUser

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

saveConsentReferenceInSessionAndCurrentUserModel

public void saveConsentReferenceInSessionAndCurrentUserModel(HttpServletRequest request)

Description copied from interface: ConsentService

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

Specified by:

saveConsentReferenceInSessionAndCurrentUserModel in interface ConsentService

Parameters:

request - Http request

getConsentReferenceFromCookie

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

Description copied from interface: ConsentService

Fetches the consent reference from cookie

Specified by:

getConsentReferenceFromCookie in interface ConsentService

Parameters:

siteId - base site identifier

request - http request

Returns:

consent reference

getConsentReferenceFromSession

public java.lang.String getConsentReferenceFromSession()

Description copied from interface: ConsentService

Fetches the consent reference from session

Specified by:

getConsentReferenceFromSession in interface ConsentService

Returns:

consent reference

setProfileConsentCookieAndSession

public void setProfileConsentCookieAndSession(HttpServletRequest request,
                                              HttpServletResponse response,
                                              boolean consent)

Description copied from interface: ConsentService

Saves the profile consent separately in a cookie and session attribute

Specified by:

setProfileConsentCookieAndSession in interface ConsentService

Parameters:

request - http request

response - http reponse

consent - true or false

removeConsentReferenceCookieAndSession

public void removeConsentReferenceCookieAndSession(HttpServletResponse response)

Description copied from interface: ConsentService

removes the consent reference cookie

Specified by:

removeConsentReferenceCookieAndSession in interface ConsentService

Parameters:

response - http response

deleteConsentReferenceInConsentServiceAndInUserModel

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

Description copied from interface: ConsentService

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

Specified by:

deleteConsentReferenceInConsentServiceAndInUserModel in interface ConsentService

Parameters:

userModel - the user

baseSiteId - the base site id

getDebugFlagValue

protected static java.lang.String getDebugFlagValue(UserModel userModel)

shouldSendEvent

protected boolean shouldSendEvent(java.lang.String consentReference,
                                  java.lang.String baseSiteId)

isValidConsentReference

protected static boolean isValidConsentReference(java.lang.String consentReferenceId)

setAttributeInSession

protected void setAttributeInSession(java.lang.String key,
                                     java.lang.Object value)

getSiteId

protected java.lang.String getSiteId()

getCurrentBaseSiteModel

protected java.util.Optional<BaseSiteModel> getCurrentBaseSiteModel()

logSuccess

protected static void logSuccess(java.util.Optional<RawResponse> rawResponse,
                                 java.lang.String message)

logError

protected static void logError(java.lang.Throwable error)

getClient

protected ConsentServiceClient getClient()

getCookieGenerator

protected EnhancedCookieGenerator getCookieGenerator()

setCookieGenerator

public void setCookieGenerator(EnhancedCookieGenerator cookieGenerator)

getSessionService

public SessionService getSessionService()

setSessionService

public void setSessionService(SessionService sessionService)

getUserService

public UserService getUserService()

setUserService

public void setUserService(UserService userService)

getProfileConfigurationService

public ProfileConfigurationService getProfileConfigurationService()

setProfileConfigurationService

public void setProfileConfigurationService(ProfileConfigurationService profileConfigurationService)

getRetrieveRestClientStrategy

public RetrieveRestClientStrategy getRetrieveRestClientStrategy()

setRetrieveRestClientStrategy

public void setRetrieveRestClientStrategy(RetrieveRestClientStrategy retrieveRestClientStrategy)

getBaseSiteService

public BaseSiteService getBaseSiteService()

setBaseSiteService

public void setBaseSiteService(BaseSiteService baseSiteService)

getModelService

public ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

setConsentReferenceForCurrentUser

protected void setConsentReferenceForCurrentUser(java.lang.String consentReferenceId)

resetConsentReferenceForUser

protected void resetConsentReferenceForUser(UserModel user)