You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-commits@jackrabbit.apache.org by re...@apache.org on 2022/12/19 15:41:48 UTC
[jackrabbit-oak] branch OAK-10044 updated (859166d48c -> 0f581781c8)
This is an automated email from the ASF dual-hosted git repository.
reschke pushed a change to branch OAK-10044
in repository https://gitbox.apache.org/repos/asf/jackrabbit-oak.git
from 859166d48c OAK-10040: Update animal-sniffer dependency to 1.22 (#799)
new 2e9db5dcda OAK-10044: oak-commons JDK11 Javadoc fixes
new ba8db7ac35 OAK-10044: oak-core JDK11 Javadoc fixes
new 334d704fdc OAK-10044: oak-run-commons JDK11 Javadoc fixes
new dcd9088859 OAK-10044: oak-search-elastic JDK11 Javadoc fixes
new 479242a290 OAK-10044: oak-security-spi JDK11 Javadoc fixes
new 0f581781c8 OAK-10044: oak-store-document JDK11 Javadoc fixes
The 6 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../apache/jackrabbit/oak/commons/Compression.java | 2 +-
.../oak/plugins/metric/util/StatsProviderUtil.java | 5 +++--
.../index/indexer/document/flatfile/MergeRunner.java | 20 ++++++++++----------
.../MultithreadedTraverseWithSortStrategy.java | 4 ++--
.../index/elastic/ElasticIndexNameHelper.java | 6 +++---
.../accesscontrol/AccessControlConstants.java | 8 ++++----
.../plugins/document/ThrottlingStatsCollector.java | 3 ++-
.../oak/plugins/document/util/LogSilencer.java | 4 ++--
.../oak/plugins/document/util/TriStatsConsumer.java | 3 ---
9 files changed, 27 insertions(+), 28 deletions(-)
[jackrabbit-oak] 03/06: OAK-10044: oak-run-commons JDK11 Javadoc fixes
Posted by re...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
reschke pushed a commit to branch OAK-10044
in repository https://gitbox.apache.org/repos/asf/jackrabbit-oak.git
commit 334d704fdc1fae5fe3429adffe906fca7e1e6b0e
Author: Julian Reschke <ju...@gmx.de>
AuthorDate: Mon Dec 19 16:40:46 2022 +0100
OAK-10044: oak-run-commons JDK11 Javadoc fixes
---
.../index/indexer/document/flatfile/MergeRunner.java | 20 ++++++++++----------
.../MultithreadedTraverseWithSortStrategy.java | 4 ++--
2 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/oak-run-commons/src/main/java/org/apache/jackrabbit/oak/index/indexer/document/flatfile/MergeRunner.java b/oak-run-commons/src/main/java/org/apache/jackrabbit/oak/index/indexer/document/flatfile/MergeRunner.java
index d7dc7624d1..258952e295 100644
--- a/oak-run-commons/src/main/java/org/apache/jackrabbit/oak/index/indexer/document/flatfile/MergeRunner.java
+++ b/oak-run-commons/src/main/java/org/apache/jackrabbit/oak/index/indexer/document/flatfile/MergeRunner.java
@@ -58,11 +58,11 @@ import static org.apache.jackrabbit.oak.index.indexer.document.flatfile.FlatFile
* </ol>
* Strategy -
* <ol>
- * <li>Wait for n files</li>
- * <li>construct new list of files to be merged by checking if its already merged</li>
+ * <li>Wait for n files
+ * <li>construct new list of files to be merged by checking if its already merged
* and create intermediate merge file
* (if final merge) merge all intermediate merge files and create sorted file
- * <li>add all merged files to merged list</li>
+ * <li>add all merged files to merged list
* </ol>
*
* <h3>Merge task explanation -</h3>
@@ -106,14 +106,14 @@ import static org.apache.jackrabbit.oak.index.indexer.document.flatfile.FlatFile
*
* <h3>Force Stop Explanation -</h3>
* <ol>
- * <li>On receiving MERGE_FORCE_STOP_POISON_PILL in SORTED_FILE_QUEUE from parent thread, all un-started tasks will be skipped.</li>
- * <li>No more tasks will be created on MERGE_FORCE_STOP_POISON_PILL message is received.</li>
- * <li>Running merge will continue to finish.</li>
- * <li>Final merge will not be performed.</li>
- * <li>This will not result in lose of data under conditions that -</li>
+ * <li>On receiving MERGE_FORCE_STOP_POISON_PILL in SORTED_FILE_QUEUE from parent thread, all un-started tasks will be skipped.
+ * <li>No more tasks will be created on MERGE_FORCE_STOP_POISON_PILL message is received.
+ * <li>Running merge will continue to finish.
+ * <li>Final merge will not be performed.
+ * <li>This will not result in lose of data under conditions that -
* <ol>
- * <li>Files will not be removed until merge task is completed. Parent thread should add unmerged files to the SORTED_FILE_QUEUE on retry.</li>
- * <li>Merged files will still be under the merge folder. Parent thread should add those files to the SORTED_FILE_QUEUE on retry.</li>
+ * <li>Files will not be removed until merge task is completed. Parent thread should add unmerged files to the SORTED_FILE_QUEUE on retry.
+ * <li>Merged files will still be under the merge folder. Parent thread should add those files to the SORTED_FILE_QUEUE on retry.
* </ol>
* </li>
* </ol>
diff --git a/oak-run-commons/src/main/java/org/apache/jackrabbit/oak/index/indexer/document/flatfile/MultithreadedTraverseWithSortStrategy.java b/oak-run-commons/src/main/java/org/apache/jackrabbit/oak/index/indexer/document/flatfile/MultithreadedTraverseWithSortStrategy.java
index d207de7bad..3900ed4baa 100644
--- a/oak-run-commons/src/main/java/org/apache/jackrabbit/oak/index/indexer/document/flatfile/MultithreadedTraverseWithSortStrategy.java
+++ b/oak-run-commons/src/main/java/org/apache/jackrabbit/oak/index/indexer/document/flatfile/MultithreadedTraverseWithSortStrategy.java
@@ -132,13 +132,13 @@ import static org.apache.jackrabbit.oak.plugins.document.mongo.MongoDocumentTrav
* If some state information is found, that means, some data was already dumped. So to avoid again downloading that data, we create two tasks-
* Suppose the traversing range of this sort-work-dir is - _modified in [10, 100) and the state information is (50, doc_id)
* <ol>
- * <li>First task will download docs with _modified = 50 and _id < doc_id</li>
+ * <li>First task will download docs with _modified = 50 and _id < doc_id</li>
* <li>Second task downloads docs with _modified in [51, 100) </li>
* </ol>
* </li>
* </ol>
* </li>
- * <li>If multiple retries have happened, there would be a list of sort-work-dirs from each of the runs i.e. a List<List<File>>.</li>
+ * <li>If multiple retries have happened, there would be a list of sort-work-dirs from each of the runs i.e. a {@code List<List<File>>}.</li>
* <li>The list should be sorted in order of run i.e. first list would be the list of dirs from first run and last list would be the list of files from the most recent run
* which failed.</li>
* <li>The data dump files from each of sort-work-dirs of every run would be considered, but for creating further tasks for downloading remaining data
[jackrabbit-oak] 02/06: OAK-10044: oak-core JDK11 Javadoc fixes
Posted by re...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
reschke pushed a commit to branch OAK-10044
in repository https://gitbox.apache.org/repos/asf/jackrabbit-oak.git
commit ba8db7ac3501a70e9af2477536feb698628bfd48
Author: Julian Reschke <ju...@gmx.de>
AuthorDate: Mon Dec 19 16:40:29 2022 +0100
OAK-10044: oak-core JDK11 Javadoc fixes
---
.../apache/jackrabbit/oak/plugins/metric/util/StatsProviderUtil.java | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/metric/util/StatsProviderUtil.java b/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/metric/util/StatsProviderUtil.java
index 5e6c243354..498bffb1da 100644
--- a/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/metric/util/StatsProviderUtil.java
+++ b/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/metric/util/StatsProviderUtil.java
@@ -31,10 +31,11 @@ import java.util.function.BiFunction;
/**
* Util class to generate a name for Stats implementations that can be used for creating labels in prometheus.
- * Usage - StatsProviderUtil(<StatisticsProvider Object>).getHistoStats().apply(metricName, labels)
+ * <p>
+ * Usage - {@code StatsProviderUtil(<StatisticsProvider Object>).getHistoStats().apply(metricName, labels)}
* where metricName is a String to denote the metric name and labels is map of label values.
* Resultant metric will be created with a name as follows -
- * metricName;labelName1=labelValue1;labelName2=labelValue2
+ * {@code metricName;labelName1=labelValue1;labelName2=labelValue2}.
* This can then be translated by a consuming alerting system like prometheus into metric name and labels separately.
*/
public class StatsProviderUtil {
[jackrabbit-oak] 05/06: OAK-10044: oak-security-spi JDK11 Javadoc fixes
Posted by re...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
reschke pushed a commit to branch OAK-10044
in repository https://gitbox.apache.org/repos/asf/jackrabbit-oak.git
commit 479242a290d78542a7e3166ecec561153e3efb7c
Author: Julian Reschke <ju...@gmx.de>
AuthorDate: Mon Dec 19 16:41:22 2022 +0100
OAK-10044: oak-security-spi JDK11 Javadoc fixes
---
.../authorization/accesscontrol/AccessControlConstants.java | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/oak-security-spi/src/main/java/org/apache/jackrabbit/oak/spi/security/authorization/accesscontrol/AccessControlConstants.java b/oak-security-spi/src/main/java/org/apache/jackrabbit/oak/spi/security/authorization/accesscontrol/AccessControlConstants.java
index 28e421a359..3b2c165b48 100644
--- a/oak-security-spi/src/main/java/org/apache/jackrabbit/oak/spi/security/authorization/accesscontrol/AccessControlConstants.java
+++ b/oak-security-spi/src/main/java/org/apache/jackrabbit/oak/spi/security/authorization/accesscontrol/AccessControlConstants.java
@@ -82,10 +82,10 @@ public interface AccessControlConstants {
*
* Example:
* <pre>
- * rep:current = [] => restriction applies to the target node only
- * rep:current = [*] => restriction applies to the target node and all it's properties
- * rep:current = [jcr:primaryType] => restriction applies to the target node and it's property jcr:primaryType
- * rep:current = [a, b, prefix:c] => restriction applies to the target node and it's properties a, b and prefix:c
+ * rep:current = [] => restriction applies to the target node only
+ * rep:current = [*] => restriction applies to the target node and all it's properties
+ * rep:current = [jcr:primaryType] => restriction applies to the target node and it's property jcr:primaryType
+ * rep:current = [a, b, prefix:c] => restriction applies to the target node and it's properties a, b and prefix:c
* </pre>
*
* @since OAK 1.42.0
[jackrabbit-oak] 06/06: OAK-10044: oak-store-document JDK11 Javadoc fixes
Posted by re...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
reschke pushed a commit to branch OAK-10044
in repository https://gitbox.apache.org/repos/asf/jackrabbit-oak.git
commit 0f581781c8202a53e0e58e3f049d998b6ce7cd23
Author: Julian Reschke <ju...@gmx.de>
AuthorDate: Mon Dec 19 16:41:37 2022 +0100
OAK-10044: oak-store-document JDK11 Javadoc fixes
---
.../jackrabbit/oak/plugins/document/ThrottlingStatsCollector.java | 3 ++-
.../org/apache/jackrabbit/oak/plugins/document/util/LogSilencer.java | 4 ++--
.../apache/jackrabbit/oak/plugins/document/util/TriStatsConsumer.java | 3 ---
3 files changed, 4 insertions(+), 6 deletions(-)
diff --git a/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/ThrottlingStatsCollector.java b/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/ThrottlingStatsCollector.java
index 421d8e38ab..10a769a91f 100644
--- a/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/ThrottlingStatsCollector.java
+++ b/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/ThrottlingStatsCollector.java
@@ -23,7 +23,8 @@ import java.util.List;
/**
* Stats Collector for throttling operation.
- * <p/>It's implementation are required to provide the time taken for implementing each operation while throttling is ON.
+ * <p>
+ * It's implementation are required to provide the time taken for implementing each operation while throttling is ON.
*/
public interface ThrottlingStatsCollector {
diff --git a/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/util/LogSilencer.java b/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/util/LogSilencer.java
index bf38704ccb..d05d9e12ab 100644
--- a/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/util/LogSilencer.java
+++ b/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/util/LogSilencer.java
@@ -51,8 +51,8 @@ public class LogSilencer {
/**
* Create a new LogSilencer
* @param silenceMillis milliseconds after which the silences herein should time out.
- * If the value is <0 it means no timeout, if it is ==0 it is silenced only
- * for the very same millisecond, and >0 the silence is active for that specified
+ * If the value is <0 it means no timeout, if it is ==0 it is silenced only
+ * for the very same millisecond, and >0 the silence is active for that specified
* amount of time.
* @param cacheSize the size of the cache held by the LogSilencer. The cache is
* used to store the keys and timeout values for each of them.
diff --git a/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/util/TriStatsConsumer.java b/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/util/TriStatsConsumer.java
index 3421094883..ef39b2e807 100644
--- a/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/util/TriStatsConsumer.java
+++ b/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/util/TriStatsConsumer.java
@@ -25,9 +25,6 @@ import java.util.List;
/**
* {@link FunctionalInterface} to consume Metric Stats for create/upsert operation
- * @param <T> the type of the first argument to the consumer
- * @param <U> the type of the second argument to the consumer
- * @param <V> the type of the third argument to the consumer
*/
public interface TriStatsConsumer {
[jackrabbit-oak] 04/06: OAK-10044: oak-search-elastic JDK11 Javadoc fixes
Posted by re...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
reschke pushed a commit to branch OAK-10044
in repository https://gitbox.apache.org/repos/asf/jackrabbit-oak.git
commit dcd908885944d54f7f25da719fcc9f8c91858b72
Author: Julian Reschke <ju...@gmx.de>
AuthorDate: Mon Dec 19 16:41:06 2022 +0100
OAK-10044: oak-search-elastic JDK11 Javadoc fixes
---
.../oak/plugins/index/elastic/ElasticIndexNameHelper.java | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/oak-search-elastic/src/main/java/org/apache/jackrabbit/oak/plugins/index/elastic/ElasticIndexNameHelper.java b/oak-search-elastic/src/main/java/org/apache/jackrabbit/oak/plugins/index/elastic/ElasticIndexNameHelper.java
index bb80cb04ea..00ce66b042 100644
--- a/oak-search-elastic/src/main/java/org/apache/jackrabbit/oak/plugins/index/elastic/ElasticIndexNameHelper.java
+++ b/oak-search-elastic/src/main/java/org/apache/jackrabbit/oak/plugins/index/elastic/ElasticIndexNameHelper.java
@@ -71,9 +71,9 @@ public class ElasticIndexNameHelper {
*
* Examples:
* <ul>
- * <li>prefix, abc -> prefix.abc</li>
- * <li>prefix, xy:abc -> prefix.xyabc</li>
- * <li>prefix, /oak:index/abc -> prefix.abc</li>
+ * <li>prefix, abc -> prefix.abc</li>
+ * <li>prefix, xy:abc -> prefix.xyabc</li>
+ * <li>prefix, /oak:index/abc -> prefix.abc</li>
* </ul>
* <p>
* The resulting file name would be truncated to {@link #MAX_NAME_LENGTH}
[jackrabbit-oak] 01/06: OAK-10044: oak-commons JDK11 Javadoc fixes
Posted by re...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
reschke pushed a commit to branch OAK-10044
in repository https://gitbox.apache.org/repos/asf/jackrabbit-oak.git
commit 2e9db5dcdad2b16ce031212cf4845bd862cd6160
Author: Julian Reschke <ju...@gmx.de>
AuthorDate: Mon Dec 19 16:40:19 2022 +0100
OAK-10044: oak-commons JDK11 Javadoc fixes
---
.../src/main/java/org/apache/jackrabbit/oak/commons/Compression.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/Compression.java b/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/Compression.java
index 24738ad7e3..bc5e268e08 100644
--- a/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/Compression.java
+++ b/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/Compression.java
@@ -28,7 +28,7 @@ import java.util.zip.GZIPOutputStream;
/**
* This interface provides a default list of support compression algorithms and some utility functions.
* It is mainly used by intermediate stored files in {@link org.apache.jackrabbit.oak.commons.sort.ExternalSort} and
- * sort/index utilities in {@link org.apache.jackrabbit.oak.index.indexer.document.flatfile}.
+ * sort/index utilities in {@code org.apache.jackrabbit.oak.index.indexer.document.flatfile}.
*
* Other compression algorithms can be supported by implementing the methods.
*/