You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by re...@apache.org on 2021/11/06 16:55:26 UTC
svn commit: r1894782 - in /jackrabbit/site/trunk/src/site/markdown:
first-hops.md frequently-asked-questions.md
getting-started-with-apache-jackrabbit.md jcr-api.md jcr.md
Author: reschke
Date: Sat Nov 6 16:55:26 2021
New Revision: 1894782
URL: http://svn.apache.org/viewvc?rev=1894782&view=rev
Log:
JCR-4732: Host JCR 2.0 spec and its javadoc below https://jackrabbit.apache.org
Modified:
jackrabbit/site/trunk/src/site/markdown/first-hops.md
jackrabbit/site/trunk/src/site/markdown/frequently-asked-questions.md
jackrabbit/site/trunk/src/site/markdown/getting-started-with-apache-jackrabbit.md
jackrabbit/site/trunk/src/site/markdown/jcr-api.md
jackrabbit/site/trunk/src/site/markdown/jcr.md
Modified: jackrabbit/site/trunk/src/site/markdown/first-hops.md
URL: http://svn.apache.org/viewvc/jackrabbit/site/trunk/src/site/markdown/first-hops.md?rev=1894782&r1=1894781&r2=1894782&view=diff
==============================================================================
--- jackrabbit/site/trunk/src/site/markdown/first-hops.md (original)
+++ jackrabbit/site/trunk/src/site/markdown/first-hops.md Sat Nov 6 16:55:26 2021
@@ -125,8 +125,8 @@ jcr-2.0.jar library. The promise of the
these interfaces in your content application, it should remain mostly
independent of the underlying content repository implementation.
-The [Repository](http://www.day.com/maven/javax.jcr/javadocs/jcr-2.0/javax/jcr/Repository.html?is-external=true)
-interface represents a given content repository instance and the [Session](http://www.day.com/maven/javax.jcr/javadocs/jcr-2.0/javax/jcr/Session.html?is-external=true)
+The [Repository](https://s.apache.org/jcr-2.0-javadoc/javax/jcr/Repository.html?is-external=true)
+interface represents a given content repository instance and the [Session](https://s.apache.org/jcr-2.0-javadoc/javax/jcr/Session.html?is-external=true)
interface represents a single login session for accessing the repository.
A session is needed to access any content within a repository.
@@ -182,7 +182,7 @@ persistence manager.
The `Repository.login(Credentials)` method starts a repository session using the
-default workspace and some user credentials. The FirstHop example uses [GuestCredentials](http://www.day.com/maven/javax.jcr/javadocs/jcr-2.0/javax/jcr/GuestCredentials.html?is-external=true)
+default workspace and some user credentials. The FirstHop example uses [GuestCredentials](https://s.apache.org/jcr-2.0-javadoc/javax/jcr/GuestCredentials.html?is-external=true)
and Jackrabbit maps it to the read-only anonymous user.
Since we use the `TransientRepository` class as the Repository
@@ -214,7 +214,7 @@ available using the `Session.getUserID()
Each content repository implementation publishes a number of string
descriptors that describe the various implementation properties, like the
-implementation level and the supported optional JCR features. See the [Repository](http://www.day.com/maven/javax.jcr/javadocs/jcr-2.0/javax/jcr/Repository.html?is-external=true)
+implementation level and the supported optional JCR features. See the [Repository](https://s.apache.org/jcr-2.0-javadoc/javax/jcr/Repository.html?is-external=true)
interface for a list of the standard repository descriptors. The
`REP_NAME_DESC` descriptor contains the name of the repository
implementation, in this case `"Jackrabbit"`.
@@ -293,14 +293,14 @@ Hop example, so let's just walk through
import javax.jcr.Node;
-These are two new classes we need for this example. The [SimpleCredentials](http://www.day.com/maven/javax.jcr/javadocs/jcr-2.0/javax/jcr/SimpleCredentials.html?is-external=true)
-class is a simple implementation of the [Credentials](http://www.day.com/maven/javax.jcr/javadocs/jcr-2.0/javax/jcr/Credentials.html?is-external=true)
+These are two new classes we need for this example. The [SimpleCredentials](https://s.apache.org/jcr-2.0-javadoc/javax/jcr/SimpleCredentials.html?is-external=true)
+class is a simple implementation of the [Credentials](https://s.apache.org/jcr-2.0-javadoc/javax/jcr/Credentials.html?is-external=true)
interface used for passing explicit user credentials to the
`Repository.login(Credentials)` method.
-The [Node](http://www.day.com/maven/javax.jcr/javadocs/jcr-2.0/javax/jcr/Node.html?is-external=true)
+The [Node](https://s.apache.org/jcr-2.0-javadoc/javax/jcr/Node.html?is-external=true)
interface is used to manage the content nodes in a repository. There is a
-related interface called [Property](http://www.day.com/maven/javax.jcr/javadocs/jcr-2.0/javax/jcr/Property.html?is-external=true)
+related interface called [Property](https://s.apache.org/jcr-2.0-javadoc/javax/jcr/Property.html?is-external=true)
for managing content properties, but in this example we use the Property
interface only indirectly.
@@ -405,7 +405,7 @@ contains all the names of the ancestor n
the current node or property.
The path of a node or property can be retrieved using the Item.getPath()
-method. The [Item](http://www.day.com/maven/javax.jcr/javadocs/jcr-2.0/javax/jcr/Item.html?is-external=true)
+method. The [Item](https://s.apache.org/jcr-2.0-javadoc/javax/jcr/Item.html?is-external=true)
interface is a superinterface of Node and Property, and contains all the
functionality shared by nodes and properties.
@@ -416,7 +416,7 @@ output the line `"/hello/world"`.
Properties can be accessed using the `Node.getProperty(String relPath)`
-method that returns an instance of the [Property](http://www.day.com/maven/javax.jcr/javadocs/jcr-2.0/javax/jcr/Property.html?is-external=true)
+method that returns an instance of the [Property](https://s.apache.org/jcr-2.0-javadoc/javax/jcr/Property.html?is-external=true)
interface that represents the property at the given path relative to the
current node. In this case the "message" property is the one we created a
few lines earlier.
@@ -644,7 +644,7 @@ content:
This deserializes an XML document and adds the resulting item subgraph as a
child of the node at the provided path.
-The flag [ImportUUIDBehavior](http://www.day.com/maven/javax.jcr/javadocs/jcr-2.0/javax/jcr/ImportUUIDBehavior.html?is-external=true)
+The flag [ImportUUIDBehavior](https://s.apache.org/jcr-2.0-javadoc/javax/jcr/ImportUUIDBehavior.html?is-external=true)
governs how the identifiers of incoming nodes are handled.
There are four options:
Modified: jackrabbit/site/trunk/src/site/markdown/frequently-asked-questions.md
URL: http://svn.apache.org/viewvc/jackrabbit/site/trunk/src/site/markdown/frequently-asked-questions.md?rev=1894782&r1=1894781&r2=1894782&view=diff
==============================================================================
--- jackrabbit/site/trunk/src/site/markdown/frequently-asked-questions.md (original)
+++ jackrabbit/site/trunk/src/site/markdown/frequently-asked-questions.md Sat Nov 6 16:55:26 2021
@@ -23,8 +23,8 @@ General
-------
### What is JCR?
-JCR is the acronym of the Content Repository for Java technology API, a standard interface for accessing content repositories.
-JCR version 1.0 was specified in Java Specification Request 170 ([JSR 170](http://jcp.org/en/jsr/detail?id=170)),
+JCR is the acronym of the Content Repository for Java technology API, a standard interface for accessing content repositories.
+JCR version 1.0 was specified in Java Specification Request 170 ([JSR 170](http://jcp.org/en/jsr/detail?id=170)),
and version 2.0 is currently under work in [JSR 283|http://jcp.org/en/jsr/detail?id=283].
### What is a content repository?
@@ -45,7 +45,7 @@ official reference implementation (RI) a
(TCK) released along with the final JCR API.
### What do I do if I have a question?
-Please ask questions on the [Jackrabbit mailing lists](http://jackrabbit.apache.org/mailing-lists.html).
+Please ask questions on the [Jackrabbit mailing lists](http://jackrabbit.apache.org/mailing-lists.html).
There is the users list for questions around using JCR and Jackrabbit and
the dev list for the development of Jackrabbit itself and for people
starting to extend Jackrabbit or other advanced topics.
@@ -77,7 +77,7 @@ features, please see section 8.1 Tran
specification.
### How do I create new workspaces in Jackrabbit?
-The JCR 2.0 API has two [Workspace.createWorkspace\(\)](http://www.day.com/maven/jsr170/javadocs/jcr-2.0/javax/jcr/Workspace.html#createWorkspace\(java.lang.String\)) methods for that.
+The JCR 2.0 API has two [Workspace.createWorkspace\(\)](https://s.apache.org/jcr-2.0-javadoc/javax/jcr/Workspace.html#createWorkspace\(java.lang.String\)) methods for that.
The JCR 1.0 API does not contain features for creating or managing
workspaces, so you need to use Jackrabbit-specific functionality for
@@ -102,7 +102,7 @@ a workspace by manually removing the wor
repository instance is not running.
### How do I deploy Jackrabbit into Tomcat?
-* Download [jcr-1.0.jar](http://www.day.com/maven/javax.jcr/jars/jcr-1.0.jar) and put it into `<tomcat-install-dir>/shared/lib`.
+* Download [jcr-1.0.jar](https://repo1.maven.org/maven2/javax/jcr/jcr/1.0/jcr-1.0.jar) and put it into `<tomcat-install-dir>/shared/lib`.
* Get the WAR distribution from the [Downloads](downloads.html) page and deploy it into Tomcat.
* Point your browser to `http://localhost:8080/jackrabbit-webapp-<version>`
@@ -113,8 +113,8 @@ Access control
### How do I use LDAP, Kerberos, or some other authentication mechanism with Jackrabbit?
Jackrabbit uses the Java Authentication and Authorization Service (JAAS)
-for authenticating users. You should be able to use any JAAS LoginModule
-implementation (e.g. the LoginModules in thecom.sum.security.auth.modulepackage)
+for authenticating users. You should be able to use any JAAS LoginModule
+implementation (e.g. the LoginModules in thecom.sum.security.auth.modulepackage)
for authentication. See the JAAS documentation for configuration instructions.
### How do I manage the access rights of authenticated users?
@@ -139,7 +139,7 @@ of the Jackrabbit system architecture. R
performance of the PM are crucial to the overall
stability and performance of the repository. If e.g. the data
that a PM is based upon is allowed to change through external
-means the integrity of the repository would be at risk (think of referential
+means the integrity of the repository would be at risk (think of referential
integrity / node references e.g.).
In practice, a persistence manager is any Java class that
@@ -153,7 +153,7 @@ give additional flexibility.
A Jackrabbit file system (FS) is an internal component that
implements standard file system operations on top of some underlying
storage mechanism (a normal file system, a database, a webdav server,
-or a custom file format). A file system component is any Java class
+or a custom file format). A file system component is any Java class
that implements the FileSystem interface and the
associated behavioral contracts. File systems are used in
Jackrabbit both as sub-components of the persistence managers and
@@ -190,7 +190,7 @@ element in `repository.xml only` acts as
Verify that you also put the jar files into the classpath that jackrabbit
depends on for text extraction. You can find all required jar files inside
-the jackrabbit-webapp war file (the *WEB-INF/lib* folder).
+the jackrabbit-webapp war file (the *WEB-INF/lib* folder).
Go to the [downloads](downloads.html) page to get the war file.
Some documents may still not be searchable for various reasons: the
@@ -221,13 +221,13 @@ JSR 170 says in section 6.6.4.3:
> The context node of an XPath query is the XML node relative to which the
> query expression is evaluated.
->
+>
> A relative XPath statement (one that does not have a leading /) will be
> interpreted relative to the root node of the workspace, which, in the XML
> document view is the top-most XML element, <jcr:root>. This means that one
> should not include jcr:root as the first segment in a relative XPath
> statement, since that element is already the default context node.
->
+>
> An absolute XPath (one with a leading /), in contrast, will be interpreted
> relative to a position one level above <jcr:root>. This means that an
> absolute XPath must either begin with // or with /jcr:root in order to
Modified: jackrabbit/site/trunk/src/site/markdown/getting-started-with-apache-jackrabbit.md
URL: http://svn.apache.org/viewvc/jackrabbit/site/trunk/src/site/markdown/getting-started-with-apache-jackrabbit.md?rev=1894782&r1=1894781&r2=1894782&view=diff
==============================================================================
--- jackrabbit/site/trunk/src/site/markdown/getting-started-with-apache-jackrabbit.md (original)
+++ jackrabbit/site/trunk/src/site/markdown/getting-started-with-apache-jackrabbit.md Sat Nov 6 16:55:26 2021
@@ -18,8 +18,8 @@
Getting Started with Apache Jackrabbit
======================================
To get started with Jackrabbit you should first become familiar with the
-JCR API. Download the [JSR 170 specification](http://jcp.org/aboutJava/communityprocess/final/jsr170/index.html),
-browse the [API documentation](http://www.day.com/maven/jsr170/javadocs/jcr-1.0/),
+JCR API. Download the [JSR 170 specification](http://jcp.org/aboutJava/communityprocess/final/jsr170/index.html),
+browse the [API documentation](https://s.apache.org/jcr-1.0-javadoc/),
check our introduction to JCR levels, or read some of the JCR
articles to understand the content repository model that Jackrabbit
implements. You can also take a look at the various JCR and
Modified: jackrabbit/site/trunk/src/site/markdown/jcr-api.md
URL: http://svn.apache.org/viewvc/jackrabbit/site/trunk/src/site/markdown/jcr-api.md?rev=1894782&r1=1894781&r2=1894782&view=diff
==============================================================================
--- jackrabbit/site/trunk/src/site/markdown/jcr-api.md (original)
+++ jackrabbit/site/trunk/src/site/markdown/jcr-api.md Sat Nov 6 16:55:26 2021
@@ -27,14 +27,14 @@ repository but are not (yet) specified
See the javadoc documentation of the JCR API and Apache Jackrabbit releases:
-* [JCR 2.0](https://docs.adobe.com/docs/en/spec/javax.jcr/javadocs/jcr-2.0)
+* [JCR 2.0](https://s.apache.org/jcr-2.0-javadoc/)
* [Apache Jackrabbit Trunk](http://jackrabbit.apache.org/api/trunk/)
* [Apache Jackrabbit 2.20](http://jackrabbit.apache.org/api/2.20/)
* [Apache Jackrabbit 2.16](http://jackrabbit.apache.org/api/2.16/)
* [Apache Jackrabbit 2.14](http://jackrabbit.apache.org/api/2.14/)
-* [JCR 1.0](http://www.day.com/maven/jsr170/javadocs/jcr-1.0/)
+* [JCR 1.0](https://s.apache.org/jcr-1.0-javadoc/)
JSR-170 Levels
--------------
@@ -73,4 +73,4 @@ includes functions like: Versioning, (JT
A fully JSR-170 compliant repository like Jackrabbit encompasses all the functionality and therefore lends itself as
general purpose, off-the-shelf infrastructure for Content-, Document- and Source Code Management or for just about any
-other application that persists content.
\ No newline at end of file
+other application that persists content.
Modified: jackrabbit/site/trunk/src/site/markdown/jcr.md
URL: http://svn.apache.org/viewvc/jackrabbit/site/trunk/src/site/markdown/jcr.md?rev=1894782&r1=1894781&r2=1894782&view=diff
==============================================================================
--- jackrabbit/site/trunk/src/site/markdown/jcr.md (original)
+++ jackrabbit/site/trunk/src/site/markdown/jcr.md Sat Nov 6 16:55:26 2021
@@ -1,10 +1,24 @@
-Title: JCR
+JCR
+=====
+
The JCR API library is a core dependency for most of the [Jackrabbit components](jackrabbit-components.html)
-. The *jcr-1.0.jar* file contains all the [javax.jcr interfaces|http://www.day.com/maven/jsr170/javadocs/jcr-1.0/]
- specified by [JSR 170|http://jcp.org/en/jsr/detail?id=170]
-.
-
-The JCR API library is available under the [Day Spec License](http://www.day.com/maven/jsr170/licenses/day-spec-license.htm)
- and can be downloaded either from the [JCP web site|http://jcp.org/aboutJava/communityprocess/final/jsr170/index.html]
- or the [central Maven repository|http://repo1.maven.org/maven2/javax/jcr/jcr/1.0/]
-.
+
+JCR 1.0
+--------
+* The *jcr-1.0.jar* file contains all the [javax.jcr interfaces](https://s.apache.org/jcr-1.0-javadoc/]
+specified by [JSR 170](http://jcp.org/en/jsr/detail?id=170)
+
+
+* The JCR API library is available under the [Day Spec License](https://s.apache.org/jcr-1.0-spec/license.html)
+and can be downloaded either from the [JCP web site](http://jcp.org/aboutJava/communityprocess/final/jsr170/index.html)
+or the [central Maven repository](http://repo1.maven.org/maven2/javax/jcr/jcr/1.0/)
+
+JCR 2.0
+--------
+* The *jcr-2.0.jar* file contains all the [javax.jcr interfaces](https://s.apache.org/jcr-2.0-javadoc/]
+specified by [JSR 283](http://jcp.org/en/jsr/detail?id=283)
+
+
+* The JCR API library is available under the [Day Spec License](https://s.apache.org/jcr-2.0-spec/license.html)
+and can be downloaded either from the [JCP web site](http://jcp.org/aboutJava/communityprocess/final/jsr283/index.html)
+or the [central Maven repository](http://repo1.maven.org/maven2/javax/jcr/jcr/2.0/)