public interface OptOutService
OptOutService
provides the names of cookies/headers that represent the user's choice of "opting
out", i.e. not wanting to be tracked by means of cookies. The service also provides the names of white-listed cookies
and a convenience method to determine whether a given request is opted out.
This service is intended to be used by applications for the purpose of identifying opted-out requests and change
behavior regarding the setting of cookies according to the opt-out status and / or white-list.Modifier and Type | Method and Description |
---|---|
Collection<String> |
getCookieNames()
A configured collection of names of cookies that a client can set to opt-out of tracking.
|
Map<String,String> |
getHeaders()
A map of name/value pairs of HTTP headers that a client can set to opt-out of tracking.
|
Collection<String> |
getWhitelistCookieNames()
A collection of names of cookies that are still allowed by configuration to be set regardless of the client
opting out.
|
boolean |
isOptedOut(javax.servlet.http.HttpServletRequest request)
Determines whether the request contains any cookies or headers that match any of the configured opt-out cookies
or headers.
|
Collection<String> getCookieNames()
Collection
representing the cookie names.Map<String,String> getHeaders()
Map
representing the configured header name/value pairs.Collection<String> getWhitelistCookieNames()
Collection
representing the cookie names.boolean isOptedOut(javax.servlet.http.HttpServletRequest request)
request
- The request to check.true
if the request contains any of the cookies/headers indicated via getCookieNames()
or getHeaders()
."Copyright © 2006 - 2015 Adobe Systems Incorporated. All Rights Reserved"