Package 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.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method 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, javax.servlet.http.HttpServletRequest request)
      Fetches the consent reference from cookie
      java.lang.String getConsentReferenceFromHeader​(javax.servlet.http.HttpServletRequest request)
      Fetches the consent reference from header name specified in the property profileservices.occ.consent.header.name
      java.lang.String getConsentReferenceFromSession()
      Fetches the consent reference from session
      boolean isProfileTrackingConsentGiven()
      Checks if the user (logged in or anonymous) has granted the consent to allow profile tracking
      boolean isProfileTrackingConsentGiven​(javax.servlet.http.HttpServletRequest request)
      Checks if the user (logged In or Anonymous) has granted the consent to allow profile tracking
      void removeConsentReferenceInSession​(javax.servlet.http.HttpServletResponse response)
      removes the consent reference in session
      void saveConsentReferenceInSession​(java.lang.String consentId)
      It gets the consent reference stored in a cookie and saves it in the session for further events
      void saveConsentReferenceInSessionAndCurrentUserModel​(javax.servlet.http.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 setProfileConsent​(boolean consent)  
      void setProfileConsentCookieAndSession​(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, boolean consent)
      Saves the profile consent separately in a cookie and session attribute
      void setProfileIdCookie​(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String consentReferenceId)
      Saves the profile id i.e old consent reference separately as a session cookie so that profile tag can skip getting a new consent reference.

    • Method Detail

      • isProfileTrackingConsentGiven

        boolean isProfileTrackingConsentGiven​(javax.servlet.http.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​(javax.servlet.http.HttpServletRequest request,
                                       javax.servlet.http.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

      • setProfileConsent

        void setProfileConsent​(boolean consent)

      • saveConsentReferenceInSessionAndCurrentUserModel

        void saveConsentReferenceInSessionAndCurrentUserModel​(javax.servlet.http.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,
                                               javax.servlet.http.HttpServletRequest request)
        Fetches the consent reference from cookie
        Parameters:
        siteId - base site identifier
        request - http request
        Returns:
        consent reference

      • getConsentReferenceFromHeader

        java.lang.String getConsentReferenceFromHeader​(javax.servlet.http.HttpServletRequest request)
        Fetches the consent reference from header name specified in the property profileservices.occ.consent.header.name
        Parameters:
        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

      • removeConsentReferenceInSession

        void removeConsentReferenceInSession​(javax.servlet.http.HttpServletResponse response)
        removes the consent reference in session
        Parameters:
        response - http response

      • saveConsentReferenceInSession

        void saveConsentReferenceInSession​(java.lang.String consentId)
        It gets the consent reference stored in a cookie and saves it in the session for further events
        Parameters:
        consentId - the consent reference

      • isProfileTrackingConsentGiven

        boolean isProfileTrackingConsentGiven()
        Checks if the user (logged in or anonymous) has granted the consent to allow profile tracking
        Returns:
        true if consent is given

      • setProfileIdCookie

        void setProfileIdCookie​(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response,
                        java.lang.String consentReferenceId)
        Saves the profile id i.e old consent reference separately as a session cookie so that profile tag can skip getting a new consent reference.
        Parameters:
        request - http request
        response - http response to which the cookie is added if the request doesnt have CR cookie
        consentReferenceId - the profile id or consent reference id of the user