You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by bu...@apache.org on 2012/04/22 18:52:31 UTC
svn commit: r813967 [12/16] - /websites/staging/sling/trunk/content/
Added: websites/staging/sling/trunk/content/release-management.html
==============================================================================
--- websites/staging/sling/trunk/content/release-management.html (added)
+++ websites/staging/sling/trunk/content/release-management.html Sun Apr 22 16:52:28 2012
@@ -0,0 +1,625 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<!--
+
+ 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.
+-->
+ <head>
+ <title>Apache Sling - Release Management</title>
+ <link rel="stylesheet" href="http://sling.apache.org/site/media.data/site.css" type="text/css" media="all">
+ <link rel="icon" href="http://sling.apache.org/site/media.data/favicon.ico">
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+ </head>
+ <body>
+ <div class="title">
+ <div class="logo">
+ <a href="http://sling.apache.org/site/index.html">
+ <img border="0" alt="Apache Sling" src="http://sling.apache.org/site/media.data/logo.png">
+ </a>
+ </div>
+ <div class="header">
+ <a href="http://www.apache.org/">
+ <img border="0" alt="Apache" src="http://sling.apache.org/site/media.data/apache.png">
+ </a>
+ </div>
+ </div>
+
+ <div class="menu">
+ <h1 id="documentation">Documentation</h1>
+<ul>
+<li><a href="getting-started.html">Getting Started</a></li>
+<li><a href="the-sling-engine.html">The Sling Engine</a></li>
+<li><a href="development.html">Development</a></li>
+<li><a href="bundles.html">Bundles</a></li>
+<li><a href="tutorials-&-how-tos.html">Tutorials & How-Tos</a></li>
+<li><a href="configuration.html">Configuration</a></li>
+<li><a href="http://sling.apache.org/apidocs/sling5/index.html">API docs</a></li>
+<li><a href="http://s.apache.org/sling.wiki">Wiki</a></li>
+<li><a href="http://s.apache.org/sling.faq">FAQ</a></li>
+</ul>
+<h1 id="project-info">Project info</h1>
+<ul>
+<li><a href="http://sling.apache.org/site/downloads.cgi">Downloads</a></li>
+<li><a href="http://www.apache.org/licenses/">License</a></li>
+<li><a href="contributing.html">Contributing</a></li>
+<li><a href="news.html">News</a></li>
+<li><a href="links.html">Links</a></li>
+<li><a href="project-information.html">Project Information</a></li>
+<li><a href="https://issues.apache.org/jira/browse/SLING">Issue Tracker</a></li>
+<li><a href="http://svn.apache.org/viewvc/sling/trunk">Browse Source Repository</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+<h1 id="sponsorship">Sponsorship</h1>
+<ul>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/foundation/buy_stuff.html">Buy Stuff</a></li>
+</ul>
+<iframe
+ src="http://www.apache.org/ads/button.html"
+ style="border-width:0; float: left" frameborder="0"
+ scrolling="no"
+ width="135"
+ height="135">
+</iframe>
+ </div>
+
+ <div class="main">
+ <div class="breadcrump" style="font-size: 80%;">
+ (TODO: breadcrumb here)
+ </div>
+ <h1 class="title">Release Management</h1>
+ <div>
+ <p><a name="ReleaseManagement-ReleaseManagement"></a></p>
+<h1 id="release-management">Release Management</h1>
+<p>Sling releases (and SNAPSHOTS) are deployed to the <a href="http://repository.apache.org">Nexus repository</a>
+ instead of the traditional deployment via the Maven 2 mirros source on
+<em>people.apache.org</em>. This makes the release process much leaner and
+simpler. In addtion we can benefit from the Apache Parent POM 6, which has
+most of the release profile setup built-in.</p>
+<p>Most of the hard work of preparing and deploying the release is done by
+Maven.</p>
+<p>{toc:minLevel=2}</p>
+<p><a name="ReleaseManagement-Prerequisites"></a></p>
+<h2 id="prerequisites">Prerequisites</h2>
+<ul>
+<li>To prepare or perform a release you <em>MUST BE</em> at least be an Apache Sling
+Committer.</li>
+<li>Each and every release must be signed; therefore the public key should be
+cross signed by other Apache committers (not required but suggested) and
+this public key should be added to <a href="http://www.apache.org/dist/sling/KEYS">http://www.apache.org/dist/sling/KEYS</a>
+ and either on pool.sks-keyservers.net or pgp.mit.edu (See Appendix A)</li>
+<li>When preparing the release on Mac OS X, check out Appendix B before
+trying the steps in the next chapter.</li>
+<li>Make sure you have all Apache servers defined in your <a href="http://maven.apache.org/developers/committer-settings.html">settings.xml</a></li>
+</ul>
+<p><em>Note</em>: Listing the Apache servers in the <em>settings.xml</em> file also
+requires adding the password to that file. Starting with Maven 2.1 this
+password may be encrypted and needs not be give in plaintext. Please refer
+to <a href="http://maven.apache.org/guides/mini/guide-encryption.html">Password Encryption</a>
+ for more information.</p>
+<p>In the past we staged release candidates on our local machines using a
+semi-manual process. Now that we inherit from the Apache parent POM version
+6, a repository manager will automatically handle staging for you. This
+means you now only need to specify your GPG passphrase in the release
+profile of your <em>${user.home}/.m2/settings.xml</em>:</p>
+<div class="codehilite"><pre><span class="nt"><settings></span>
+ ...
+ <span class="nt"><profiles></span>
+ <span class="nt"><profile></span>
+ <span class="nt"><id></span>apache-release<span class="nt"></id></span>
+ <span class="nt"><properties></span>
+ <span class="nt"><gpg.passphrase></span> <span class="c"><!-- YOUR KEY PASSPHRASE --></span>
+</pre></div>
+
+
+<p></gpg.passphrase>
+ </properties>
+ </profile>
+ </profiles>
+ ...
+ </settings></p>
+<p>Everything else has been configured in the latest Sling Parent POM:</p>
+<div class="codehilite"><pre><span class="nt"><parent></span>
+ <span class="nt"><groupId></span>org.apache.sling<span class="nt"></groupId></span>
+ <span class="nt"><artifactId></span>sling<span class="nt"></artifactId></span>
+ <span class="nt"><version></span>6<span class="nt"></version></span>
+<span class="nt"></parent></span>
+</pre></div>
+
+
+<p><a name="ReleaseManagement-StagingtheReleaseCandidates"></a></p>
+<h2 id="staging-the-release-candidates">Staging the Release Candidates</h2>
+<p>First prepare your POMs for release:</p>
+<ol>
+<li>Make sure there are no snapshots in the POMs to be released</li>
+<li>
+<p>Check that your POMs will not lose content when they are rewritten during
+the release process</p>
+<p>$ mvn release:prepare -DdryRun=true</p>
+</li>
+</ol>
+<p>Compare the original <em>pom.xml</em> with the one called <em>pom.xml.tag</em> to see
+if the license or any other info has been removed. This has been known to
+happen if the starting <em><project></em> tag is not on a single line. The only
+things that should be different between these files are the <em><version></em>
+and <em><scm></em> elements. If there are any other changes, you must fix the
+original <em>pom.xml</em> file and commit before proceeding with the release.
+1. Publish a snapshot</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">mvn</span> <span class="n">deploy</span>
+<span class="o">...</span>
+<span class="p">[</span><span class="n">INFO</span><span class="p">]</span>
+</pre></div>
+
+
+<p>[deploy:deploy]
+ [INFO]
+ Retrieving previous build number from apache.snapshots.https
+ ...</p>
+<ol>
+<li>
+<ul>
+<li>If you experience an error during deployment like a HTTP 401 check your
+settings for the required server entries as outlined in the <em>Prerequisites</em></li>
+</ul>
+</li>
+<li>
+<ul>
+<li>
+<dl>
+<dt>Be sure that the generated artifacts respect the Apache release <a href="http://www.apache.org/dev/release.html">rules</a></dt>
+<dd>NOTICE and LICENSE files should be present in the META-INF directory
+within the jar. For -sources artifacts, be sure that your POM does not use
+the maven-source-plugin:2.0.3 which is broken. The recommended version at
+this time is 2.0.4</dd>
+</dl>
+</li>
+</ul>
+</li>
+<li>
+<ul>
+<li>You should verify the deployment under the <a href="https://repository.apache.org/content/groups/snapshots/org/apache/sling">snapshot</a>
+ repository on Apache</li>
+</ul>
+</li>
+<li>
+<p>Prepare the release</p>
+<p>$ mvn release:clean
+$ mvn release:prepare</p>
+</li>
+<li>
+<ul>
+<li>Preparing the release will create the new tag in SVN, automatically
+checking in on your behalf</li>
+</ul>
+</li>
+<li>
+<ul>
+<li>If you get a build failure because of an SVN commit problem (namely <em>The
+specified baseline is not the latest baseline, so it may not be checked
+out.</em>), just repeat the <em>mvn release:prepare</em> command until SVN is happy.
+This is based on a known timing issue when using the European SVN mirror.</li>
+</ul>
+</li>
+<li>
+<p>Stage the release for a vote</p>
+<p>$ mvn release:perform</p>
+</li>
+<li>
+<ul>
+<li>The release will automatically be inserted into a temporary staging
+repository for you, see the Nexus <a href="http://www.sonatype.com/books/nexus-book/reference/staging.html">staging documentation</a>
+ for full details</li>
+</ul>
+</li>
+<li>
+<ul>
+<li>You can continue to use <em>mvn release:prepare</em> and {{mvn
+release:perform}} on other sub-projects as necessary on the same machine
+and they will be combined in the same staging repository - this is useful
+when making a release of multiple Sling modules.</li>
+</ul>
+</li>
+<li>Close the staging repository</li>
+<li>
+<ul>
+<li>Login to <a href="https://repository.apache.org">https://repository.apache.org</a>
+ using your Apache SVN credentials. Click on <em>Staging</em> on the left. Then
+click on <em>org.apache.sling</em> in the list of repositories. In the panel below
+you should see an open repository that is linked to your username and IP.
+Right click on this repository and select <em>Close</em>. This will close the
+repository from future deployments and make it available for others to
+view. If you are staging multiple releases together, skip this step until
+you have staged everything</li>
+</ul>
+</li>
+<li>Verify the staged artifacts</li>
+<li>
+<ul>
+<li>If you click on your repository, a tree view will appear below. You can
+then browse the contents to ensure the artifacts are as you expect them.
+Pay particular attention to the existence of *.asc (signature) files. If
+you don't like the content of the repository, right click your repository
+and choose <em>Drop</em>. You can then rollback your release (see <em>Canceling the
+Release</em>) and repeat the process</li>
+</ul>
+</li>
+<li>
+<ul>
+<li>Note the staging repository URL (especially the number at the end of the
+URL) you will need this in your vote email</li>
+</ul>
+</li>
+</ol>
+<p><a name="ReleaseManagement-StartingtheVote"></a></p>
+<h2 id="starting-the-vote">Starting the Vote</h2>
+<p>Propose a vote on the dev list with the closed issues, the issues left, and
+the staging repository - for example:</p>
+<div class="codehilite"><pre><span class="n">To:</span> <span class="s">"Sling Developers List"</span> <span class="sr"><dev@sling.apache.org></span>
+<span class="n">Subject:</span> <span class="p">[</span><span class="n">VOTE</span><span class="p">]</span>
+</pre></div>
+
+
+<p>Release Apache Sling ABC version X.Y.Z</p>
+<div class="codehilite"><pre><span class="n">Hi</span><span class="p">,</span>
+
+<span class="n">We</span> <span class="n">solved</span> <span class="n">N</span> <span class="n">issues</span> <span class="n">in</span> <span class="n">this</span> <span class="n">release:</span>
+<span class="n">https:</span><span class="sr">//iss</span><span class="n">ues</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="sr">/jira/</span><span class="n">browse</span><span class="sr">/SLING/</span><span class="n">fixforversion</span><span class="o">/...</span>
+
+<span class="n">There</span> <span class="n">are</span> <span class="n">still</span> <span class="n">some</span> <span class="n">outstanding</span> <span class="n">issues:</span>
+<span class="n">https:</span><span class="sr">//iss</span><span class="n">ues</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="sr">/jira/</span><span class="n">browse</span><span class="sr">/SLING/com</span><span class="n">ponent</span><span class="o">/...</span>
+
+<span class="n">Staging</span> <span class="n">repository:</span>
+<span class="n">https:</span><span class="sr">//</span><span class="n">repository</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="sr">/content/</span><span class="n">repositories</span><span class="o">/</span><span class="n">orgapachesling</span><span class="o">-</span><span class="p">[</span><span class="n">YOUR</span> <span class="n">REPOSITORY</span> <span class="n">ID</span><span class="p">]</span>
+</pre></div>
+
+
+<p>/</p>
+<div class="codehilite"><pre><span class="n">You</span> <span class="n">can</span> <span class="k">use</span> <span class="n">this</span> <span class="n">UNIX</span> <span class="n">script</span> <span class="n">to</span> <span class="n">download</span> <span class="n">the</span> <span class="n">release</span> <span class="ow">and</span> <span class="n">verify</span> <span class="n">the</span>
+</pre></div>
+
+
+<p>signatures:
+ http://svn.apache.org/repos/asf/sling/trunk/check_staged_release.sh</p>
+<div class="codehilite"><pre><span class="err">Usage:</span>
+<span class="err">sh</span> <span class="err">check_staged_release.sh</span> <span class="err">[YOUR</span> <span class="err">REPOSITORY</span> <span class="err">ID]</span>
+</pre></div>
+
+
+<p>/tmp/sling-staging</p>
+<div class="codehilite"><pre><span class="n">Please</span> <span class="n">vote</span> <span class="n">to</span> <span class="n">approve</span> <span class="n">this</span> <span class="n">release:</span>
+
+ <span class="p">[</span> <span class="p">]</span>
+</pre></div>
+
+
+<p>+1 Approve the release
+ [ ]
+ 0 Don't care
+ [ ]
+ -1 Don't release, because ...</p>
+<div class="codehilite"><pre><span class="n">This</span> <span class="n">vote</span> <span class="n">will</span> <span class="n">be</span> <span class="nb">open</span> <span class="k">for</span> <span class="mi">72</span> <span class="n">hours</span><span class="o">.</span>
+</pre></div>
+
+
+<p><a name="ReleaseManagement-WaitfortheResults"></a></p>
+<h2 id="wait-for-the-results">Wait for the Results</h2>
+<p>From <a href="http://www.apache.org/foundation/voting.html">Votes on Package Releases</a>
+:</p>
+<p>{quote}Votes on whether a package is ready to be released follow a format
+similar to majority approval -- except that the decision is officially
+determined solely by whether at least three +1 votes were registered.
+Releases may not be vetoed. Generally the community will table the vote to
+release if anyone identifies serious problems, but in most cases the
+ultimate decision, once three or more positive votes have been garnered,
+lies with the individual serving as release manager. The specifics of the
+process may vary from project to project, but the 'minimum of three +1
+votes' rule is universal.{quote}</p>
+<p>The list of binding voters is available on the <a href="project-team.html">Project Team</a>
+ page.</p>
+<p>If the vote is successful, post the result to the dev list - for example:</p>
+<div class="codehilite"><pre><span class="n">To:</span> <span class="s">"Sling Developers List"</span> <span class="sr"><dev@sling.apache.org></span>
+<span class="n">Subject:</span> <span class="p">[</span><span class="n">RESULT</span><span class="p">]</span>
+</pre></div>
+
+
+<p>[VOTE]
+ Release Apache Sling ABC version X.Y.Z</p>
+<div class="codehilite"><pre><span class="n">Hi</span><span class="p">,</span>
+
+<span class="n">The</span> <span class="n">vote</span> <span class="n">has</span> <span class="n">passed</span> <span class="n">with</span> <span class="n">the</span> <span class="n">following</span> <span class="n">result</span> <span class="p">:</span>
+
+<span class="o">+</span><span class="mi">1</span> <span class="p">(</span><span class="n">binding</span><span class="p">):</span> <span class="o"><<</span><span class="n">list</span> <span class="n">of</span> <span class="n">names</span><span class="o">>></span>
+<span class="o">+</span><span class="mi">1</span> <span class="p">(</span><span class="n">non</span> <span class="n">binding</span><span class="p">):</span> <span class="o"><<</span><span class="n">list</span> <span class="n">of</span> <span class="n">names</span><span class="o">>></span>
+
+<span class="n">I</span> <span class="n">will</span> <span class="n">copy</span> <span class="n">this</span> <span class="n">release</span> <span class="n">to</span> <span class="n">the</span> <span class="n">Sling</span> <span class="n">dist</span> <span class="n">directory</span> <span class="ow">and</span>
+<span class="n">promote</span> <span class="n">the</span> <span class="n">artifacts</span> <span class="n">to</span> <span class="n">the</span> <span class="n">central</span> <span class="n">Maven</span> <span class="n">repository</span><span class="o">.</span>
+</pre></div>
+
+
+<p>Be sure to include all votes in the list and indicate which votes were
+binding. Consider -1 votes very carefully. While there is technically no
+veto on release votes, there may be reasons for people to vote -1. So
+sometimes it may be better to cancel a release when someone, especially a
+member of the PMC, votes -1.</p>
+<p>If the vote is unsuccessful, you need to fix the issues and restart the
+process - see <em>Canceling the Release</em>.</p>
+<p>If the vote is successful, you need to promote and distribute the release -
+see <em>Promoting the Release</em>.</p>
+<p><a name="ReleaseManagement-CancelingtheRelease"></a></p>
+<h2 id="canceling-the-release">Canceling the Release</h2>
+<p>If the vote fails, or you decide to redo the release:</p>
+<ol>
+<li>Remove the release tag from Subversion (<em>svn del ...</em>)</li>
+<li>Login to <a href="https://repository.apache.org">https://repository.apache.org</a>
+ using your Apache SVN credentials. Click on <em>Staging</em> on the left. Then
+click on <em>org.apache.sling</em> in the list of repositories. In the panel below
+you should see a closed repository that is linked to your username and IP
+(if it's not yet closed you need to right click and select <em>Close</em>). Right
+click on this repository and select <em>Drop</em>.</li>
+<li>Rollback the version in the <em>pom.xml</em> and commit any fixes you need to
+make</li>
+</ol>
+<p><a name="ReleaseManagement-PromotingtheRelease"></a></p>
+<h2 id="promoting-the-release">Promoting the Release</h2>
+<p>If the vote passes:</p>
+<ol>
+<li>Copy the released artifacts to the Sling dist directory
+(<em>/x1/www/www.apache.org/dist/sling</em>) on <em>people.apache.org</em>. This
+folder is replicated to <a href="http://www.apache.org/dist/sling/">http://www.apache.org/dist/sling/</a>
+ a few times a day.</li>
+<li>Delete the old release from the Sling dist directory (it's archived)</li>
+<li>Login to <a href="https://repository.apache.org">https://repository.apache.org</a>
+ with your Apache SVN credentials. Click on <em>Staging</em>. Find your closed
+staging repository and select it by checking the select box. Select the
+<em>Releases</em> repository from the drop-down list and click <em>Release</em> from the
+menu above.</li>
+<li>Once the release is promoted click on <em>Repositories</em>, select the
+<em>Releases</em> repository and validate that your artifacts are all there.</li>
+<li>If you're releasing bundles, you should also add them to the Sling
+Release OBR (see <em>Appendix C</em>).</li>
+<li>Update the news section on the website at <a href="news.html">news</a>
+.</li>
+<li>Update the download page on the website at <a href="downloads.html">downloads</a>
+ to point to the new release.</li>
+</ol>
+<p>For the last two tasks, it's better to give the mirrors some time to
+distribute the uploaded artifacts (one day should be fine). This ensures
+that once the website (news and download page) is updated, people can
+actually download the artifacts.</p>
+<p><a name="ReleaseManagement-UpdateJIRA"></a></p>
+<h2 id="update-jira">Update JIRA</h2>
+<p>Go to <a href="https://issues.apache.org/jira/plugins/servlet/project-config/SLING/versions">Manage Versions</a>
+ section on the SLING JIRA and mark the X.Y.Z version as released setting
+the release date to the date the vote has been closed.</p>
+<p>Also create a new version X.Y.Z+2, if that hasn't already been done.</p>
+<p><a name="ReleaseManagement-CreateanAnnouncement"></a></p>
+<h2 id="create-an-announcement">Create an Announcement</h2>
+<div class="codehilite"><pre><span class="n">To:</span> <span class="s">"Sling Developers List"</span> <span class="sr"><dev@sling.apache.org></span><span class="p">,</span> <span class="s">"Apache Announcements"</span>
+</pre></div>
+
+
+<p><a href="mailto:announce@apache.org">announce@apache.org</a>
+ Subject: [ANN]
+ Apache Sling ABC version X.Y.Z Released</p>
+<div class="codehilite"><pre><span class="n">The</span> <span class="n">Apache</span> <span class="n">Sling</span> <span class="n">team</span> <span class="n">is</span> <span class="n">pleased</span> <span class="n">to</span> <span class="n">announce</span> <span class="n">the</span> <span class="n">release</span> <span class="n">of</span> <span class="n">Apache</span> <span class="n">Sling</span>
+</pre></div>
+
+
+<p>ABC version X.Y.Z</p>
+<div class="codehilite"><pre><span class="n">Apache</span> <span class="n">Sling</span> <span class="n">is</span> <span class="n">a</span> <span class="n">web</span> <span class="n">framework</span> <span class="n">that</span> <span class="n">uses</span> <span class="n">a</span> <span class="n">Java</span> <span class="n">Content</span> <span class="n">Repository</span><span class="p">,</span> <span class="n">such</span>
+</pre></div>
+
+
+<p>as Apache Jackrabbit, to store and manage content. Sling applications use
+either scripts or Java servlets, selected based on simple name conventions,
+to process HTTP requests in a RESTful way.</p>
+<div class="codehilite"><pre><span class="o"><<</span><span class="n">insert</span> <span class="n">short</span> <span class="n">description</span> <span class="n">of</span> <span class="n">the</span> <span class="n">sub</span><span class="o">-</span><span class="n">project</span><span class="o">>></span>
+
+<span class="n">http:</span><span class="sr">//s</span><span class="n">ling</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="sr">/site/</span><span class="n">apache</span><span class="o">-</span><span class="n">sling</span><span class="o">-</span><span class="n">ABC</span><span class="o">.</span><span class="n">html</span>
+
+<span class="n">This</span> <span class="n">release</span> <span class="n">is</span> <span class="n">available</span> <span class="n">from</span> <span class="n">http:</span><span class="sr">//s</span><span class="n">ling</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="sr">/site/</span><span class="n">downloads</span><span class="o">.</span><span class="n">cgi</span>
+</pre></div>
+
+
+<p>and Maven:</p>
+<div class="codehilite"><pre><span class="nt"><dependency></span>
+ <span class="nt"><groupId></span>org.apache.sling<span class="nt"></groupId></span>
+ <span class="nt"><artifactId></span>org.apache.sling.ABC<span class="nt"></artifactId></span>
+ <span class="nt"><version></span>X.Y.Z<span class="nt"></version></span>
+<span class="nt"></dependency></span>
+
+Release Notes:
+
+<span class="err"><</span><span class="nt"><insert</span> <span class="err">release</span> <span class="err">notes</span> <span class="err">in</span> <span class="err">text</span> <span class="err">format</span> <span class="err">from</span> <span class="err">JIRA</span><span class="nt">></span>>
+
+Enjoy!
+
+-The Sling team
+</pre></div>
+
+
+<p><em>Important</em>: Add the release to the Software section of the next board
+report below <a href="https://cwiki.apache.org/confluence/display/SLING/Reports">Reports</a>
+.</p>
+<p><a name="ReleaseManagement-RelatedLinks"></a></p>
+<h2 id="related-links">Related Links</h2>
+<ol>
+<li><a href="http://www.apache.org/dev/release-signing.html">http://www.apache.org/dev/release-signing.html</a></li>
+<li><a href="http://wiki.apache.org/incubator/SigningReleases">http://wiki.apache.org/incubator/SigningReleases</a></li>
+</ol>
+<p><a name="ReleaseManagement-AppendixA:CreateandAddyourkeyto<a href="http://www.apache.org/dist/sling/KEYS">http://www.apache.org/dist/sling/KEYS</a>"></a></p>
+<h2 id="appendix-a-create-and-add-your-key-to-httpwwwapacheorgdistslingkeys">Appendix A: Create and Add your key to [http://www.apache.org/dist/sling/KEYS]</h2>
+<p>Considering that you are using a *nix system with a working OpenSSH,
+GnuPG, and bash you can create and add your own key with the following
+command:</p>
+<ol>
+<li>
+<p><em>Create a public/private pair key</em>:</p>
+<p>$ gpg --gen-key</p>
+</li>
+</ol>
+<p>When gpg asks for e-mail linked the key you <em>MUST USE</em> the
+<committer>@apache.org one
+When gpg asks for comment linked the key you <em>SHOULD USE</em> "CODE SIGNING
+KEY"
+1. <em>Add the key to</em> <a href="http://www.apache.org/dist/sling/KEYS:">http://www.apache.org/dist/sling/KEYS:</a>
+ type the following command replacing the word e-mail with your Apache's
+one (<committer>@apache.org).</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="err">(</span><span class="nv">gpg</span> <span class="o">--</span><span class="n">list</span><span class="o">-</span><span class="n">sigs</span> <span class="n">e</span><span class="o">-</span><span class="n">mail</span> <span class="o">&&</span> <span class="n">gpg</span> <span class="o">--</span><span class="n">export</span> <span class="o">--</span><span class="n">armor</span> <span class="n">e</span><span class="o">-</span><span class="n">mail</span><span class="p">)</span> <span class="o">></span> <span class="n">toadd</span><span class="o">.</span><span class="n">key</span>
+<span class="nv">$</span> <span class="nv">scp</span> <span class="n">toadd</span><span class="o">.</span><span class="n">key</span> <span class="n">people</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org:</span>
+<span class="nv">$</span> <span class="nv">ssh</span> <span class="n">people</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span> <span class="err">"</span><span class="n">cat</span> <span class="n">toadd</span><span class="o">.</span><span class="n">key</span> <span class="o">>></span>
+</pre></div>
+
+
+<p>/x1/www/www.apache.org/dist/sling/KEYS"</p>
+<ol>
+<li>You are <em>DONE</em>, but to see the changes on <a href="http://www.apache.org/dist/sling/KEYS">http://www.apache.org/dist/sling/KEYS</a>
+ you must wait 2 hours</li>
+</ol>
+<p>You also have to add your public key either on pool.sks-keyservers.net or
+pgp.mit.edu (for the statging repository).</p>
+<p><a name="ReleaseManagement-AppendixB:preparingreleasesonMacOSX"></a></p>
+<h2 id="appendix-b-preparing-releases-on-mac-os-x">Appendix B: preparing releases on Mac OS X</h2>
+<p>When running the <em>mvn release:prepare</em> command on Mac OS X, you might see
+the following error:</p>
+<div class="codehilite"><pre><span class="p">[</span><span class="n">INFO</span><span class="p">]</span>
+</pre></div>
+
+
+<p>Working directory: /homedir/dev/sling/dependencymanager
+ [INFO]</p>
+<hr />
+<div class="codehilite"><pre><span class="p">[</span><span class="n">ERROR</span><span class="p">]</span>
+</pre></div>
+
+
+<p>BUILD FAILURE
+ [INFO]</p>
+<hr />
+<div class="codehilite"><pre><span class="p">[</span><span class="n">INFO</span><span class="p">]</span>
+</pre></div>
+
+
+<p>Unable to commit files
+ Provider message:
+ The svn command failed.
+ Command output:
+ svn: Commit failed (details follow):
+ svn: MKACTIVITY of
+'/repos/asf/!svn/act/4f11ad5d-9161-0410-b4dd-cb727141ea8c': authorization
+failed (https://svn.apache.org){code}</p>
+<div class="codehilite"><pre><span class="n">This</span> <span class="n">is</span> <span class="n">due</span> <span class="n">to</span> <span class="n">a</span> <span class="n">bug</span> <span class="n">in</span> <span class="n">Subversion</span> <span class="n">on</span> <span class="n">the</span> <span class="n">Mac</span><span class="p">,</span> <span class="n">as</span> <span class="n">described</span> <span class="n">by</span> <span class="n">Brett</span> <span class="n">Porter</span>
+</pre></div>
+
+
+<p>in his [blog|http://blogs.exist.com/bporter/2008/02/25/working-around-non-interactive-problems-in-leopards-subversion/]
+. He proposes putting an "svn" script at the head of your path to fix the
+issue.</p>
+<div class="codehilite"><pre><span class="n">h2</span><span class="o">.</span> <span class="n">Appendix</span> <span class="n">C:</span> <span class="n">Deploy</span> <span class="n">bundles</span> <span class="n">on</span> <span class="n">the</span> <span class="n">Sling</span> <span class="n">OBR</span>
+
+<span class="n">We</span> <span class="n">are</span> <span class="n">mainting</span> <span class="n">an</span> <span class="n">OSGi</span> <span class="n">Bundle</span> <span class="n">Repository</span> <span class="n">providing</span> <span class="n">all</span> <span class="n">release</span> <span class="n">of</span> <span class="n">the</span>
+</pre></div>
+
+
+<p>Sling Bundles. This repository is maintained as part of the Apache Sling
+site and is available at [http://sling.apache.org/obr/sling.xml]
+. The source for this page is maintained in the SVN repository below the
+<em>site</em>, that is at [http://svn.apache.org/repos/asf/sling/site/]
+. To update the Sling OBR repository you must be an Apache Sling Committer
+since this requires SVN write access.</p>
+<div class="codehilite"><pre><span class="n">To</span> <span class="n">update</span> <span class="n">the</span> <span class="n">OBR</span> <span class="n">you</span> <span class="n">may</span> <span class="k">use</span> <span class="n">the</span> <span class="n">Apache</span> <span class="n">Felix</span> <span class="n">Maven</span> <span class="n">Bundle</span> <span class="n">Plugin</span> <span class="n">which</span>
+</pre></div>
+
+
+<p>prepares the bundle descriptor to be added to the OBR file. Follow these
+steps to update the OBR:</p>
+<div class="codehilite"><pre><span class="o">*</span><span class="mi">1</span><span class="o">.</span> <span class="n">Checkout</span> <span class="ow">or</span> <span class="n">update</span> <span class="n">the</span> <span class="n">Site</span> <span class="n">Source</span><span class="o">*</span>
+</pre></div>
+
+
+<p>$ svn checkout https://svn.apache.org/repos/asf/sling/site</p>
+<div class="codehilite"><pre><span class="n">Note</span><span class="p">,</span> <span class="n">that</span> <span class="n">you</span> <span class="n">have</span> <span class="n">to</span> <span class="n">checkout</span> <span class="n">the</span> <span class="n">site</span> <span class="n">using</span> <span class="n">the</span> <span class="p">{{</span><span class="n">https</span><span class="p">}}</span> <span class="n">URL</span><span class="p">,</span> <span class="n">otherwise</span>
+</pre></div>
+
+
+<p>you will not be able to commit the changes later.</p>
+<div class="codehilite"><pre><span class="o">*</span><span class="mi">2</span><span class="o">.</span> <span class="n">Deploy</span> <span class="n">the</span> <span class="n">Descriptor</span><span class="o">*</span>
+
+<span class="n">To</span> <span class="n">deploy</span> <span class="n">the</span> <span class="n">project</span> <span class="n">descriptor</span><span class="p">,</span> <span class="n">checkout</span> <span class="n">the</span> <span class="n">tag</span> <span class="n">of</span> <span class="n">the</span> <span class="n">bundle</span> <span class="n">to</span> <span class="n">deploy</span>
+</pre></div>
+
+
+<p>and run maven</p>
+<p>$ svn checkout http://svn.apache.org/repos/asf/sling/tags/the_module_tag
+$ mvn clean install \
+ org.apache.felix:maven-bundle-plugin:deploy \
+ -DprefixUrl=http://repo1.maven.org/maven2 \
+ -DremoteOBR=sling.xml \</p>
+<p>-DaltDeploymentRepository=apache.releases::default::file:///path_to_site_checkout/obr</p>
+<div class="codehilite"><pre><span class="n">This</span> <span class="n">generates</span> <span class="n">the</span> <span class="n">bundle</span> <span class="n">descriptor</span> <span class="ow">and</span> <span class="n">adds</span> <span class="n">it</span> <span class="n">to</span> <span class="n">the</span> <span class="p">{{</span><span class="n">sling</span><span class="o">.</span><span class="n">xml</span><span class="p">}}</span> <span class="n">file</span>
+</pre></div>
+
+
+<p>of your site checkout.</p>
+<div class="codehilite"><pre><span class="o">*</span><span class="mi">2</span><span class="n">a</span><span class="o">.</span> <span class="n">Variant:</span> <span class="n">Refer</span> <span class="n">to</span> <span class="n">Maven</span> <span class="n">Repository</span><span class="o">*</span>
+
+<span class="n">Instead</span> <span class="n">of</span> <span class="n">checking</span> <span class="n">out</span> <span class="ow">and</span> <span class="n">building</span> <span class="n">the</span> <span class="n">project</span> <span class="n">locally</span><span class="p">,</span> <span class="n">you</span> <span class="n">may</span> <span class="n">also</span> <span class="k">use</span>
+</pre></div>
+
+
+<p>the {{deploy-file}} goal of the Maven Bundle Plugin:</p>
+<p>$ wget
+http://repo1.maven.org/maven2/org/apache/sling/the_module/version/the_module-version.jar
+$ wget
+http://repo1.maven.org/maven2/org/apache/sling/the_module/version/the_module-version.pom
+$ mvn org.apache.felix:maven-bundle-plugin:deploy-file \
+ -Dfile=the_module-version.jar -DpomFile=the_module-version.pom \</p>
+<p>-DbundleUrl=http://repo1.maven.org/maven2/org/apache/sling/the_module/version/the_module-version.jar
+\
+ -Durl=file:///path_to_site_checkout/obr \
+ -DprefixUrl=http://repo1.maven.org/maven2 \
+ -DremoteOBR=sling.xml
+$ rm the_module-version.jar the_module-version.pom</p>
+<div class="codehilite"><pre><span class="o">*</span><span class="mi">3</span><span class="o">.</span> <span class="n">Commite</span> <span class="n">the</span> <span class="n">Site</span> <span class="n">Changes</span><span class="o">*</span>
+
+<span class="n">In</span> <span class="n">the</span> <span class="n">Site</span> <span class="n">checkout</span> <span class="n">folder</span> <span class="n">commit</span> <span class="n">the</span> <span class="n">changes</span> <span class="n">to</span> <span class="n">the</span> <span class="p">{{</span><span class="n">obr</span><span class="o">/</span><span class="n">sling</span><span class="o">.</span><span class="n">xml</span><span class="p">}}</span>
+</pre></div>
+
+
+<p>files (you may also review the changes using the {{svn diff}} command).</p>
+<p>$ svn commit -m"Add Bundle ABC Version X.Y.Z" obr/sling.xml</p>
+<div class="codehilite"><pre><span class="o">*</span><span class="mi">4</span><span class="o">.</span> <span class="n">Update</span> <span class="n">the</span> <span class="n">Site</span> <span class="n">on</span><span class="o">*</span> <span class="p">{{{</span><span class="o">*</span><span class="p">}</span><span class="n">people</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="p">{</span><span class="o">*</span><span class="p">}}}</span>
+
+<span class="n">After</span> <span class="n">committing</span> <span class="n">the</span> <span class="n">changes</span><span class="p">,</span> <span class="n">you</span> <span class="n">have</span> <span class="n">to</span> <span class="n">update</span> <span class="n">the</span> <span class="n">site</span> <span class="n">source</span><span class="p">,</span> <span class="n">which</span> <span class="n">is</span>
+</pre></div>
+
+
+<p>getting mirrored to the web servers on {{people.apache.org}}</p>
+<p>$ ssh people.apache.org svn update /x1/www/sling.apache.org/obr/sling.xml</p>
+<div class="codehilite"><pre><span class="n">After</span> <span class="n">updating</span> <span class="n">the</span> <span class="n">site</span> <span class="n">source</span> <span class="n">it</span> <span class="n">will</span> <span class="n">generally</span> <span class="n">take</span> <span class="n">an</span> <span class="n">hour</span> <span class="ow">or</span> <span class="n">two</span> <span class="k">until</span>
+</pre></div>
+
+
+<p>the changes are visible on the web.</p>
+ </div>
+ </div>
+
+ <div class="trademarkFooter">
+ Apache Sling, Sling, Apache, the Apache feather logo, and the Apache Sling project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
+ </div>
+ </body>
+</html>
Added: websites/staging/sling/trunk/content/repository-based-development.html
==============================================================================
--- websites/staging/sling/trunk/content/repository-based-development.html (added)
+++ websites/staging/sling/trunk/content/repository-based-development.html Sun Apr 22 16:52:28 2012
@@ -0,0 +1,229 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<!--
+
+ 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.
+-->
+ <head>
+ <title>Apache Sling - Repository Based Development</title>
+ <link rel="stylesheet" href="http://sling.apache.org/site/media.data/site.css" type="text/css" media="all">
+ <link rel="icon" href="http://sling.apache.org/site/media.data/favicon.ico">
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+ </head>
+ <body>
+ <div class="title">
+ <div class="logo">
+ <a href="http://sling.apache.org/site/index.html">
+ <img border="0" alt="Apache Sling" src="http://sling.apache.org/site/media.data/logo.png">
+ </a>
+ </div>
+ <div class="header">
+ <a href="http://www.apache.org/">
+ <img border="0" alt="Apache" src="http://sling.apache.org/site/media.data/apache.png">
+ </a>
+ </div>
+ </div>
+
+ <div class="menu">
+ <h1 id="documentation">Documentation</h1>
+<ul>
+<li><a href="getting-started.html">Getting Started</a></li>
+<li><a href="the-sling-engine.html">The Sling Engine</a></li>
+<li><a href="development.html">Development</a></li>
+<li><a href="bundles.html">Bundles</a></li>
+<li><a href="tutorials-&-how-tos.html">Tutorials & How-Tos</a></li>
+<li><a href="configuration.html">Configuration</a></li>
+<li><a href="http://sling.apache.org/apidocs/sling5/index.html">API docs</a></li>
+<li><a href="http://s.apache.org/sling.wiki">Wiki</a></li>
+<li><a href="http://s.apache.org/sling.faq">FAQ</a></li>
+</ul>
+<h1 id="project-info">Project info</h1>
+<ul>
+<li><a href="http://sling.apache.org/site/downloads.cgi">Downloads</a></li>
+<li><a href="http://www.apache.org/licenses/">License</a></li>
+<li><a href="contributing.html">Contributing</a></li>
+<li><a href="news.html">News</a></li>
+<li><a href="links.html">Links</a></li>
+<li><a href="project-information.html">Project Information</a></li>
+<li><a href="https://issues.apache.org/jira/browse/SLING">Issue Tracker</a></li>
+<li><a href="http://svn.apache.org/viewvc/sling/trunk">Browse Source Repository</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+<h1 id="sponsorship">Sponsorship</h1>
+<ul>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/foundation/buy_stuff.html">Buy Stuff</a></li>
+</ul>
+<iframe
+ src="http://www.apache.org/ads/button.html"
+ style="border-width:0; float: left" frameborder="0"
+ scrolling="no"
+ width="135"
+ height="135">
+</iframe>
+ </div>
+
+ <div class="main">
+ <div class="breadcrump" style="font-size: 80%;">
+ (TODO: breadcrumb here)
+ </div>
+ <h1 class="title">Repository Based Development</h1>
+ <div>
+ <p><a name="RepositoryBasedDevelopment-RepositoryBasedDevelopment"></a></p>
+<h1 id="repository-based-development">Repository Based Development</h1>
+<p>{toc:minLevel=2|maxLevel=3}</p>
+<p><a name="RepositoryBasedDevelopment-WebDAVSupport"></a></p>
+<h2 id="webdav-support">WebDAV Support</h2>
+<p>WebDAV support in Sling is based on the <a href="http://jackrabbit.apache.org/doc/components/jcr-server.html">Simple WebDAV</a>
+ implementation of Apache Jackrabbit which is integrated in the
+<em>jcr/webdav</em> project. This bundle provides WebDAV access to Sling's
+repository in two flavours: (1) Access to all workspaces of the repository
+on a separate URL space -- by default rooted at <em>/dav</em> in the Sling
+context -- and (2) access to the workspace used by Sling itself at the root
+of the Sling context.</p>
+<p><a name="RepositoryBasedDevelopment-Example"></a></p>
+<h4 id="example">Example</h4>
+<p>Consider Sling be installed on a Servlet container in the <em>/sling</em>
+context on <em>some.host.net:8080</em>. Here you would access the Sling
+workspace by directing your WebDAV client to the URL
+<em>http://some.host.net:8080/sling</em>. To access the <em>sample</em> workspace,
+which is not used by Sling itself, you would direct your WebDAV client to
+the URL <em>http://some.host.net:8080/sling/dav/sample</em>.</p>
+<p>Please note that accessing the repository in the separate URI space is
+actually faster, since requests do not pass the Sling resource and script
+resolution framework but instead hit the Jackrabbit Simple WebDAV Servlet
+directly.</p>
+<p><a name="RepositoryBasedDevelopment-SeparateURISpaceWebDAV"></a></p>
+<h4 id="separate-uri-space-webdav">Separate URI Space WebDAV</h4>
+<p>When accessing the repository through WebDAV in its separate URI Space, the
+URLs have the following generic structure:</p>
+<p>{panel}
+slingroot/prefix/workspace/item
+{panel}</p>
+<ul>
+<li><strong>slingroot</strong> is the URL of the Sling web application context. In
+the above example, this would <em>http://some.host.net:8080/sling</em>.</li>
+<li><strong>prefix</strong> is the URL prefix to address the WebDAV servlet. By
+default this is set to <em>/dav</em> but may be configured to any valid path.</li>
+<li><strong>workspace</strong> is the name of the workspace to be accessed through
+WebDAV.</li>
+<li><strong>item</strong> is the path to the JCR Item to access.</li>
+</ul>
+<p>If you access the WebDAV server at the prefix path -- e.g.
+<em>!http://localhost:8080/dav</em> -- you will be redirected to the default
+workspace with a temporary redirect status 302. Some clients, such as the
+Linux <em>davfs</em>, do not like this redirection and must be configured to
+explicitly address the default workspace.</p>
+<p><a name="RepositoryBasedDevelopment-Configuration"></a></p>
+<h3 id="configuration">Configuration</h3>
+<p>The Jackrabbit Simple WebDAV support in Sling has the following
+configuration options:</p>
+<table>
+<tr><th> Property </th><th> Default </th><th> Description </th></tr>
+<tr><td> Root Path </td><td> */dav* </td><td> The root path at which the Simple WebDAV Servlet
+is accessible. Access to the repository is provided in two ways. You may
+connect your WebDAV client directly to the root of the Sling web
+application to access the workspace of Sling directly. The other way is
+required if you want to connect your WebDAV client to any other workspace
+besides the Sling workspace. In this case you connect your WebDAV client to
+another a path comprised of this root path plus the name of the workspace.
+For example to connect to the *some_other* workspace, you might connect
+to *http://slinghost/dav/some_other*. </td></tr>
+<tr><td> Authentication Realm </td><td> *Sling WebDAV* </td><td> The name of the HTTP Basic
+Authentication Realm presented to the client to ask for authentication
+credentials to access the repository. </td></tr>
+<tr><td> Non Collection Node Typee </td><td> [ *nt:file*, *nt:resource* ](-*nt:file*,-*nt:resource*-.html)
+ </td><td> The JCR Node Types considered being non-collection resouces by WebDAV.
+Any node replying *true* to *Node.isNodeType()* for one of the listed
+types is considered a non-collection resource. Otherwise the respective
+node is considered a colleciton resource. </td></tr>
+<tr><td> Filter Prefixes </td><td> [ *jcr*, *rep* ](-*jcr*,-*rep*-.html)
+ </td><td> A list of namespace prefixes indicating JCR items filtered from being
+reported as collection members or properties. The default list includes jcr
+and rep (Jackrabbit internal namespace prefix) items. Do not modify this
+setting unless you know exactly what you are doing. </td></tr>
+<tr><td> Filter Node Types </td><td> -- </td><td> Nodetype names to be used to filter child nodes.
+A child node can be filtered if the declaring nodetype of its definition is
+one of the nodetype names specified in the nodetypes Element. E.g. defining
+rep:root as filtered nodetype whould result in jcr:system being hidden but
+no other child node of the root node, since those are defined by the
+nodetype nt:unstructered. The default is empty. Do not modify this setting
+unless you know exactly what you are doing. </td></tr>
+<tr><td> Filter URIs </td><td> -- </td><td> A list of namespace URIs indicating JCR items filtered
+from being reported as collection members or properties. The default list
+is empty. Do not modify this setting unless you know exactly what you are
+doing. </td></tr>
+<tr><td> Collection Primary Type </td><td> *sling:Folder* </td><td> The JCR Primary Node Type to
+assign to nodes created to reflect WebDAV collections. You may name any
+primary node type here, provided it allows the creation of nodex of this
+type and the defined Non-Collection Primary Type below it. </td></tr>
+<tr><td> Non-Collection Primary Type </td><td> *nt:file* </td><td> The JCR Primary Node Type to
+assign to nodes created to reflect WebDAV non-collection resources. You may
+name any primary node type here, provided the node type is allowed to be
+created below nodes of the type defined for the Collection Primary Type and
+that a child node with the name "jcr:content" may be created below the
+non-collection resource whose type is defined by the Content Primary Type.
+</td></tr>
+<tr><td> Content Primary Type </td><td> *nt:resource* </td><td> The JCR Primary Node Type to
+assign to the jcr:content child node of a WebDAV non-collection resource.
+You may name any primary node type here, provided the node type is allowed
+to be created as the jcr:content child node of the node type defined by the
+Non-Collection Primary Type. In addition the node type must allow at least
+the following properties: jcr:data (binary), jcr:lastModified (date), and
+jcr:mimeType (string). </td></tr>
+</table>
+
+<p><a name="RepositoryBasedDevelopment-AdvancedTechnicalDetails"></a></p>
+<h4 id="advanced-technical-details">Advanced Technical Details</h4>
+<p>Since the Jackrabbit Simple WebDAV Servlet is originally configured using
+an XML configuration file, which provides a great deal of flexibility, the
+integration into Sling had to assume some simplifications, of which some of
+the above parameters are part:</p>
+<p><em>IOManager</em></p>
+<p>This implementation uses the standard
+<em>org.apache.jackrabbit.server.io.IOManagerImpl</em> class and adds the
+<em>org.apache.jackrabbit.server.io.DirListingExportHandler</em> and
+<em>org.apache.jackrabbit.server.io.DefaultHandler</em> IO handlers as its only
+handlers. The <em>DefaultHandler</em> is configured from the three node types
+listed as configuration parameters above (collection, non-collection, and
+content primary node types).</p>
+<p><em>PropertyManager</em></p>
+<p>This implementation uses the standard
+<em>org.apache.jackrabbit.server.io.PropertyManagerImpl</em> and adds the same
+<em>DirListingExportHandler</em> and <em>DefaultHanlder</em> instances as its own
+handlers as are used by the IO Manager.</p>
+<p><em>ItemFilter</em></p>
+<p>This implementation uses the standard
+<em>org.apache.jackrabbit.webdav.simple.DefaultItemFilter</em> implementation as
+its item filter and configures the filter with the namespace prefixes and
+URIs as well as the node types configured as parameters.</p>
+<p><em>Collection Node Types</em></p>
+<p>This implementation only supports listing node types which are considered
+representing non-collection resources. All nodes which are instances of any
+of the configured node types are considered non-collection resources. All
+other nodes are considere collection resources.</p>
+<p><a name="RepositoryBasedDevelopment-EclipsepluginforJCR"></a></p>
+<h2 id="eclipse-plugin-for-jcr">Eclipse plugin for JCR</h2>
+<p>TBD</p>
+ </div>
+ </div>
+
+ <div class="trademarkFooter">
+ Apache Sling, Sling, Apache, the Apache feather logo, and the Apache Sling project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
+ </div>
+ </body>
+</html>
Added: websites/staging/sling/trunk/content/request-listeners.html
==============================================================================
--- websites/staging/sling/trunk/content/request-listeners.html (added)
+++ websites/staging/sling/trunk/content/request-listeners.html Sun Apr 22 16:52:28 2012
@@ -0,0 +1,130 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<!--
+
+ 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.
+-->
+ <head>
+ <title>Apache Sling - Request Listeners</title>
+ <link rel="stylesheet" href="http://sling.apache.org/site/media.data/site.css" type="text/css" media="all">
+ <link rel="icon" href="http://sling.apache.org/site/media.data/favicon.ico">
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+ </head>
+ <body>
+ <div class="title">
+ <div class="logo">
+ <a href="http://sling.apache.org/site/index.html">
+ <img border="0" alt="Apache Sling" src="http://sling.apache.org/site/media.data/logo.png">
+ </a>
+ </div>
+ <div class="header">
+ <a href="http://www.apache.org/">
+ <img border="0" alt="Apache" src="http://sling.apache.org/site/media.data/apache.png">
+ </a>
+ </div>
+ </div>
+
+ <div class="menu">
+ <h1 id="documentation">Documentation</h1>
+<ul>
+<li><a href="getting-started.html">Getting Started</a></li>
+<li><a href="the-sling-engine.html">The Sling Engine</a></li>
+<li><a href="development.html">Development</a></li>
+<li><a href="bundles.html">Bundles</a></li>
+<li><a href="tutorials-&-how-tos.html">Tutorials & How-Tos</a></li>
+<li><a href="configuration.html">Configuration</a></li>
+<li><a href="http://sling.apache.org/apidocs/sling5/index.html">API docs</a></li>
+<li><a href="http://s.apache.org/sling.wiki">Wiki</a></li>
+<li><a href="http://s.apache.org/sling.faq">FAQ</a></li>
+</ul>
+<h1 id="project-info">Project info</h1>
+<ul>
+<li><a href="http://sling.apache.org/site/downloads.cgi">Downloads</a></li>
+<li><a href="http://www.apache.org/licenses/">License</a></li>
+<li><a href="contributing.html">Contributing</a></li>
+<li><a href="news.html">News</a></li>
+<li><a href="links.html">Links</a></li>
+<li><a href="project-information.html">Project Information</a></li>
+<li><a href="https://issues.apache.org/jira/browse/SLING">Issue Tracker</a></li>
+<li><a href="http://svn.apache.org/viewvc/sling/trunk">Browse Source Repository</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+<h1 id="sponsorship">Sponsorship</h1>
+<ul>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/foundation/buy_stuff.html">Buy Stuff</a></li>
+</ul>
+<iframe
+ src="http://www.apache.org/ads/button.html"
+ style="border-width:0; float: left" frameborder="0"
+ scrolling="no"
+ width="135"
+ height="135">
+</iframe>
+ </div>
+
+ <div class="main">
+ <div class="breadcrump" style="font-size: 80%;">
+ (TODO: breadcrumb here)
+ </div>
+ <h1 class="title">Request Listeners</h1>
+ <div>
+ <p><a name="RequestListeners-RequestListenersupport"></a></p>
+<h1 id="request-listener-support">Request Listener support</h1>
+<p>Sling provides the possibility to "listen" to a request processed by the
+Sling Engine (<em>SlingMainServlet</em>). To get notified you implement the
+service interface <em>org.apache.sling.api.request.SlingRequestListener</em>.</p>
+<p><DIV class="code panel" style="border-style: solid;border-width: 1px;"><DIV class="codeHeader panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;"><B>SlingRequestListener</B></DIV><DIV class="codeContent panelContent">
+ public interface SlingRequestListener {</p>
+<div class="codehilite"><pre> <span class="n">static</span> <span class="n">final</span> <span class="n">String</span> <span class="n">SERVICE_NAME</span> <span class="o">=</span>
+</pre></div>
+
+
+<p>"org.apache.sling.api.request.SlingRequestListener"; </p>
+<div class="codehilite"><pre> /**
+ * This method is called from the Sling application for every
+ * <span class="nt"><code></span>EventType<span class="nt"></code></span> appearing during the dispatching of
+ * a Sling request
+ *
+ * @param sre the object representing the event
+ *
+ * @see org.apache.sling.api.request.SlingRequestEvent.EventType
+ */
+ public void onEvent( SlingRequestEvent sre );
+}
+</pre></div>
+
+
+<p>There are no special properties to set. </p>
+<p><a name="RequestListeners-Supportedtypesofevents"></a></p>
+<h2 id="supported-types-of-events">Supported types of events</h2>
+<p>At the moment you will get two different types of <em>SlingRequestEvent</em>:
+<table>
+<tr><th> events types (<em>SlingRequestEvent.EventType</em>) </th><th> point in time </th></tr>
+<tr><td> EVENT_INIT </td><td> after entering the <em>service</em> method in
+<em>SlingMainServlet</em>. Note that this will be <em>after</em> the <em>handleSecurity</em>
+call. </td></tr>
+<tr><td> EVENT_DESTROY </td><td> at the end of the <em>service</em> method in
+<em>SlingMainServlet</em> </td></tr></p>
+ </div>
+ </div>
+
+ <div class="trademarkFooter">
+ Apache Sling, Sling, Apache, the Apache feather logo, and the Apache Sling project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
+ </div>
+ </body>
+</html>
Added: websites/staging/sling/trunk/content/request-parameters.html
==============================================================================
--- websites/staging/sling/trunk/content/request-parameters.html (added)
+++ websites/staging/sling/trunk/content/request-parameters.html Sun Apr 22 16:52:28 2012
@@ -0,0 +1,213 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<!--
+
+ 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.
+-->
+ <head>
+ <title>Apache Sling - Request Parameters</title>
+ <link rel="stylesheet" href="http://sling.apache.org/site/media.data/site.css" type="text/css" media="all">
+ <link rel="icon" href="http://sling.apache.org/site/media.data/favicon.ico">
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+ </head>
+ <body>
+ <div class="title">
+ <div class="logo">
+ <a href="http://sling.apache.org/site/index.html">
+ <img border="0" alt="Apache Sling" src="http://sling.apache.org/site/media.data/logo.png">
+ </a>
+ </div>
+ <div class="header">
+ <a href="http://www.apache.org/">
+ <img border="0" alt="Apache" src="http://sling.apache.org/site/media.data/apache.png">
+ </a>
+ </div>
+ </div>
+
+ <div class="menu">
+ <h1 id="documentation">Documentation</h1>
+<ul>
+<li><a href="getting-started.html">Getting Started</a></li>
+<li><a href="the-sling-engine.html">The Sling Engine</a></li>
+<li><a href="development.html">Development</a></li>
+<li><a href="bundles.html">Bundles</a></li>
+<li><a href="tutorials-&-how-tos.html">Tutorials & How-Tos</a></li>
+<li><a href="configuration.html">Configuration</a></li>
+<li><a href="http://sling.apache.org/apidocs/sling5/index.html">API docs</a></li>
+<li><a href="http://s.apache.org/sling.wiki">Wiki</a></li>
+<li><a href="http://s.apache.org/sling.faq">FAQ</a></li>
+</ul>
+<h1 id="project-info">Project info</h1>
+<ul>
+<li><a href="http://sling.apache.org/site/downloads.cgi">Downloads</a></li>
+<li><a href="http://www.apache.org/licenses/">License</a></li>
+<li><a href="contributing.html">Contributing</a></li>
+<li><a href="news.html">News</a></li>
+<li><a href="links.html">Links</a></li>
+<li><a href="project-information.html">Project Information</a></li>
+<li><a href="https://issues.apache.org/jira/browse/SLING">Issue Tracker</a></li>
+<li><a href="http://svn.apache.org/viewvc/sling/trunk">Browse Source Repository</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+<h1 id="sponsorship">Sponsorship</h1>
+<ul>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/foundation/buy_stuff.html">Buy Stuff</a></li>
+</ul>
+<iframe
+ src="http://www.apache.org/ads/button.html"
+ style="border-width:0; float: left" frameborder="0"
+ scrolling="no"
+ width="135"
+ height="135">
+</iframe>
+ </div>
+
+ <div class="main">
+ <div class="breadcrump" style="font-size: 80%;">
+ (TODO: breadcrumb here)
+ </div>
+ <h1 class="title">Request Parameters</h1>
+ <div>
+ <p><a name="RequestParameters-RequestParameterHandlinginSling"></a></p>
+<h1 id="request-parameter-handling-in-sling">Request Parameter Handling in Sling</h1>
+<p>{excerpt:hidden=true}Explains how Sling provides request parameters to the
+<em>Component</em>.{excerpt}</p>
+<p><a name="RequestParameters-ServletAPI"></a></p>
+<h2 id="servlet-api">Servlet API</h2>
+<p>The Servlet API specification provides the following methods to access the
+parameters of a request</p>
+<table>
+<tr><td> *HttpServletRequest.getQueryString()* </td><td> Returns the query part of the
+request URL </td></tr>
+<tr><td> *ServletRequest.getParameter(String)* </td><td> Returns the (first) named
+parameter </td></tr>
+<tr><td> *ServletRequest.getParameterValues(String)* </td><td> Returns all parameters of
+that name </td></tr>
+<tr><td> *ServletRequest.getParameterMap()* </td><td> Returns all parameters as a map of {{String[](.html)
+}} </td></tr>
+<tr><td> *ServletRequest.getParameterNames()* </td><td> Returns an enumeration of the
+names of the parameters </td></tr>
+</table>
+
+<p>As a special restriction only two kinds of parameters are supported: (1)
+Query String parameters and (2) parameters contained in the request data of
+content type <em>application/x-www-form-encoded</em>. That is file uploads using
+request data of type <em>multipart/form-data</em> are not directly supported by
+the servlet specification. Finally the actual encoding of the parameters is
+all but safe because the encoding of URLs is not very well defined and
+browsers do not set the character encoding when sending post data.
+Fortunately, they use the same character encoding for sending back form
+content as was used by the server to send the form.</p>
+<p><a name="RequestParameters-SlingAPI"></a></p>
+<h2 id="sling-api">Sling API</h2>
+<p>To overcome these restrictions and to provide uniform access to request
+parameters the Sling API in addition to the Servlet API methods to access
+parameters provides an abstraction of parameters which is applicable to all
+parameters sent by clients, the <em>RequestParameter</em> interface. Through
+this interface, each parameter may be analyzed for these topics:</p>
+<table>
+<tr><td> Raw Content </td><td> Byte array and *InputStream* representation of the
+request parameter values. You will generally use the *InputStream* to
+handle uploaded files. </td></tr>
+<tr><td> String Content </td><td> Access the values as strings is some given encoding (see
+below) or by requesting the conversion using an explicit encoding. </td></tr>
+<tr><td> File Uploads </td><td> Find out whether a parameter is a file upload, get the
+size in bytes of the parameter value and client side file name as sent by
+the browser. </td></tr>
+</table>
+
+<p>To accomodate this new interface as well as to provide easy access in the
+traditional way the <em>SlingHttpServletRequest</em> interface adds following
+methods to the standard Servlet API parameter access methods:</p>
+<table>
+<tr><td> *getRequestParameter(String)* </td><td> Returns the (first) named parameter as
+a *RequestParameter* instance </td></tr>
+<tr><td> *getRequestParameters(String)* </td><td> Returns the named parameter as an
+array of *RequestParameter* instances </td></tr>
+<tr><td> *getRequestParameterMap()* </td><td> Returns *RequestParameterMap* being a
+map of *RequestParameter* arrays indexed by parameter names </td></tr>
+</table>
+
+<p>All parameters are handled the same, that is all methods give access to the
+same parameters regardless of whether the parameters were transmitted in
+the request query, as part of form encoded data or as part of a
+<em>multipart/form-data</em> request.</p>
+<p>As of Sling Engine 2.1.0 the order or request parameters in the
+<em>getRequestParameterMap()</em>, <em>getParameterMap()</em>, and
+<em>getParameterNams()</em> is preserved as follows:</p>
+<ul>
+<li>The first entries are the parameters reported by the servlet container.
+The order of these parameters amongst each other is not defined. The
+<em>SlingHttpServletRequest</em> provides them in the same order as provided by
+the servlet container.</li>
+<li>After the servlet container provided parameters are parameters extracted from the request in case <em>multipart/form-data</em> POST requests. The order of these parameters is preserved as they are submitted in the request. This conforms to HTML 4.01 spec on forms submitted with multipart/form-data encoding: <em>A "multipart/form-data" message contains a series of parts, each representing a successful control. The parts are sent to the processing agent in the same order the corresponding controls appear in the document stream. Part boundaries should not occur in any of the data; how this is done lies outside the scope of this specification</em> (<a href="http://www.w3.org/TR/html401/interact/forms.html">17.13.4 Form content types</a>
+)</li>
+</ul>
+<p>Be warned: Only rely on request parameter ordering <em>multipart/form-data</em>
+POST requests without a query part in the request URL.</p>
+<p><a name="RequestParameters-CharacterEncoding"></a></p>
+<h2 id="character-encoding">Character Encoding</h2>
+<p>Traditionally, the encoding of parameters, especially in text area input
+forms, has been a big issue. To solve this issue Sling introduces the
+following convention:</p>
+<ul>
+<li>All forms should contain a hidden field of the name <em>_charset_</em>
+containing the actual encoding used to send the form from the server to the
+client</li>
+<li>All forms should be sent with <em>UTF-8</em> character encoding</li>
+</ul>
+<p>The first rule is essential as it helps decoding the form input correctly.
+The second rule is not actually a very hard requirement but to enable
+support for all (or most) character sets used, using <em>UTF-8</em> is one of the
+best choices anyway.</p>
+<p>When Sling is now receiving a request and is asked for the parameters, the
+parameters are parsed in two phases: The first phase just parses the raw
+input data using an identity transformation of bytes to characters. This
+identity transformation happens to generate strings as the original data
+was generated with <em>ISO-8859-1</em> encoding. The second phase locates the
+<em>_charset_</em> parameter and fixes the character encodings of the
+parameters as follows:</p>
+<ul>
+<li>All names of the parameters are re-encoded</li>
+<li>The parameter values are re-encoded, unless the parameter value is an uploaded file. Actually the parameter (not the files of course) are internally as {{byte<a href=".html"></a>
+}} where the conversion to a string is done on the fly (and yes, the
+conversion using the <em>_charset_</em> character encoding is of course cached
+for performance reasons)</li>
+<li>If the parameter is an uploaded file, the file name is re-encoded on
+the fly when accessed</li>
+</ul>
+<p>{info}
+Up to and including Sling Engine 2.2.2 request parameters are always
+decoded with ISO-8859-1 encoding if the <em>_charset_</em> request parameter
+is missing. As of Sling Engine 2.2.4 the <em>_charset_</em> request parameter
+is optional. As of this version the Sling Main Servlet supports a
+configuration setting which allows to change the default character encoding
+used if the <em>_charset_</em> request parameter is missing. To enable this
+functionality set the <em>sling.default.parameter.encoding</em> parameter of the
+Sling Main Servlet (PID <em>org.apache.sling.engine.impl.SlingMainServlet</em>)
+configuration to the desired encoding, which of course must be supported by
+the actual Java Platform.
+{info}</p>
+ </div>
+ </div>
+
+ <div class="trademarkFooter">
+ Apache Sling, Sling, Apache, the Apache feather logo, and the Apache Sling project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
+ </div>
+ </body>
+</html>