Author: reschke
Date: Tue Apr 30 16:20:37 2019
New Revision: 1858442
URL: http://svn.apache.org/viewvc?rev=1858442&view=rev
Log:
OAK-8288: fix javadoc:javadoc for jdk >= 13 - changes reverted (see ticket)
Modified:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/atomic/AtomicCounterEditor.java
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/tree/impl/ImmutableTree.java
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/security/authentication/AuthenticationConfigurationImpl.java
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/security/authentication/user/LoginModuleImpl.java
jackrabbit/oak/trunk/oak-exercise/src/main/java/org/apache/jackrabbit/oak/exercise/security/authorization/models/readonly/ReadOnlyAuthorizationConfiguration.java
jackrabbit/oak/trunk/oak-security-spi/src/main/java/org/apache/jackrabbit/oak/spi/security/principal/PrincipalConfiguration.java
jackrabbit/oak/trunk/oak-store-composite/src/main/java/org/apache/jackrabbit/oak/composite/package-info.java
jackrabbit/oak/trunk/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/rdb/RDBDocumentStore.java
Modified:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/atomic/AtomicCounterEditor.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/atomic/AtomicCounterEditor.java?rev=1858442&r1=1858441&r2=1858442&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/atomic/AtomicCounterEditor.java
(original)
+++
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/atomic/AtomicCounterEditor.java
Tue Apr 30 16:20:37 2019
@@ -101,7 +101,7 @@ import org.slf4j.LoggerFactory;
* session.logout();
* </pre>
*
- * <h2>Internal behavioural details</h2>
+ * <h3>Internal behavioural details</h3>
*
* <p>
* The related jira ticket is <a
href="https://issues.apache.org/jira/browse/OAK-2472";>OAK-2472</a>.
Modified:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/tree/impl/ImmutableTree.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/tree/impl/ImmutableTree.java?rev=1858442&r1=1858441&r2=1858442&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/tree/impl/ImmutableTree.java
(original)
+++
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/tree/impl/ImmutableTree.java
Tue Apr 30 16:20:37 2019
@@ -34,7 +34,7 @@ import org.jetbrains.annotations.Nullabl
* Immutable implementation of the {@code Tree} interface in order to provide
* the much feature rich API functionality for a given {@code NodeState}.
*
- * <h2>Tree hierarchy</h2>
+ * <h3>Tree hierarchy</h3>
* Due to the nature of this {@code Tree} implementation creating a proper
* hierarchical view of the tree structure is the responsibility of the caller.
* It is recommended to start with the state of the
@@ -49,7 +49,7 @@ import org.jetbrains.annotations.Nullabl
* {@link #ImmutableTree(ImmutableTree.ParentProvider, String,
org.apache.jackrabbit.oak.spi.state.NodeState)}
* an specify an appropriate {@code ParentProvider} implementation.
*
- * <h2>ParentProvider</h2>
+ * <h3>ParentProvider</h3>
* Apart from create the tree hierarchy in traversal mode this tree
implementation
* allows to instantiate disconnected trees that depending on the use may
* never or on demand retrieve hierarchy information. The following default
@@ -64,13 +64,13 @@ import org.jetbrains.annotations.Nullabl
* upon hierarchy related methods like {@link #getParent()}, {@link
#getPath()}</li>
* </ul>
*
- * <h2>Filtering 'hidden' items</h2>
+ * <h3>Filtering 'hidden' items</h3>
* This {@code Tree} implementation reflects the item hierarchy as exposed by
the
* underlying {@code NodeState}. In contrast to the mutable implementations it
* does not filter out 'hidden' items as identified by
* {@code org.apache.jackrabbit.oak.spi.state.NodeStateUtils#isHidden(String)}.
*
- * <h2>Equality and hash code</h2>
+ * <h3>Equality and hash code</h3>
* In contrast to {@link
org.apache.jackrabbit.oak.plugins.tree.impl.AbstractMutableTree}
* the {@code ImmutableTree} implements
* {@link Object#equals(Object)} and {@link Object#hashCode()}: Two {@code
ImmutableTree}s
Modified:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/security/authentication/AuthenticationConfigurationImpl.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/security/authentication/AuthenticationConfigurationImpl.java?rev=1858442&r1=1858441&r2=1858442&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/security/authentication/AuthenticationConfigurationImpl.java
(original)
+++
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/security/authentication/AuthenticationConfigurationImpl.java
Tue Apr 30 16:20:37 2019
@@ -121,7 +121,7 @@ public class AuthenticationConfiguration
* related validation is omitted</li>
* </ul>
*
- * <h4>Configuration Options</h4>
+ * <h3>Configuration Options</h3>
* <ul>
* <li>{@link #PARAM_APP_NAME}: The appName passed to
* {@code Configuration#getAppConfigurationEntry(String)}. The default
Modified:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/security/authentication/user/LoginModuleImpl.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/security/authentication/user/LoginModuleImpl.java?rev=1858442&r1=1858441&r2=1858442&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/security/authentication/user/LoginModuleImpl.java
(original)
+++
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/security/authentication/user/LoginModuleImpl.java
Tue Apr 30 16:20:37 2019
@@ -54,7 +54,7 @@ import org.slf4j.LoggerFactory;
* associated with user are retrieved from a configurable
* {@link org.apache.jackrabbit.oak.spi.security.principal.PrincipalProvider}.
*
- * <h2>Credentials</h2>
+ * <h3>Credentials</h3>
*
* The {@code Credentials} are collected during {@link #login()} using the
* following logic:
@@ -81,12 +81,12 @@ import org.slf4j.LoggerFactory;
* The {@link Credentials} obtained during the {@code #login()} are added to
* the shared state and - upon successful {@code #commit()} to the {@code
Subject}.
*
- * <h2>Principals</h2>
+ * <h3>Principals</h3>
* Upon successful login the principals associated with the user are calculated
* (see also {@link AbstractLoginModule#getPrincipals(String)}. These
principals
* are finally added to the subject during {@code #commit()}.
*
- * <h2>Impersonation</h2>
+ * <h3>Impersonation</h3>
* Impersonation such as defined by {@link
javax.jcr.Session#impersonate(javax.jcr.Credentials)}
* is covered by this login module by the means of {@link
ImpersonationCredentials}.
* Impersonation will succeed if the {@link
ImpersonationCredentials#getBaseCredentials() base credentials}
Modified:
jackrabbit/oak/trunk/oak-exercise/src/main/java/org/apache/jackrabbit/oak/exercise/security/authorization/models/readonly/ReadOnlyAuthorizationConfiguration.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-exercise/src/main/java/org/apache/jackrabbit/oak/exercise/security/authorization/models/readonly/ReadOnlyAuthorizationConfiguration.java?rev=1858442&r1=1858441&r2=1858442&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-exercise/src/main/java/org/apache/jackrabbit/oak/exercise/security/authorization/models/readonly/ReadOnlyAuthorizationConfiguration.java
(original)
+++
jackrabbit/oak/trunk/oak-exercise/src/main/java/org/apache/jackrabbit/oak/exercise/security/authorization/models/readonly/ReadOnlyAuthorizationConfiguration.java
Tue Apr 30 16:20:37 2019
@@ -72,12 +72,12 @@ import org.jetbrains.annotations.Nullabl
import static
org.apache.jackrabbit.oak.spi.security.RegistrationConstants.OAK_SECURITY_NAME;
/**
- * <h2>Read Only Authorization Model</h2>
+ * <h1>Read Only Authorization Model</h1>
*
* This authorization module forms part of the training material provided by
the
* <i>oak-exercise</i> module and must not be used in a productive environment!
*
- * <h3>Overview</h3>
+ * <h2>Overview</h2>
* This simplistic authorization model is limited to permission evaluation and
* doesn't support access control management.
*
@@ -88,7 +88,7 @@ import static org.apache.jackrabbit.oak.
* There exists a single exception to that rule: For the internal {@link
SystemPrincipal}
* permission evaluation is not enforced by this module i.e. this module is
skipped.
*
- * <h3>Intended Usage</h3>
+ * <h2>Intended Usage</h2>
* This authorization model is intended to be used in 'AND' combination with
the
* default authorization setup defined by Oak (and optionally additional models
* such as e.g. <i>oak-authorization-cug</i>.
@@ -96,12 +96,12 @@ import static org.apache.jackrabbit.oak.
* It is not intended to be used as standalone model as it would grant full
read
* access to everyone.
*
- * <h3>Limitations</h3>
+ * <h2>Limitations</h2>
* Experimental model for training purpose and not intended for usage in
production.
*
- * <h3>Key Features</h3>
+ * <h2>Key Features</h2>
*
- * <h4>Access Control Management</h4>
+ * <h3>Access Control Management</h3>
*
* <table style="text-align: left;">
* <caption></caption>
@@ -115,7 +115,7 @@ import static org.apache.jackrabbit.oak.
* <tr><td>Effective Policies by Principals</td><td>for every set of
principals a single effective policy of type {@link
NamedAccessControlPolicy}</td></tr>
* </table>
*
- * <h4>Permission Evaluation</h4>
+ * <h3>Permission Evaluation</h3>
*
* <table>
* <caption></caption>
@@ -124,20 +124,20 @@ import static org.apache.jackrabbit.oak.
* <tr><td>Aggregated Permission Provider</td><td>yes</td></tr>
* </table>
*
- * <h3>Representation in the Repository</h3>
+ * <h2>Representation in the Repository</h2>
*
* There exists no dedicated access control or permission content for this
* authorization model as it doesn't persist any information into the
repository.
* {@link SecurityConfiguration#getContext()} therefore returns the {@link
Context#DEFAULT default}.
*
- * <h3>Configuration</h3>
+ * <h2>Configuration</h2>
*
* This model comes with a single mandatory configurable property:
*
* - configurationRanking : {@link CompositeConfiguration#PARAM_RANKING}, no
default value.
*
*
- * <h3>Installation Instructions</h3>
+ * <h2>Installation Instructions</h2>
*
* The following steps are required to install this authorization model in an
OSGi based Oak setup.
*
Modified:
jackrabbit/oak/trunk/oak-security-spi/src/main/java/org/apache/jackrabbit/oak/spi/security/principal/PrincipalConfiguration.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-security-spi/src/main/java/org/apache/jackrabbit/oak/spi/security/principal/PrincipalConfiguration.java?rev=1858442&r1=1858441&r2=1858442&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-security-spi/src/main/java/org/apache/jackrabbit/oak/spi/security/principal/PrincipalConfiguration.java
(original)
+++
jackrabbit/oak/trunk/oak-security-spi/src/main/java/org/apache/jackrabbit/oak/spi/security/principal/PrincipalConfiguration.java
Tue Apr 30 16:20:37 2019
@@ -45,8 +45,8 @@ public interface PrincipalConfiguration
/**
* Returns an instance of the OAK {@link PrincipalProvider}.
*
- * <h4>Backwards compatibility with Jackrabbit 2.x</h4>
- * <h5>Configuration of Principal Providers</h5>
+ * <h3>Backwards compatibility with Jackrabbit 2.x</h3>
+ * <h4>Configuration of Principal Providers</h4>
* In Jackrabbit 2.x the configuration of principal providers was tied to
* the LoginModule configuration and thus mixing authentication concerns
* with the principal management. Since OAK makes the {@code
PrincipalProvider}
@@ -56,7 +56,7 @@ public interface PrincipalConfiguration
* {@link org.apache.jackrabbit.oak.spi.security.SecurityProvider} is
* made available in the {@link
org.apache.jackrabbit.oak.spi.security.authentication.AuthenticationConfiguration}.
*
- * <h5>Multiple Sources for Principals</h5>
+ * <h4>Multiple Sources for Principals</h4>
* In Jackrabbit 2.x it was possible to configure multiple principal
providers.
* As of OAK there is only one single principal provider implementation
* responsible for a given workspace. If principals originate from
different
Modified:
jackrabbit/oak/trunk/oak-store-composite/src/main/java/org/apache/jackrabbit/oak/composite/package-info.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-store-composite/src/main/java/org/apache/jackrabbit/oak/composite/package-info.java?rev=1858442&r1=1858441&r2=1858442&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-store-composite/src/main/java/org/apache/jackrabbit/oak/composite/package-info.java
(original)
+++
jackrabbit/oak/trunk/oak-store-composite/src/main/java/org/apache/jackrabbit/oak/composite/package-info.java
Tue Apr 30 16:20:37 2019
@@ -15,11 +15,11 @@
* limitations under the License.
*/
/**
- * <h2>Composition support</h2>
+ * <h1>Composition support</h1>
*
* <p>This package contains support classes for implementing a composite
persistence at the {@linkplain org.apache.jackrabbit.oak.spi.state.NodeStore}
level.</p>
*
- * <h3>Design goals</h3>
+ * <h2>Design goals</h2>
* <ol>
* <li>Transparency of the composition setup. Neither the NodeStores nor the
code using a composite
* NodeStore should be aware of the specific implementation being
used.</li>
@@ -28,7 +28,7 @@
* <li>Negligible performance impact. Composition should not add a
significat performance overhead.</li>
* </ol>
*
- * <h3>Implementation</h3>
+ * <h2>Implementation</h2>
*
* <p>The main entry point is the {@link
org.apache.jackrabbit.oak.composite.CompositeNodeStore},
* which wraps one or more NodeStore instances. Also of interest are the
{@link org.apache.jackrabbit.oak.composite.CompositeNodeState} and {@link
org.apache.jackrabbit.oak.composite.CompositeNodeBuilder}.
@@ -41,7 +41,7 @@
* <p>Using this approach allows us to always keep related NodeStore,
NodeState and NodeBuilder
* instances isolated from other instances.
*
- * <h3>Open items</h3>
+ * <h2>Open items</h2>
*
* <p>1. Brute-force support for oak:mount nodes.
*
Modified:
jackrabbit/oak/trunk/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/rdb/RDBDocumentStore.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/rdb/RDBDocumentStore.java?rev=1858442&r1=1858441&r2=1858442&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/rdb/RDBDocumentStore.java
(original)
+++
jackrabbit/oak/trunk/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/rdb/RDBDocumentStore.java
Tue Apr 30 16:20:37 2019
@@ -100,7 +100,7 @@ import com.google.common.collect.Sets;
/**
* Implementation of {@link DocumentStore} for relational databases.
*
- * <h2 id="apidocs.supported-databases">Supported Databases</h2>
+ * <h3 id="apidocs.supported-databases">Supported Databases</h3>
* <p>
* The code is supposed to be sufficiently generic to run with a variety of
* database implementations. However, the tables are created when required to
@@ -116,7 +116,7 @@ import com.google.common.collect.Sets;
* <li>Oracle</li>
* </ul>
*
- * <h2 id="apidocs.table-layout">Table Layout</h2>
+ * <h3 id="apidocs.table-layout">Table Layout</h3>
* <p>
* Data for each of the DocumentStore's {@link Collection}s is stored in its
own
* database table (with a name matching the collection).
@@ -126,7 +126,7 @@ import com.google.common.collect.Sets;
* {@link Document} (or a part of one). Additional fields are used for queries,
* debugging, and concurrency control:
* <table style="text-align: left;">
- * <caption>RDBDocumentStore Column Layout</caption>
+ * <caption></caption>
* <thead>
* <tr>
* <th>Column</th>
@@ -203,7 +203,7 @@ import com.google.common.collect.Sets;
* testing, as tables can also be dropped automatically when the store is
* disposed (this only happens for those tables that have been created on
* demand).
- * <h3 id="apidocs.versioning">Versioning</h3>
+ * <h4 id="apidocs.versioning">Versioning</h4>
* <p>
* The initial database layout used in OAK 1.0 through 1.6 is version 0.
* <p>
@@ -216,7 +216,7 @@ import com.google.common.collect.Sets;
* The code deals with both version 0, version 1 and version 2 table layouts.
By
* default, it tries to create version 2 tables, and also tries to upgrade
* existing version 0 and 1 tables to version 2.
- * <h3>DB-specific information</h3>
+ * <h4>DB-specific information</h4>
* <p>
* Databases need to be configured so that:
* <ul>
@@ -238,11 +238,11 @@ import com.google.common.collect.Sets;
* command can be used to print out the DDL statements that would have been
used for auto-creation
* and/or automatic schema updates.
*
- * <h2>Caching</h2>
+ * <h3>Caching</h3>
* <p>
* The cache borrows heavily from the {@link MongoDocumentStore}
implementation.
*
- * <h2>Queries</h2>
+ * <h3>Queries</h3>
* <p>
* The implementation currently supports only three indexed properties: "_bin",
* "deletedOnce", and "_modified". Attempts to use a different indexed property
