faq.fml

jsr170接口的java实现。是个apache的开源项目。

<?xml version="1.0" encoding="UTF-8"?>
<!--
   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.
 -->
<faqs title="Frequently Asked Questions">

  <part id="general">
    <title>General</title>

    <faq id="whats-jcr">
      <question>
        What is JCR?
      </question>
      <answer>
        <p>
          JCR is the acronym of the
          <a href="http://jcp.org/en/jsr/detail?id=170">JSR 170: Content
          Repository for Java&#8482; technology API</a>, a standard interface
          for accessing content repositories.
        </p>
      </answer>
    </faq>

    <faq id="whats-cr">
      <question>
        What is a content repository?
      </question>
      <answer>
        <p>
          A content repository is an information management system that
          provides various services for storing, accessing, and managing
          content. In addition to a hierarchically structured storage system,
          common services of a content repository are versioning,
          access control, full text searching, and event monitoring.
        </p>
        <p>
          A content repository is <em>not</em> a content management
          system (CMS), although most of the existing CMSs contain a
          more or less featured custom content repository implementation.
          A CMS uses a content repository as an underlying component
          for presentation, business logic, and other features.
        </p>
      </answer>
    </faq>

    <faq id="whats-jackrabbit">
      <question>
        What is Jackrabbit?
      </question>
      <answer>
        <p>
          The Apache Jackrabbit is a fully featured content repository that
          implements all of the JCR API. The Jackrabbit project was started
          when <a href="http://www.day.com/">Day Software</a>, the JSR-170
          specification lead, licensed their initial implementation of the
          JCR reference implementation. Since then the Jackrabbit codebase
          has been used for the official reference implementation (RI) and 
          technology compatibility kit (TCK) released along with the final
          JCR API.
        </p>
      </answer>
    </faq>
  </part>

  <part id="build">
    <title>Building Jackrabbit</title>

    <faq id="build-how">
      <question>
        How do I build the Jackrabbit sources?
      </question>
      <answer>
        See the <a href="doc/building.html">Building Jackrabbit</a> section
        of the <a href="doc/index.html">Jackrabbit documentation</a> for
        detailed build instructions.
      </answer>
    </faq>

    <faq id="build-missing-pom">
      <question>
        Why does the Maven build fail with the message
        "You must define currentVersion in your POM."?
      </question>
      <answer>
        <p>
          You are most probably running Maven from a wrong directory.
          Maven expects to find the file <code>project.xml</code> in the
          current directory (unless the <code>-d</code>, <code>-p</code>,
          or <code>-f</code> option is given). Please check that you
          are in the correct directory and try running Maven again.
        </p>
      </answer>
    </faq>

<!-- The following issue is no longer relevant, commenting it out. -jukka -->
<!--
    <faq id="build-java5">
      <question>
        Why does the Maven build fail with the message
        "Provider org.apache.xalan.processor.TransformerFactoryImpl not found"?
      </question>
      <answer>
        <p>
          This error message comes from the Jackrabbit build environment
          trying to generate the XPath grammar files with an XSLT
          transformation when using Java 5. Due to a Maven limitation (see
          <a href="http://jira.codehaus.org/secure/ViewIssue.jspa?key=MAVEN-156">MAVEN-156</a>)
          the class name of the XSLT transformer factory has been hardcoded
          in the Jackrabbit build environment. This solution works well with
          JDK 1.4, but fails with Java 5 that uses a different XSLT transformer.
        </p>
        <p>
          To work around this problem, Java 5 users need to download the
          <code>xalan.jar</code> and <code>serializer.jar</code> files from
          the <a href="http://xml.apache.org/xalan-j/downloads.html">Xalan-Java binary distribution</a>
          and place them in the <code>$MAVEN_HOME/lib/endorsed</code> directory.
          Maven 1.1 users need to place the files in
          <code>$AVA_HOME/jre/lib/endorsed</code> as Maven 1.1 does not have
          a private endorsed library directory.
        </p>
      </answer>
    </faq>
-->

    <faq id="build-connect">
      <question>
        Why does the Maven build fail with the message
        "java.net.ConnectException: Connection timed out: connect"?
      </question>
      <answer>
        <p>
          This error message can appears when one of the Maven repositories
          used for downloading Jackrabbit dependencies is not available.
          This can happen if your network connection is broken or if the
          repository server is down. Please check your network connection
          or wait a while for the repository to come back online.
        </p>
      </answer>
    </faq>
  </part>

  <part id="using">
    <title>Using Jackrabbit</title>

    <faq id="howto-jcr">
      <question>
        How do I do X with JCR/Jackrabbit?
      </question>
      <answer>
        <p>
          See the <a href="http://jcp.org/aboutJava/communityprocess/final/jsr170/index.html">JCR specification</a>,
          the <a href="http://www.day.com/maven/jsr170/javadocs/jcr-1.0/">JCR API documentation</a>,
          or the <a href="http://wiki.apache.org/jackrabbit/ExamplesPage">Examples page</a>
          on the <a href="http://wiki.apache.org/jackrabbit/FrontPage">Jackrabbit wiki</a>
          for information on how to perform various operation using the JCR API.
        </p>
        <p>
          For Jackrabbit features (like access control and node type management)
          not covered by the JCR API, see the
          <a href="http://wiki.apache.org/jackrabbit/ExamplesPage">Examples page</a>
          on the wiki, the <a href="apidocs/index.html">Jackrabbit javadocs</a>,
          or contact the <a href="http://jackrabbit.apache.org/mail-lists.html">Jackrabbit mailing list</a>.
        </p>
      </answer>
    </faq>

    <faq id="using-jta">
      <question>
        How do I use transactions with JCR?
      </question>
      <answer>
        <p>
          See the 
          <a href="http://article.gmane.org/gmane.comp.apache.jackrabbit.devel/446">mailing list announcement</a>
          for a simple example on using the <a href="http://java.sun.com/products/jta/">JTA</a>
          support in Jackrabbit.
        </p>
        <p>
          For a more complete explanation of the transaction features, please
          see section 8.1 Transactions of the
          <a href="http://jcp.org/aboutJava/communityprocess/final/jsr170/index.html">JCR specification</a>.
        </p>
      </answer>
    </faq>

    <faq id="create-workspace">
      <question>
        How do I create new workspaces in Jackrabbit?
      </question>
      <answer>
        <p>
          The JCR API does not contain features for creating or managing
          workspaces, so you need to use Jackrabbit-specific functionality
          for creating new workspaces.
        </p>
        <p>
          You can create a new workspace either manually or programmatically.
          The manual way is to create a new workspace directory within
          the repository home directory and to place a new
          <code>workspace.xml</code> configuration file in that folder.
          You can use the configuration file of an existing workspace as
          an example, just remember to change the name of the workspace
          in the <code>&lt;Workspace name="..."&gt;"</code> tag.
          See the <a href="doc/config.html">Configuring Jackrabbit</a>
          page for configuration details. Note also that you need to restart
          the repository instance to access the new workspace.
        </p>
        <p>
          The programmatic way is to acquire a <code>Workspace</code> instance
          using the normal JCR API and to cast the instance to the Jackrabbit
          <code>WorkspaceImpl</code> class. You can then use the
          <a href="apidocs/org/apache/jackrabbit/core/WorkspaceImpl.html#createWorkspace(java.lang.String)">WorkspaceImpl.createWorkspace(String)</a>
          method to create new workspaces.
        </p>
      </answer>
    </faq>

    <faq id="create-workspace">
      <question>
        How do I delete a workspace in Jackrabbit?
      </question>
      <answer>
        <p>
          There is currently no programmatic way to delete workspaces.
          You can delete a workspace by manually removing the workspace
          directory when the repository instance is not running.
        </p>
      </answer>
    </faq>
  </part>

  <part id="access">
    <title>Access control</title>

    <faq id="access-authentication">
      <question>
        How do I use LDAP, Kerberos, or some other authentication mechanism
        with Jackrabbit?
      </question>
      <answer>
        <p>
          Jackrabbit uses the
          <a href="http://java.sun.com/products/jaas/">Java Authentication and Authorization Service</a>
          (JAAS) for authenticating users. You should be able to use any
          JAAS LoginModule implementation (e.g. the LoginModules in the
          <a href="http://java.sun.com/j2se/1.4.2/docs/guide/security/jaas/spec/com/sun/security/auth/module/package-summary.html">com.sum.security.auth.module</a>
          package) for authentication. See the JAAS documentation for
          configuration instructions.
        </p>
      </answer>
    </faq>

    <faq id="access-authorization">
      <question>
        How do I manage the access rights of authenticated users?
      </question>
      <answer>
        <p>
          The current Jackrabbit
          <a href="apidocs/org/apache/jackrabbit/core/security/SimpleAccessManager.html">SimpleAccessManager</a>
          class only supports three access levels: anonymous, normal, and
          system. Anonymous users have read access while normal and system
          users have full read-write access. You need to implement a custom
          <a href="apidocs/org/apache/jackrabbit/core/security/AccessManager.html">AccessManager</a>
          class to get more fine-grained access control.
        </p>
      </answer>
    </faq>
  </part>

  <part id="pms">
    <title>Persistence managers</title>