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/05/22 10:25:36 UTC
svn commit: r818658 [1/23] - in /websites/staging/sling/trunk/content: ./
tutorials-how-tos/
Author: buildbot
Date: Tue May 22 08:25:32 2012
New Revision: 818658
Log:
Staging update by buildbot for sling
Added:
websites/staging/sling/trunk/content/accessing-filesystem-resources-extensions-fsresource.html
websites/staging/sling/trunk/content/authentication-actors.html
websites/staging/sling/trunk/content/authentication-authenticationhandler.html
websites/staging/sling/trunk/content/authentication-framework.html
websites/staging/sling/trunk/content/authentication-tasks.html
websites/staging/sling/trunk/content/bundle-resources-extensions-bundleresource.html
websites/staging/sling/trunk/content/content-loading-jcr-contentloader.html
websites/staging/sling/trunk/content/internationalization-support-i18n.html
websites/staging/sling/trunk/content/managing-permissions-jackrabbit-accessmanager.html
websites/staging/sling/trunk/content/managing-users-and-groups-jackrabbit-usermanager.html
websites/staging/sling/trunk/content/manipulating-content-the-slingpostservlet-servlets-post.html
websites/staging/sling/trunk/content/mime-type-support-commons-mime.html
websites/staging/sling/trunk/content/output-rewriting-pipelines-org-apache-sling-rewriter.html
websites/staging/sling/trunk/content/run-modes-org-apache-sling-runmode.html
websites/staging/sling/trunk/content/scheduler-service-commons-scheduler.html
websites/staging/sling/trunk/content/sling-settings-org-apache-sling-settings.html
websites/staging/sling/trunk/content/tutorials-how-tos/
websites/staging/sling/trunk/content/tutorials-how-tos.html
websites/staging/sling/trunk/content/tutorials-how-tos/46-line-blog.html
websites/staging/sling/trunk/content/tutorials-how-tos/getting-resources-and-properties-in-sling.html
websites/staging/sling/trunk/content/tutorials-how-tos/how-to-manage-events-in-sling.html
websites/staging/sling/trunk/content/tutorials-how-tos/installing-and-upgrading-bundles.html
websites/staging/sling/trunk/content/tutorials-how-tos/jackrabbit-persistence.html
websites/staging/sling/trunk/content/tutorials-how-tos/testing-sling-based-applications.html
Removed:
websites/staging/sling/trunk/content/46-line-blog.html
websites/staging/sling/trunk/content/authentication---actors.html
websites/staging/sling/trunk/content/authentication---authenticationhandler.html
websites/staging/sling/trunk/content/authentication---framework.html
websites/staging/sling/trunk/content/authentication---tasks.html
websites/staging/sling/trunk/content/getting-resources-and-properties-in-sling.html
websites/staging/sling/trunk/content/how-to-manage-events-in-sling.html
websites/staging/sling/trunk/content/installing-and-upgrading-bundles.html
websites/staging/sling/trunk/content/jackrabbit-persistence.html
Modified:
websites/staging/sling/trunk/content/ (props changed)
websites/staging/sling/trunk/content/adapters.html
websites/staging/sling/trunk/content/apache-sling-commons-thread-pool.html
websites/staging/sling/trunk/content/apache-sling-community-roles-and-processes.html
websites/staging/sling/trunk/content/apache-sling-eventing-and-job-handling.html
websites/staging/sling/trunk/content/apache-sling.html
websites/staging/sling/trunk/content/architecture.html
websites/staging/sling/trunk/content/assembly.html
websites/staging/sling/trunk/content/authentication.html
websites/staging/sling/trunk/content/bundles.html
websites/staging/sling/trunk/content/client-request-logging.html
websites/staging/sling/trunk/content/commons-html-utilities.html
websites/staging/sling/trunk/content/configuration.html
websites/staging/sling/trunk/content/contributing.html
websites/staging/sling/trunk/content/default-mapping-and-rendering.html
websites/staging/sling/trunk/content/dependency-management.html
websites/staging/sling/trunk/content/development.html
websites/staging/sling/trunk/content/discover-sling-in-15-minutes.html
websites/staging/sling/trunk/content/dispatching-requests.html
websites/staging/sling/trunk/content/documentation.html
websites/staging/sling/trunk/content/downloads.html
websites/staging/sling/trunk/content/embedding-sling.html
websites/staging/sling/trunk/content/errorhandling.html
websites/staging/sling/trunk/content/eventing-and-jobs.html
websites/staging/sling/trunk/content/filters.html
websites/staging/sling/trunk/content/form-based-authenticationhandler.html
websites/staging/sling/trunk/content/getting-and-building-sling.html
websites/staging/sling/trunk/content/getting-started.html
websites/staging/sling/trunk/content/groovy-support.html
websites/staging/sling/trunk/content/guides.html
websites/staging/sling/trunk/content/issue-tracker.html
websites/staging/sling/trunk/content/jcr-installer-provider.html
websites/staging/sling/trunk/content/jspc.html
websites/staging/sling/trunk/content/launch-sling.html
websites/staging/sling/trunk/content/links.html
websites/staging/sling/trunk/content/logging.html
websites/staging/sling/trunk/content/mappings-for-resource-resolution.html
websites/staging/sling/trunk/content/maven-archetypes.html
websites/staging/sling/trunk/content/maven-launchpad-plugin.html
websites/staging/sling/trunk/content/maventipsandtricks.html
websites/staging/sling/trunk/content/media.html
websites/staging/sling/trunk/content/monitoring-requests.html
websites/staging/sling/trunk/content/navigation.html
websites/staging/sling/trunk/content/news.html
websites/staging/sling/trunk/content/old-stuff.html
websites/staging/sling/trunk/content/openid-authenticationhandler.html
websites/staging/sling/trunk/content/osgi-installer.html
websites/staging/sling/trunk/content/plugins.html
websites/staging/sling/trunk/content/project-information.html
websites/staging/sling/trunk/content/project-license.html
websites/staging/sling/trunk/content/project-team.html
websites/staging/sling/trunk/content/release-management.html
websites/staging/sling/trunk/content/repository-based-development.html
websites/staging/sling/trunk/content/request-listeners.html
websites/staging/sling/trunk/content/request-parameters.html
websites/staging/sling/trunk/content/request-processing.html
websites/staging/sling/trunk/content/resources.html
websites/staging/sling/trunk/content/scriptengineintegration.html
websites/staging/sling/trunk/content/security.html
websites/staging/sling/trunk/content/servlet-resolution.html
websites/staging/sling/trunk/content/servlets.html
websites/staging/sling/trunk/content/sitemap.html
websites/staging/sling/trunk/content/sling-api.html
websites/staging/sling/trunk/content/sling-testing-tools.html
websites/staging/sling/trunk/content/sling.html
websites/staging/sling/trunk/content/the-sling-engine.html
websites/staging/sling/trunk/content/the-sling-launchpad.html
websites/staging/sling/trunk/content/url-decomposition.html
websites/staging/sling/trunk/content/version-policy.html
websites/staging/sling/trunk/content/web-console-extensions.html
websites/staging/sling/trunk/content/wiki.html
websites/staging/sling/trunk/content/wrap-or-decorate-resources.html
websites/staging/sling/trunk/content/xslt-processing-pipeline.html
Propchange: websites/staging/sling/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue May 22 08:25:32 2012
@@ -1 +1 @@
-1341343
+1341347
Added: websites/staging/sling/trunk/content/accessing-filesystem-resources-extensions-fsresource.html
==============================================================================
--- websites/staging/sling/trunk/content/accessing-filesystem-resources-extensions-fsresource.html (added)
+++ websites/staging/sling/trunk/content/accessing-filesystem-resources-extensions-fsresource.html Tue May 22 08:25:32 2012
@@ -0,0 +1,128 @@
+<!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 - Accessing Filesystem Resources (extensions.fsresource)</title>
+ <link rel="stylesheet" href="/css/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">
+ <p><strong>Documentation</strong> <br />
+<a href="/getting-started.html">Getting Started</a> <br />
+<a href="/the-sling-engine.html">The Sling Engine</a> <br />
+<a href="/development.html">Development</a> <br />
+<a href="/bundles.html">Bundles</a> <br />
+<a href="/tutorials-how-tos.html">Tutorials & How-Tos</a> <br />
+<a href="/configuration.html">Configuration</a> <br />
+<a href="http://s.apache.org/sling.wiki">Wiki</a> <br />
+<a href="http://s.apache.org/sling.faq">FAQ</a> <br />
+<a href="/sitemap.html">Site Map</a></p>
+<p><strong>API Docs</strong> <br />
+<a href="http://sling.apache.org/apidocs/sling6/index.html">Sling 6</a> <br />
+<a href="http://sling.apache.org/apidocs/sling5/index.html">Sling 5</a> <br />
+</p>
+<p><strong>Project info</strong> <br />
+<a href="http://sling.apache.org/site/downloads.cgi">Downloads</a> <br />
+<a href="http://www.apache.org/licenses/">License</a> <br />
+<a href="/contributing.html">Contributing</a> <br />
+<a href="/news.html">News</a> <br />
+<a href="/links.html">Links</a> <br />
+<a href="/project-information.html">Project Information</a> <br />
+<a href="https://issues.apache.org/jira/browse/SLING">Issue Tracker</a> <br />
+<a href="http://svn.apache.org/viewvc/sling/trunk">Browse Source Repository</a> <br />
+<a href="/security.html">Security</a> <br />
+</p>
+<p><strong>Sponsorship</strong> <br />
+<a href="http://www.apache.org/foundation/thanks.html">Thanks</a> <br />
+<a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a> <br />
+<a href="http://www.apache.org/foundation/buy_stuff.html">Buy Stuff</a> <br />
+</p>
+<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%;">
+ <a href="/">Home</a>
+ </div>
+ <h1>Accessing Filesystem Resources (extensions.fsresource)</h1>
+ <h1 id="accessing-filesystem-resources">Accessing Filesystem Resources</h1>
+<div class="toc">
+<ul>
+<li><a href="#accessing-filesystem-resources">Accessing Filesystem Resources</a><ul>
+<li><a href="#introduction">Introduction</a></li>
+<li><a href="#resource-types">Resource Types</a></li>
+<li><a href="#adapters">Adapters</a></li>
+<li><a href="#configuration">Configuration</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<h2 id="introduction">Introduction</h2>
+<p>The Filesystem Resource Provider provides access to the operating system's filesystem through the Sling <code>ResourceResolver</code>. Multiple locations may be mapped into the resource tree by configuring the filesystem location and the resource tree root path for each location to be mapped.</p>
+<h2 id="resource-types">Resource Types</h2>
+<p>Files and directories are mapped into the resource tree as regular <code>Resource</code> instances whose resource type depends on the actual nature of the mapped filesystem resource:</p>
+<ul>
+<li>Regular files are assigned the <code>nt:file</code> resource type</li>
+<li>Directories are assigned the <code>nt:folder</code> resource type</li>
+</ul>
+<h2 id="adapters">Adapters</h2>
+<p>Filesystem resources extend from Sling's <code>AbstractResource</code> class and thus are adaptable to any type for which an <code>AdapterFactory</code> is registered supporting file system resources. In addition Filesystem Resources support the following adapters natively:</p>
+<ul>
+<li><code>java.io.File</code> -- The Java file object providing access to the filesystem file</li>
+<li><code>java.net.URL</code> -- A valid <code>file://</code> URL to the file. This URL is derived from the <code>java.io.File</code> object by calling the <code>File.toURI().toURL()</code> sequence.</li>
+<li><code>java.io.InputStream</code> -- If the <code>java.io.File</code> can be read from (as per <code>File.canRead()</code> an <code>InputStream</code> to read from the file is returned.</li>
+</ul>
+<h2 id="configuration">Configuration</h2>
+<p>The Filesystem Resource Provider is configured with OSGi Configuration Admin factory configurtions whose factory PID is <code>org.apache.sling.fsprovider.internal.FsResourceProvider</code>. Configuration can be managed using the OSGi Configuration Admin API, through the Web Console or by any other means supporting Configuration Admin configurations.</p>
+<p>The following configuration properties must be specified:</p>
+<p>| Parameter | Name | Description |
+| Provider Root | <code>provider.roots</code> | Location in the virtual resource tree where the filesystem resources are mapped in. This property must not be an empty string. |
+| Filesystem Root | <code>provider.file</code> | Filesystem directory mapped to the virtual resource tree. This property must not be an empty string. If the path is relative it is resolved against <code>sling.home</code> or the current working directory. The path may be a file or folder. If the path does not address an existing file or folder, an empty folder is created. |</p>
+ <div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
+ Rev. 1341347 by fmeschbe on Tue, 22 May 2012 08:25:18 +0000
+ </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>
+ </div>
+ </body>
+</html>
Modified: websites/staging/sling/trunk/content/adapters.html
==============================================================================
--- websites/staging/sling/trunk/content/adapters.html (original)
+++ websites/staging/sling/trunk/content/adapters.html Tue May 22 08:25:32 2012
@@ -82,70 +82,44 @@
<a href="/">Home</a>
</div>
<h1>Adapters</h1>
- <p><a name="Adapters-Adapters"></a></p>
-<h1 id="adapters">Adapters</h1>
-<p>The <em>Resource</em> and <em>ResourceResolver</em> interfaces are defined with a
-method <em>adaptTo</em>, which adapts the object to other classes. Using this
-mechanism the JCR session of the resource resolver calling the <em>adaptTo</em>
-method with the <em>javax.jcr.Session</em> class object. Likewise the JCR node
-on which a resource is based can be retrieved by calling the
-<em>Resource.adaptTo</em> method with the <em>javax.jcr.Node</em> class object.</p>
-<p>To use resources as scripts, the <em>Resource.adaptTo</em> method must support
-being called with the <em>org.apache.sling.api.script.SlingScript</em> class
-object. But of course, we do not want to integrate the script manager with
-the resource resolver. To enable adapting objects to classes which are not
-foreseen by the original implementation, a factory mechanism is used. This
-way, the script manager can provide an adapter factory to adapt
-<em>Resource</em> to <em>SlingScript</em> objects.</p>
-<p><a name="Adapters-Adaptable"></a></p>
+ <h1 id="adapters">Adapters</h1>
+<p>The <code>Resource</code> and <code>ResourceResolver</code> interfaces are defined with a method <code>adaptTo</code>, which adapts the object to other classes. Using this mechanism the JCR session of the resource resolver calling the <code>adaptTo</code> method with the <code>javax.jcr.Session</code> class object. Likewise the JCR node on which a resource is based can be retrieved by calling the <code>Resource.adaptTo</code> method with the <code>javax.jcr.Node</code> class object.</p>
+<p>To use resources as scripts, the <code>Resource.adaptTo</code> method must support being called with the <code>org.apache.sling.api.script.SlingScript</code> class object. But of course, we do not want to integrate the script manager with the resource resolver. To enable adapting objects to classes which are not foreseen by the original implementation, a factory mechanism is used. This way, the script manager can provide an adapter factory to adapt <code>Resource</code> to <code>SlingScript</code> objects.</p>
<h2 id="adaptable">Adaptable</h2>
-<p>The <em>Adaptable</em> interface defines the API to be implemented by a class
-providing adaptability to another class. The single method defined by this
-interface is</p>
-<div class="codehilite"><pre><span class="o">/**</span>
- <span class="o">*</span> <span class="n">Adapts</span> <span class="n">the</span> <span class="n">adaptable</span> <span class="n">to</span> <span class="n">another</span> <span class="n">type</span><span class="o">.</span>
- <span class="o">*</span> <span class="sr"><p></span>
- <span class="o">*</span> <span class="n">Please</span> <span class="ow">not</span> <span class="n">that</span> <span class="n">it</span> <span class="n">is</span> <span class="n">explicitly</span> <span class="n">left</span> <span class="n">as</span> <span class="n">an</span> <span class="n">implementation</span> <span class="n">detail</span>
+<p>The <code>Adaptable</code> interface defines the API to be implemented by a class providing adaptability to another class. The single method defined by this interface is</p>
+<div class="codehilite"><pre>/**
+ * Adapts the adaptable to another type.
+ * <span class="nt"><p></span>
+ * Please not that it is explicitly left as an implementation detail whether
+ * each call to this method with the same <span class="nt"><code></span>type<span class="nt"></code></span> yields the same
+ * object or a new object on each call.
+ * <span class="nt"><p></span>
+ * Implementations of this method should document their adapted types as
+ * well as their behaviour with respect to returning newly created or not
+ * instance on each call.
+ *
+ * @param <span class="nt"><AdapterType></span> The generic type to which this resource is adapted
+ * to
+ * @param type The Class object of the target type, such as
+ * <span class="nt"><code></span>javax.jcr.Node.class<span class="nt"></code></span> or
+ * <span class="nt"><code></span>java.io.File.class<span class="nt"></code></span>
+ * @return The adapter target or <span class="nt"><code></span>null<span class="nt"></code></span> if the resource cannot
+ * adapt to the requested type
+ */
+<span class="nt"><AdapterType></span> AdapterType adaptTo(Class<span class="nt"><AdapterType></span> type);
</pre></div>
-<p>whether
- * each call to this method with the same <code>type</code> yields the same
- * object or a new object on each call.
- * <p>
- * Implementations of this method should document their adapted types as
- * well as their behaviour with respect to returning newly created or not
- * instance on each call.
- <em>
- * @param <AdapterType> The generic type to which this resource is adapted
- * to
- * @param type The Class object of the target type, such as
- * <code>javax.jcr.Node.class</code> or
- * <code>java.io.File.class</code>
- * @return The adapter target or <code>null</code> if the resource cannot
- * adapt to the requested type
- </em>/
- <AdapterType> AdapterType adaptTo(Class<AdapterType> type);</p>
-<p>This method is called to get a view of the same object in terms of another
-class. Examples of implementations of this method is the Sling
-<em>ResourceResolver</em> implementation providing adapting to a JCR session and
-the Sling JCR based <em>Resource</em> implementation providing adapting to a JCR
-node.</p>
-<p><a name="Adapters-ExtendingAdapters"></a></p>
+<p>This method is called to get a view of the same object in terms of another class. Examples of implementations of this method is the Sling <code>ResourceResolver</code> implementation providing adapting to a JCR session and the Sling JCR based <code>Resource</code> implementation providing adapting to a JCR node.</p>
<h2 id="extending-adapters">Extending Adapters</h2>
-<p>Sometimes an <em>Adaptable</em> implementation cannot foresee future uses and
-requirements. To cope with such extensibility requirements two interfaces
-and an abstract base class are defined:</p>
+<p>Sometimes an <code>Adaptable</code> implementation cannot foresee future uses and requirements. To cope with such extensibility requirements two interfaces and an abstract base class are defined:</p>
<ul>
-<li><em>AdapterManager</em></li>
-<li><em>AdapterFactory</em></li>
-<li><em>SlingAdaptable</em></li>
+<li><code>AdapterManager</code></li>
+<li><code>AdapterFactory</code></li>
+<li><code>SlingAdaptable</code></li>
</ul>
-<p><a name="Adapters-AdapterFactory"></a></p>
<h2 id="adapterfactory">AdapterFactory</h2>
-<p>The <em>AdapterFactory</em> interface defines the service interface and API for
-factories supporting extensible adapters for <em>SlingAdaptable</em> objects.
-The interface has a single method:</p>
+<p>The <code>AdapterFactory</code> interface defines the service interface and API for factories supporting extensible adapters for <code>SlingAdaptable</code> objects. The interface has a single method:</p>
<div class="codehilite"><pre>/**
* Adapt the given object to the adaptable type. The adaptable object is
* guaranteed to be an instance of one of the classes listed in the
@@ -154,83 +128,57 @@ The interface has a single method:</p>
* service registration properties.
* <span class="nt"><p></span>
* This method may return <span class="nt"><code></span>null<span class="nt"></code></span> if the adaptable object cannot
- * be adapted to the adapter (target) type for any reason. In this case,
+ * be adapted to the adapter (target) type for any reason. In this case, the
+ * implementation should log a message to the log facility noting the cause
+ * for not being able to adapt.
+ * <span class="nt"><p></span>
+ * Note that the <span class="nt"><code></span>adaptable<span class="nt"></code></span> object is not required to implement
+ * the <span class="nt"><code></span>Adaptable<span class="nt"></code></span> interface, though most of the time this method
+ * is called by means of calling the {@link Adaptable#adaptTo(Class)}
+ * method.
+ *
+ * @param <span class="nt"><AdapterType></span> The generic type of the adapter (target) type.
+ * @param adaptable The object to adapt to the adapter type.
+ * @param type The type to which the object is to be adapted.
+ * @return The adapted object or <span class="nt"><code></span>null<span class="nt"></code></span> if this factory instance
+ * cannot adapt the object.
+ */
+<span class="nt"><AdapterType></span> AdapterType getAdapter(Object adaptable,
+ Class<span class="nt"><AdapterType></span> type);
</pre></div>
-<p>the
- * implementation should log a message to the log facility noting the cause
- * for not being able to adapt.
- * <p>
- * Note that the <code>adaptable</code> object is not required to implement
- * the <code>Adaptable</code> interface, though most of the time this
-method
- * is called by means of calling the {@link Adaptable#adaptTo(Class)}
- * method.
- <em>
- * @param <AdapterType> The generic type of the adapter (target) type.
- * @param adaptable The object to adapt to the adapter type.
- * @param type The type to which the object is to be adapted.
- * @return The adapted object or <code>null</code> if this factory instance
- * cannot adapt the object.
- </em>/
- <AdapterType> AdapterType getAdapter(Object adaptable,
- Class<AdapterType> type);</p>
-<p>Implementations of this interface are registered as OSGi services providing
-two lists: The list of classes wich may be adapted (property named
-<em>adaptables</em>) and the list of classes to which the adapted class may be
-adapted (property named <em>adapters</em>). A good example of an Class
-implementing <em>AdapterFactory</em> is the <em>SlingScriptAdapterFactory</em>.</p>
-<p><em>AdapterFactory</em> services are gathered by a <em>AdapterManager</em>
-implementation for use by consumers. Consumers should not care for
-<em>AdapterFactory</em> services.</p>
-<p><a name="Adapters-AdapterManager"></a></p>
+<p>Implementations of this interface are registered as OSGi services providing two lists: The list of classes wich may be adapted (property named <em>adaptables</em>) and the list of classes to which the adapted class may be adapted (property named <em>adapters</em>). A good example of an Class implementing <code>AdapterFactory</code> is the <code>SlingScriptAdapterFactory</code>.</p>
+<p><code>AdapterFactory</code> services are gathered by a <code>AdapterManager</code> implementation for use by consumers. Consumers should not care for <code>AdapterFactory</code> services.</p>
<h2 id="adaptermanager">AdapterManager</h2>
-<p>The <em>AdapterManager</em> is defines the service interface for the genralized
-and extensible use of <em>AdapterFactory</em> services. Thus the adapter manager
-may be retrieved from the service registry to try to adapt whatever object
-that needs to be adapted - provided appropriate adapters exist.</p>
-<p>The <em>AdapterManager</em> interface is defined as follows:</p>
+<p>The <code>AdapterManager</code> is defines the service interface for the genralized and extensible use of <code>AdapterFactory</code> services. Thus the adapter manager may be retrieved from the service registry to try to adapt whatever object that needs to be adapted - provided appropriate adapters exist.</p>
+<p>The <code>AdapterManager</code> interface is defined as follows:</p>
<div class="codehilite"><pre>/**
* Returns an adapter object of the requested <span class="nt"><code></span>AdapterType<span class="nt"></code></span> for
* the given <span class="nt"><code></span>adaptable<span class="nt"></code></span> object.
* <span class="nt"><p></span>
- * The <span class="nt"><code></span>adaptable<span class="nt"></code></span> object may be any non-<span class="nt"><code></span>null<span class="nt"></code></span>
+ * The <span class="nt"><code></span>adaptable<span class="nt"></code></span> object may be any non-<span class="nt"><code></span>null<span class="nt"></code></span> object
+ * and is not required to implement the <span class="nt"><code></span>Adaptable<span class="nt"></code></span> interface.
+ *
+ * @param <span class="nt"><AdapterType></span> The generic type of the adapter (target) type.
+ * @param adaptable The object to adapt to the adapter type.
+ * @param type The type to which the object is to be adapted.
+ * @return The adapted object or <span class="nt"><code></span>null<span class="nt"></code></span> if no factory exists to
+ * adapt the <span class="nt"><code></span>adaptable<span class="nt"></code></span> to the <span class="nt"><code></span>AdapterType<span class="nt"></code></span>
+ * or if the <span class="nt"><code></span>adaptable<span class="nt"></code></span> cannot be adapted for any other
+ * reason.
+ */
+<span class="nt"><AdapterType></span> AdapterType getAdapter(Object adaptable,
+ Class<span class="nt"><AdapterType></span> type);
</pre></div>
-<p>object
- * and is not required to implement the <code>Adaptable</code> interface.
- <em>
- * @param <AdapterType> The generic type of the adapter (target) type.
- * @param adaptable The object to adapt to the adapter type.
- * @param type The type to which the object is to be adapted.
- * @return The adapted object or <code>null</code> if no factory exists to
- * adapt the <code>adaptable</code> to the <code>AdapterType</code>
- * or if the <code>adaptable</code> cannot be adapted for any other
- * reason.
- </em>/
- <AdapterType> AdapterType getAdapter(Object adaptable,
- Class<AdapterType> type);</p>
-<p>Any object can theoretically be adapted to any class even if it does not
-implement the <em>Adaptable</em> interface, if an <em>AdapterFactory</em> service
-delivers a <em>getAdapter()</em> method which adapts an object to another one.
-To check if there's any existing <em>AdapterFactory</em> which can adapt a given
-object to another one the <em>AdapterManager</em> service with it's
-<em>getAdapter()</em> method does the job. So the <em>Adaptable</em> interface merely
-is an indicator that the object provides built-in support for beeing
-adapted.</p>
-<p><a name="Adapters-SlingAdaptable"></a></p>
+<p>Any object can theoretically be adapted to any class even if it does not implement the <code>Adaptable</code> interface, if an <code>AdapterFactory</code> service delivers a <code>getAdapter()</code> method which adapts an object to another one. To check if there's any existing <code>AdapterFactory</code> which can adapt a given object to another one the <code>AdapterManager</code> service with it's <code>getAdapter()</code> method does the job. So the <code>Adaptable</code> interface merely is an indicator that the object provides built-in support for beeing adapted.</p>
<h2 id="slingadaptable">SlingAdaptable</h2>
-<p>The <em>SlingAdaptable</em> class is an implementation of the <em>Adaptable</em>
-interface which provides built-in support to call the <em>AdapterManager</em> to
-provide an adapter from the <em>Adaptable</em> object to the requested class.</p>
-<p>An example of extending the <em>SlingAdaptable</em> class will be the Sling JCR
-based <em>Resource</em> implementation. This way, such a resource may be adapted
-to a <em>SlingScript</em> by means of an appropriatley programmed
-<em>AdapterFactory</em> (see below).</p>
+<p>The <code>SlingAdaptable</code> class is an implementation of the <code>Adaptable</code> interface which provides built-in support to call the <code>AdapterManager</code> to provide an adapter from the <code>Adaptable</code> object to the requested class.</p>
+<p>An example of extending the <code>SlingAdaptable</code> class will be the Sling JCR based <code>Resource</code> implementation. This way, such a resource may be adapted to a <code>SlingScript</code> by means of an appropriatley programmed <code>AdapterFactory</code> (see below).</p>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
- Rev. 1328899 by fmeschbe on Sun, 22 Apr 2012 16:52:13 +0000
+ Rev. 1341347 by fmeschbe on Tue, 22 May 2012 08:25:18 +0000
</div>
<div class="trademarkFooter">
Apache Sling, Sling, Apache, the Apache feather logo, and the Apache Sling project
Modified: websites/staging/sling/trunk/content/apache-sling-commons-thread-pool.html
==============================================================================
--- websites/staging/sling/trunk/content/apache-sling-commons-thread-pool.html (original)
+++ websites/staging/sling/trunk/content/apache-sling-commons-thread-pool.html Tue May 22 08:25:32 2012
@@ -82,21 +82,12 @@
<a href="/">Home</a>
</div>
<h1>Apache Sling Commons Thread Pool</h1>
- <p>The Apache Sling Commons Thread Pool bundle provides a thread pool
-services. All thread pools are managed by the
-<em>{nl:org.apache.sling.commons.threads.ThreadPoolManager}</em>. This service can
-be used to get a thread pool.</p>
-<p>Thread pools are managed by name - there is a default thread pool and
-custom thread pools can be generated on demand using a unique name.</p>
-<p>The thread pools are actually wrappers around the thread pool support
-(executer) from the Java library. The advantage of using this thread pool
-service is, that the pools can be configured and managed through OSGi
-configurations. In addition the bundle contains a plugin for the Apache
-Felix Web Console.</p>
-<p>When using the {nl:ThreadPoolMananger} it is important to release a thread
-pool using the manager after it has been used.</p>
+ <p>The Apache Sling Commons Thread Pool bundle provides a thread pool services. All thread pools are managed by the <em>{nl:org.apache.sling.commons.threads.ThreadPoolManager}</em>. This service can be used to get a thread pool.</p>
+<p>Thread pools are managed by name - there is a default thread pool and custom thread pools can be generated on demand using a unique name.</p>
+<p>The thread pools are actually wrappers around the thread pool support (executer) from the Java library. The advantage of using this thread pool service is, that the pools can be configured and managed through OSGi configurations. In addition the bundle contains a plugin for the Apache Felix Web Console.</p>
+<p>When using the {nl:ThreadPoolMananger} it is important to release a thread pool using the manager after it has been used.</p>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
- Rev. 1328899 by fmeschbe on Sun, 22 Apr 2012 16:52:13 +0000
+ Rev. 1341347 by fmeschbe on Tue, 22 May 2012 08:25:18 +0000
</div>
<div class="trademarkFooter">
Apache Sling, Sling, Apache, the Apache feather logo, and the Apache Sling project
Modified: websites/staging/sling/trunk/content/apache-sling-community-roles-and-processes.html
==============================================================================
--- websites/staging/sling/trunk/content/apache-sling-community-roles-and-processes.html (original)
+++ websites/staging/sling/trunk/content/apache-sling-community-roles-and-processes.html Tue May 22 08:25:32 2012
@@ -82,83 +82,34 @@
<a href="/">Home</a>
</div>
<h1>Apache Sling Community Roles and Processes</h1>
- <p><a name="ApacheSlingCommunityRolesandProcesses-CommunityRolesandProcesses"></a></p>
-<h1 id="community-roles-and-processes">Community Roles and Processes</h1>
-<p>The Community Roles and Processes are put in effect as of 13/May/2009.
-Updated 7/December/2009 to reflect Sling being a top level project.</p>
-<p><a name="ApacheSlingCommunityRolesandProcesses-Roles"></a></p>
+ <h1 id="community-roles-and-processes">Community Roles and Processes</h1>
+<p>The Community Roles and Processes are put in effect as of 13/May/2009. Updated 7/December/2009 to reflect Sling being a top level project.</p>
<h2 id="roles">Roles</h2>
-<p>There are different roles with which Sling community members may be
-associated: User, Contributor, Committer, and PMC (Project Management
-Committee) Member. These roles are assigned and assumed based on merit. </p>
-<p>The User and Contributor roles are acquired by using the software and
-participating in the community, but the Committer and PMC member roles can
-only be granted by a PMC vote.</p>
-<p>The roles defined here conform to the ASF's <a href="http://www.apache.org/foundation/how-it-works.html#roles">definition of roles</a>
-.</p>
-<p><a name="ApacheSlingCommunityRolesandProcesses-Users"></a></p>
+<p>There are different roles with which Sling community members may be associated: User, Contributor, Committer, and PMC (Project Management Committee) Member. These roles are assigned and assumed based on merit. </p>
+<p>The User and Contributor roles are acquired by using the software and participating in the community, but the Committer and PMC member roles can only be granted by a PMC vote.</p>
+<p>The roles defined here conform to the ASF's <a href="">definition of roles</a>.</p>
<h3 id="users">Users</h3>
-<p>Users are the people who use any of the products of the Sling project.
-People in this role are not contributing code, but they are using the
-products, reporting bugs, making feature requests, testing code, and such.
-This is by far the most important category of people, since without users
-there is no reason for Sling. When a user starts to contribute code or
-documentation patches, they become a <em>Contributor</em>.</p>
-<p><a name="ApacheSlingCommunityRolesandProcesses-Contributors"></a></p>
+<p>Users are the people who use any of the products of the Sling project. People in this role are not contributing code, but they are using the products, reporting bugs, making feature requests, testing code, and such. This is by far the most important category of people, since without users there is no reason for Sling. When a user starts to contribute code or documentation patches, they become a <em>Contributor</em>.</p>
<h3 id="contributors">Contributors</h3>
-<p>Contributors are the people who write code or documentation patches or
-contribute positively to the project in other ways. A volunteer's
-contribution is always recognized.</p>
-<p><a name="ApacheSlingCommunityRolesandProcesses-Committers"></a></p>
+<p>Contributors are the people who write code or documentation patches or contribute positively to the project in other ways. A volunteer's contribution is always recognized.</p>
<h3 id="committers">Committers</h3>
-<p>Contributors who give frequent and valuable contributions to a subproject of Sling can have their status promoted to that of a <em><a href="http://www.apache.org/dev/committers.html">Committer</a>
-</em>. A Committer has write access to Sling's source code repository.
-Contributors of documentation are eligible as committers in the same way as
-contributors of pure code.</p>
-<p><a name="ApacheSlingCommunityRolesandProcesses-PMCMembers"></a></p>
+<p>Contributors who give frequent and valuable contributions to a subproject of Sling can have their status promoted to that of a <em><a href="">Committer</a></em>. A Committer has write access to Sling's source code repository. Contributors of documentation are eligible as committers in the same way as contributors of pure code.</p>
<h3 id="pmc-members">PMC Members</h3>
-<p>Committers showing continued interest in the project and taking an active part in the evolution of the project may be elected as <em><a href="http://www.apache.org/dev/pmc.html">PMC</a>
- members</em>. The PMC (Project Management Committee) is the official managing
-body of project and is responsible for setting its overall direction.</p>
-<p><a name="ApacheSlingCommunityRolesandProcesses-Processes"></a></p>
+<p>Committers showing continued interest in the project and taking an active part in the evolution of the project may be elected as <em><a href="">PMC</a> members</em>. The PMC (Project Management Committee) is the official managing body of project and is responsible for setting its overall direction.</p>
<h2 id="processes">Processes</h2>
-<p><a name="ApacheSlingCommunityRolesandProcesses-BecomingaUserorContributor"></a></p>
<h3 id="becoming-a-user-or-contributor">Becoming a User or Contributor</h3>
-<p>There is no requirement for becoming a User or Contributor; these roles are
-open to everyone.</p>
-<p><a name="ApacheSlingCommunityRolesandProcesses-BecomingaCommitter"></a></p>
+<p>There is no requirement for becoming a User or Contributor; these roles are open to everyone.</p>
<h3 id="becoming-a-committer">Becoming a Committer</h3>
-<p>In order for a Contributor to become a Committer, a member of the PMC can
-nominate that Contributor to the PMC. Once a Contributor is nominated, the
-PMC calls a vote on the PMC private mailing list.</p>
-<p>If there are at least three positive votes and no negative votes after
-three days (72 hours), the results are posted to the PMC private mailing
-list.</p>
-<p>Upon a positive vote result, the Contributor will be emailed by the PMC to
-invite him/her to become a Committer. If the invitation is accepted, an
-announcement about the new Committer is made to the developer mailing list
-and he/she is given write access to the source code repository. A
-Contributor will not officially become a Committer member until the
-appropriate legal paperwork is submitted.</p>
-<p><a name="ApacheSlingCommunityRolesandProcesses-BecomingaPMCMember"></a></p>
+<p>In order for a Contributor to become a Committer, a member of the PMC can nominate that Contributor to the PMC. Once a Contributor is nominated, the PMC calls a vote on the PMC private mailing list.</p>
+<p>If there are at least three positive votes and no negative votes after three days (72 hours), the results are posted to the PMC private mailing list.</p>
+<p>Upon a positive vote result, the Contributor will be emailed by the PMC to invite him/her to become a Committer. If the invitation is accepted, an announcement about the new Committer is made to the developer mailing list and he/she is given write access to the source code repository. A Contributor will not officially become a Committer member until the appropriate legal paperwork is submitted.</p>
<h3 id="becoming-a-pmc-member">Becoming a PMC Member</h3>
-<p>In order for a Committer to become a member of the PMC, a member of the PMC
-can nominate that Committer to the PMC. Once a Committer is nominated, the
-PMC calls a vote on the PMC private mailing list.</p>
-<p>If there are at least three positive votes and no negative votes after
-three days (72 hours), the results are posted to the PMC private mailing
-list.</p>
-<p>To have the Committer being accepted as a PMC member, the ASF Board has
-acknowledge the addition to the PMC. The Committer should not be consulted
-about his/her desire to become a PMC member before the board
-acknowledgement, or be informed that they are being considered, since this
-could create hard feelings if the vote does not pass.</p>
-<p>Upon a positive vote result, the PMC member will be emailed by the PMC to
-invite him/her to become a PMC member. If the invitation is accepted, an
-announcement about the new PMC member is made to the developer mailing
-list.</p>
+<p>In order for a Committer to become a member of the PMC, a member of the PMC can nominate that Committer to the PMC. Once a Committer is nominated, the PMC calls a vote on the PMC private mailing list.</p>
+<p>If there are at least three positive votes and no negative votes after three days (72 hours), the results are posted to the PMC private mailing list.</p>
+<p>To have the Committer being accepted as a PMC member, the ASF Board has acknowledge the addition to the PMC. The Committer should not be consulted about his/her desire to become a PMC member before the board acknowledgement, or be informed that they are being considered, since this could create hard feelings if the vote does not pass.</p>
+<p>Upon a positive vote result, the PMC member will be emailed by the PMC to invite him/her to become a PMC member. If the invitation is accepted, an announcement about the new PMC member is made to the developer mailing list.</p>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
- Rev. 1328899 by fmeschbe on Sun, 22 Apr 2012 16:52:13 +0000
+ Rev. 1341347 by fmeschbe on Tue, 22 May 2012 08:25:18 +0000
</div>
<div class="trademarkFooter">
Apache Sling, Sling, Apache, the Apache feather logo, and the Apache Sling project