Skip navigation links
A B C D E F G H I L M N O P Q R S T U V 

A

Action - Class in org.apache.unomi.api.actions
An action that can be executed as a consequence of a Rule being triggered.
Action() - Constructor for class org.apache.unomi.api.actions.Action
Instantiates a new Action.
Action(ActionType) - Constructor for class org.apache.unomi.api.actions.Action
Instantiates a new Action with the specified ActionType
ActionExecutor - Interface in org.apache.unomi.api.actions
A piece of code that performs a specified Action, given a triggering Event
ActionPostExecutor - Interface in org.apache.unomi.api.actions
An action to be executed after all Rule-derived have been processed.
ActionType - Class in org.apache.unomi.api.actions
A type definition for Actions.
ActionType() - Constructor for class org.apache.unomi.api.actions.ActionType
Instantiates a new Action type.
ActionType(Metadata) - Constructor for class org.apache.unomi.api.actions.ActionType
Instantiates a new Action type.
Aggregate - Class in org.apache.unomi.api.query
A specification for an aggregate as part of AggregateQuerys
Aggregate() - Constructor for class org.apache.unomi.api.query.Aggregate
 
AggregateQuery - Class in org.apache.unomi.api.query
A query by aggregate: results matching the specified Condition are aggregated using a given Aggregate specification, creating buckets which cardinality is calculated.
AggregateQuery() - Constructor for class org.apache.unomi.api.query.AggregateQuery
Instantiates a new Aggregate query.
AggregateQuery(Aggregate) - Constructor for class org.apache.unomi.api.query.AggregateQuery
Instantiates a new Aggregate query with the specified Aggregate.
AggregateQuery(Condition) - Constructor for class org.apache.unomi.api.query.AggregateQuery
Instantiates a new Aggregate query with the specified Condition.
AggregateQuery(Aggregate, Condition) - Constructor for class org.apache.unomi.api.query.AggregateQuery
Instantiates a new Aggregate query with the specified Aggregate and Condition
anonymizeBrowsingData(String) - Method in interface org.apache.unomi.api.services.PrivacyService
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)
anonymizeProfile(String, String) - Method in interface org.apache.unomi.api.services.PrivacyService
This method will "anonymize" a profile by removing from the associated profile all the properties that have been defined as "denied properties".
authenticateThirdPartyServer(String, String) - Method in interface org.apache.unomi.api.services.EventService
Get the third party server name, if the request is originated from a known peer

B

batchProfilesUpdate(BatchUpdate) - Method in interface org.apache.unomi.api.services.ProfileService
Update all profiles in batch according to the specified BatchUpdate
BatchUpdate - Class in org.apache.unomi.api
A representation of an operation to update the value of a property on items matching a specific condition.
BatchUpdate() - Constructor for class org.apache.unomi.api.BatchUpdate
 
bestMatch(Profile, Session, PersonalizationService.PersonalizationRequest) - Method in interface org.apache.unomi.api.services.PersonalizationService
Get the best match among a list of items, for the specified profile and session

C

Campaign - Class in org.apache.unomi.api.campaigns
A goal-oriented, time-limited marketing operation that needs to be evaluated for return on investment performance by tracking the ratio of visits to conversions.
Campaign() - Constructor for class org.apache.unomi.api.campaigns.Campaign
Instantiates a new Campaign.
Campaign(Metadata) - Constructor for class org.apache.unomi.api.campaigns.Campaign
Instantiates a new Campaign with the specified metadata.
CampaignDetail - Class in org.apache.unomi.api.campaigns
Details about a Campaign.
CampaignDetail(Campaign) - Constructor for class org.apache.unomi.api.campaigns.CampaignDetail
Instantiates a new Campaign detail.
CampaignEvent - Class in org.apache.unomi.api.campaigns.events
A specific campaign event to help analyzing your key performance indicators by marking specific dates during your campaign.
CampaignEvent() - Constructor for class org.apache.unomi.api.campaigns.events.CampaignEvent
Instantiates a new Campaign event.
CampaignEvent(Metadata) - Constructor for class org.apache.unomi.api.campaigns.events.CampaignEvent
Instantiates a new Campaign event with the specified metadata.
canHandle(Event) - Method in interface org.apache.unomi.api.services.EventListenerService
Whether or not this listener can handle the specified event.
ClusterNode - Class in org.apache.unomi.api
Information about a cluster node.
ClusterNode() - Constructor for class org.apache.unomi.api.ClusterNode
Instantiates a new Cluster node.
ClusterService - Interface in org.apache.unomi.api.services
A service to access information about the context server's cluster.
compareTo(Metadata) - Method in class org.apache.unomi.api.Metadata
 
Condition - Class in org.apache.unomi.api.conditions
A set of elements that can be evaluated.
Condition() - Constructor for class org.apache.unomi.api.conditions.Condition
Instantiates a new Condition.
Condition(ConditionType) - Constructor for class org.apache.unomi.api.conditions.Condition
Instantiates a new Condition with the specified ConditionType.
ConditionType - Class in org.apache.unomi.api.conditions
ConditionTypes define new conditions that can be applied to items (for example to decide whether a rule needs to be triggered or if a profile is considered as taking part in a campaign) or to perform queries against the stored unomi data.
ConditionType() - Constructor for class org.apache.unomi.api.conditions.ConditionType
Instantiates a new Condition type.
ConditionType(Metadata) - Constructor for class org.apache.unomi.api.conditions.ConditionType
Instantiates a new Condition type with the specified metadata
configChanged(ConfigSharingService.ConfigChangeEvent) - Method in interface org.apache.unomi.api.services.ConfigSharingService.ConfigChangeListener
 
ConfigChangeEvent(ConfigSharingService.ConfigChangeEvent.ConfigChangeEventType, String, Object, Object) - Constructor for class org.apache.unomi.api.services.ConfigSharingService.ConfigChangeEvent
 
ConfigSharingService - Interface in org.apache.unomi.api.services
A service to share configuration properties with other bundles.
ConfigSharingService.ConfigChangeEvent - Class in org.apache.unomi.api.services
 
ConfigSharingService.ConfigChangeEvent.ConfigChangeEventType - Enum in org.apache.unomi.api.services
 
ConfigSharingService.ConfigChangeListener - Interface in org.apache.unomi.api.services
 
Consent - Class in org.apache.unomi.api
A consent is an object attached to a profile that indicates whether the profile has agreed or denied a special consent type.
Consent() - Constructor for class org.apache.unomi.api.Consent
Empty constructor mostly used for JSON (de-) serialization
Consent(String, String, ConsentStatus, Date, Date) - Constructor for class org.apache.unomi.api.Consent
A constructor to directly build a consent with all it's properties
Consent(Map<String, Object>, DateFormat) - Constructor for class org.apache.unomi.api.Consent
A constructor from a map used for example when we use the deserialized data from event properties.
ConsentStatus - Enum in org.apache.unomi.api
This enum class represents the type of grant a @Consent might have.
containsParameter(String) - Method in class org.apache.unomi.api.conditions.Condition
Determines whether this condition contains the parameter identified by the specified name.
ContextRequest - Class in org.apache.unomi.api
An incoming request for context information from clients of the context server.
ContextRequest() - Constructor for class org.apache.unomi.api.ContextRequest
 
ContextResponse - Class in org.apache.unomi.api
A context server response resulting from the evaluation of a client's context request.
ContextResponse() - Constructor for class org.apache.unomi.api.ContextResponse
 
createPersona(String) - Method in interface org.apache.unomi.api.services.ProfileService
Creates a persona with the specified identifier and automatically creates an associated session with it.
createScoringDefinition(String, String, String, String) - Method in interface org.apache.unomi.api.services.SegmentService
Creates a scoring with the specified scope, identifier, name and description.
CustomItem - Class in org.apache.unomi.api
A generic extension of Item for context server extensions, properties are stored in a Map.
CustomItem() - Constructor for class org.apache.unomi.api.CustomItem
Instantiates a new Custom item.
CustomItem(String, String) - Constructor for class org.apache.unomi.api.CustomItem
Instantiates a new Custom item.

D

DateRange - Class in org.apache.unomi.api.query
A data range.
DateRange() - Constructor for class org.apache.unomi.api.query.DateRange
 
DefinitionsService - Interface in org.apache.unomi.api.services
A service to retrieve definition information about core context server entities such as conditions, actions and values.
delete(String, boolean) - Method in interface org.apache.unomi.api.services.ProfileService
Removes the profile (or persona if the persona parameter is set to true) identified by the specified identifier.
deleteProfile(String) - Method in interface org.apache.unomi.api.services.PrivacyService
Deletes the current profile (but has no effect on sessions and events).
deleteProfileData(String) - Method in interface org.apache.unomi.api.services.PrivacyService
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.
deletePropertyType(String) - Method in interface org.apache.unomi.api.services.ProfileService
Deletes the property type identified by the specified identifier.
DependentMetadata - Class in org.apache.unomi.api.segments
 
DependentMetadata(List<Metadata>, List<Metadata>) - Constructor for class org.apache.unomi.api.segments.DependentMetadata
 

E

equals(Object) - Method in class org.apache.unomi.api.actions.ActionType
 
equals(Object) - Method in class org.apache.unomi.api.conditions.Condition
 
equals(Object) - Method in class org.apache.unomi.api.conditions.ConditionType
 
equals(Object) - Method in class org.apache.unomi.api.Item
 
equals(Object) - Method in class org.apache.unomi.api.Metadata
 
equals(Object) - Method in class org.apache.unomi.api.ValueType
 
Event - Class in org.apache.unomi.api
An event that can be processed and evaluated by the context server.
Event() - Constructor for class org.apache.unomi.api.Event
Instantiates a new Event.
Event(String, Session, Profile, String, Item, Item, Date) - Constructor for class org.apache.unomi.api.Event
Instantiates a new Event.
Event(String, Session, Profile, String, Item, Item, Map<String, Object>, Date, boolean) - Constructor for class org.apache.unomi.api.Event
Instantiates a new Event.
EventInfo - Class in org.apache.unomi.api
Basic event information
EventInfo() - Constructor for class org.apache.unomi.api.EventInfo
 
EventListenerService - Interface in org.apache.unomi.api.services
A service that gets notified (via EventListenerService.onEvent(Event)) whenever an event it can handle as decided by EventListenerService.canHandle(Event) occurs in the context server.
EventProperty - Class in org.apache.unomi.api
An event property.
EventProperty() - Constructor for class org.apache.unomi.api.EventProperty
Initializes an instance of this class.
EventProperty(String) - Constructor for class org.apache.unomi.api.EventProperty
Initializes an instance of an event property with the string value type.
EventProperty(String, String) - Constructor for class org.apache.unomi.api.EventProperty
Initializes an instance of this class.
EventsCollectorRequest - Class in org.apache.unomi.api
A request for events to be processed.
EventsCollectorRequest() - Constructor for class org.apache.unomi.api.EventsCollectorRequest
 
EventService - Interface in org.apache.unomi.api.services
A service to publish events, notably issued from user interactions with tracked entities, in the context server.
EventSource - Class in org.apache.unomi.api
TODO: REMOVE
EventSource() - Constructor for class org.apache.unomi.api.EventSource
 
EventTarget - Class in org.apache.unomi.api
TODO: REMOVE
EventTarget() - Constructor for class org.apache.unomi.api.EventTarget
 
EventTarget(String, String) - Constructor for class org.apache.unomi.api.EventTarget
 
execute(Action, Event) - Method in interface org.apache.unomi.api.actions.ActionExecutor
Executes a specified Action, given a triggering Event.
execute() - Method in interface org.apache.unomi.api.actions.ActionPostExecutor
Performs the action.
exportProfilesPropertiesToCsv(Query) - Method in interface org.apache.unomi.api.services.ProfileService
Creates a String containing comma-separated values (CSV) formatted version of profiles matching the specified query.
extractConditionBySystemTag(Condition, String) - Method in interface org.apache.unomi.api.services.DefinitionsService
Retrieves a condition matching the specified system tag identifier from the specified root condition.
extractConditionByTag(Condition, String) - Method in interface org.apache.unomi.api.services.DefinitionsService
Deprecated.
extractConditionsByType(Condition, String) - Method in interface org.apache.unomi.api.services.DefinitionsService
Retrieves all conditions of the specified type from the specified root condition.

F

filter(Profile, Session, PersonalizationService.PersonalizedContent) - Method in interface org.apache.unomi.api.services.PersonalizationService
Check if an item is visible for the specified profile and session
Filter() - Constructor for class org.apache.unomi.api.services.PersonalizationService.Filter
 
findProfilesByPropertyValue(String, String, int, int, String) - Method in interface org.apache.unomi.api.services.ProfileService
Find profiles which have the specified property with the specified value, ordered according to the specified sortBy String and paged: only size of them are retrieved, starting with the offset-th one.
findProfileSessions(String) - Method in interface org.apache.unomi.api.services.ProfileService
Retrieves sessions associated with the profile identified by the specified identifier.

G

get(int) - Method in class org.apache.unomi.api.PartialList
Retrieves the element at the specified index
getActionExecutor() - Method in class org.apache.unomi.api.actions.ActionType
Retrieves the action executor.
getActionPostExecutors() - Method in class org.apache.unomi.api.Event
Retrieves the action post executors for this event, if extra actions need to be executed after all Rule-triggered actions have been processed
getActions() - Method in class org.apache.unomi.api.rules.Rule
Retrieves the actions to be performed when this rule triggers.
getActionsTime() - Method in class org.apache.unomi.api.rules.RuleStatistics
Retrieve the accumulated time of the rule's actions
getActionType() - Method in class org.apache.unomi.api.actions.Action
Retrieves the action's type.
getActionType(String) - Method in interface org.apache.unomi.api.services.DefinitionsService
Retrieves the action type associated with the specified identifier.
getActionTypeBySystemTag(String) - Method in interface org.apache.unomi.api.services.DefinitionsService
Retrieves the set of action types with the specified system tag.
getActionTypeByTag(String) - Method in interface org.apache.unomi.api.services.DefinitionsService
Retrieves the set of action types with the specified tag.
getActionTypeId() - Method in class org.apache.unomi.api.actions.Action
Retrieves the identifier of the associated action type.
getAggregate() - Method in class org.apache.unomi.api.query.AggregateQuery
Retrieves the aggregate.
getAggregate(String, String) - Method in interface org.apache.unomi.api.services.QueryService
Retrieves the number of items with the specified type as defined by the Item subclass public field ITEM_TYPE and aggregated by possible values of the specified property.
getAggregate(String, String, AggregateQuery) - Method in interface org.apache.unomi.api.services.QueryService
TODO: rework, this method is confusing since it either behaves like QueryService.getAggregate(String, String) if query is null but completely differently if it isn't Retrieves the number of items with the specified type as defined by the Item subclass public field ITEM_TYPE and aggregated by possible values of the specified property or, if the specified query is not null, perform that aggregate query.
getAllActionTypes() - Method in interface org.apache.unomi.api.services.DefinitionsService
Retrieves all known action types.
getAllConditionTypes() - Method in interface org.apache.unomi.api.services.DefinitionsService
Retrieves all condition types.
getAllProfilesCount() - Method in interface org.apache.unomi.api.services.ProfileService
Retrieves the number of unique profiles.
getAllRuleStatistics() - Method in interface org.apache.unomi.api.services.RulesService
Retrieves the statistics for all the rules
getAllUserLists() - Method in interface org.apache.unomi.api.services.UserListService
 
getAllValueTypes() - Method in interface org.apache.unomi.api.services.DefinitionsService
Retrieves all known value types.
getAnonymousProfile(Profile) - Method in interface org.apache.unomi.api.services.PrivacyService
Build a new anonymous profile (but doesn't persist it in the persistence service).
getAppliesOn() - Method in class org.apache.unomi.api.services.PersonalizationService.Filter
Retrieves the list of targets this filter applies on.
getAttributes() - Method in class org.apache.unomi.api.Event
Retrieves the attributes.
getAutomaticMappingsFrom() - Method in class org.apache.unomi.api.PropertyType
Retrieves the set of JCR properties from which properties of this type would be automatically initialized from.
getCampaign() - Method in class org.apache.unomi.api.campaigns.CampaignDetail
Retrieves the associated campaign.
getCampaign(String) - Method in interface org.apache.unomi.api.services.GoalsService
Retrieves the campaign identified by the specified identifier
getCampaignDetail(String) - Method in interface org.apache.unomi.api.services.GoalsService
Retrieves the CampaignDetail associated with the campaign identified with the specified identifier
getCampaignDetails(Query) - Method in interface org.apache.unomi.api.services.GoalsService
Retrieves campaign details for campaigns matching the specified query.
getCampaignId() - Method in class org.apache.unomi.api.campaigns.events.CampaignEvent
Retrieves the identifier of the associated Campaign.
getCampaignId() - Method in class org.apache.unomi.api.goals.Goal
Retrieves the identifier of the campaign this goal is part of, if any.
getCampaignMetadatas() - Method in interface org.apache.unomi.api.services.GoalsService
Retrieves the set of Metadata associated with existing campaigns.
getCampaignMetadatas(Query) - Method in interface org.apache.unomi.api.services.GoalsService
Retrieves the set of Metadata associated with existing campaign matching the specified Query
getCampaignSessionSuccess() - Method in class org.apache.unomi.api.campaigns.CampaignDetail
Retrieves the number of campaign session successes.
getCampaignSessionViews() - Method in class org.apache.unomi.api.campaigns.CampaignDetail
Retrieves the number of campaign session views.
getCapabilities() - Method in class org.apache.unomi.api.ServerInfo
 
getClusterNodes() - Method in interface org.apache.unomi.api.services.ClusterService
Retrieves the list of available nodes for this context server instance.
getCondition() - Method in class org.apache.unomi.api.BatchUpdate
Retrieves the condition which items we want to update must satisfy.
getCondition() - Method in class org.apache.unomi.api.query.AggregateQuery
Retrieves the condition.
getCondition() - Method in class org.apache.unomi.api.query.Query
Retrieves the Condition associated with this Query.
getCondition() - Method in class org.apache.unomi.api.rules.Rule
Retrieves the condition that, when satisfied, triggers the rule.
getCondition() - Method in class org.apache.unomi.api.segments.ScoringElement
Retrieves the condition.
getCondition() - Method in class org.apache.unomi.api.segments.Segment
Retrieves the condition that users' Profile must satisfy in order to be considered member of this Segment.
getCondition() - Method in class org.apache.unomi.api.services.PersonalizationService.Filter
Retrieves the condition associated with this filter.
getConditionEvaluator() - Method in class org.apache.unomi.api.conditions.ConditionType
Retrieves the condition evaluator.
getConditionsTime() - Method in class org.apache.unomi.api.rules.RuleStatistics
Retrieve the accumulated time evaluating the conditions of the rule in the cluster
getConditionType() - Method in class org.apache.unomi.api.conditions.Condition
Retrieves the associated condition type.
getConditionType(String) - Method in interface org.apache.unomi.api.services.DefinitionsService
Retrieves the condition type associated with the specified identifier.
getConditionTypeId() - Method in class org.apache.unomi.api.conditions.Condition
Retrieves the identifier of the associated condition type.
getConditionTypesBySystemTag(String) - Method in interface org.apache.unomi.api.services.DefinitionsService
Retrieves the set of condition types with the specified system tag.
getConditionTypesByTag(String) - Method in interface org.apache.unomi.api.services.DefinitionsService
Retrieves the set of condition types with the specified tag.
getConsents() - Method in class org.apache.unomi.api.ContextResponse
Retrieves the map of consents for the current profile.
getConsents() - Method in class org.apache.unomi.api.Profile
Returns all the consents, including the revokes ones.
getContents() - Method in class org.apache.unomi.api.services.PersonalizationService.PersonalizationRequest
 
getConversionRate() - Method in class org.apache.unomi.api.campaigns.CampaignDetail
Retrieves the conversion rate.
getConversionRate() - Method in class org.apache.unomi.api.goals.GoalReport.Stat
 
getCost() - Method in class org.apache.unomi.api.campaigns.Campaign
Retrieves the cost incurred by this Campaign.
getCost() - Method in class org.apache.unomi.api.campaigns.events.CampaignEvent
Retrieves the cost associated with this campaign event.
getCpuLoad() - Method in class org.apache.unomi.api.ClusterNode
Retrieves the cpu load.
getCurrency() - Method in class org.apache.unomi.api.campaigns.Campaign
Retrieves the currency associated to the Campaign's cost.
getCurrency() - Method in class org.apache.unomi.api.campaigns.events.CampaignEvent
Retrieves the currency.
getDateRanges() - Method in class org.apache.unomi.api.PropertyType
Retrieves the date ranges.
getDateRanges() - Method in class org.apache.unomi.api.query.Aggregate
 
getDefaultValue() - Method in class org.apache.unomi.api.Parameter
 
getDefaultValue() - Method in class org.apache.unomi.api.PropertyType
Retrieves the default value defined for property using this PropertyType.
getDeniedProperties(String) - Method in interface org.apache.unomi.api.services.PrivacyService
Gets the list of denied properties.
getDeniedPropertyDistribution(String) - Method in interface org.apache.unomi.api.services.PrivacyService
Deprecated.
do not use
getDescription() - Method in class org.apache.unomi.api.Metadata
Retrieves the description.
getDescriptionKey() - Method in class org.apache.unomi.api.ValueType
Retrieves the ResourceBundle key used to localize this ValueType's description.
getDuration() - Method in class org.apache.unomi.api.Session
Retrieves the duration.
getElements() - Method in class org.apache.unomi.api.segments.Scoring
Retrieves the details of this Scoring.
getEndDate() - Method in class org.apache.unomi.api.campaigns.Campaign
Retrieves the end date for this Campaign.
getEngagedProfiles() - Method in class org.apache.unomi.api.campaigns.CampaignDetail
Retrieves the number of engaged profiles.
getEntryCondition() - Method in class org.apache.unomi.api.campaigns.Campaign
Retrieves the entry condition that must be satisfied for users to be considered as taking part of this Campaign.
getEventDate() - Method in class org.apache.unomi.api.campaigns.events.CampaignEvent
Retrieves the event date.
getEventProperties() - Method in interface org.apache.unomi.api.services.EventService
Retrieves the list of available event properties.
getEvents() - Method in class org.apache.unomi.api.ContextRequest
Retrieves the events that the client has generated as part of its processes and wishes the context server to process.
getEvents() - Method in class org.apache.unomi.api.EventsCollectorRequest
Retrieves the events to be processed.
getEvents(Query) - Method in interface org.apache.unomi.api.services.GoalsService
Retrieves CampaignEvents matching the specified query.
getEventType() - Method in class org.apache.unomi.api.Event
Retrieves the event type.
getEventType() - Method in class org.apache.unomi.api.services.ConfigSharingService.ConfigChangeEvent
 
getEventTypeIds() - Method in interface org.apache.unomi.api.services.EventService
Retrieves the set of known event type identifiers.
getEventTypes() - Method in class org.apache.unomi.api.ServerInfo
 
getExecutionCount() - Method in class org.apache.unomi.api.rules.RuleStatistics
Retrieve the execution count of the rule in the cluster
getExistingProperties(String, String) - Method in interface org.apache.unomi.api.services.ProfileService
Retrieves the existing property types for the specified type as defined by the Item subclass public field ITEM_TYPE and with the specified tag.
getExistingProperties(String, String, boolean) - Method in interface org.apache.unomi.api.services.ProfileService
Retrieves the existing property types for the specified type as defined by the Item subclass public field ITEM_TYPE and with the specified tag (system or regular) TODO: move to a different class
getFilter() - Method in class org.apache.unomi.api.PropertyMergeStrategyType
Retrieves the OSGi filter used to identify the implementation associated with this PropertyMergeStrategyType.
getFilteredEventTypes(String) - Method in interface org.apache.unomi.api.services.PrivacyService
Retrieve the list of events that the profile has deactivated.
getFilteredEventTypes(Profile) - Method in interface org.apache.unomi.api.services.PrivacyService
Retrieve the list of events that the profile has deactivated.
getFilteringResults() - Method in class org.apache.unomi.api.ContextResponse
Retrieves the results of the evaluation content filtering definitions and whether individual definitions match with the associated profile (potentially modified by overridden values).
getFilters() - Method in class org.apache.unomi.api.ContextRequest
Retrieves the filters aimed at content personalization that should be evaluated for the given session and/or profile so that the context server can tell the client whether the content associated with the filter should be activated for this profile/session.
getFilters() - Method in class org.apache.unomi.api.services.PersonalizationService.PersonalizedContent
Retrieves the filters.
getFrom() - Method in class org.apache.unomi.api.query.DateRange
 
getFrom() - Method in class org.apache.unomi.api.query.IpRange
 
getFrom() - Method in class org.apache.unomi.api.query.NumericRange
 
getGlobalStats() - Method in class org.apache.unomi.api.goals.GoalReport
 
getGoal(String) - Method in interface org.apache.unomi.api.services.GoalsService
Retrieves the goal associated with the specified identifier.
getGoalMetadatas() - Method in interface org.apache.unomi.api.services.GoalsService
Retrieves the set of Metadata associated with existing goals.
getGoalMetadatas(Query) - Method in interface org.apache.unomi.api.services.GoalsService
Retrieves the set of Metadata associated with existing goals matching the specified Query
getGoalReport(String) - Method in interface org.apache.unomi.api.services.GoalsService
Retrieves the report for the goal identified with the specified identifier.
getGoalReport(String, AggregateQuery) - Method in interface org.apache.unomi.api.services.GoalsService
Retrieves the report for the goal identified with the specified identifier, considering only elements determined by the specified AggregateQuery.
getId() - Method in class org.apache.unomi.api.EventProperty
Retrieves the identifier for this EventProperty.
getId() - Method in class org.apache.unomi.api.EventSource
 
getId() - Method in class org.apache.unomi.api.EventTarget
 
getId() - Method in class org.apache.unomi.api.Metadata
Retrieves the identifier for the entity associated with this Metadata
getId() - Method in class org.apache.unomi.api.Parameter
 
getId() - Method in class org.apache.unomi.api.PropertyMergeStrategyType
Retrieves the identifier for this PropertyMergeStrategyType.
getId() - Method in class org.apache.unomi.api.services.PersonalizationService.PersonalizationRequest
 
getId() - Method in class org.apache.unomi.api.services.PersonalizationService.PersonalizedContent
Retrieves the filter identifier associated with this content filtering definition.
getId() - Method in class org.apache.unomi.api.ValueType
Retrieves this ValueType's identifier.
getInternalHostAddress() - Method in class org.apache.unomi.api.ClusterNode
Retrieves the internal host address which uses the HTTP/HTTPS protocol for communications between clients and the context server.
getIpRanges() - Method in class org.apache.unomi.api.PropertyType
Retrieves the ip ranges.
getItemId() - Method in class org.apache.unomi.api.Item
Retrieves the Item's identifier used to uniquely identify this Item when persisted or when referred to.
getItemType(Class) - Static method in class org.apache.unomi.api.Item
 
getItemType() - Method in class org.apache.unomi.api.Item
Retrieves the Item's type used to assert metadata and structure common to Items of this type, notably for persistence purposes.
getKey() - Method in class org.apache.unomi.api.goals.GoalReport.Stat
 
getKey() - Method in class org.apache.unomi.api.query.DateRange
 
getKey() - Method in class org.apache.unomi.api.query.IpRange
 
getKey() - Method in class org.apache.unomi.api.query.NumericRange
 
getLastEventDate() - Method in class org.apache.unomi.api.Session
Retrieves the last event date.
getLastSession() - Method in class org.apache.unomi.api.PersonaWithSessions
 
getLastSyncDate() - Method in class org.apache.unomi.api.rules.RuleStatistics
Retrieve the last sync date
getLimit() - Method in class org.apache.unomi.api.query.Query
Retrieves the number of elements to retrieve.
getLinkedItems() - Method in class org.apache.unomi.api.rules.Rule
Retrieves the linked items.
getList() - Method in class org.apache.unomi.api.PartialList
Retrieves the limited list view.
getLoadAverage() - Method in class org.apache.unomi.api.ClusterNode
Retrieves the load average for the last minute, five minutes and fifteen minutes.
getLocalActionsTime() - Method in class org.apache.unomi.api.rules.RuleStatistics
Retrieve the accumulated time spent executing the rule's actions since the last sync with the cluster
getLocalConditionsTime() - Method in class org.apache.unomi.api.rules.RuleStatistics
Retrieve the accumulated execution time of the rule's condition since the last sync with the cluster
getLocalExecutionCount() - Method in class org.apache.unomi.api.rules.RuleStatistics
Retrieve the execution count of the rule on this single node since the last sync with the cluster
getMatchingIndividuals(String, int, int, String) - Method in interface org.apache.unomi.api.services.SegmentService
Retrieves a list of profiles matching the conditions defined by the segment identified by the specified identifier, ordered according to the specified sortBy String and and paged: only size of them are retrieved, starting with the offset-th one.
getMatchingIndividualsCount(String) - Method in interface org.apache.unomi.api.services.SegmentService
Retrieves the number of profiles matching the conditions defined by the segment identified by the specified identifier.
getMergedWith() - Method in class org.apache.unomi.api.Profile
Retrieves the identifier of the profile this profile is merged with if any.
getMergeStrategy() - Method in class org.apache.unomi.api.PropertyType
Retrieves the identifier of the PropertyMergeStrategyType to be used in case profiles with properties using this PropertyType are being merged.
getMetadata() - Method in class org.apache.unomi.api.MetadataItem
Retrieves the associated Metadata.
getMetric(String, String, String, Condition) - Method in interface org.apache.unomi.api.services.QueryService
Retrieves the specified metrics for the specified field of items of the specified type as defined by the Item subclass public field ITEM_TYPE and matching the specified Condition.
getName() - Method in class org.apache.unomi.api.EventInfo
 
getName() - Method in class org.apache.unomi.api.Metadata
Retrieves the name.
getName() - Method in class org.apache.unomi.api.services.ConfigSharingService.ConfigChangeEvent
 
getNameKey() - Method in class org.apache.unomi.api.ValueType
Retrieves the ResourceBundle key used to localize this ValueType's name.
getNewValue() - Method in class org.apache.unomi.api.services.ConfigSharingService.ConfigChangeEvent
 
getNumberOfGoals() - Method in class org.apache.unomi.api.campaigns.CampaignDetail
Retrieves the number of goals.
getNumericRanges() - Method in class org.apache.unomi.api.PropertyType
Retrieves the numeric ranges.
getNumericRanges() - Method in class org.apache.unomi.api.query.Aggregate
 
getOccurences() - Method in class org.apache.unomi.api.EventInfo
 
getOffset() - Method in class org.apache.unomi.api.PartialList
Retrieves the offset of the first element of the view.
getOffset() - Method in class org.apache.unomi.api.query.Query
Retrieves the offset of the first element to be retrieved
getOldValue() - Method in class org.apache.unomi.api.services.ConfigSharingService.ConfigChangeEvent
 
getPageSize() - Method in class org.apache.unomi.api.PartialList
Retrieves the number of elements this PartialList contains.
getParameter(String) - Method in class org.apache.unomi.api.conditions.Condition
Retrieves the parameter identified by the specified name.
getParameters() - Method in class org.apache.unomi.api.actions.ActionType
Retrieves the parameters.
getParameters() - Method in class org.apache.unomi.api.conditions.ConditionType
Retrieves the defined Parameters for this ConditionType.
getParameters() - Method in class org.apache.unomi.api.query.Aggregate
 
getParameterValues() - Method in class org.apache.unomi.api.actions.Action
Retrieves the parameter values as a Map of parameter name - associated value pairs.
getParameterValues() - Method in class org.apache.unomi.api.conditions.Condition
Retrieves a Map of all parameter name - value pairs for this condition.
getParentCondition() - Method in class org.apache.unomi.api.conditions.ConditionType
Retrieves the parent condition.
getPath() - Method in class org.apache.unomi.api.EventSource
 
getPercentage() - Method in class org.apache.unomi.api.goals.GoalReport.Stat
 
getPersona() - Method in class org.apache.unomi.api.PersonaWithSessions
 
getPersonalizations() - Method in class org.apache.unomi.api.ContextRequest
 
getPersonalizations() - Method in class org.apache.unomi.api.ContextResponse
 
getPersonaSessions(String, int, int, String) - Method in interface org.apache.unomi.api.services.ProfileService
Retrieves the sessions associated with the persona identified by the specified identifier, ordered according to the specified sortBy String and and paged: only size of them are retrieved, starting with the offset-th one.
getPluginId() - Method in interface org.apache.unomi.api.PluginType
Retrieves the plugin identifier, corresponding to the identifier of the OSGi bundle implementing the plugin.
getPluginId() - Method in class org.apache.unomi.api.PropertyMergeStrategyType
 
getPluginId() - Method in class org.apache.unomi.api.ValueType
 
getPrimaryGoal() - Method in class org.apache.unomi.api.campaigns.Campaign
Retrieves the identifier for this Campaign's primary Goal.
getPriority() - Method in class org.apache.unomi.api.rules.Rule
Retrieves the priority in case this Rule needs to be executed before other ones when similar conditions match.
getProfile() - Method in class org.apache.unomi.api.Event
Retrieves the profile.
getProfile() - Method in class org.apache.unomi.api.Session
Retrieves the associated Profile.
getProfileId() - Method in class org.apache.unomi.api.ContextResponse
Retrieves the profile identifier associated with the profile of the user on behalf of which the client performed the context request.
getProfileId() - Method in class org.apache.unomi.api.Event
Retrieves the profile identifier of the Profile associated with this event
getProfileId() - Method in class org.apache.unomi.api.Session
Retrieves the identifier of the associated Profile.
getProfileOverrides() - Method in class org.apache.unomi.api.ContextRequest
Retrieves the profile overrides.
getProfileProperties() - Method in class org.apache.unomi.api.ContextResponse
Retrieves the profile properties that were requested by the client.
getProfileSegments() - Method in class org.apache.unomi.api.ContextResponse
Retrieves the identifiers of the profile segments associated with the user if they were requested by the client.
getProfileSessions(String, String, int, int, String) - Method in interface org.apache.unomi.api.services.ProfileService
Retrieves the sessions associated with the profile identified by the specified identifier that match the specified query (if specified), ordered according to the specified sortBy String and and paged: only size of them are retrieved, starting with the offset-th one.
getProperties() - Method in class org.apache.unomi.api.CustomItem
Retrieves this CustomItem's properties.
getProperties() - Method in class org.apache.unomi.api.Event
Retrieves the properties.
getProperties() - Method in class org.apache.unomi.api.EventTarget
 
getProperties() - Method in class org.apache.unomi.api.Profile
Retrieves a Map of all property name - value pairs for this profile.
getProperties() - Method in class org.apache.unomi.api.services.PersonalizationService.Filter
 
getProperties() - Method in class org.apache.unomi.api.services.PersonalizationService.PersonalizedContent
 
getProperties() - Method in class org.apache.unomi.api.Session
Retrieves a Map of all property name - value pairs.
getProperty(String) - Method in class org.apache.unomi.api.Event
Retrieves the value of the property identified by the specified name.
getProperty(String) - Method in class org.apache.unomi.api.Profile
Retrieves the property identified by the specified name.
getProperty() - Method in class org.apache.unomi.api.query.Aggregate
 
getProperty(String) - Method in interface org.apache.unomi.api.services.ConfigSharingService
 
getProperty(String) - Method in class org.apache.unomi.api.Session
Retrieves the property identified by the specified name.
getPropertyMergeStrategyType(String) - Method in interface org.apache.unomi.api.services.DefinitionsService
Retrieves the property merge strategy type associated with the specified identifier.
getPropertyName() - Method in class org.apache.unomi.api.BatchUpdate
Retrieves the property name which value needs to be updated.
getPropertyNames() - Method in interface org.apache.unomi.api.services.ConfigSharingService
 
getPropertyType(String) - Method in interface org.apache.unomi.api.services.ProfileService
Retrieves the property type identified by the specified identifier.
getPropertyTypeByMapping(String) - Method in interface org.apache.unomi.api.services.ProfileService
TODO
getPropertyTypeBySystemTag(String) - Method in interface org.apache.unomi.api.services.ProfileService
Retrieves all property types with the specified system tag TODO: move to a different class
getPropertyTypeByTag(String) - Method in interface org.apache.unomi.api.services.ProfileService
Retrieves all property types with the specified tag TODO: move to a different class
getPropertyTypeMapping(String) - Method in interface org.apache.unomi.api.services.ProfileService
TODO
getPropertyValue() - Method in class org.apache.unomi.api.BatchUpdate
Retrieves the new property value.
getPublicHostAddress() - Method in class org.apache.unomi.api.ClusterNode
Retrieves the public host address.
getQueryBuilder() - Method in class org.apache.unomi.api.conditions.ConditionType
Retrieves the query builder.
getQueryCount(String, Condition) - Method in interface org.apache.unomi.api.services.QueryService
Retrieves the number of items of the specified type as defined by the Item subclass public field ITEM_TYPE and matching the specified Condition.
getRank() - Method in class org.apache.unomi.api.PropertyType
Retrieves the rank of this PropertyType for ordering purpose.
getRequiredProfileProperties() - Method in class org.apache.unomi.api.ContextRequest
Retrieves the list of profile properties the context server should return with its context response.
getRequiredSessionProperties() - Method in class org.apache.unomi.api.ContextRequest
Retrieves the list of session properties the context server should return with its context response.
getRevokeDate() - Method in class org.apache.unomi.api.Consent
Retrieves the end date for this consent.
getRule(String) - Method in interface org.apache.unomi.api.services.RulesService
Retrieves the rule identified by the specified identifier.
getRuleDetails(Query) - Method in interface org.apache.unomi.api.services.RulesService
Retrieves rule details for rules matching the specified query.
getRuleMetadatas() - Method in interface org.apache.unomi.api.services.RulesService
Retrieves the metadata for all known rules.
getRuleMetadatas(Query) - Method in interface org.apache.unomi.api.services.RulesService
Retrieves rule metadatas for rules matching the specified Query.
getRuleStatistics(String) - Method in interface org.apache.unomi.api.services.RulesService
Retrieves the statistics for a rule
getScope() - Method in class org.apache.unomi.api.Consent
Retrieve the scope for this consent
getScope() - Method in class org.apache.unomi.api.Event
 
getScope() - Method in class org.apache.unomi.api.EventSource
 
getScope() - Method in class org.apache.unomi.api.Item
Retrieves the Item's scope.
getScope() - Method in class org.apache.unomi.api.Metadata
Retrieves the scope for the entity associated with this Metadata
getScope() - Method in class org.apache.unomi.api.MetadataItem
 
getScope() - Method in class org.apache.unomi.api.Profile
Retrieves the Item's scope.
getScope() - Method in class org.apache.unomi.api.Session
 
getScores() - Method in class org.apache.unomi.api.Profile
Retrieves the scores associated to this profile.
getScores() - Method in class org.apache.unomi.api.segments.SegmentsAndScores
Retrieves the scores as a Map of scoring name - associated score pairs.
getScoringDefinition(String) - Method in interface org.apache.unomi.api.services.SegmentService
Retrieves the scoring identified by the specified identifier.
getScoringDependentMetadata(String) - Method in interface org.apache.unomi.api.services.SegmentService
Retrieves the list of Segment and Scoring metadata depending on the specified scoring.
getScoringMetadatas(int, int, String) - Method in interface org.apache.unomi.api.services.SegmentService
Retrieves the set of all scoring metadata.
getScoringMetadatas(Query) - Method in interface org.apache.unomi.api.services.SegmentService
Retrieves the set of scoring metadata for scorings matching the specified query.
getScorings() - Method in class org.apache.unomi.api.segments.DependentMetadata
 
getScrollIdentifier() - Method in class org.apache.unomi.api.PartialList
Retrieve the scroll identifier to make it possible to continue a scrolling list query
getScrollTimeValidity() - Method in class org.apache.unomi.api.PartialList
Retrieve the value of the scroll time validity to make it possible to continue a scrolling list query
getSegmentDefinition(String) - Method in interface org.apache.unomi.api.services.SegmentService
Retrieves the segment identified by the specified identifier.
getSegmentDependentMetadata(String) - Method in interface org.apache.unomi.api.services.SegmentService
Retrieves the list of Segment and Scoring metadata depending on the specified segment.
getSegmentMetadatas(int, int, String) - Method in interface org.apache.unomi.api.services.SegmentService
Retrieves segment metadatas, ordered according to the specified sortBy String and and paged: only size of them are retrieved, starting with the offset-th one.
getSegmentMetadatas(String, int, int, String) - Method in interface org.apache.unomi.api.services.SegmentService
Retrieves segment metadatas for segments in the specified scope, ordered according to the specified sortBy String and and paged: only size of them are retrieved, starting with the offset-th one.
getSegmentMetadatas(Query) - Method in interface org.apache.unomi.api.services.SegmentService
Retrieves the metadata for segments matching the specified Query.
getSegmentMetadatasForProfile(Profile) - Method in interface org.apache.unomi.api.services.SegmentService
Retrieves the list of segment metadata for the segments the specified profile is a member of.
getSegments() - Method in class org.apache.unomi.api.Profile
Retrieves the identifiers of the segments this profile is a member of.
getSegments() - Method in class org.apache.unomi.api.segments.DependentMetadata
 
getSegments() - Method in class org.apache.unomi.api.segments.SegmentsAndScores
Retrieves the segments identifiers.
getSegmentsAndScoresForProfile(Profile) - Method in interface org.apache.unomi.api.services.SegmentService
Retrieves the segments and scores for the specified profile.
getServerIdentifier() - Method in class org.apache.unomi.api.ServerInfo
 
getServerInfo() - Method in interface org.apache.unomi.api.services.PrivacyService
Retrieves the server information, including the name and version of the server, the event types if recognizes as well as the capabilities supported by the system.
getServerVersion() - Method in class org.apache.unomi.api.ServerInfo
 
getSession() - Method in class org.apache.unomi.api.Event
Retrieves the session.
getSessionId() - Method in class org.apache.unomi.api.ContextRequest
Retrieve the sessionId passed along with the request.
getSessionId() - Method in class org.apache.unomi.api.ContextResponse
Retrieves the session identifier associated with the processed request.
getSessionId() - Method in class org.apache.unomi.api.Event
Retrieves the session identifier if available.
getSessionId() - Method in class org.apache.unomi.api.EventsCollectorRequest
Retrieve the sessionId passed along with the request.
getSessionProperties() - Method in class org.apache.unomi.api.ContextResponse
Retrieves the session properties that were requested by the client.
getSessionPropertiesOverrides() - Method in class org.apache.unomi.api.ContextRequest
Retrieves the session properties overrides.
getSessions() - Method in class org.apache.unomi.api.PersonaWithSessions
 
getSize() - Method in class org.apache.unomi.api.Session
Retrieves the size.
getSortby() - Method in class org.apache.unomi.api.query.Query
Retrieves the sorting specifications for this Query in String format, if any.
getSource() - Method in class org.apache.unomi.api.ContextRequest
Retrieves the source of the context request.
getSource() - Method in class org.apache.unomi.api.Event
Retrieves the source.
getSplit() - Method in class org.apache.unomi.api.goals.GoalReport
 
getStartCount() - Method in class org.apache.unomi.api.goals.GoalReport.Stat
 
getStartDate() - Method in class org.apache.unomi.api.campaigns.Campaign
Retrieves the start date for this Campaign.
getStartEvent() - Method in class org.apache.unomi.api.goals.Goal
Retrieves the Condition determining the goal's start event if any, used for more complex goals where an action has to be accomplished first before evaluating the success of the final goal (funnel goal for example).
getStatus() - Method in class org.apache.unomi.api.Consent
Retrieves the status for this consent.
getStatusDate() - Method in class org.apache.unomi.api.Consent
Retrieve the date at which this consent was given.
getStrategy() - Method in class org.apache.unomi.api.BatchUpdate
Retrieves the identifier for the PropertyMergeStrategyType to use during the update if needed.
getStrategy() - Method in class org.apache.unomi.api.services.PersonalizationService.PersonalizationRequest
 
getStrategyOptions() - Method in class org.apache.unomi.api.services.PersonalizationService.PersonalizationRequest
 
getSystemProperties() - Method in class org.apache.unomi.api.Profile
Retrieves a Map of system property name - value pairs for this profile.
getSystemProperties() - Method in class org.apache.unomi.api.Session
Retrieves a Map of system property name - value pairs.
getSystemTags() - Method in class org.apache.unomi.api.Metadata
Retrieves a set of String system tag names associated with this Metadata
getTags() - Method in class org.apache.unomi.api.Metadata
Retrieves a set of String tag names associated with this Metadata
getTags() - Method in class org.apache.unomi.api.ValueType
Retrieves the tags used by this ValueType.
getTarget() - Method in class org.apache.unomi.api.Event
Retrieves the target.
getTarget() - Method in class org.apache.unomi.api.PropertyType
Retrieves the target for this property type, indicating the type of elements this property type is defined for.
getTarget() - Method in class org.apache.unomi.api.services.PersonalizationService.Target
Retrieves the target.
getTargetCount() - Method in class org.apache.unomi.api.goals.GoalReport.Stat
 
getTargetEvent() - Method in class org.apache.unomi.api.goals.Goal
Retrieves the Condition determining the target event which needs to occur to consider the goal accomplished.
getTargetPropertyTypes(String) - Method in interface org.apache.unomi.api.services.ProfileService
Retrieves all the property types associated with the specified target.
getTargetPropertyTypes() - Method in interface org.apache.unomi.api.services.ProfileService
Retrieves all known property types.
getText() - Method in class org.apache.unomi.api.query.Query
Retrieves the text to be used in full-text searches, if any.
getTimeStamp() - Method in class org.apache.unomi.api.Event
 
getTimeStamp() - Method in class org.apache.unomi.api.Session
Retrieves the session creation timestamp.
getTimeStamp() - Method in interface org.apache.unomi.api.TimestampedItem
Retrieves the associated timestamp.
getTimezone() - Method in class org.apache.unomi.api.campaigns.Campaign
Retrieves the timezone associated with this Campaign's start and end dates.
getTimezone() - Method in class org.apache.unomi.api.campaigns.events.CampaignEvent
Retrieves the timezone.
getTo() - Method in class org.apache.unomi.api.query.DateRange
 
getTo() - Method in class org.apache.unomi.api.query.IpRange
 
getTo() - Method in class org.apache.unomi.api.query.NumericRange
 
getTotalSize() - Method in class org.apache.unomi.api.PartialList
Retrieves the total size of elements in the original List.
getTrackedConditions() - Method in class org.apache.unomi.api.ContextResponse
Retrieves the tracked conditions, if any, associated with the source of the context request that resulted in this ContextResponse.
getTrackedConditions(Item) - Method in interface org.apache.unomi.api.services.RulesService
Retrieves tracked conditions (rules with a condition marked with the trackedCondition tag and which sourceEventCondition matches the specified item) for the specified item.
getType() - Method in class org.apache.unomi.api.EventSource
 
getType() - Method in class org.apache.unomi.api.EventTarget
 
getType() - Method in class org.apache.unomi.api.Parameter
 
getType() - Method in class org.apache.unomi.api.query.Aggregate
 
getTypeIdentifier() - Method in class org.apache.unomi.api.Consent
Retrieve the consent type identifier for this consent.
getTypesByPlugin() - Method in interface org.apache.unomi.api.services.DefinitionsService
Retrieves a Map of plugin identifier to a list of plugin types defined by that particular plugin.
getUptime() - Method in class org.apache.unomi.api.ClusterNode
Retrieves the uptime.
getUserListMetadatas(int, int, String) - Method in interface org.apache.unomi.api.services.UserListService
Retrieves user lists metadatas, ordered according to the specified sortBy String and and paged: only size of them are retrieved, starting with the offset-th one.
getValue() - Method in class org.apache.unomi.api.segments.ScoringElement
Retrieves the value.
getValues() - Method in class org.apache.unomi.api.services.PersonalizationService.Target
Retrieves the values.
getValueType() - Method in class org.apache.unomi.api.EventProperty
Retrieves the type.
getValueType() - Method in class org.apache.unomi.api.PropertyType
Retrieves the value type associated with values defined for properties using this PropertyType.
getValueType(String) - Method in interface org.apache.unomi.api.services.DefinitionsService
Retrieves the value type associated with the specified identifier.
getValueTypeByTag(String) - Method in interface org.apache.unomi.api.services.DefinitionsService
Retrieves the set of value types with the specified tag.
getValueTypeId() - Method in class org.apache.unomi.api.PropertyType
Retrieves the identifier of the value type constraining values for properties using this PropertyType.
getVersion() - Method in class org.apache.unomi.api.Item
 
Goal - Class in org.apache.unomi.api.goals
A tracked activity / action that can be accomplished by site (scope) visitors.
Goal() - Constructor for class org.apache.unomi.api.goals.Goal
 
Goal(Metadata) - Constructor for class org.apache.unomi.api.goals.Goal
 
GoalReport - Class in org.apache.unomi.api.goals
Report information about a Goal.
GoalReport() - Constructor for class org.apache.unomi.api.goals.GoalReport
 
GoalReport.Stat - Class in org.apache.unomi.api.goals
Statistics
GoalsService - Interface in org.apache.unomi.api.services
A service to interact with Goals and Campaigns.

H

hasEventAlreadyBeenRaised(Event, boolean) - Method in interface org.apache.unomi.api.services.EventService
Checks whether the specified event has already been raised either for the associated session or profile depending on the specified session parameter.
hashCode() - Method in class org.apache.unomi.api.actions.ActionType
 
hashCode() - Method in class org.apache.unomi.api.conditions.Condition
 
hashCode() - Method in class org.apache.unomi.api.conditions.ConditionType
 
hashCode() - Method in class org.apache.unomi.api.Item
 
hashCode() - Method in class org.apache.unomi.api.Metadata
 
hashCode() - Method in class org.apache.unomi.api.ValueType
 
hasProperty(String) - Method in interface org.apache.unomi.api.services.ConfigSharingService
 
HTTP_REQUEST_ATTRIBUTE - Static variable in class org.apache.unomi.api.Event
A constant for the name of the attribute that can be used to retrieve the current HTTP request.
HTTP_RESPONSE_ATTRIBUTE - Static variable in class org.apache.unomi.api.Event
A constant for the name of the attribute that can be used to retrieve the current HTTP response.

I

IpRange - Class in org.apache.unomi.api.query
An IP address range.
IpRange() - Constructor for class org.apache.unomi.api.query.IpRange
 
ipRanges() - Method in class org.apache.unomi.api.query.Aggregate
 
isAnonymousBrowsing() - Method in class org.apache.unomi.api.ContextResponse
Retrieves the current status of anonymous browsing, as set by the privacy service
isAnonymousProfile() - Method in class org.apache.unomi.api.Profile
Returns true if this profile is an anonymous profile.
isConsentGrantedAtDate(Date) - Method in class org.apache.unomi.api.Consent
Tests if the consent is GRANTED at the specified date
isConsentGrantedNow() - Method in class org.apache.unomi.api.Consent
Test if the consent is GRANTED right now.
isData() - Method in class org.apache.unomi.api.ClusterNode
Determines whether this ClusterNode locally stores data.
isEnabled() - Method in class org.apache.unomi.api.Metadata
Whether the associated entity is considered active by the context server, in particular to check if rules need to be created / triggered
isEventAllowed(Event, String) - Method in interface org.apache.unomi.api.services.EventService
Check if the sender is allowed to sent the speecified event.
isForceRefresh() - Method in class org.apache.unomi.api.query.Query
Determines whether or not an index refresh is needed before performing this Query
isHidden() - Method in class org.apache.unomi.api.Metadata
Whether the associated entity is considered for internal purposes only and should therefore be hidden to accessing UIs.
isMaster() - Method in class org.apache.unomi.api.ClusterNode
Determines whether this ClusterNode is a master node, i.e.
isMissingPlugins() - Method in class org.apache.unomi.api.Metadata
Whether the associated entity is waiting on additional plugins to become available to be able to properly perform its function.
isMultivalued() - Method in class org.apache.unomi.api.Parameter
 
isMultivalued() - Method in class org.apache.unomi.api.PropertyType
Whether properties using this property type are multi-valued.
isPersistent() - Method in class org.apache.unomi.api.Event
Determines whether this Event needs to be persisted to the context server or not.
isProfileInSegment(Profile, String) - Method in interface org.apache.unomi.api.services.SegmentService
Determines whether the specified profile is part of the segment identified by the specified identifier.
isProtected() - Method in class org.apache.unomi.api.PropertyType
Whether properties with this type are marked as protected.
isRaiseEventOnlyOnceForProfile() - Method in class org.apache.unomi.api.rules.Rule
Determines whether the event raised when the rule is triggered should only be raised once per Profile.
isRaiseEventOnlyOnceForSession() - Method in class org.apache.unomi.api.rules.Rule
Determines whether the event raised when the rule is triggered should only be raised once per Session.
isReadOnly() - Method in class org.apache.unomi.api.Metadata
Whether the associated entity can be accessed but not modified.
isRequireAnonymousBrowsing(String) - Method in interface org.apache.unomi.api.services.PrivacyService
Tests if the anonymous browsing flag is set of the specified profile.
isRequireAnonymousBrowsing(Profile) - Method in interface org.apache.unomi.api.services.PrivacyService
Tests if the anonymous browsing flag is set of the specified profile.
isRequireSegments() - Method in class org.apache.unomi.api.ContextRequest
Determines whether or not the context server should return the segments associated with the profile from which the request was issued.
Item - Class in org.apache.unomi.api
A context server tracked entity.
Item() - Constructor for class org.apache.unomi.api.Item
 
Item(String) - Constructor for class org.apache.unomi.api.Item
 
ITEM_TYPE - Static variable in class org.apache.unomi.api.actions.ActionType
 
ITEM_TYPE - Static variable in class org.apache.unomi.api.campaigns.Campaign
The Campaign ITEM_TYPE.
ITEM_TYPE - Static variable in class org.apache.unomi.api.campaigns.events.CampaignEvent
The CampaignEvent ITEM_TYPE.
ITEM_TYPE - Static variable in class org.apache.unomi.api.conditions.ConditionType
 
ITEM_TYPE - Static variable in class org.apache.unomi.api.CustomItem
The CustomItem ITEM_TYPE.
ITEM_TYPE - Static variable in class org.apache.unomi.api.Event
The Event ITEM_TYPE.
ITEM_TYPE - Static variable in class org.apache.unomi.api.goals.Goal
 
ITEM_TYPE - Static variable in class org.apache.unomi.api.lists.UserList
The Segment ITEM_TYPE.
ITEM_TYPE - Static variable in class org.apache.unomi.api.Persona
 
ITEM_TYPE - Static variable in class org.apache.unomi.api.PersonaSession
 
ITEM_TYPE - Static variable in class org.apache.unomi.api.Profile
The Profile ITEM_TYPE
ITEM_TYPE - Static variable in class org.apache.unomi.api.PropertyType
The PropertyType ITEM_TYPE.
ITEM_TYPE - Static variable in class org.apache.unomi.api.rules.Rule
The Rule ITEM_TYPE.
ITEM_TYPE - Static variable in class org.apache.unomi.api.rules.RuleStatistics
The RuleStatistics ITEM_TYPE.
ITEM_TYPE - Static variable in class org.apache.unomi.api.segments.Scoring
The Scoring ITEM_TYPE.
ITEM_TYPE - Static variable in class org.apache.unomi.api.segments.Segment
The Segment ITEM_TYPE.
ITEM_TYPE - Static variable in class org.apache.unomi.api.Session
The Session ITEM_TYPE.
itemId - Variable in class org.apache.unomi.api.Item
 
itemType - Variable in class org.apache.unomi.api.Item
 

L

load(String) - Method in interface org.apache.unomi.api.services.ProfileService
Retrieves the profile identified by the specified identifier.
loadPersona(String) - Method in interface org.apache.unomi.api.services.ProfileService
Retrieves the persona identified by the specified identifier.
loadPersonaWithSessions(String) - Method in interface org.apache.unomi.api.services.ProfileService
Retrieves the persona identified by the specified identifier and all its associated sessions
loadSession(String, Date) - Method in interface org.apache.unomi.api.services.ProfileService
Retrieves the session identified by the specified identifier.

M

matchCondition(Condition, Profile, Session) - Method in interface org.apache.unomi.api.services.ProfileService
Checks whether the specified profile and/or session satisfy the specified condition.
mergeProfiles(Profile, List<Profile>) - Method in interface org.apache.unomi.api.services.ProfileService
Merges the specified profiles into the provided so-called master profile, merging properties according to the PropertyMergeStrategyType specified on their PropertyType.
mergeProperty(String, PropertyType, List<Profile>, Profile) - Method in interface org.apache.unomi.api.PropertyMergeStrategyExecutor
Merges the value of the property identified by the specified name and type from the specified profiles into the specified target profile.
Metadata - Class in org.apache.unomi.api
A class providing information about context server entities.
Metadata() - Constructor for class org.apache.unomi.api.Metadata
Instantiates a new Metadata.
Metadata(String) - Constructor for class org.apache.unomi.api.Metadata
Instantiates a new Metadata with the specified identifier.
Metadata(String, String, String, String) - Constructor for class org.apache.unomi.api.Metadata
Instantiates a new Metadata with the provided information.
metadata - Variable in class org.apache.unomi.api.MetadataItem
 
MetadataItem - Class in org.apache.unomi.api
A superclass for all Items that bear Metadata.
MetadataItem() - Constructor for class org.apache.unomi.api.MetadataItem
 
MetadataItem(Metadata) - Constructor for class org.apache.unomi.api.MetadataItem
 

N

NO_CHANGE - Static variable in interface org.apache.unomi.api.services.EventService
No change occurred following an event being handled.
NumericRange - Class in org.apache.unomi.api.query
A numeric range.
NumericRange() - Constructor for class org.apache.unomi.api.query.NumericRange
 

O

onEvent(Event) - Method in interface org.apache.unomi.api.services.EventListenerService
Handles the specified event.
org.apache.unomi.api - package org.apache.unomi.api
 
org.apache.unomi.api.actions - package org.apache.unomi.api.actions
 
org.apache.unomi.api.campaigns - package org.apache.unomi.api.campaigns
 
org.apache.unomi.api.campaigns.events - package org.apache.unomi.api.campaigns.events
 
org.apache.unomi.api.conditions - package org.apache.unomi.api.conditions
 
org.apache.unomi.api.goals - package org.apache.unomi.api.goals
 
org.apache.unomi.api.lists - package org.apache.unomi.api.lists
 
org.apache.unomi.api.query - package org.apache.unomi.api.query
 
org.apache.unomi.api.rules - package org.apache.unomi.api.rules
 
org.apache.unomi.api.segments - package org.apache.unomi.api.segments
 
org.apache.unomi.api.services - package org.apache.unomi.api.services
 

P

Parameter - Class in org.apache.unomi.api
A representation of a condition parameter, to be used in the segment building UI to either select parameters from a choicelist or to enter a specific value.
Parameter() - Constructor for class org.apache.unomi.api.Parameter
 
PartialList<T> - Class in org.apache.unomi.api
A list of elements representing a limited view of a larger list, starting from a given element (offset from the first) and showing only a given number of elements, instead of showing all of them.
PartialList() - Constructor for class org.apache.unomi.api.PartialList
Instantiates a new PartialList.
PartialList(List<T>, long, long, long) - Constructor for class org.apache.unomi.api.PartialList
Instantiates a new PartialList.
Persona - Class in org.apache.unomi.api
A persona is a "virtual" profile used to represent categories of profiles, and may also be used to test how a personalized experience would look like using this virtual profile.
Persona() - Constructor for class org.apache.unomi.api.Persona
 
Persona(String) - Constructor for class org.apache.unomi.api.Persona
 
PERSONAL_IDENTIFIER_TAG_NAME - Static variable in interface org.apache.unomi.api.services.ProfileService
 
PersonalizationRequest() - Constructor for class org.apache.unomi.api.services.PersonalizationService.PersonalizationRequest
 
PersonalizationService - Interface in org.apache.unomi.api.services
A service to fulfill personalization request.
PersonalizationService.Filter - Class in org.apache.unomi.api.services
A filter definition for content filtering
PersonalizationService.PersonalizationRequest - Class in org.apache.unomi.api.services
Personalization request
PersonalizationService.PersonalizedContent - Class in org.apache.unomi.api.services
A personalizated content definition.
PersonalizationService.Target - Class in org.apache.unomi.api.services
A target for content filtering.
PersonalizationStrategy - Interface in org.apache.unomi.api
 
PersonalizedContent() - Constructor for class org.apache.unomi.api.services.PersonalizationService.PersonalizedContent
 
personalizeList(Profile, Session, PersonalizationService.PersonalizationRequest) - Method in interface org.apache.unomi.api.PersonalizationStrategy
 
personalizeList(Profile, Session, PersonalizationService.PersonalizationRequest) - Method in interface org.apache.unomi.api.services.PersonalizationService
Get a personalized list, filtered and sorted, based on the profile and session
PersonaSession - Class in org.apache.unomi.api
A Persona session.
PersonaSession() - Constructor for class org.apache.unomi.api.PersonaSession
 
PersonaSession(String, Profile, Date) - Constructor for class org.apache.unomi.api.PersonaSession
 
PersonaWithSessions - Class in org.apache.unomi.api
A convenience object gathering a Persona and its associated PersonaSessions.
PersonaWithSessions() - Constructor for class org.apache.unomi.api.PersonaWithSessions
 
PersonaWithSessions(Persona, List<PersonaSession>) - Constructor for class org.apache.unomi.api.PersonaWithSessions
 
PluginType - Interface in org.apache.unomi.api
The interface for unomi plugins.
PrivacyService - Interface in org.apache.unomi.api.services
This service regroups all privacy-related operations
Profile - Class in org.apache.unomi.api
A user profile gathering all known information about a given user as well as segments it is part of and scores.
Profile() - Constructor for class org.apache.unomi.api.Profile
Instantiates a new Profile.
Profile(String) - Constructor for class org.apache.unomi.api.Profile
Instantiates a new Profile with the specified identifier.
PROFILE_UPDATED - Static variable in interface org.apache.unomi.api.services.EventService
The associated profile was updated following an event being handled.
ProfileService - Interface in org.apache.unomi.api.services
A service to access and operate on Profiles, Sessions and Personas.
PropertyMergeStrategyExecutor - Interface in org.apache.unomi.api
A strategy algorithm to merge profile properties such as "adding integers", "using oldest value", "using most recent value", "merging lists", etc...
PropertyMergeStrategyType - Class in org.apache.unomi.api
A unomi plugin that defines a new property merge strategy.
PropertyMergeStrategyType() - Constructor for class org.apache.unomi.api.PropertyMergeStrategyType
 
PropertyType - Class in org.apache.unomi.api
A user-defined profile or session property, specifying how possible values are constrained, if the value is multi-valued (a vector of values as opposed to a scalar value).
PropertyType() - Constructor for class org.apache.unomi.api.PropertyType
Instantiates a new Property type.
PropertyType(Metadata) - Constructor for class org.apache.unomi.api.PropertyType
Instantiates a new Property type with the specified Metadata.
purge(Date) - Method in interface org.apache.unomi.api.services.ClusterService
Removes all data before the specified date from the context server.
purge(String) - Method in interface org.apache.unomi.api.services.ClusterService
Removes all data associated with the provided scope.

Q

Query - Class in org.apache.unomi.api.query
A query wrapper gathering all elements needed for a potentially complex CXS query: Condition, offset, limit, sorting specification, etc.
Query() - Constructor for class org.apache.unomi.api.query.Query
Instantiates a new Query.
QueryService - Interface in org.apache.unomi.api.services
A service to perform queries.

R

removeActionType(String) - Method in interface org.apache.unomi.api.services.DefinitionsService
Remove the action type
removeCampaign(String) - Method in interface org.apache.unomi.api.services.GoalsService
Removes the campaign associated with the specified identifier, also removing associated rules if needed.
removeCampaignEvent(String) - Method in interface org.apache.unomi.api.services.GoalsService
Removes the campaign event associated with the specified identifier.
removeConditionType(String) - Method in interface org.apache.unomi.api.services.DefinitionsService
Remove the condition type
removeGoal(String) - Method in interface org.apache.unomi.api.services.GoalsService
Removes the goal associated with the specified identifier, also removing associated rules if needed.
removeProperty(String) - Method in interface org.apache.unomi.api.services.ConfigSharingService
 
removeProperty(String, String) - Method in interface org.apache.unomi.api.services.PrivacyService
Removes a property from the specified profile.
removeRule(String) - Method in interface org.apache.unomi.api.services.RulesService
Deletes the rule identified by the specified identifier.
removeScoringDefinition(String, boolean) - Method in interface org.apache.unomi.api.services.SegmentService
Removes the scoring definition identified by the specified identifier.
removeSegmentDefinition(String, boolean) - Method in interface org.apache.unomi.api.services.SegmentService
Removes the segment definition identified by the specified identifier.
resetAllRuleStatistics() - Method in interface org.apache.unomi.api.services.RulesService
Resets all the rule statistics to zero, useful when testing or if you want to set a point in time.
resolveConditionType(Condition) - Method in interface org.apache.unomi.api.services.DefinitionsService
Resolves (if possible) the ConditionTypes for the specified condition and its sub-conditions (if any) from the type identifiers existing on the specified condition TODO: remove from API and move to a different class?
Rule - Class in org.apache.unomi.api.rules
A conditional set of actions to be executed in response to incoming events.
Rule() - Constructor for class org.apache.unomi.api.rules.Rule
Instantiates a new Rule.
Rule(Metadata) - Constructor for class org.apache.unomi.api.rules.Rule
Instantiates a new Rule with the specified Metadata.
RulesService - Interface in org.apache.unomi.api.services
A service to access and operate on Rules.
RuleStatistics - Class in org.apache.unomi.api.rules
A separate item to track rule statistics, because we will manage the persistence and updating of these seperately from the rules themselves.
RuleStatistics() - Constructor for class org.apache.unomi.api.rules.RuleStatistics
 
RuleStatistics(String) - Constructor for class org.apache.unomi.api.rules.RuleStatistics
 

S

save(Profile) - Method in interface org.apache.unomi.api.services.ProfileService
Saves the specified profile in the context server.
saveOrMerge(Profile) - Method in interface org.apache.unomi.api.services.ProfileService
Merge the specified profile properties in an existing profile,or save new profile if it does not exist yet
savePersona(Persona) - Method in interface org.apache.unomi.api.services.ProfileService
Persists the specified Persona in the context server.
savePersonaWithSessions(PersonaWithSessions) - Method in interface org.apache.unomi.api.services.ProfileService
Save a persona with its sessions.
saveSession(Session) - Method in interface org.apache.unomi.api.services.ProfileService
Saves the specified session.
scope - Variable in class org.apache.unomi.api.Item
 
Scoring - Class in org.apache.unomi.api.segments
A set of conditions associated with a value to assign to Profiles when matching so that the associated users can be scored along that dimension.
Scoring() - Constructor for class org.apache.unomi.api.segments.Scoring
Instantiates a new Scoring.
Scoring(Metadata) - Constructor for class org.apache.unomi.api.segments.Scoring
Instantiates a new Scoring with the specified metadata.
ScoringElement - Class in org.apache.unomi.api.segments
A scoring dimension along profiles can be evaluated and associated value to be assigned.
ScoringElement() - Constructor for class org.apache.unomi.api.segments.ScoringElement
Instantiates a new Scoring element.
search(Query, Class<T>) - Method in interface org.apache.unomi.api.services.ProfileService
Retrieves profiles or personas matching the specified query.
searchEvents(Condition, int, int) - Method in interface org.apache.unomi.api.services.EventService
Retrieves Events matching the specified Condition.
searchEvents(String, String[], String, int, int, String) - Method in interface org.apache.unomi.api.services.EventService
Retrieves Events for the Session identified by the provided session identifier, matching any of the provided event types, ordered according to the specified sortBy String and paged: only size of them are retrieved, starting with the offset-th one.
searchSessions(Query) - Method in interface org.apache.unomi.api.services.ProfileService
Retrieves sessions matching the specified query.
Segment - Class in org.apache.unomi.api.segments
A dynamically evaluated group of similar profiles in order to categorize the associated users.
Segment() - Constructor for class org.apache.unomi.api.segments.Segment
Instantiates a new Segment.
Segment(Metadata) - Constructor for class org.apache.unomi.api.segments.Segment
Instantiates a new Segment with the specified metadata.
SegmentsAndScores - Class in org.apache.unomi.api.segments
A combination of Segment and scores (usually associated with a Profile).
SegmentsAndScores(Set<String>, Map<String, Integer>) - Constructor for class org.apache.unomi.api.segments.SegmentsAndScores
Instantiates a new SegmentsAndScores.
SegmentService - Interface in org.apache.unomi.api.services
A service to access and operate on Segments and Scorings
send(Event) - Method in interface org.apache.unomi.api.services.EventService
Propagates the specified event in the context server, notifying EventListenerService instances if needed.
sendEvent(Serializable) - Method in interface org.apache.unomi.api.services.ClusterService
This function will send an event to the nodes of the cluster The function takes a Serializable to avoid dependency on any clustering framework
ServerInfo - Class in org.apache.unomi.api
Basic information about a Unomi server
ServerInfo() - Constructor for class org.apache.unomi.api.ServerInfo
 
Session - Class in org.apache.unomi.api
A time-bounded interaction between a user (via their associated Profile) and a unomi-enabled application.
Session() - Constructor for class org.apache.unomi.api.Session
Instantiates a new Session.
Session(String, Profile, Date, String) - Constructor for class org.apache.unomi.api.Session
Instantiates a new Session.
SESSION_UPDATED - Static variable in interface org.apache.unomi.api.services.EventService
The associated session was updated following an event being handled.
setActionExecutor(String) - Method in class org.apache.unomi.api.actions.ActionType
Sets the action executor.
setActionPostExecutors(List<ActionPostExecutor>) - Method in class org.apache.unomi.api.Event
Sets the action post executors.
setActions(List<Action>) - Method in class org.apache.unomi.api.rules.Rule
Sets the actions to be performed when this rule triggers.
setActionsTime(long) - Method in class org.apache.unomi.api.rules.RuleStatistics
Sets the accumulated time for the rule's actions
setActionType(ActionType) - Method in class org.apache.unomi.api.actions.Action
Sets the action's type.
setActionType(ActionType) - Method in interface org.apache.unomi.api.services.DefinitionsService
Stores the action type
setActionTypeId(String) - Method in class org.apache.unomi.api.actions.Action
Sets the identifier of the associated action type.
setAggregate(Aggregate) - Method in class org.apache.unomi.api.query.AggregateQuery
Sets the aggregate.
setAnonymousBrowsing(boolean) - Method in class org.apache.unomi.api.ContextResponse
Set the user anonymous browsing status
setAppliesOn(List<PersonalizationService.Target>) - Method in class org.apache.unomi.api.services.PersonalizationService.Filter
Specifies which targets this filter applies on.
setAutomaticMappingsFrom(Set<String>) - Method in class org.apache.unomi.api.PropertyType
Specifies the set of JCR properties from which properties of this type would be automatically initialized from.
setCampaign(Campaign) - Method in class org.apache.unomi.api.campaigns.CampaignDetail
Sets the associated campaign.
setCampaign(Campaign) - Method in interface org.apache.unomi.api.services.GoalsService
Saves the specified campaign in the context server and creates associated Rules if the campaign is enabled.
setCampaignEvent(CampaignEvent) - Method in interface org.apache.unomi.api.services.GoalsService
Saves the specified campaign event in the context server.
setCampaignId(String) - Method in class org.apache.unomi.api.campaigns.events.CampaignEvent
Sets the campaign id.
setCampaignId(String) - Method in class org.apache.unomi.api.goals.Goal
 
setCampaignSessionSuccess(long) - Method in class org.apache.unomi.api.campaigns.CampaignDetail
Sets the number of campaign session successes.
setCampaignSessionViews(long) - Method in class org.apache.unomi.api.campaigns.CampaignDetail
Sets the number of campaign session views.
setCapabilities(Map<String, String>) - Method in class org.apache.unomi.api.ServerInfo
 
setChoiceListInitializerFilter(String) - Method in class org.apache.unomi.api.Parameter
Deprecated.
setCondition(Condition) - Method in class org.apache.unomi.api.BatchUpdate
Specifies the condition which items to update.
setCondition(Condition) - Method in class org.apache.unomi.api.query.AggregateQuery
Sets the condition.
setCondition(Condition) - Method in class org.apache.unomi.api.query.Query
Sets the Condition associated with this Query.
setCondition(Condition) - Method in class org.apache.unomi.api.rules.Rule
Sets the condition that, when satisfied, triggers the rule..
setCondition(Condition) - Method in class org.apache.unomi.api.segments.ScoringElement
Sets the condition.
setCondition(Condition) - Method in class org.apache.unomi.api.segments.Segment
Sets the condition that users' Profile must satisfy in order to be considered member of this Segment.
setCondition(Condition) - Method in class org.apache.unomi.api.services.PersonalizationService.Filter
Sets the condition associated with this filter.
setConditionEvaluator(String) - Method in class org.apache.unomi.api.conditions.ConditionType
Sets the condition evaluator.
setConditionsTime(long) - Method in class org.apache.unomi.api.rules.RuleStatistics
Sets the execution time of the condition of the rule for the whole cluster
setConditionType(ConditionType) - Method in class org.apache.unomi.api.conditions.Condition
Sets the condition type.
setConditionType(ConditionType) - Method in interface org.apache.unomi.api.services.DefinitionsService
Stores the condition type
setConditionTypeId(String) - Method in class org.apache.unomi.api.conditions.Condition
Sets the identifier of the associated condition type.
setConsent(Consent) - Method in class org.apache.unomi.api.Profile
Set a consent into the profile.
setConsents(Map<String, Consent>) - Method in class org.apache.unomi.api.ContextResponse
Sets the map of consents for the current profile.
setContents(List<PersonalizationService.PersonalizedContent>) - Method in class org.apache.unomi.api.services.PersonalizationService.PersonalizationRequest
 
setConversionRate(double) - Method in class org.apache.unomi.api.campaigns.CampaignDetail
Sets the conversion rate.
setConversionRate(double) - Method in class org.apache.unomi.api.goals.GoalReport.Stat
 
setCost(Double) - Method in class org.apache.unomi.api.campaigns.Campaign
Sets the cost incurred by this Campaign.
setCost(Double) - Method in class org.apache.unomi.api.campaigns.events.CampaignEvent
Sets the cost.
setCpuLoad(double) - Method in class org.apache.unomi.api.ClusterNode
Sets the cpu load.
setCurrency(String) - Method in class org.apache.unomi.api.campaigns.Campaign
Sets the currency associated to the Campaign's cost.
setCurrency(String) - Method in class org.apache.unomi.api.campaigns.events.CampaignEvent
Sets the currency.
setData(boolean) - Method in class org.apache.unomi.api.ClusterNode
Specifies whether this ClusterNode locally stores data.
setDateRanges(List<DateRange>) - Method in class org.apache.unomi.api.PropertyType
Sets the date ranges.
setDateRanges(List<DateRange>) - Method in class org.apache.unomi.api.query.Aggregate
 
setDefaultValue(String) - Method in class org.apache.unomi.api.Parameter
 
setDefaultValue(String) - Method in class org.apache.unomi.api.PropertyType
Sets the default value that properties using this PropertyType will use if no value is specified explicitly.
setDeniedProperties(String, List<String>) - Method in interface org.apache.unomi.api.services.PrivacyService
Deprecated.
don't use this method, instead mark properties with the personal identifier tag which will mark them as denied by the getDeniedProperties method
setDeniedPropertyDistribution(String, List<String>) - Method in interface org.apache.unomi.api.services.PrivacyService
Deprecated.
do not use
setDescription(String) - Method in class org.apache.unomi.api.Metadata
Sets the description.
setDescriptionKey(String) - Method in class org.apache.unomi.api.ValueType
Sets the description key.
setElements(List<ScoringElement>) - Method in class org.apache.unomi.api.segments.Scoring
Sets the elements.
setEnabled(boolean) - Method in class org.apache.unomi.api.Metadata
Specifies whether the associated entity should be active or not.
setEndDate(Date) - Method in class org.apache.unomi.api.campaigns.Campaign
Sets the end date for this Campaign.
setEngagedProfiles(long) - Method in class org.apache.unomi.api.campaigns.CampaignDetail
Sets the number of engaged profiles.
setEntryCondition(Condition) - Method in class org.apache.unomi.api.campaigns.Campaign
Sets the entry condition that must be satisfied for users to be considered as taking part of this Campaign..
setEventDate(Date) - Method in class org.apache.unomi.api.campaigns.events.CampaignEvent
Sets the event date.
setEvents(List<Event>) - Method in class org.apache.unomi.api.ContextRequest
Specifies the events to be processed by the context server.
setEvents(List<Event>) - Method in class org.apache.unomi.api.EventsCollectorRequest
 
setEventTypes(List<EventInfo>) - Method in class org.apache.unomi.api.ServerInfo
 
setExecutionCount(long) - Method in class org.apache.unomi.api.rules.RuleStatistics
Set the execution count of the rule in the cluster
setFilter(String) - Method in class org.apache.unomi.api.PropertyMergeStrategyType
 
setFilteredEventTypes(String, List<String>) - Method in interface org.apache.unomi.api.services.PrivacyService
Set the list of filtered event types for a profile.
setFilterid(String) - Method in class org.apache.unomi.api.services.PersonalizationService.PersonalizedContent
Deprecated.
this method is deprecated use the setId method instead
setFilteringResults(Map<String, Boolean>) - Method in class org.apache.unomi.api.ContextResponse
Sets the filtering results.
setFilters(List<PersonalizationService.PersonalizedContent>) - Method in class org.apache.unomi.api.ContextRequest
Specifies the content filters to be evaluated.
setFilters(List<PersonalizationService.Filter>) - Method in class org.apache.unomi.api.services.PersonalizationService.PersonalizedContent
Sets the filters.
setForceRefresh(boolean) - Method in class org.apache.unomi.api.query.Query
Specifies whether or not an index refresh is needed before performing this Query.
setFrom(Object) - Method in class org.apache.unomi.api.query.DateRange
 
setFrom(String) - Method in class org.apache.unomi.api.query.IpRange
 
setFrom(Double) - Method in class org.apache.unomi.api.query.NumericRange
 
setGlobalStats(GoalReport.Stat) - Method in class org.apache.unomi.api.goals.GoalReport
 
setGoal(Goal) - Method in interface org.apache.unomi.api.services.GoalsService
Saves the specified goal in the context server and creates associated Rules if the goal is enabled.
setHidden(boolean) - Method in class org.apache.unomi.api.Metadata
Specifies whether the associated entity is hidden.
setId(String) - Method in class org.apache.unomi.api.EventProperty
Sets the identifier.
setId(String) - Method in class org.apache.unomi.api.EventSource
 
setId(String) - Method in class org.apache.unomi.api.EventTarget
 
setId(String) - Method in class org.apache.unomi.api.Metadata
Sets the id.
setId(String) - Method in class org.apache.unomi.api.PropertyMergeStrategyType
 
setId(String) - Method in class org.apache.unomi.api.services.PersonalizationService.PersonalizationRequest
 
setId(String) - Method in class org.apache.unomi.api.services.PersonalizationService.PersonalizedContent
Sets the filter identifier associated with this content filtering definition.
setId(String) - Method in class org.apache.unomi.api.ValueType
Sets this ValueType's identifier.
setInternalHostAddress(String) - Method in class org.apache.unomi.api.ClusterNode
Sets the internal host address which uses the HTTP/HTTPS protocol for communications between clients and the context server.
setIpRanges(List<IpRange>) - Method in class org.apache.unomi.api.PropertyType
Sets the ip ranges.
setIpRanges(List<IpRange>) - Method in class org.apache.unomi.api.query.Aggregate
 
setItemId(String) - Method in class org.apache.unomi.api.Item
 
setItemType(String) - Method in class org.apache.unomi.api.Item
 
setKey(String) - Method in class org.apache.unomi.api.goals.GoalReport.Stat
 
setKey(String) - Method in class org.apache.unomi.api.query.DateRange
 
setKey(String) - Method in class org.apache.unomi.api.query.IpRange
 
setKey(String) - Method in class org.apache.unomi.api.query.NumericRange
 
setLastEventDate(Date) - Method in class org.apache.unomi.api.Session
Sets the last event date.
setLastSyncDate(Date) - Method in class org.apache.unomi.api.rules.RuleStatistics
Sets the last sync date
setLimit(int) - Method in class org.apache.unomi.api.query.Query
Sets the number of elements to retrieve.
setLinkedItems(List<String>) - Method in class org.apache.unomi.api.rules.Rule
Sets the linked items.
setList(List<T>) - Method in class org.apache.unomi.api.PartialList
Sets the view list.
setLoadAverage(double[]) - Method in class org.apache.unomi.api.ClusterNode
Sets the load average for the last minute, five minutes and fifteen minutes.
setLocalActionsTime(long) - Method in class org.apache.unomi.api.rules.RuleStatistics
Sets the accumulated time spend executing the rule's actions since the last sync with the cluster
setLocalConditionsTime(long) - Method in class org.apache.unomi.api.rules.RuleStatistics
Sets the accumulated execution time of the rule's condition since the last sync with the cluster
setLocalExecutionCount(long) - Method in class org.apache.unomi.api.rules.RuleStatistics
Sets the number of local execution counts for this node since the last sync with the cluster
setMaster(boolean) - Method in class org.apache.unomi.api.ClusterNode
Specifies whether this ClusterNode is a master node, i.e.
setMergedWith(String) - Method in class org.apache.unomi.api.Profile
TODO: should be removed from the API
setMergeStrategy(String) - Method in class org.apache.unomi.api.PropertyType
Sets the identifier of the PropertyMergeStrategyType to be used in case profiles with properties using this PropertyType are being merged
setMetadata(Metadata) - Method in class org.apache.unomi.api.MetadataItem
 
setMissingPlugins(boolean) - Method in class org.apache.unomi.api.Metadata
Specifies whether the associated entity is waiting on additional plugins to become available.
setMultivalued(Boolean) - Method in class org.apache.unomi.api.PropertyType
Specifies whether properties using this property type are multi-valued.
setName(String) - Method in class org.apache.unomi.api.EventInfo
 
setName(String) - Method in class org.apache.unomi.api.Metadata
Sets the name.
setNameKey(String) - Method in class org.apache.unomi.api.ValueType
Sets the name key.
setNumberOfGoals(long) - Method in class org.apache.unomi.api.campaigns.CampaignDetail
Sets the number of goals.
setNumericRanges(List<NumericRange>) - Method in class org.apache.unomi.api.PropertyType
Sets the numeric ranges.
setOccurences(Long) - Method in class org.apache.unomi.api.EventInfo
 
setOffset(long) - Method in class org.apache.unomi.api.PartialList
 
setOffset(int) - Method in class org.apache.unomi.api.query.Query
Sets the offset of the first element to be retrieved
setPageSize(long) - Method in class org.apache.unomi.api.PartialList
 
setParameter(String, Object) - Method in class org.apache.unomi.api.actions.Action
Sets the parameter identified by the specified name to the specified value.
setParameter(String, Object) - Method in class org.apache.unomi.api.conditions.Condition
Sets the parameter identified by the specified name to the specified value.
setParameters(List<Parameter>) - Method in class org.apache.unomi.api.actions.ActionType
Sets the parameters.
setParameters(List<Parameter>) - Method in class org.apache.unomi.api.conditions.ConditionType
Sets the List of the defined Parameters for this ConditionType.
setParameters(Map<String, Object>) - Method in class org.apache.unomi.api.query.Aggregate
 
setParameterValues(Map<String, Object>) - Method in class org.apache.unomi.api.actions.Action
Sets the parameter values as a Map of parameter name - associated value pairs.
setParameterValues(Map<String, Object>) - Method in class org.apache.unomi.api.conditions.Condition
Sets the parameter name - value pairs for this profile.
setParentCondition(Condition) - Method in class org.apache.unomi.api.conditions.ConditionType
Sets the parent condition.
setPath(String) - Method in class org.apache.unomi.api.EventSource
 
setPercentage(double) - Method in class org.apache.unomi.api.goals.GoalReport.Stat
 
setPersistent(boolean) - Method in class org.apache.unomi.api.Event
Specifies if this Event needs to be persisted.
setPersona(Persona) - Method in class org.apache.unomi.api.PersonaWithSessions
 
setPersonalizations(List<PersonalizationService.PersonalizationRequest>) - Method in class org.apache.unomi.api.ContextRequest
 
setPersonalizations(Map<String, List<String>>) - Method in class org.apache.unomi.api.ContextResponse
 
setPluginId(long) - Method in interface org.apache.unomi.api.PluginType
Associates this plugin with its associated OSGi bundle identifier.
setPluginId(long) - Method in class org.apache.unomi.api.PropertyMergeStrategyType
 
setPluginId(long) - Method in class org.apache.unomi.api.ValueType
 
setPrimaryGoal(String) - Method in class org.apache.unomi.api.campaigns.Campaign
Sets the identifier for this Campaign's primary Goal.
setPriority(int) - Method in class org.apache.unomi.api.rules.Rule
Sets the priority in case this Rule needs to be executed before other ones when similar conditions match.
setProfile(Profile) - Method in class org.apache.unomi.api.Event
Sets the profile.
setProfile(Profile) - Method in class org.apache.unomi.api.Session
Sets the associated Profile.
setProfileId(String) - Method in class org.apache.unomi.api.ContextResponse
Sets the profile id.
setProfileId(String) - Method in class org.apache.unomi.api.Event
Sets the profile id.
setProfileOverrides(Profile) - Method in class org.apache.unomi.api.ContextRequest
Sets the profile overrides.
setProfileProperties(Map<String, Object>) - Method in class org.apache.unomi.api.ContextResponse
Sets the profile properties.
setProfileSegments(Set<String>) - Method in class org.apache.unomi.api.ContextResponse
Sets the profile segments.
setProperties(Map<String, Object>) - Method in class org.apache.unomi.api.CustomItem
Sets the properties.
setProperties(Map<String, Object>) - Method in class org.apache.unomi.api.EventTarget
 
setProperties(Map<String, Object>) - Method in class org.apache.unomi.api.Profile
Sets the property name - value pairs for this profile.
setProperties(Map<String, Object>) - Method in class org.apache.unomi.api.services.PersonalizationService.Filter
 
setProperties(Map<String, Object>) - Method in class org.apache.unomi.api.services.PersonalizationService.PersonalizedContent
 
setProperties(Map<String, Object>) - Method in class org.apache.unomi.api.Session
Sets the property name - value pairs.
setProperty(String, Object) - Method in class org.apache.unomi.api.Event
Sets the property identified by the provided name to the specified value.
setProperty(String, Object) - Method in class org.apache.unomi.api.Profile
Sets the property identified by the specified name to the specified value.
setProperty(String) - Method in class org.apache.unomi.api.query.Aggregate
 
setProperty(String, Object) - Method in interface org.apache.unomi.api.services.ConfigSharingService
 
setProperty(String, Object) - Method in class org.apache.unomi.api.Session
Sets the property identified by the specified name to the specified value.
setPropertyName(String) - Method in class org.apache.unomi.api.BatchUpdate
Specifies (as an Apache Commons BeanUtils expression) which property needs to be updated.
setPropertyType(PropertyType) - Method in interface org.apache.unomi.api.services.ProfileService
Persists the specified property type in the context server.
setPropertyValue(Object) - Method in class org.apache.unomi.api.BatchUpdate
Sets the new property value to use for the update.
setProtected(boolean) - Method in class org.apache.unomi.api.PropertyType
Specifies whether properties with this type are marked as protected.
setPublicHostAddress(String) - Method in class org.apache.unomi.api.ClusterNode
Sets the public host address.
setQueryBuilder(String) - Method in class org.apache.unomi.api.conditions.ConditionType
Sets the query builder.
setRaiseEventOnlyOnceForProfile(boolean) - Method in class org.apache.unomi.api.rules.Rule
Specifies whether the event raised when the rule is triggered should only be raised once per Profile.
setRaiseEventOnlyOnceForSession(boolean) - Method in class org.apache.unomi.api.rules.Rule
Specifies whether the event raised when the rule is triggered should only be raised once per Session.
setRank(Double) - Method in class org.apache.unomi.api.PropertyType
Specifies the rank of this PropertyType for ordering purpose.
setReadOnly(boolean) - Method in class org.apache.unomi.api.Metadata
Specifies whether the associated entity should be only accessed and not modified.
setRequireAnonymousBrowsing(String, boolean, String) - Method in interface org.apache.unomi.api.services.PrivacyService
Controls the activation/deactivation of anonymous browsing.
setRequiredProfileProperties(List<String>) - Method in class org.apache.unomi.api.ContextRequest
Specifies which profile properties should be returned with the response.
setRequiredSessionProperties(List<String>) - Method in class org.apache.unomi.api.ContextRequest
Specifies which session properties should be returned with the response.
setRequireSegments(boolean) - Method in class org.apache.unomi.api.ContextRequest
Specifies whether to return the profile segments with the response.
setRevokeDate(Date) - Method in class org.apache.unomi.api.Consent
Sets the end date for this consent.
setRule(Rule) - Method in interface org.apache.unomi.api.services.RulesService
Persists the specified rule to the context server.
setScope(String) - Method in class org.apache.unomi.api.Consent
Set the scope for this consent
setScope(String) - Method in class org.apache.unomi.api.Event
 
setScope(String) - Method in class org.apache.unomi.api.EventSource
 
setScope(String) - Method in class org.apache.unomi.api.Item
 
setScope(String) - Method in class org.apache.unomi.api.Metadata
Sets the scope.
setScope(String) - Method in class org.apache.unomi.api.Session
 
setScores(Map<String, Integer>) - Method in class org.apache.unomi.api.Profile
TODO: should be removed from the API
setScoringDefinition(Scoring) - Method in interface org.apache.unomi.api.services.SegmentService
Persists the specified scoring in the context server.
setScorings(List<Metadata>) - Method in class org.apache.unomi.api.segments.DependentMetadata
 
setScrollIdentifier(String) - Method in class org.apache.unomi.api.PartialList
 
setScrollTimeValidity(String) - Method in class org.apache.unomi.api.PartialList
 
setSegmentDefinition(Segment) - Method in interface org.apache.unomi.api.services.SegmentService
Persists the specified segment in the context server.
setSegments(Set<String>) - Method in class org.apache.unomi.api.Profile
Sets the identifiers of the segments this profile is a member of.
setSegments(List<Metadata>) - Method in class org.apache.unomi.api.segments.DependentMetadata
 
setServerIdentifier(String) - Method in class org.apache.unomi.api.ServerInfo
 
setServerVersion(String) - Method in class org.apache.unomi.api.ServerInfo
 
setSession(Session) - Method in class org.apache.unomi.api.Event
Sets the session.
setSessionId(String) - Method in class org.apache.unomi.api.ContextRequest
Sets the sessionId in the request.
setSessionId(String) - Method in class org.apache.unomi.api.ContextResponse
Sets the session id.
setSessionId(String) - Method in class org.apache.unomi.api.EventsCollectorRequest
Sets the sessionId in the request.
setSessionProperties(Map<String, Object>) - Method in class org.apache.unomi.api.ContextResponse
Sets the session properties.
setSessionPropertiesOverrides(Map<String, Object>) - Method in class org.apache.unomi.api.ContextRequest
Sets the session properties overrides.
setSessions(List<PersonaSession>) - Method in class org.apache.unomi.api.PersonaWithSessions
 
setSize(int) - Method in class org.apache.unomi.api.Session
Sets the size.
setSortby(String) - Method in class org.apache.unomi.api.query.Query
Sets the String representation of the sorting specifications for this Query if any.
setSource(Item) - Method in class org.apache.unomi.api.ContextRequest
Sets the source.
setSource(Item) - Method in class org.apache.unomi.api.Event
Sets the source.
setSplit(List<GoalReport.Stat>) - Method in class org.apache.unomi.api.goals.GoalReport
 
setStartCount(long) - Method in class org.apache.unomi.api.goals.GoalReport.Stat
 
setStartDate(Date) - Method in class org.apache.unomi.api.campaigns.Campaign
Sets the start date for this Campaign.
setStartEvent(Condition) - Method in class org.apache.unomi.api.goals.Goal
 
setStatus(ConsentStatus) - Method in class org.apache.unomi.api.Consent
Sets the status for this consent.
setStatusDate(Date) - Method in class org.apache.unomi.api.Consent
Sets the date from which this consent applies.
setStrategy(String) - Method in class org.apache.unomi.api.BatchUpdate
Sets the identifier for the PropertyMergeStrategyType to use during the update if needed.
setStrategy(String) - Method in class org.apache.unomi.api.services.PersonalizationService.PersonalizationRequest
 
setStrategyOptions(Map<String, Object>) - Method in class org.apache.unomi.api.services.PersonalizationService.PersonalizationRequest
 
setSystemProperties(Map<String, Object>) - Method in class org.apache.unomi.api.Profile
Specifies the system property name - value pairs for this profile.
setSystemProperties(Map<String, Object>) - Method in class org.apache.unomi.api.Session
Specifies the system property name - value pairs.
setSystemTags(Set<String>) - Method in class org.apache.unomi.api.Metadata
Sets the system tags.
setTags(Set<String>) - Method in class org.apache.unomi.api.Metadata
Sets the tags.
setTags(Set<String>) - Method in class org.apache.unomi.api.ValueType
Sets the tags used by this ValueType.
setTarget(Item) - Method in class org.apache.unomi.api.Event
Sets the target.
setTarget(String) - Method in class org.apache.unomi.api.PropertyType
Sets the target for this property type.
setTarget(String) - Method in class org.apache.unomi.api.services.PersonalizationService.Target
Sets the target.
setTargetCount(long) - Method in class org.apache.unomi.api.goals.GoalReport.Stat
 
setTargetEvent(Condition) - Method in class org.apache.unomi.api.goals.Goal
 
setText(String) - Method in class org.apache.unomi.api.query.Query
Sets to be used in full-text searches
setTimezone(String) - Method in class org.apache.unomi.api.campaigns.Campaign
Sets the timezone associated with this Campaign's start and end dates.
setTimezone(String) - Method in class org.apache.unomi.api.campaigns.events.CampaignEvent
Sets the timezone.
setTo(Object) - Method in class org.apache.unomi.api.query.DateRange
 
setTo(String) - Method in class org.apache.unomi.api.query.IpRange
 
setTo(Double) - Method in class org.apache.unomi.api.query.NumericRange
 
setTotalSize(long) - Method in class org.apache.unomi.api.PartialList
 
setTrackedConditions(Set<Condition>) - Method in class org.apache.unomi.api.ContextResponse
Sets the tracked conditions.
setType(String) - Method in class org.apache.unomi.api.EventSource
 
setType(String) - Method in class org.apache.unomi.api.EventTarget
 
setType(String) - Method in class org.apache.unomi.api.query.Aggregate
 
setTypeIdentifier(String) - Method in class org.apache.unomi.api.Consent
Set the type identifier.
setUptime(long) - Method in class org.apache.unomi.api.ClusterNode
Sets the uptime.
setValue(int) - Method in class org.apache.unomi.api.segments.ScoringElement
Sets the value.
setValues(List<String>) - Method in class org.apache.unomi.api.services.PersonalizationService.Target
Sets the values.
setValueType(String) - Method in class org.apache.unomi.api.EventProperty
Sets the value type.
setValueType(ValueType) - Method in class org.apache.unomi.api.PropertyType
Sets the value type.
setValueTypeId(String) - Method in class org.apache.unomi.api.PropertyType
Sets the value type identifier.
setVersion(Long) - Method in class org.apache.unomi.api.Item
 
size() - Method in class org.apache.unomi.api.PartialList
Retrieves the size of this PartialList.
Stat() - Constructor for class org.apache.unomi.api.goals.GoalReport.Stat
 
SYSTEM_SCOPE - Static variable in class org.apache.unomi.api.Metadata
Default scope, gathers default entities and can also be used to share entities across scopes.

T

Target() - Constructor for class org.apache.unomi.api.services.PersonalizationService.Target
 
TimestampedItem - Interface in org.apache.unomi.api
A context-server entity that is timestamped.
toMap(DateFormat) - Method in class org.apache.unomi.api.Consent
This is a utility method to generate a Map based on the contents of the consents.
toString() - Method in class org.apache.unomi.api.conditions.Condition
 
toString() - Method in class org.apache.unomi.api.Consent
 
toString() - Method in class org.apache.unomi.api.EventTarget
 
toString() - Method in class org.apache.unomi.api.Profile
 

U

UserList - Class in org.apache.unomi.api.lists
Created by amidani on 24/03/2017.
UserList() - Constructor for class org.apache.unomi.api.lists.UserList
Instantiates a new UserList.
UserList(Metadata) - Constructor for class org.apache.unomi.api.lists.UserList
Instantiates a new UserList with the specified metadata.
UserListService - Interface in org.apache.unomi.api.services
Created by amidani on 24/03/2017.

V

valueOf(String) - Static method in enum org.apache.unomi.api.ConsentStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.unomi.api.services.ConfigSharingService.ConfigChangeEvent.ConfigChangeEventType
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.unomi.api.ConsentStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.unomi.api.services.ConfigSharingService.ConfigChangeEvent.ConfigChangeEventType
Returns an array containing the constants of this enum type, in the order they are declared.
ValueType - Class in org.apache.unomi.api
A value type to be used to constrain property values.
ValueType() - Constructor for class org.apache.unomi.api.ValueType
Instantiates a new Value type.
ValueType(String) - Constructor for class org.apache.unomi.api.ValueType
Instantiates a new Value type with the specified identifier.
version - Variable in class org.apache.unomi.api.Item
 
A B C D E F G H I L M N O P Q R S T U V 
Skip navigation links

Copyright © 2014–2018 Apache Software Foundation. All rights reserved.