From jackrabbit-commits-return-1750-apmail-incubator-jackrabbit-commits-archive=www.apache.org@incubator.apache.org Fri Jan 20 01:35:04 2006
Return-Path: <jackrabbit-commits-return-1750-apmail-incubator-jackrabbit-commits-archive=www.apache.org@incubator.apache.org>
Delivered-To: apmail-incubator-jackrabbit-commits-archive@www.apache.org
Received: (qmail 71488 invoked from network); 20 Jan 2006 01:35:04 -0000
Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199)
  by minotaur.apache.org with SMTP; 20 Jan 2006 01:35:04 -0000
Received: (qmail 74666 invoked by uid 500); 20 Jan 2006 01:34:59 -0000
Mailing-List: contact jackrabbit-commits-help@incubator.apache.org; run by ezmlm
Precedence: bulk
List-Help: <mailto:jackrabbit-commits-help@incubator.apache.org>
List-Unsubscribe: <mailto:jackrabbit-commits-unsubscribe@incubator.apache.org>
List-Post: <mailto:jackrabbit-commits@incubator.apache.org>
List-Id: <jackrabbit-commits.incubator.apache.org>
Reply-To: jackrabbit-dev@incubator.apache.org
Delivered-To: mailing list jackrabbit-commits@incubator.apache.org
Received: (qmail 74644 invoked by uid 500); 20 Jan 2006 01:34:58 -0000
Delivered-To: apmail-incubator-jackrabbit-cvs@incubator.apache.org
Received: (qmail 74630 invoked by uid 99); 20 Jan 2006 01:34:58 -0000
Received: from asf.osuosl.org (HELO asf.osuosl.org) (140.211.166.49)
    by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 19 Jan 2006 17:34:58 -0800
X-ASF-Spam-Status: No, hits=-9.4 required=10.0
	tests=ALL_TRUSTED,NO_REAL_NAME
X-Spam-Check-By: apache.org
Received: from [209.237.227.194] (HELO minotaur.apache.org) (209.237.227.194)
    by apache.org (qpsmtpd/0.29) with SMTP; Thu, 19 Jan 2006 17:34:57 -0800
Received: (qmail 71189 invoked by uid 65534); 20 Jan 2006 01:34:37 -0000
Message-ID: <20060120013437.71188.qmail@minotaur.apache.org>
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r370691 -
 /incubator/jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/core/config/package.html
Date: Fri, 20 Jan 2006 01:34:37 -0000
To: jackrabbit-cvs@incubator.apache.org
From: jukka@apache.org
X-Mailer: svnmailer-1.0.5
X-Virus-Checked: Checked by ClamAV on apache.org
X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N

Author: jukka
Date: Thu Jan 19 17:34:30 2006
New Revision: 370691

URL: http://svn.apache.org/viewcvs?rev=370691&view=rev
Log:
JCR-306: Added documentation about the configuration construction.

Modified:
    incubator/jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/core/config/package.html

Modified: incubator/jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/core/config/package.html
URL: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/core/config/package.html?rev=370691&r1=370690&r2=370691&view=diff
==============================================================================
--- incubator/jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/core/config/package.html (original)
+++ incubator/jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/core/config/package.html Thu Jan 19 17:34:30 2006
@@ -4,12 +4,22 @@
 This package contains functionality for reading and manipulating the
 Jackrabbit configuration. The configuration functionality can be
 divided in two parts: parsing and representing configuration.
+
+<h2>Parsing configuration</h2>
 <p>
 The configuration parsing functionality is located in the
 {@link org.apache.jackrabbit.core.config.ConfigurationParser ConfigurationParser}
 class. The parser class reads repository and workspace configuration
 files and builds corresponding configuration object structures.
 <p>
+<p>
+The static <code>create()</code> factory methods of the
+{@link org.apache.jackrabbit.core.config.RepositoryConfig RepositoryConfig}
+class are the standard ways of invoking the configuration parser.
+</p>
+
+<h2>Representating configuration</h2>
+<p>
 The parsed configuration information is represented using Config object
 structures. The
 {@link org.apache.jackrabbit.core.config.RepositoryConfig RepositoryConfig}
@@ -32,4 +42,14 @@
 class contains also a set of static and instance methods for manipulating
 the repository configuration, especially creating and loading workspace
 configurations.
+
+<h2>Modifying configuration</h2>
+<p>
+The configuration classes in this package are immutable and <code>final</code>
+to enforce the contract that the configuration should not be modified once
+it has been intstantiated. The public constructors allow a limited form of
+dynamic configurability for Jackrabbit, but note that the only officially
+supported Jackrabbit configuration interface are the XML configuration files.
+</p>
+
 </body>