senselogic.sitevision.api.cookie

Interface SiteCookieUtil

@Requireable(value="SiteCookieUtil")
public interface SiteCookieUtil

Site cookie utility interface.

Contains methods for retrieving sv:siteCookie Nodes of current site and current user's consent status of them.

An instance of the Sitevision class implementing this interface can be obtained via Utils.getSiteCookieUtil(). See Utils for how to obtain an instance of the Utils interface.

Since:

Sitevision 9.1

Author:

Karl Eklöf

See Also:

ResourceLocatorUtil.getSiteCookieRepository()

Method Summary

Modifier and Type	Method and Description
boolean	checkUserConsent(Node aSiteCookie) Checks whether or not current user explicitly has accepted a specific site cookie.
String	createUserConsentCookieValue(List<Node> aAllowCookieIdList) Generates a consent string that can be saved as cookie value for the cookie named getUserConsentCookieName().
List<Node>	getAnalyticsSiteCookies() Analytics Site cookies (sv:siteCookie) of current site.
String	getAnalyticsSiteCookiesDescription() Gets the analytics site cookies category description.
String	getAnalyticsSiteCookiesTitle() Gets the analytics site cookies category title.
List<Node>	getCustomSiteCookies() Custom Site cookies (sv:siteCookie) of current site.
String	getCustomSiteCookiesDescription() Gets the custom site cookies category description.
String	getCustomSiteCookiesTitle() Gets the custom site cookies category title.
List<Node>	getFunctionalSiteCookies() Functional Site cookies (sv:siteCookie) of current site.
String	getFunctionalSiteCookiesDescription() Gets the functional site cookies category description.
String	getFunctionalSiteCookiesTitle() Gets the functional site cookies category title.
List<Node>	getMarketingSiteCookies() Marketing Site cookies (sv:siteCookie) of current site.
String	getMarketingSiteCookiesDescription() Gets the marketing site cookies category description.
String	getMarketingSiteCookiesTitle() Gets the marketing site cookies category title.
List<Node>	getNecessarySiteCookies() Necessary Site cookies (sv:siteCookie) of current site.
String	getNecessarySiteCookiesDescription() Gets the necessary site cookies category description.
String	getNecessarySiteCookiesTitle() Gets the necessary site cookies category title.
String	getUserConsentCookieName() The name of the cookie that contains data about site cookie consents.
List<Node>	getUserConsents() Gets all sv:siteCookie nodes that current user has accepted.
boolean	hasPendingUserConsents() Whether or not current user has explicitly accepted/rejected all "user selectable" site cookies.
boolean	hasUserConsentCookie() Whether or not current user has a consent cookie.
Node	resolveSiteCookieByIdentifier(String aCookieIdentifier) Convenience method that resolves a sv:siteCookie Node from a given cookie identifier.

Method Detail

getNecessarySiteCookies

List<Node> getNecessarySiteCookies()

Necessary Site cookies (sv:siteCookie) of current site.

Returns:

the necessary site cookies of current site, or empty list if current site has no site cookies

getNecessarySiteCookiesTitle

String getNecessarySiteCookiesTitle()

Gets the necessary site cookies category title.

Returns:

necessary site cookies category title

getNecessarySiteCookiesDescription

String getNecessarySiteCookiesDescription()

Gets the necessary site cookies category description.

Returns:

necessary site cookies category description

getAnalyticsSiteCookies

List<Node> getAnalyticsSiteCookies()

Analytics Site cookies (sv:siteCookie) of current site.

Returns:

the analytics site cookies of current site, or empty list if current site has no site cookies

getAnalyticsSiteCookiesTitle

String getAnalyticsSiteCookiesTitle()

Gets the analytics site cookies category title.

Returns:

analytics site cookies category title

getAnalyticsSiteCookiesDescription

String getAnalyticsSiteCookiesDescription()

Gets the analytics site cookies category description.

Returns:

analytics site cookies category description

getMarketingSiteCookies

List<Node> getMarketingSiteCookies()

Marketing Site cookies (sv:siteCookie) of current site.

Returns:

the marketing site cookies of current site, or empty list if current site has no site cookies

getMarketingSiteCookiesTitle

String getMarketingSiteCookiesTitle()

Gets the marketing site cookies category title.

Returns:

marketing site cookies category title

getMarketingSiteCookiesDescription

String getMarketingSiteCookiesDescription()

Gets the marketing site cookies category description.

Returns:

marketing site cookies category description

getFunctionalSiteCookies

List<Node> getFunctionalSiteCookies()

Functional Site cookies (sv:siteCookie) of current site.

Returns:

the functional site cookies of current site, or empty list if current site has no site cookies

Since:

Sitevision 9.1.1

getFunctionalSiteCookiesTitle

String getFunctionalSiteCookiesTitle()

Gets the functional site cookies category title.

Returns:

functional site cookies category title

Since:

Sitevision 9.1.1

getFunctionalSiteCookiesDescription

String getFunctionalSiteCookiesDescription()

Gets the functional site cookies category description.

Returns:

functional site cookies category description

Since:

Sitevision 9.1.1

getCustomSiteCookies

List<Node> getCustomSiteCookies()

Custom Site cookies (sv:siteCookie) of current site.

Returns:

the custom site cookies of current site, or empty list if current site has no site cookies

getCustomSiteCookiesTitle

String getCustomSiteCookiesTitle()

Gets the custom site cookies category title.

Returns:

custom site cookies category title

getCustomSiteCookiesDescription

String getCustomSiteCookiesDescription()

Gets the custom site cookies category description.

Returns:

custom site cookies category description

resolveSiteCookieByIdentifier

Node resolveSiteCookieByIdentifier(String aCookieIdentifier)

Convenience method that resolves a sv:siteCookie Node from a given cookie identifier.

Parameters:

aCookieIdentifier - the site cookie identifier

Returns:

the sv:siteCookie Node with the "cookieIdentifier" property that matches aCookieIdentifier. Returns null if aCookieIdentifier is null, blank or indeterminable

checkUserConsent

boolean checkUserConsent(Node aSiteCookie)

Checks whether or not current user explicitly has accepted a specific site cookie.

Parameters:

aSiteCookie - the sv:siteCookie

Returns:

true if current user has accepted aSiteCookie, false otherwise

hasPendingUserConsents

boolean hasPendingUserConsents()

Whether or not current user has explicitly accepted/rejected all "user selectable" site cookies.

Returns:

true if there are site cookies that current user hasn't yet accepted/rejected, false otherwise

See Also:

hasUserConsentCookie()

hasUserConsentCookie

boolean hasUserConsentCookie()

Whether or not current user has a consent cookie.

Returns:

true if current user has a consent cookie set, false otherwise

See Also:

hasPendingUserConsents()

getUserConsentCookieName

String getUserConsentCookieName()

The name of the cookie that contains data about site cookie consents.

Returns:

the name of the cookie that contains data about site cookie consents

createUserConsentCookieValue

String createUserConsentCookieValue(List<Node> aAllowCookieIdList)
                             throws IllegalArgumentException

Generates a consent string that can be saved as cookie value for the cookie named getUserConsentCookieName().

Note! All "user selectable" sv:siteCookie Nodes that are not present in aAllowCookieIdList will be treated as rejected.

Parameters:

aAllowCookieIdList - the list of sv:siteCookie accepted by current user

Returns:

a string that represents the accept/reject status for current sv:siteCookie's

Throws:

IllegalArgumentException - if aAllowCookieIdList is null or contains other than sv:siteCookie Nodes

getUserConsents

List<Node> getUserConsents()

Gets all sv:siteCookie nodes that current user has accepted.

Returns:

the list of sv:siteCookie Nodes current user has accepted. Returns empty list if site has no site cookies or if current user hasn't accepted any sv:siteCookie