Page added by Mike Mueller

Bundle Resources

Introduction
Resource Types
Adapters
Configuration

Introduction

The Bundle Resource Provider provides access to files/directories included in a OSGi bundle through the Sling ResourceResolver.

Resource Types

Files and directories are mapped into the resource tree as regular Resource instances whose resource type depends on the actual nature of the mapped resource:

Regular files are assigned the nt:file resource type
Directories are assigned the nt:folder resource type

Adapters

Filesystem resources extend from Sling's AbstractResource class and thus are adaptable to any type for which an AdapterFactory is registered supporting bundle resources. In addition BundleResource support the following adapters natively:

java.net.URL – A valid bundle:// URL to the resource in the bundle.
java.io.InputStream – An InputStream to read from the file is returned (only for files, not for directories).

Configuration

Providing bundles have a Bundle manifest header Sling-Bundle-Resources containing a list of absolute path prefixes provided by the bundle and the correspondent path in the resource tree. The two path are separated by comma or whitespace (SP, TAB, VTAB, CR, LF), the list entries are separated by semicolon.

Example (manifest.mf):

...
Sling-Bundle-Resources: /libs/sling/explorer,                         
    /libs/sling/servlet/default/explorer
...

The Bundle Resource Provider also has a web console plugin, thus the configuration can be seen and edited in the web console.

Change Notification Preferences

View Online | Add Comment

[CONF] Apache Sling Website > Bundle Resources (extensions.bundleresource)