jackrabbit-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ju...@apache.org
Subject svn commit: r761331 - in /jackrabbit/commons/site/src/site: apt/jcr-rmi/ apt/jcr-rmi/1.5/ apt/jcr-rmi/1.5/using.apt apt/jcr-rmi/index.apt site.xml
Date Thu, 02 Apr 2009 16:04:12 GMT
Author: jukka
Date: Thu Apr  2 16:04:12 2009
New Revision: 761331

URL: http://svn.apache.org/viewvc?rev=761331&view=rev
Log:
commons: Some content for JCR-RMI

Added:
    jackrabbit/commons/site/src/site/apt/jcr-rmi/
    jackrabbit/commons/site/src/site/apt/jcr-rmi/1.5/
    jackrabbit/commons/site/src/site/apt/jcr-rmi/1.5/using.apt   (with props)
    jackrabbit/commons/site/src/site/apt/jcr-rmi/index.apt   (with props)
Modified:
    jackrabbit/commons/site/src/site/site.xml

Added: jackrabbit/commons/site/src/site/apt/jcr-rmi/1.5/using.apt
URL: http://svn.apache.org/viewvc/jackrabbit/commons/site/src/site/apt/jcr-rmi/1.5/using.apt?rev=761331&view=auto
==============================================================================
--- jackrabbit/commons/site/src/site/apt/jcr-rmi/1.5/using.apt (added)
+++ jackrabbit/commons/site/src/site/apt/jcr-rmi/1.5/using.apt Thu Apr  2 16:04:12 2009
@@ -0,0 +1,92 @@
+                       -------------
+                       Using JCR-RMI
+                       -------------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one or more
+~~ contributor license agreements.  See the NOTICE file distributed with
+~~ this work for additional information regarding copyright ownership.
+~~ The ASF licenses this file to You under the Apache License, Version 2.0
+~~ (the "License"); you may not use this file except in compliance with
+~~ the License.  You may obtain a copy of the License at
+~~
+~~     http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing, software
+~~ distributed under the License is distributed on an "AS IS" BASIS,
+~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+~~ See the License for the specific language governing permissions and
+~~ limitations under the License.
+
+Using JCR-RMI
+
+    This document describes how to use the JCR-RMI component of
+    Apache Jackrabbit.
+
+Setting up a remote repository
+
+    Setting up the server part of the JCR-RMI layer is quite straightforward.
+    After instantiating a local JCR repository you need to wrap it into
+    a remote adapter and create an RMI binding for the repository. A variation
+    of the following code is usually all that is needed in addition to
+    the standard RMI setup (starting rmiregistry, etc.):
+
+----
+Repository repository = ...; // The local repository
+String name = ...; // The RMI URL for the repository
+
+RemoteAdapterFactory factory = new ServerAdapterFactory();
+RemoteRepository remote = factory.getRemoteRepository(repository);
+Naming.bind(name, remote);  // Make the RMI binding using java.rmi.Naming
+----
+
+Accessing a remote repository
+
+    The ClientRepositoryFactory class provides a convenient mechanism for
+    looking up a remote JCR-RMI repository. The factory can be used either
+    directly or as a JNDI object factory.
+
+    The following example shows how to use the ClientRepositoryFactory
+    directly:
+
+----
+String name = ...; // The RMI URL of the repository
+
+ClientRepositoryFactory factory = new ClientRepositoryFactory();
+Repository repository = factory.getRepository(name);
+----
+
+    The ClientRepositoryFactory can also be used via JNDI. The following
+    example settings and code demonstrate how to configure and use the
+    transparent JCR-RMI layer in a Tomcat 5.5 web application:
+
+    context.xml:
+
+----
+<Resource name="jcr/Repository" auth="Container"
+          type="javax.jcr.Repository"
+          factory="org.apache.jackrabbit.rmi.client.ClientRepositoryFactory"
+          url="..."/>
+----
+
+    web.xml:
+
+----
+<resource-env-ref>
+  <description>The external content repository</description>
+  <resource-env-ref-name>jcr/Repository</resource-env-ref-name>
+  <resource-env-ref-type>javac.jcr.Repository</resource-env-ref-type>
+</resource-env-ref>
+----
+
+    SomeServlet.java:
+
+----
+Context initial = new InitialContext();
+Context context = (Context) initial.lookup("java:comp/env");
+Repository repository = (Repository) context.lookup("jcr/Repository");
+----
+
+    Note that in the example above only the context.xml configuration file
+    contains a direct references to the JCR-RMI layer. All other parts of
+    the web application can be implemented using the standard JCR interfaces.
+ 
\ No newline at end of file

Propchange: jackrabbit/commons/site/src/site/apt/jcr-rmi/1.5/using.apt
------------------------------------------------------------------------------
    svn:eol-style = native

Added: jackrabbit/commons/site/src/site/apt/jcr-rmi/index.apt
URL: http://svn.apache.org/viewvc/jackrabbit/commons/site/src/site/apt/jcr-rmi/index.apt?rev=761331&view=auto
==============================================================================
--- jackrabbit/commons/site/src/site/apt/jcr-rmi/index.apt (added)
+++ jackrabbit/commons/site/src/site/apt/jcr-rmi/index.apt Thu Apr  2 16:04:12 2009
@@ -0,0 +1,61 @@
+                       -------
+                       JCR-RMI
+                       -------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one or more
+~~ contributor license agreements.  See the NOTICE file distributed with
+~~ this work for additional information regarding copyright ownership.
+~~ The ASF licenses this file to You under the Apache License, Version 2.0
+~~ (the "License"); you may not use this file except in compliance with
+~~ the License.  You may obtain a copy of the License at
+~~
+~~     http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing, software
+~~ distributed under the License is distributed on an "AS IS" BASIS,
+~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+~~ See the License for the specific language governing permissions and
+~~ limitations under the License.
+
+JCR-RMI - Remote JCR access
+
+    JCR-RMI is a transparent Remote Method Invocation (RMI) layer for the
+    Content Repository for Java Technology API (JCR). The layer makes it
+    possible to remotely access JCR content repositories and is compatible
+    with all JCR implementations.
+
+    JCR-RMI is a part of the
+    {{{http://jackrabbit.apache.org/commons/}JCR Commons}} subproject of
+    {{{http://jackrabbit.apache.org/}Apache Jackrabbit}}. Jackrabbit is a
+    project of the {{{http://www.apache.org/}Apache Software Foundation}}.
+
+Releases
+
+    There are currently no standalone releases of the JCR-RMI component.
+    See the Apache Jackrabbit
+    {{{http://jackrabbit.apache.org/downloads.html}downloads page}} for
+    releases that contain also the JCR-RMI component.
+
+Documentation
+
+    * Jackrabbit JCR-RMI 1.5.0
+        * {{{1.5/using.html}Using JCR-RMI}}
+
+Development infrastructure
+
+    Discussion about development and use of the JCR-RMI component takes
+    place on the Jackrabbit
+    {{{http://jackrabbit.apache.org/mailing-lists.html}mailing lists}}.
+    Please use <<<[rmi]>>> as a subject prefix when discussing JCR-RMI.
+
+    Use the {{{https://issues.apache.org/jira/browse/JCRRMI}JCRRMI}} issue
+    tracker for reporting bugs or requesting new features in JCR-RMI.
+    See the Jackrabbit
+    {{{http://jackrabbit.apache.org/issue-tracker.html}issue tracker page}}
+    for more information on how and when to use the issue tracker.
+
+    The latest JCR-RMI sources are available in Subversion at
+    {{https://svn.apache.org/repos/asf/jackrabbit/commons/jcr-rmi/trunk}}.
+    See the Jackrabbit
+    {{{http://jackrabbit.apache.org/source-repository.html}source repository page}}
+    for more information on how to access the source repository.

Propchange: jackrabbit/commons/site/src/site/apt/jcr-rmi/index.apt
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: jackrabbit/commons/site/src/site/site.xml
URL: http://svn.apache.org/viewvc/jackrabbit/commons/site/src/site/site.xml?rev=761331&r1=761330&r2=761331&view=diff
==============================================================================
--- jackrabbit/commons/site/src/site/site.xml (original)
+++ jackrabbit/commons/site/src/site/site.xml Thu Apr  2 16:04:12 2009
@@ -27,5 +27,15 @@
     <menu name="Apache JCR Commons">
       <item name="Introduction" href="index.html"/>
     </menu>
+
+    <menu name="Components">
+      <item name="JCR-RMI" href="jcr-rmi/index.html">
+        <item name="1.5">
+          <item name="Using JCR-RMI" href="jcr-rmi/1.5/using.html"/>
+          <item name="Javadoc" href="jcr-rmi/1.5/api/"/>
+        </item>
+      </item>
+    </menu>
+
   </body>
 </project>



Mime
View raw message