public interface PrivacyService
Modifier and Type | Method and Description |
---|---|
Boolean |
anonymizeBrowsingData(String profileId)
This method will anonymize browsing data by creating an anonymous profile for the current profile,
and then re-associating all the profile's sessions and events with the new anonymous profile
todo this method does not anonymize any session or event properties that may contain profile
data (such as the login event)
|
Boolean |
anonymizeProfile(String profileId,
String scope)
This method will "anonymize" a profile by removing from the associated profile all the properties
that have been defined as "denied properties".
|
Boolean |
deleteProfile(String profileId)
Deletes the current profile (but has no effect on sessions and events).
|
Boolean |
deleteProfileData(String profileId,
boolean purgeData)
This method will perform two operations, first it will call the anonymizeBrowsingData method on the
specified profile, and then it will delete the profile from the persistence service.
|
Profile |
getAnonymousProfile(Profile profile)
Build a new anonymous profile (but doesn't persist it in the persistence service).
|
List<String> |
getDeniedProperties(String profileId)
Gets the list of denied properties.
|
List<String> |
getDeniedPropertyDistribution(String profileId)
Deprecated.
As of version 1.3.0-incubating, do not use this method
|
List<String> |
getFilteredEventTypes(Profile profile)
Retrieve the list of events that the profile has deactivated.
|
List<String> |
getFilteredEventTypes(String profileId)
Retrieve the list of events that the profile has deactivated.
|
ServerInfo |
getServerInfo()
Retrieves the default base Apache Unomi server information, including the name and version of the server, build
time information and the event types
if recognizes as well as the capabilities supported by the system.
|
List<ServerInfo> |
getServerInfos()
Retrieves the list of the server information objects, that include extensions.
|
Boolean |
isRequireAnonymousBrowsing(Profile profile)
Tests if the anonymous browsing flag is set of the specified profile.
|
Boolean |
isRequireAnonymousBrowsing(String profileId)
Tests if the anonymous browsing flag is set of the specified profile.
|
Boolean |
removeProperty(String profileId,
String propertyName)
Removes a property from the specified profile.
|
Boolean |
setDeniedProperties(String profileId,
List<String> propertyNames)
Deprecated.
As of version 1.3.0-incubating, do not use this method, instead mark properties with the personal identifier tag which
will mark them as denied by the getDeniedProperties method
|
Boolean |
setDeniedPropertyDistribution(String profileId,
List<String> propertyNames)
Deprecated.
As of version 1.3.0-incubating, do not use this method
|
Boolean |
setFilteredEventTypes(String profileId,
List<String> eventTypes)
Set the list of filtered event types for a profile.
|
Boolean |
setRequireAnonymousBrowsing(String profileId,
boolean anonymous,
String scope)
Controls the activation/deactivation of anonymous browsing.
|
ServerInfo getServerInfo()
List<ServerInfo> getServerInfos()
Boolean deleteProfile(String profileId)
profileId
- the identifier of the profile to delete and replaceBoolean anonymizeProfile(String profileId, String scope)
profileId
- the identifier of the profile that needs to be anonymized.scope
- The scope will be used to send events, once for the anonymizeProfile event, the other for the profileUpdated eventBoolean anonymizeBrowsingData(String profileId)
profileId
- the identifier of the profile on which to perform the anonymizations of the browsing
dataBoolean deleteProfileData(String profileId, boolean purgeData)
profileId
- the identifier of the profilepurgeData
- flag that indicates whether to purge the profile's dataBoolean setRequireAnonymousBrowsing(String profileId, boolean anonymous, String scope)
profileId
- the identifier of the profile on which to set the anonymous browsing property flaganonymous
- the value of the anonymous browsing flag.scope
- a scope used to send a profileUpdated event internallyBoolean isRequireAnonymousBrowsing(String profileId)
profileId
- the identifier of the profile on which we want to retrieve the anonymous browsing flagBoolean isRequireAnonymousBrowsing(Profile profile)
profile
- the profile on which we want to retrieve the anonymous browsing flagProfile getAnonymousProfile(Profile profile)
profile
- the profile for which to create the anonymous profileList<String> getFilteredEventTypes(String profileId)
profileId
- the identifier for the profile for which we want to retrieve the list of forbidden
event typesList<String> getFilteredEventTypes(Profile profile)
profile
- the profile for which we want to retrieve the list of forbidden
event typesBoolean setFilteredEventTypes(String profileId, List<String> eventTypes)
profileId
- the identifier of the profile on which to filter the eventseventTypes
- a list of event types that will be filter for the profileList<String> getDeniedProperties(String profileId)
profileId
- the identified of the profile@Deprecated Boolean setDeniedProperties(String profileId, List<String> propertyNames)
profileId
- the profile for which to see the denied propertiespropertyNames
- the property names to be denied@Deprecated List<String> getDeniedPropertyDistribution(String profileId)
profileId
- the identifier of the profile@Deprecated Boolean setDeniedPropertyDistribution(String profileId, List<String> propertyNames)
profileId
- the identifier of the profilepropertyNames
- do not useCopyright © 2014–2022 Apache Software Foundation. All rights reserved.