Added javadoc generation and fixed blocking javadoc issues. Project: http://git-wip-us.apache.org/repos/asf/incubator-unomi/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-unomi/commit/36fdfcb0 Tree: http://git-wip-us.apache.org/repos/asf/incubator-unomi/tree/36fdfcb0 Diff: http://git-wip-us.apache.org/repos/asf/incubator-unomi/diff/36fdfcb0
Branch: refs/heads/master Commit: 36fdfcb09d46e9f29df8f0b7b8caf9ec9bc4c0fc Parents: 00d03ff Author: Chris Laprun <[email protected]> Authored: Thu Nov 19 22:51:45 2015 +0100 Committer: Chris Laprun <[email protected]> Committed: Thu Nov 19 22:53:47 2015 +0100 ---------------------------------------------------------------------- .../main/java/org/apache/unomi/api/ContextRequest.java | 6 +++--- api/src/main/java/org/apache/unomi/api/Item.java | 2 +- api/src/main/java/org/apache/unomi/api/Profile.java | 10 +++++----- .../elasticsearch/plugin/security/IPRangeMatcher.java | 2 +- .../actions/RequestHeaderToProfilePropertyAction.java | 2 +- .../actions/RequestParameterToProfilePropertyAction.java | 2 +- pom.xml | 10 ++++++++++ src/site/site.xml | 1 + 8 files changed, 23 insertions(+), 12 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/36fdfcb0/api/src/main/java/org/apache/unomi/api/ContextRequest.java ---------------------------------------------------------------------- diff --git a/api/src/main/java/org/apache/unomi/api/ContextRequest.java b/api/src/main/java/org/apache/unomi/api/ContextRequest.java index f1e642a..5e2c115 100644 --- a/api/src/main/java/org/apache/unomi/api/ContextRequest.java +++ b/api/src/main/java/org/apache/unomi/api/ContextRequest.java @@ -32,16 +32,16 @@ import java.util.Set; * An incoming request for context information from clients of the context server. This allows clients to specify which type of information they are interested in getting from * the context server as well as specify incoming events or content filtering or property/segment overrides for personalization or impersonation. This conditions what the * context server will return with its response. - * <p/> + * <p> * Events that are generated on the client as part of its functioning can be specified in the client as part of its request for contextual data. The context server will deliver * these events to {@link EventListenerService}s to be processed. In particular, the {@link * RulesService} will trigger any applicable {@link Rule} which in turn might trigger {@link * Action}s. An appropriate Event is also triggered when a Rule matches so that other rules can react to it. Finally, an event will also * be emitted if the user {@link Profile} has been updated as part of the event processing. - * <p/> + * <p> * A client wishing to perform content personalization might also specify filtering condition to be evaluated by the context server so that it can tell the client * whether the content associated with the filter should be activated for this profile/session. - * <p/> + * <p> * It is also possible to clients wishing to perform user impersonation to specify properties or segment to override the proper ones so as to emulate a specific profile, in * which case the overridden value will temporarily replace the proper values so that all rules will be evaluated with these values instead of the proper ones. * http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/36fdfcb0/api/src/main/java/org/apache/unomi/api/Item.java ---------------------------------------------------------------------- diff --git a/api/src/main/java/org/apache/unomi/api/Item.java b/api/src/main/java/org/apache/unomi/api/Item.java index 18e5910..2af5c00 100644 --- a/api/src/main/java/org/apache/unomi/api/Item.java +++ b/api/src/main/java/org/apache/unomi/api/Item.java @@ -28,7 +28,7 @@ import java.io.Serializable; * public String constant named {@code ITEM_TYPE} that is used to identify the type of a specific Item via {@link #getItemType}. It is therefore important that * {@code ITEM_TYPE} be unique across all persisted type of Items. Similarly, since Items are persisted according to their type, an Item's identifier must be unique among * Items of the same type. - * <p/> + * <p> * Additionally, Items are also gathered by scope allowing the context server to group together related Items (usually pertaining to a given site being analyzed, * though scopes could span across sites depending on the desired analysis granularity). Scopes allow clients accessing the context server to filter data. The context server * defines a built-in scope ({@link Metadata#SYSTEM_SCOPE}) that clients can use to share data across scopes. http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/36fdfcb0/api/src/main/java/org/apache/unomi/api/Profile.java ---------------------------------------------------------------------- diff --git a/api/src/main/java/org/apache/unomi/api/Profile.java b/api/src/main/java/org/apache/unomi/api/Profile.java index dc8ed09..7163e00 100644 --- a/api/src/main/java/org/apache/unomi/api/Profile.java +++ b/api/src/main/java/org/apache/unomi/api/Profile.java @@ -28,10 +28,10 @@ import java.util.Set; /** * A user profile gathering all known information about a given user as well as segments it is part of and scores. - * <p/> + * <p> * Contrary to other unomi {@link Item}s, profiles are not part of a scope since we want to be able to track the associated user across applications. For this reason, data * collected for a given profile in a specific scope is still available to any scoped item that accesses the profile information. - * <p/> + * <p> * It is interesting to note that there is not necessarily a one to one mapping between users and profiles as users can be captured across applications and different observation * contexts. As identifying information might not be available in all contexts in which data is collected, resolving profiles to a single physical user can become complex because * physical users are not observed directly. Rather, their portrait is progressively patched together and made clearer as unomi captures more and more traces of their actions. @@ -49,11 +49,11 @@ public class Profile extends Item { */ public static final String ITEM_TYPE = "profile"; private static final long serialVersionUID = -7409439322939712238L; - private Map<String, Object> properties = new HashMap<String, Object>(); + private Map<String, Object> properties = new HashMap<>(); - private Map<String, Object> systemProperties = new HashMap<String, Object>(); + private Map<String, Object> systemProperties = new HashMap<>(); - private Set<String> segments = new HashSet<String>(); + private Set<String> segments = new HashSet<>(); private Map<String, Integer> scores; http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/36fdfcb0/persistence-elasticsearch/plugins/security/src/main/java/org/apache/unomi/elasticsearch/plugin/security/IPRangeMatcher.java ---------------------------------------------------------------------- diff --git a/persistence-elasticsearch/plugins/security/src/main/java/org/apache/unomi/elasticsearch/plugin/security/IPRangeMatcher.java b/persistence-elasticsearch/plugins/security/src/main/java/org/apache/unomi/elasticsearch/plugin/security/IPRangeMatcher.java index 85b1983..e1cfbde 100644 --- a/persistence-elasticsearch/plugins/security/src/main/java/org/apache/unomi/elasticsearch/plugin/security/IPRangeMatcher.java +++ b/persistence-elasticsearch/plugins/security/src/main/java/org/apache/unomi/elasticsearch/plugin/security/IPRangeMatcher.java @@ -36,7 +36,7 @@ import java.util.List; /** * A class that enables to get an IP range from CIDR specification. It supports * both IPv4 and IPv6. - * <p/> + * <p> * This class was adapted from the CIDRUtils code at https://github.com/edazdarevic/CIDRUtils * and support for IP ranges was added. */ http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/36fdfcb0/plugins/request/src/main/java/org/apache/unomi/plugins/request/actions/RequestHeaderToProfilePropertyAction.java ---------------------------------------------------------------------- diff --git a/plugins/request/src/main/java/org/apache/unomi/plugins/request/actions/RequestHeaderToProfilePropertyAction.java b/plugins/request/src/main/java/org/apache/unomi/plugins/request/actions/RequestHeaderToProfilePropertyAction.java index ec6c5e9..b6cb0c0 100644 --- a/plugins/request/src/main/java/org/apache/unomi/plugins/request/actions/RequestHeaderToProfilePropertyAction.java +++ b/plugins/request/src/main/java/org/apache/unomi/plugins/request/actions/RequestHeaderToProfilePropertyAction.java @@ -27,7 +27,7 @@ import javax.servlet.http.HttpServletRequest; /** * Copies a request header value to a profile property * - * @todo add support for multi-valued parameters or storing values as a list + * TODO add support for multi-valued parameters or storing values as a list */ public class RequestHeaderToProfilePropertyAction implements ActionExecutor { public int execute(Action action, Event event) { http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/36fdfcb0/plugins/request/src/main/java/org/apache/unomi/plugins/request/actions/RequestParameterToProfilePropertyAction.java ---------------------------------------------------------------------- diff --git a/plugins/request/src/main/java/org/apache/unomi/plugins/request/actions/RequestParameterToProfilePropertyAction.java b/plugins/request/src/main/java/org/apache/unomi/plugins/request/actions/RequestParameterToProfilePropertyAction.java index 74f72d4..be4e084 100644 --- a/plugins/request/src/main/java/org/apache/unomi/plugins/request/actions/RequestParameterToProfilePropertyAction.java +++ b/plugins/request/src/main/java/org/apache/unomi/plugins/request/actions/RequestParameterToProfilePropertyAction.java @@ -27,7 +27,7 @@ import javax.servlet.http.HttpServletRequest; /** * Copies a request parameter to a profile property * - * @todo add support for multi-valued parameters or storing values as a list + * TODO add support for multi-valued parameters or storing values as a list */ public class RequestParameterToProfilePropertyAction implements ActionExecutor { public int execute(Action action, Event event) { http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/36fdfcb0/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml index de409d5..1d1874b 100644 --- a/pom.xml +++ b/pom.xml @@ -571,6 +571,11 @@ _ <artifactId>apache-rat-plugin</artifactId> <version>0.11</version> </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-javadoc-plugin</artifactId> + <version>2.10.3</version> + </plugin> </plugins> </build> @@ -582,6 +587,11 @@ _ <artifactId>maven-project-info-reports-plugin</artifactId> <version>2.8.1</version> </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-javadoc-plugin</artifactId> + <version>2.10.3</version> + </plugin> </plugins> </reporting> http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/36fdfcb0/src/site/site.xml ---------------------------------------------------------------------- diff --git a/src/site/site.xml b/src/site/site.xml index 62f0571..4df2320 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -117,6 +117,7 @@ <item name="Configuration" href="configuration.html" /> <item name="Cluster setup" href="clustering.html" /> <item name="Concepts" href="concepts.html"/> + <item name="Javadoc" href="./apidocs/index.html"/> </menu> <menu name="parent" ref="parent"/>
