You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by cz...@apache.org on 2018/02/05 00:15:26 UTC
[sling-site] branch asf-site updated: Update bundle resource
provider docs
This is an automated email from the ASF dual-hosted git repository.
cziegeler pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/sling-site.git
The following commit(s) were added to refs/heads/asf-site by this push:
new f17f780 Update bundle resource provider docs
f17f780 is described below
commit f17f78065a9b255547cb22b5573692ce570792f3
Author: Carsten Ziegeler <cz...@adobe.com>
AuthorDate: Sun Feb 4 16:15:25 2018 -0800
Update bundle resource provider docs
---
...bundle-resources-extensions-bundleresource.html | 67 ++++++++++++++++------
.../discover-sling-in-15-minutes.html | 4 +-
sitemap.html | 2 +-
sitemap.xml | 2 +-
tags/bundles.html | 2 +-
tags/resources.html | 2 +-
6 files changed, 56 insertions(+), 23 deletions(-)
diff --git a/documentation/bundles/bundle-resources-extensions-bundleresource.html b/documentation/bundles/bundle-resources-extensions-bundleresource.html
index f60ce11..9274780 100644
--- a/documentation/bundles/bundle-resources-extensions-bundleresource.html
+++ b/documentation/bundles/bundle-resources-extensions-bundleresource.html
@@ -1,7 +1,7 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/>
- <title>Apache Sling :: Bundle Resources (extensions.bundleresource)</title>
+ <title>Apache Sling :: Bundle Resources (org.apache.sling.bundleresource.impl)</title>
<link rel="icon" href="/res/favicon.ico"/>
<link rel="stylesheet" href="/res/css/site.css"/>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/>
@@ -92,41 +92,74 @@
</div>
</div><h1 class="pagetitle">
- Bundle Resources (extensions.bundleresource)
+ Bundle Resources (org.apache.sling.bundleresource.impl)
</h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script>
<div class="row"><div class="small-12 columns"><section class="wrap"><p><!-- TODO reactivate TOC once JBake moves to flexmark-java -->
</p>
-<h2><a href="#introduction" name="introduction">Introduction</a></h2>
+<h1><a href="#introduction" name="introduction">Introduction</a></h1>
<p>The Bundle Resource Provider provides access to files/directories included in an OSGi bundle through the Sling <code>ResourceResolver</code>. </p>
-<h2><a href="#resource-types" name="resource-types">Resource Types</a></h2>
+<h1><a href="#configuration" name="configuration">Configuration</a></h1>
+<p>If a bundle wants to provide resources, it must specify the Bundle manifest header <code>Sling-Bundle-Resources</code> containing a list of absolute paths. The paths are separated by comma. Without any additional information such a path is mapped 1:1 meaning that the specified path is used as the root resource path and the corresponding resource is at the same path in the bundle. </p>
+<p>The following example header maps the paths <code>/libs/sling/explorer</code> and <code>/libs/sling/servlet/default/explorer</code> in the resource tree to resources in the bundle at the same path:</p>
+<pre><code>...
+Sling-Bundle-Resources: /libs/sling/explorer,
+ /libs/sling/servlet/default/explorer
+...
+</code></pre>
+<p>If such an entry points to a file in the bundle, only this file is mapped. If such an entry points to a directory in the bundle, the whole sub tree below this directory is mapped.</p>
+<p>It's also possible to map resources from the bundle to a different location in the resource tree. In this case the path has to be extended with a path directive to declare where the resources are in the bundle. Again the following example maps the path <code>/libs/sling/explorer</code> in the resource tree to resources below <code>/resources/explorer</code> in the bundle</p>
+<pre><code>...
+Sling-Bundle-Resources: /libs/sling/explorer;path:=/resources/explorer
+...
+</code></pre>
+<h1><a href="#resource-types" name="resource-types">Resource Types</a></h1>
<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 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><a href="#adapters" name="adapters">Adapters</a></h2>
+<h1><a href="#defining-resources-through-json" name="defining-resources-through-json">Defining Resources Through JSON</a></h1>
+<p>By default, there is a 1:1 mapping between resources in the bundle and resources in the resource tree as explained above. While this works for adding files to the resource tree, it doesn't support adding arbitrary resources to the resource tree where the resources just have a map of properties and are not actually a file. By specifying the directive <code>propsJSON</code> with an extension, all files in the bundle having this extension are passed as JSON files and the contained struct [...]
+<p>For example with the following definition in the manifest:</p>
+<pre><code>...
+Sling-Bundle-Resources: /products;path:=/resources/products.json;propsJSON:=json
+...
+</code></pre>
+<p>the resource path <code>/products</code> is mapped to bundle resources at <code>/resources/products.json</code> and all bundle resources with the <code>json</code> extension are parsed. For example with the following <code>products.json</code>:</p>
+<pre><code>{
+ "sling:resourceType" : "products",
+ "sling" : {
+ "sling:resourceType" : "product",
+ "name" : "sling",
+ "title : "Apache Sling"
+ }
+}
+</code></pre>
+<p>a resource named <code>products</code> with the resource type <code>products</code> has a single child resource named <code>sling</code> and the above three properties.</p>
+<p>It's also possible to add additional properties to a file from a bundle resource. For example if the bundle contains the resource <code>tree.gif</code> and a JSON file <code>tree.gif.json</code> with the directive to parse all files ending in <code>json</code>, a file resource <code>tree.gif</code> exists in the resource tree with the additional properties from the json file. The JSON file can also override the default resource type in this case. In addition this json file can also co [...]
+<h1><a href="#adapters" name="adapters">Adapters</a></h1>
<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 bundle resources. In addition <code>BundleResource</code> support the following adapters natively:</p>
<ul>
<li><code>java.net.URL</code> -- A valid <code>bundle://</code> URL to the resource in the bundle.</li>
<li><code>java.io.InputStream</code> -- An <code>InputStream</code> to read file contents. Doesn't apply to folders.</li>
</ul>
-<h2><a href="#configuration" name="configuration">Configuration</a></h2>
-<p>Providing bundles have a Bundle manifest header <code>Sling-Bundle-Resources</code> containing a list of absolute paths provided by the bundle. The paths are separated by comma or whitespace (SP, TAB, VTAB, CR, LF). </p>
-<p>Example (manifest.mf):</p>
-<pre><code>...
-Sling-Bundle-Resources: /libs/sling/explorer,
- /libs/sling/servlet/default/explorer
-...
+<h1><a href="#capability" name="capability">Capability</a></h1>
+<p>The bundle implementing the support for bundle resources must provide the following extender capability:</p>
+<pre><code><Provide-Capability>
+ osgi.extender;osgi.extender="org.apache.sling.bundleresource";version:Version="1.1"
+<Provide-Capability>
</code></pre>
-<p>It's also possible to map resources from the bundle to a different location in the resource tree. In this case the path has to be extended with a path attrribute to declare where the resources are in the bundle:</p>
-<pre><code>...
-Sling-Bundle-Resources: /somepath/inthe/resourcetree;path:=/path/inthe/bundle
-...
+<p>Bundles providing resources to the resource tree using the described mechanism should also require this capability to ensure at runtime that there is an implementation picking up those bundle resources. This can be done by using the following require capability header:</p>
+<pre><code><Require-Capability>
+ osgi.extender;filter:="(&(osgi.extender=org.apache.sling.bundleresource)(version<=1.1.0)(!(version>=2.0.0)))"
+</Require-Capability>
</code></pre>
+<p>Without requiring the capability, the bundle containing the resources might resolve successfully but the resource are not part of the resource tree as there is no implementation picking them up.</p>
+<h1><a href="#webconsole-plugin" name="webconsole-plugin">WebConsole Plugin</a></h1>
<p>The Bundle Resource Provider also has a web console plugin through which the currently installed bundles can be seen.</p></section></div></div>
<div class="footer">
<div class="revisionInfo">
- Last modified by <span class="author">Bertrand Delacretaz</span> on <span class="comment">Fri Sep 29 15:57:01 2017 +0200</span>
+ Last modified by <span class="author">Carsten Ziegeler</span> on <span class="comment">Sun Feb 4 16:13:54 2018 -0800</span>
</div> <p>
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.
</p><p>
diff --git a/documentation/getting-started/discover-sling-in-15-minutes.html b/documentation/getting-started/discover-sling-in-15-minutes.html
index dbe4c16..2b3a90d 100644
--- a/documentation/getting-started/discover-sling-in-15-minutes.html
+++ b/documentation/getting-started/discover-sling-in-15-minutes.html
@@ -164,7 +164,7 @@ curl -X MKCOL -u admin:admin http://localhost:8080/apps/foo/bar
<pre><code>Location: /blog/adventures_with_slin
</code></pre>
<p>The actual node name might not be <em>adventures_with_slin</em> - depending on existing content in your repository, Sling will find a unique name for this new node, based on several well-know property values like title, description, etc. which are used for this if provided.</p>
-<p>So, in our case, our new node can be displayed in HTML via the <a href="http://localhost:8080/blog/adventures*with*slin.html">http://localhost:8080/blog/adventures_with_slin.html</a> URL.</p>
+<p>So, in our case, our new node can be displayed in HTML via the <a href="http://localhost:8080/blog/adventures_with_slin.html">http://localhost:8080/blog/adventures_with_slin.html</a> URL.</p>
<p>Note that we didn't set a <em>sling:resourceType</em> property on our node, so if you want to render that node with a script, you'll have to store the script under <em>/apps/nt/unstructured/html.esp</em>.</p>
<h3><a href="#add-a-page-header-with-sling-include" name="add-a-page-header-with-sling-include">Add a page header with sling.include</a></h3>
<p>The <em>sling.include</em> function can be called from scripts to include the rendered result of another node.</p>
@@ -206,7 +206,7 @@ curl -u admin:admin -T sling.jpg http://localhost:8080/images/sling.jpg
<p>The <a href="http://localhost:8080/content/mynode.html">http://localhost:8080/content/mynode.html</a>, once refreshed, now shows the blue headline and logo, and this layout also applies to any node created with <em>sling:resourceType=foo/bar</em>.</p></section></div></div>
<div class="footer">
<div class="revisionInfo">
- Last modified by <span class="author">Robert Munteanu</span> on <span class="comment">Wed Nov 22 22:30:38 2017 +0200</span>
+ Last modified by <span class="author">John Bradley</span> on <span class="comment">Sat Feb 3 18:04:27 2018 -0500</span>
</div> <p>
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.
</p><p>
diff --git a/sitemap.html b/sitemap.html
index 9d2b8bd..b829e28 100644
--- a/sitemap.html
+++ b/sitemap.html
@@ -106,7 +106,7 @@
<li><a href="/documentation/the-sling-engine/authentication/authentication-framework.html">Authentication - Framework</a></li>
<li><a href="/documentation/the-sling-engine/authentication/authentication-tasks.html">Authentication - Tasks</a></li>
<li><a href="/documentation/bundles/sling-query/basic-ideas.html">Basic Ideas</a></li>
- <li><a href="/documentation/bundles/bundle-resources-extensions-bundleresource.html">Bundle Resources (extensions.bundleresource)</a></li>
+ <li><a href="/documentation/bundles/bundle-resources-extensions-bundleresource.html">Bundle Resources (org.apache.sling.bundleresource.impl)</a></li>
<li><a href="/documentation/bundles.html">Bundles</a></li>
<li><a href="/documentation/development/client-request-logging.html">Client Request Logging</a></li>
<li><a href="/documentation/bundles/commons-html-utilities.html">Commons HTML Utilities (org.apache.sling.commons.html)</a></li>
diff --git a/sitemap.xml b/sitemap.xml
index 8d4e3cc..2001f63 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -104,7 +104,7 @@
<li><a href="/documentation/the-sling-engine/authentication/authentication-framework.html">Authentication - Framework</a></li>
<li><a href="/documentation/the-sling-engine/authentication/authentication-tasks.html">Authentication - Tasks</a></li>
<li><a href="/documentation/bundles/sling-query/basic-ideas.html">Basic Ideas</a></li>
- <li><a href="/documentation/bundles/bundle-resources-extensions-bundleresource.html">Bundle Resources (extensions.bundleresource)</a></li>
+ <li><a href="/documentation/bundles/bundle-resources-extensions-bundleresource.html">Bundle Resources (org.apache.sling.bundleresource.impl)</a></li>
<li><a href="/documentation/bundles.html">Bundles</a></li>
<li><a href="/documentation/development/client-request-logging.html">Client Request Logging</a></li>
<li><a href="/documentation/bundles/commons-html-utilities.html">Commons HTML Utilities (org.apache.sling.commons.html)</a></li>
diff --git a/tags/bundles.html b/tags/bundles.html
index 5c18bb2..80b608c 100644
--- a/tags/bundles.html
+++ b/tags/bundles.html
@@ -78,7 +78,7 @@
<tags/>
</div><tableOfContents/>
-<div class="taglinks"><h2>Tagged with 'bundles'</h2><div class="taglink"><a href="/documentation/bundles/bundle-resources-extensions-bundleresource.html">Bundle Resources (extensions.bundleresource)</a></div><div class="taglink"><a href="/documentation/bundles.html">Bundles</a></div><div class="taglink"><a href="/documentation/tutorials-how-tos/installing-and-upgrading-bundles.html">Installing and Upgrading Bundles</a></div><div class="tags"><h2>All tags</h2><span class="allTagsLink"><a [...]
+<div class="taglinks"><h2>Tagged with 'bundles'</h2><div class="taglink"><a href="/documentation/bundles/bundle-resources-extensions-bundleresource.html">Bundle Resources (org.apache.sling.bundleresource.impl)</a></div><div class="taglink"><a href="/documentation/bundles.html">Bundles</a></div><div class="taglink"><a href="/documentation/tutorials-how-tos/installing-and-upgrading-bundles.html">Installing and Upgrading Bundles</a></div><div class="tags"><h2>All tags</h2><span class="allTa [...]
<span class="allTagsLink"><a href="/tags/api.html" class="label">api<span class="badge">3</span></a></span>
<span class="allTagsLink"><a href="/tags/authentication.html" class="label">authentication<span class="badge">8</span></a></span>
<span class="allTagsLink"><a href="/tags/bundles.html" class="label">bundles<span class="badge">3</span></a></span>
diff --git a/tags/resources.html b/tags/resources.html
index a7a53e0..7c1b985 100644
--- a/tags/resources.html
+++ b/tags/resources.html
@@ -78,7 +78,7 @@
<tags/>
</div><tableOfContents/>
-<div class="taglinks"><h2>Tagged with 'resources'</h2><div class="taglink"><a href="/documentation/bundles/accessing-filesystem-resources-extensions-fsresource.html">Accessing File System Resources (org.apache.sling.fsresource)</a></div><div class="taglink"><a href="/documentation/bundles/bundle-resources-extensions-bundleresource.html">Bundle Resources (extensions.bundleresource)</a></div><div class="taglink"><a href="/documentation/tutorials-how-tos/getting-resources-and-properties-in- [...]
+<div class="taglinks"><h2>Tagged with 'resources'</h2><div class="taglink"><a href="/documentation/bundles/accessing-filesystem-resources-extensions-fsresource.html">Accessing File System Resources (org.apache.sling.fsresource)</a></div><div class="taglink"><a href="/documentation/bundles/bundle-resources-extensions-bundleresource.html">Bundle Resources (org.apache.sling.bundleresource.impl)</a></div><div class="taglink"><a href="/documentation/tutorials-how-tos/getting-resources-and-pro [...]
<span class="allTagsLink"><a href="/tags/api.html" class="label">api<span class="badge">3</span></a></span>
<span class="allTagsLink"><a href="/tags/authentication.html" class="label">authentication<span class="badge">8</span></a></span>
<span class="allTagsLink"><a href="/tags/bundles.html" class="label">bundles<span class="badge">3</span></a></span>
--
To stop receiving notification emails like this one, please contact
cziegeler@apache.org.