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, PROFILE_CONSENT, PROFILE_CONSENT_GIVEN, USER_CONSENTS

Constructor Summary

Constructors

Constructor and Description
DefaultConsentService()

Method Summary

Modifier and Type	Method and Description
protected void	addConsentReferenceCookie(HttpServletResponse response, java.lang.String consentReferenceId, java.lang.String token)
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
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 java.lang.String	getConsentReferenceTokenFromCookie(HttpServletRequest request)
protected EnhancedCookieGenerator	getCookieGenerator()
protected java.util.Optional<BaseSiteModel>	getCurrentBaseSiteModel()
ProfileConfigurationService	getProfileConfigurationService()
RetrieveRestClientStrategy	getRetrieveRestClientStrategy()
SessionService	getSessionService()
protected java.lang.String	getSiteId()
protected java.lang.String	getUserId()
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
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
protected boolean	isUserSoftLoggedIn()
protected static void	logError(java.lang.Throwable error)
protected static void	logSuccess(ConsentResponse consentResponse)
protected void	setAttributeInSession(java.lang.String key, java.lang.Object value)
void	setBaseSiteService(BaseSiteService baseSiteService)
void	setCookieGenerator(EnhancedCookieGenerator cookieGenerator)
void	setProfileConfigurationService(ProfileConfigurationService profileConfigurationService)
void	setProfileConsentCookie(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 void	storeConsentReferenceInSession(java.lang.String consentReferenceId, java.lang.String token)

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

public boolean isProfileTrackingConsentGivenForLoggedInUser()

Description copied from interface: ConsentService

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

Specified by:

isProfileTrackingConsentGivenForLoggedInUser in interface ConsentService

Returns:

true or false

isAnonymousUser

protected boolean isAnonymousUser()

isUserSoftLoggedIn

protected boolean isUserSoftLoggedIn()

isProfileTrackingConsentGivenForAnonymousUser

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

Description copied from interface: ConsentService

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

Specified by:

isProfileTrackingConsentGivenForAnonymousUser in interface ConsentService

Returns:

true or false

generateConsentReference

public void generateConsentReference(HttpServletRequest request,
                                     HttpServletResponse response)

Description copied from interface: ConsentService

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

Specified by:

generateConsentReference in interface ConsentService

Parameters:

request - Http request

response - Http response with the consent reference cookie

generateConsentReference

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

Description copied from interface: ConsentService

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

Specified by:

generateConsentReference in interface ConsentService

Parameters:

request - Http request

response - Http response with the consent reference cookie

shouldGenerateConsentReference - should generate consent reference

getUserId

protected java.lang.String getUserId()

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

getConsentReferenceTokenFromCookie

protected java.lang.String getConsentReferenceTokenFromCookie(HttpServletRequest request)

addConsentReferenceCookie

protected void addConsentReferenceCookie(HttpServletResponse response,
                                         java.lang.String consentReferenceId,
                                         java.lang.String token)

storeConsentReferenceInSession

protected void storeConsentReferenceInSession(java.lang.String consentReferenceId,
                                              java.lang.String token)

setProfileConsentCookie

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

Description copied from interface: ConsentService

Saves the profile consent separately in a cookie and session attribute

Specified by:

setProfileConsentCookie in interface ConsentService

Parameters:

request - http request

response - http reponse

consent - true or false

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

generateConsentReferenceForUser

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

Description copied from interface: ConsentService

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

Specified by:

generateConsentReferenceForUser in interface ConsentService

Parameters:

userId - the user id

Returns:

the consent service response

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(ConsentResponse consentResponse)

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)