You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@unomi.apache.org by sh...@apache.org on 2018/05/09 12:11:52 UTC
[2/5] incubator-unomi git commit: UNOMI-125 Fix various build
generation issues - Fix incomplete / erros in Javadocs - Fix RAT plugin
problem when compiling packaged sources
UNOMI-125 Fix various build generation issues
- Fix incomplete / erros in Javadocs
- Fix RAT plugin problem when compiling packaged sources
Signed-off-by: Serge Huber <sh...@apache.org>
Project: http://git-wip-us.apache.org/repos/asf/incubator-unomi/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-unomi/commit/e0ffc081
Tree: http://git-wip-us.apache.org/repos/asf/incubator-unomi/tree/e0ffc081
Diff: http://git-wip-us.apache.org/repos/asf/incubator-unomi/diff/e0ffc081
Branch: refs/heads/UNOMI-180-CXS-GRAPHQLAPI
Commit: e0ffc0814f4ff4288b591407afdb0679358249bc
Parents: 9fcfd42
Author: Serge Huber <sh...@apache.org>
Authored: Sun May 6 21:29:56 2018 +0200
Committer: Serge Huber <sh...@apache.org>
Committed: Sun May 6 21:29:56 2018 +0200
----------------------------------------------------------------------
.../main/java/org/apache/unomi/api/Consent.java | 3 +-
.../main/java/org/apache/unomi/api/Profile.java | 1 +
.../unomi/api/services/ClusterService.java | 2 +-
.../unomi/api/services/DefinitionsService.java | 12 ++++----
.../api/services/PersonalizationService.java | 5 ++-
.../unomi/api/services/PrivacyService.java | 32 +++++++++++++-------
.../unomi/api/services/ProfileService.java | 4 ++-
metrics/pom.xml | 6 ++++
.../unomi/metrics/commands/ActivateCommand.java | 2 --
.../metrics/commands/DeactivateCommand.java | 2 --
pom.xml | 1 +
11 files changed, 45 insertions(+), 25 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/e0ffc081/api/src/main/java/org/apache/unomi/api/Consent.java
----------------------------------------------------------------------
diff --git a/api/src/main/java/org/apache/unomi/api/Consent.java b/api/src/main/java/org/apache/unomi/api/Consent.java
index f0da669..2cb20ab 100644
--- a/api/src/main/java/org/apache/unomi/api/Consent.java
+++ b/api/src/main/java/org/apache/unomi/api/Consent.java
@@ -65,6 +65,7 @@ public class Consent implements Serializable {
* @param consentMap a Map that contains the following key-value pairs : typeIdentifier:String, status:String (must
* be one of GRANTED, DENIED or REVOKED), statusDate:String (ISO8601 date format !), revokeDate:String (ISO8601 date format !)
* @param dateFormat a DateFormat instance to convert the date string to date objects
+ * @throws ParseException in case one of the dates failed to parse properly
*/
public Consent(Map<String,Object> consentMap, DateFormat dateFormat) throws ParseException {
if (consentMap.containsKey("scope")) {
@@ -178,7 +179,7 @@ public class Consent implements Serializable {
/**
* Test if the consent is GRANTED right now.
* @return true if the consent is granted using the current date (internally a new Date() is created and the
- * @Consent#isConsentGivenAtDate is called.
+ * {@link Consent#isConsentGrantedAtDate} is called.
*/
@XmlTransient
public boolean isConsentGrantedNow() {
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/e0ffc081/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 5bc3b72..69c6c21 100644
--- a/api/src/main/java/org/apache/unomi/api/Profile.java
+++ b/api/src/main/java/org/apache/unomi/api/Profile.java
@@ -205,6 +205,7 @@ public class Profile extends Item {
/**
* Returns true if this profile is an anonymous profile.
+ * @return true of the profile has been marked as an anonymous profile, false otherwise.
*/
@XmlTransient
public boolean isAnonymousProfile() {
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/e0ffc081/api/src/main/java/org/apache/unomi/api/services/ClusterService.java
----------------------------------------------------------------------
diff --git a/api/src/main/java/org/apache/unomi/api/services/ClusterService.java b/api/src/main/java/org/apache/unomi/api/services/ClusterService.java
index 9a0fdfa..4c89ba9 100644
--- a/api/src/main/java/org/apache/unomi/api/services/ClusterService.java
+++ b/api/src/main/java/org/apache/unomi/api/services/ClusterService.java
@@ -54,7 +54,7 @@ public interface 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
*
- * @param event this object will be cast to {@link org.apache.karaf.cellar.core.event.Event}
+ * @param event this object will be cast to a org.apache.karaf.cellar.core.event.Event object
*/
void sendEvent(Serializable event);
}
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/e0ffc081/api/src/main/java/org/apache/unomi/api/services/DefinitionsService.java
----------------------------------------------------------------------
diff --git a/api/src/main/java/org/apache/unomi/api/services/DefinitionsService.java b/api/src/main/java/org/apache/unomi/api/services/DefinitionsService.java
index 6618741..4b1a141 100644
--- a/api/src/main/java/org/apache/unomi/api/services/DefinitionsService.java
+++ b/api/src/main/java/org/apache/unomi/api/services/DefinitionsService.java
@@ -178,9 +178,9 @@ public interface DefinitionsService {
* TODO: remove from API and move to a different class?
* TODO: purpose and behavior not clear
*
- * @param rootCondition
- * @param tag
- * @return Condition
+ * @param rootCondition the root condition where to start the extraction by class
+ * @param tag the tag to use to extract the condition
+ * @return Condition the condition that has been found matching the tag, or null if none matched
*/
@Deprecated
Condition extractConditionByTag(Condition rootCondition, String tag);
@@ -188,9 +188,9 @@ public interface DefinitionsService {
/**
* Retrieves a condition matching the specified system tag identifier from the specified root condition.
*
- * @param rootCondition
- * @param systemTag
- * @return Condition
+ * @param rootCondition the root condition where to start the extraction by class
+ * @param systemTag the tag to use to extract the condition
+ * @return Condition the condition that has been found matching the tag, or null if none matched
*/
Condition extractConditionBySystemTag(Condition rootCondition, String systemTag);
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/e0ffc081/api/src/main/java/org/apache/unomi/api/services/PersonalizationService.java
----------------------------------------------------------------------
diff --git a/api/src/main/java/org/apache/unomi/api/services/PersonalizationService.java b/api/src/main/java/org/apache/unomi/api/services/PersonalizationService.java
index 36588a4..5cff730 100644
--- a/api/src/main/java/org/apache/unomi/api/services/PersonalizationService.java
+++ b/api/src/main/java/org/apache/unomi/api/services/PersonalizationService.java
@@ -128,7 +128,10 @@ public interface PersonalizationService {
}
/**
- * @deprecated
+ * Sets the filter identifier associated with this content filtering definition.
+ *
+ * @param filterid the filter identifier associated with this content filtering definition
+ * @deprecated this method is deprecated use the setId method instead
*/
public void setFilterid(String filterid) {
this.id = filterid;
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/e0ffc081/api/src/main/java/org/apache/unomi/api/services/PrivacyService.java
----------------------------------------------------------------------
diff --git a/api/src/main/java/org/apache/unomi/api/services/PrivacyService.java b/api/src/main/java/org/apache/unomi/api/services/PrivacyService.java
index 2046642..4dc7def 100644
--- a/api/src/main/java/org/apache/unomi/api/services/PrivacyService.java
+++ b/api/src/main/java/org/apache/unomi/api/services/PrivacyService.java
@@ -30,7 +30,7 @@ public interface 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.
- * @return
+ * @return a ServerInfo object with all the server information
*/
ServerInfo getServerInfo();
@@ -135,26 +135,36 @@ public interface PrivacyService {
Boolean setFilteredEventTypes(String profileId, List<String> eventTypes);
/**
- * Gets the list of denied
- * @param profileId
- * @return
+ * Gets the list of denied properties. These are properties marked with a personal identifier tag.
+ * @param profileId the identified of the profile
+ * @return a list of profile properties identifiers that are marked as personally identifying
*/
List<String> getDeniedProperties(String profileId);
+ /**
+ * Sets the list of denied properties.
+ * @param profileId the profile for which to see the denied properties
+ * @param propertyNames the property names to be denied
+ * @return null all the time, this method is not used and is marked as deprecated
+ * @deprecated don't use this method, instead mark properties with the personal identifier tag which will mark them
+ * as denied by the getDeniedProperties method
+ */
Boolean setDeniedProperties(String profileId, List<String> propertyNames);
/**
- * @deprecated
- * @param profileId
- * @return
+ * This method doesn't do anything anymore please don't use it
+ * @deprecated do not use
+ * @param profileId the identifier of the profile
+ * @return do not use
*/
List<String> getDeniedPropertyDistribution(String profileId);
/**
- * @deprecated
- * @param profileId
- * @param propertyNames
- * @return
+ * This method doesn't do anything anymore please don't use it
+ * @deprecated do not use
+ * @param profileId the identifier of the profile
+ * @param propertyNames do not use
+ * @return do not use
*/
Boolean setDeniedPropertyDistribution(String profileId, List<String> propertyNames);
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/e0ffc081/api/src/main/java/org/apache/unomi/api/services/ProfileService.java
----------------------------------------------------------------------
diff --git a/api/src/main/java/org/apache/unomi/api/services/ProfileService.java b/api/src/main/java/org/apache/unomi/api/services/ProfileService.java
index 4c81974..028cc89 100644
--- a/api/src/main/java/org/apache/unomi/api/services/ProfileService.java
+++ b/api/src/main/java/org/apache/unomi/api/services/ProfileService.java
@@ -333,12 +333,14 @@ public interface ProfileService {
Set<PropertyType> getExistingProperties(String tag, String itemType);
/**
- * Retrieves the existing property types for the specified type as defined by the Item subclass public field {@code ITEM_TYPE} and with the specified tag.
+ * Retrieves the existing property types for the specified type as defined by the Item subclass public
+ * field {@code ITEM_TYPE} and with the specified tag (system or regular)
*
* TODO: move to a different class
*
* @param tag the tag we're interested in
* @param itemType the String representation of the item type we want to retrieve the count of, as defined by its class' {@code ITEM_TYPE} field
+ * @param systemTag whether the specified is a system tag or a regular one
* @return all property types defined for the specified item type and with the specified tag
*/
Set<PropertyType> getExistingProperties(String tag, String itemType, boolean systemTag);
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/e0ffc081/metrics/pom.xml
----------------------------------------------------------------------
diff --git a/metrics/pom.xml b/metrics/pom.xml
index a6423c0..7eaca74 100644
--- a/metrics/pom.xml
+++ b/metrics/pom.xml
@@ -70,6 +70,12 @@
<scope>provided</scope>
</dependency>
+ <dependency>
+ <groupId>org.osgi</groupId>
+ <artifactId>org.osgi.core</artifactId>
+ <scope>provided</scope>
+ </dependency>
+
<!-- Unit tests -->
<dependency>
<groupId>junit</groupId>
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/e0ffc081/metrics/src/main/java/org/apache/unomi/metrics/commands/ActivateCommand.java
----------------------------------------------------------------------
diff --git a/metrics/src/main/java/org/apache/unomi/metrics/commands/ActivateCommand.java b/metrics/src/main/java/org/apache/unomi/metrics/commands/ActivateCommand.java
index ad17c24..8ed8243 100644
--- a/metrics/src/main/java/org/apache/unomi/metrics/commands/ActivateCommand.java
+++ b/metrics/src/main/java/org/apache/unomi/metrics/commands/ActivateCommand.java
@@ -17,8 +17,6 @@
package org.apache.unomi.metrics.commands;
import org.apache.karaf.shell.commands.Command;
-import org.apache.karaf.shell.console.OsgiCommandSupport;
-import org.apache.unomi.metrics.MetricsService;
@Command(scope = "metrics", name = "activate", description = "This will activate the metrics system.")
public class ActivateCommand extends MetricsCommandSupport {
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/e0ffc081/metrics/src/main/java/org/apache/unomi/metrics/commands/DeactivateCommand.java
----------------------------------------------------------------------
diff --git a/metrics/src/main/java/org/apache/unomi/metrics/commands/DeactivateCommand.java b/metrics/src/main/java/org/apache/unomi/metrics/commands/DeactivateCommand.java
index d16eac0..ef0eefb 100644
--- a/metrics/src/main/java/org/apache/unomi/metrics/commands/DeactivateCommand.java
+++ b/metrics/src/main/java/org/apache/unomi/metrics/commands/DeactivateCommand.java
@@ -17,8 +17,6 @@
package org.apache.unomi.metrics.commands;
import org.apache.karaf.shell.commands.Command;
-import org.apache.karaf.shell.console.OsgiCommandSupport;
-import org.apache.unomi.metrics.MetricsService;
@Command(scope = "metrics", name = "deactivate", description = "This will de-activate the metrics system.")
public class DeactivateCommand extends MetricsCommandSupport {
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/e0ffc081/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index 67b9f25..4e43a20 100644
--- a/pom.xml
+++ b/pom.xml
@@ -430,6 +430,7 @@
<excludes>
<exclude>**/NOTICE.template</exclude>
<exclude>**/NOTICE-generated</exclude>
+ <exclude>**/DEPENDENCIES</exclude>
<exclude>**/target/**/*</exclude>
<!-- GIT files -->
<exclude>**/.git/**/*</exclude>