Fix front matter, using existing titles
Project: http://git-wip-us.apache.org/repos/asf/sling-site/repo Commit: http://git-wip-us.apache.org/repos/asf/sling-site/commit/88e80480 Tree: http://git-wip-us.apache.org/repos/asf/sling-site/tree/88e80480 Diff: http://git-wip-us.apache.org/repos/asf/sling-site/diff/88e80480 Branch: refs/heads/master Commit: 88e80480d5c1dd204ab2cb8a11be9f96caecc899 Parents: 5168c61 Author: Bertrand Delacretaz <bdelacre...@apache.org> Authored: Wed Jun 14 12:08:09 2017 -0400 Committer: Bertrand Delacretaz <bdelacre...@apache.org> Committed: Wed Jun 14 12:08:09 2017 -0400 ---------------------------------------------------------------------- content/apidocs/TODO.md | 6 +- content/components/TODO.md | 6 +- content/contributing.md | 7 +- content/documentation.md | 116 ++-- content/documentation/bundles.md | 7 +- ...ilesystem-resources-extensions-fsresource.md | 27 +- .../bundles/apache-sling-commons-thread-pool.md | 7 +- .../apache-sling-eventing-and-job-handling.md | 111 ++-- ...undle-resources-extensions-bundleresource.md | 33 +- .../documentation/bundles/caching-services.md | 7 +- .../bundles/commons-html-utilities.md | 7 +- .../bundles/configuration-installer-factory.md | 63 +- .../bundles/content-distribution.md | 163 +++-- .../content-loading-jcr-contentloader.md | 271 +++++---- ...ware-configuration-default-implementation.md | 23 +- .../context-aware-configuration-override.md | 37 +- .../context-aware-configuration-spi.md | 7 +- .../context-aware-configuration.md | 161 +++-- .../bundles/datasource-providers.md | 53 +- .../bundles/discovery-api-and-impl.md | 199 +++--- .../documentation/bundles/dynamic-includes.md | 39 +- .../bundles/file-installer-provider.md | 17 +- .../internationalization-support-i18n.md | 131 ++-- .../bundles/jcr-installer-provider.md | 70 +-- content/documentation/bundles/log-tracers.md | 248 ++++---- ...ging-permissions-jackrabbit-accessmanager.md | 81 ++- ...g-users-and-groups-jackrabbit-usermanager.md | 250 ++++---- ...ontent-the-slingpostservlet-servlets-post.md | 425 +++++++------ content/documentation/bundles/metrics.md | 123 ++-- .../bundles/mime-type-support-commons-mime.md | 11 +- content/documentation/bundles/models.md | 469 +++++++-------- .../bundles/nosql-resource-providers.md | 31 +- .../bundles/org-apache-sling-junit-bundles.md | 135 ++--- content/documentation/bundles/osgi-installer.md | 9 +- ...iting-pipelines-org-apache-sling-rewriter.md | 37 +- .../rendering-content-default-get-servlets.md | 21 +- .../bundles/repository-initialization.md | 174 +++--- .../documentation/bundles/request-analysis.md | 9 +- .../bundles/resource-access-security.md | 97 ++- .../documentation/bundles/resource-editor.md | 43 +- .../documentation/bundles/resource-merger.md | 155 +++-- .../scheduler-service-commons-scheduler.md | 299 +++++---- content/documentation/bundles/scripting.md | 9 +- .../bundles/scripting/scripting-htl.md | 603 +++++++++---------- .../bundles/scripting/scripting-jsp.md | 193 +++--- .../bundles/scripting/scripting-thymeleaf.md | 17 +- .../documentation/bundles/servlet-helpers.md | 91 ++- .../bundles/sling-health-check-tool.md | 163 +++-- .../bundles/sling-oak-restrictions.md | 113 ++-- content/documentation/bundles/sling-pipes.md | 277 +++++---- content/documentation/bundles/sling-query.md | 55 +- .../sling-settings-org-apache-sling-settings.md | 35 +- .../bundles/subsystem-installer-factory.md | 9 +- content/documentation/bundles/validation.md | 149 +++-- .../bundles/web-console-extensions.md | 7 +- content/documentation/bundles/xml-support.md | 7 +- content/documentation/configuration.md | 37 +- content/documentation/development.md | 7 +- .../development/client-request-logging.md | 39 +- .../development/dependency-management.md | 13 +- .../development/embedding-sling.md | 13 +- .../development/getting-and-building-sling.md | 95 ++- content/documentation/development/hamcrest.md | 49 +- .../development/htl-maven-plugin.md | 7 +- .../documentation/development/ide-tooling.md | 9 +- .../ide-tooling-incremental-build.md | 7 +- .../documentation/development/issue-tracker.md | 7 +- content/documentation/development/jcr-mock.md | 43 +- content/documentation/development/jspc.md | 7 +- content/documentation/development/jsr-305.md | 101 ++-- content/documentation/development/logging.md | 393 ++++++------ .../development/maven-archetypes.md | 7 +- .../development/maven-launchpad-plugin.md | 173 +++--- .../documentation/development/maven-usage.md | 21 +- .../development/maventipsandtricks.md | 15 +- .../development/monitoring-requests.md | 7 +- content/documentation/development/osgi-mock.md | 115 ++-- .../development/release-management.md | 474 +++++++-------- .../development/repository-based-development.md | 23 +- .../development/resourceresolver-mock.md | 23 +- content/documentation/development/sling-mock.md | 323 +++++----- .../development/sling-testing-tools.md | 85 ++- content/documentation/development/sling.md | 7 +- content/documentation/development/slingstart.md | 271 +++++---- .../documentation/development/version-policy.md | 25 +- content/documentation/getting-started.md | 9 +- .../discover-sling-in-15-minutes.md | 89 ++- content/documentation/legacy/logging.md | 29 +- content/documentation/pax-exam-utils.md | 7 +- content/documentation/the-sling-engine.md | 7 +- .../documentation/the-sling-engine/adapters.md | 175 +++--- .../the-sling-engine/architecture.md | 7 +- .../the-sling-engine/authentication.md | 17 +- .../authentication/authentication-actors.md | 27 +- .../authentication-authenticationhandler.md | 7 +- .../form-based-authenticationhandler.md | 13 +- .../openid-authenticationhandler.md | 7 +- .../authentication/authentication-framework.md | 31 +- .../authentication/authentication-tasks.md | 23 +- .../default-mapping-and-rendering.md | 7 +- .../the-sling-engine/dispatching-requests.md | 27 +- .../the-sling-engine/errorhandling.md | 35 +- .../the-sling-engine/featureflags.md | 19 +- .../documentation/the-sling-engine/filters.md | 93 ++- .../mappings-for-resource-resolution.md | 177 +++--- .../the-sling-engine/request-listeners.md | 45 +- .../the-sling-engine/request-parameters.md | 23 +- .../documentation/the-sling-engine/resources.md | 37 +- .../the-sling-engine/service-authentication.md | 87 ++- .../documentation/the-sling-engine/servlets.md | 91 ++- .../the-sling-engine/sling-api-crud-support.md | 167 +++-- .../the-sling-engine/sling-properties.md | 7 +- .../the-sling-engine/the-sling-launchpad.md | 61 +- .../the-sling-engine/url-decomposition.md | 9 +- .../url-to-script-resolution.md | 155 +++-- .../wrap-or-decorate-resources.md | 43 +- content/documentation/tutorials-how-tos.md | 7 +- .../tutorials-how-tos/46-line-blog.md | 160 +++-- ...getting-resources-and-properties-in-sling.md | 97 ++- .../how-to-manage-events-in-sling.md | 209 ++++--- .../installing-and-upgrading-bundles.md | 11 +- .../tutorials-how-tos/jackrabbit-persistence.md | 89 ++- .../testing-sling-based-applications.md | 95 ++- content/errors/403.md | 37 +- content/errors/404.md | 37 +- content/guides.md | 25 +- content/index.md | 41 +- content/javadoc-io.md | 7 +- content/links.md | 49 +- content/media.md | 7 +- content/news.md | 9 +- content/news/sling-ide-tooling-11-released.md | 7 +- content/news/sling-launchpad-8-released.md | 7 +- content/news/sling-launchpad-9-released.md | 11 +- content/old-stuff.md | 7 +- content/plugins.md | 7 +- content/project-information.md | 25 +- ...pache-sling-community-roles-and-processes.md | 9 +- content/project-information/project-license.md | 7 +- content/project-information/project-team.md | 7 +- content/project-information/security.md | 7 +- content/site-conversion.md | 7 +- 142 files changed, 5172 insertions(+), 5649 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/sling-site/blob/88e80480/content/apidocs/TODO.md ---------------------------------------------------------------------- diff --git a/content/apidocs/TODO.md b/content/apidocs/TODO.md index bbf82c8..48f6d15 100644 --- a/content/apidocs/TODO.md +++ b/content/apidocs/TODO.md @@ -1,7 +1,5 @@ -title=TODO title for TODO.md -date=1900-01-01 -type=post -tags=blog +title= +type=page status=published ~~~~~~ TODO: re-add apidocs http://git-wip-us.apache.org/repos/asf/sling-site/blob/88e80480/content/components/TODO.md ---------------------------------------------------------------------- diff --git a/content/components/TODO.md b/content/components/TODO.md index f393e1c..79d497b 100644 --- a/content/components/TODO.md +++ b/content/components/TODO.md @@ -1,7 +1,5 @@ -title=TODO title for TODO.md -date=1900-01-01 -type=post -tags=blog +title= +type=page status=published ~~~~~~ TODO re-add content/components http://git-wip-us.apache.org/repos/asf/sling-site/blob/88e80480/content/contributing.md ---------------------------------------------------------------------- diff --git a/content/contributing.md b/content/contributing.md index 0694bfc..fcb586c 100644 --- a/content/contributing.md +++ b/content/contributing.md @@ -1,10 +1,7 @@ -title=TODO title for contributing.md -date=1900-01-01 -type=post -tags=blog +title=Contributing +type=page status=published ~~~~~~ -Title: Contributing See [Project Information](/project-information.html) for details about the tools mentioned below. http://git-wip-us.apache.org/repos/asf/sling-site/blob/88e80480/content/documentation.md ---------------------------------------------------------------------- diff --git a/content/documentation.md b/content/documentation.md index 3540159..33f100b 100644 --- a/content/documentation.md +++ b/content/documentation.md @@ -1,10 +1,7 @@ -title=TODO title for documentation.md -date=1900-01-01 -type=post -tags=blog +title=Documentation +type=page status=published ~~~~~~ -Title: Documentation [TOC] @@ -12,14 +9,14 @@ Title: Documentation The documentation is split into different parts: - * [Getting Started](/documentation/getting-started.html), the right place to start! - * [The Sling Engine](/documentation/the-sling-engine.html), all about the heart of Sling - * [Development](/documentation/development.html), how do I get and develop with Sling - * [Bundles](/documentation/bundles.html), which bundle delivers which features to Sling - * [Tutorials & How-Tos](/documentation/tutorials-how-tos.html) - * [Wiki](http://cwiki.apache.org/SLING/) - * [Configuration](/documentation/configuration.html) - * [API Doc](http://sling.apache.org/apidocs/sling8/index.html) +* [Getting Started](/documentation/getting-started.html), the right place to start! +* [The Sling Engine](/documentation/the-sling-engine.html), all about the heart of Sling +* [Development](/documentation/development.html), how do I get and develop with Sling +* [Bundles](/documentation/bundles.html), which bundle delivers which features to Sling +* [Tutorials & How-Tos](/documentation/tutorials-how-tos.html) +* [Wiki](http://cwiki.apache.org/SLING/) +* [Configuration](/documentation/configuration.html) +* [API Doc](http://sling.apache.org/apidocs/sling8/index.html) # How you can contribute @@ -68,30 +65,28 @@ of the site, such as automatic link generation. Start the file with a `Title:` line to define the page title and the first H1 tag: - Title: Page Title - - Here comes the content separated with a blank like from the - header ... - + +Here comes the content separated with a blank like from the +header ... + The last modification information from SVN (revision, committer, and date/time) is automatically added when the page is rendered Excerpts can be added to a page using the `Excerpt:` header: - Title: Page Title - Excerpt: Summary of the page for inclusion in other pages; - continuation of the excerpt must be indented - - Here comes the content separated with a blank like from the - header ... +Excerpt: Summary of the page for inclusion in other pages; +continuation of the excerpt must be indented + +Here comes the content separated with a blank like from the +header ... Metadata from child pages can be referred to in the content with the Django variable reference notation using the child page name (without extension) as its container; e.g. for the child page named `childpage`: - :::django - {{ y|default:"{{" }} children.childpage.headers.excerpt }} - {{ y|default:"{{" }} children.childpage.headers.title }} +:::django +{{ y|default:"{{" }} children.childpage.headers.excerpt }} +{{ y|default:"{{" }} children.childpage.headers.title }} Content Pages can contain Django templates of the form `{{ y|default:"{{" }}...}}` and `{{ y|default:"{%" }}...%}`. If so, the page content is evaluated as a Django template before running @@ -107,41 +102,41 @@ Any page in the site can be referenced with refs.pagename returning properties: `.content` : the raw page content - + All pages in the children namespace are also available in the refs namespace - + Some usefull hints: Printing title of another page "handler": - - :::django - {{ y|default:"{{" }} refs.handler.headers.title }} + +:::django +{{ y|default:"{{" }} refs.handler.headers.title }} Printing excerpt of another page "handler": - - :::django - {{ y|default:"{{" }} refs.handler.headers.excerpt }} - + +:::django +{{ y|default:"{{" }} refs.handler.headers.excerpt }} + Linking to another page "handler": - - :::django - ({{ y|default:"{{" }} refs.handler.path }}) - + +:::django +({{ y|default:"{{" }} refs.handler.path }}) + Printing title as a link to another page "handler": - - :::django - [{{ y|default:"{{" }} refs.handler.headers.title }}]({{ y|default:"{{" }} refs.handler.path }}) - + +:::django +[{{ y|default:"{{" }} refs.handler.headers.title }}]({{ y|default:"{{" }} refs.handler.path }}) + Printing excerpt as a link to another page "handler": - - :::django - [{{ y|default:"{{" }} refs.handler.headers.excerpt }}]({{ y|default:"{{" }} refs.handler.path }}) - + +:::django +[{{ y|default:"{{" }} refs.handler.headers.excerpt }}]({{ y|default:"{{" }} refs.handler.path }}) + Print a bullet pointed child page list: - :::django - {{ y|default:"{%" }} for label, page in children %}* [{{ y|default:"{{" }} page.headers.title }}]({{ y|default:"{{" }} page.path }}) - {{ y|default:"{%" }} endfor %} +:::django +{{ y|default:"{%" }} for label, page in children %}* [{{ y|default:"{{" }} page.headers.title }}]({{ y|default:"{{" }} page.path }}) +{{ y|default:"{%" }} endfor %} <div class="note"> It is important to have the first part as a single line, otherwise @@ -169,26 +164,23 @@ for the build tools to work. To prepare for site build, the Markdown daemon has to be started: - :::sh - $ export MARKDOWN_SOCKET="$PWD/tools/build/../markdown.socket" - $ export PYTHONPATH="$PWD/tools/build" - $ python "$PWD/tools/build/markdownd.py" +:::sh +$ export MARKDOWN_SOCKET="$PWD/tools/build/../markdown.socket" +$ export PYTHONPATH="$PWD/tools/build" +$ python "$PWD/tools/build/markdownd.py" The `MARKDOWN_SOCKET` environment variables is also required by the `build_site.pl` and `build_file.pl` scripts to connect to the Markdown daemon. To build the complete site use the `build_site.pl` script: - :::sh - $ tools/build/build_site.pl --source-base $PWD/trunk \ - --target-base $PWD/trunk/target +:::sh +$ tools/build/build_site.pl --source-base $PWD/trunk --target-base $PWD/trunk/target To build a single page use the `build_file.pl` script: - :::sh - $ tools/build/build_site.pl --source-base $PWD/trunk \ - --target-base $PWD/trunk/target \ - --source content/documentation.mdtext +:::sh +$ tools/build/build_site.pl --source-base $PWD/trunk --target-base $PWD/trunk/target --source content/documentation.mdtext The argument to the `--source` parameter is relative to the `--source-base` folder. http://git-wip-us.apache.org/repos/asf/sling-site/blob/88e80480/content/documentation/bundles.md ---------------------------------------------------------------------- diff --git a/content/documentation/bundles.md b/content/documentation/bundles.md index ed3e152..279aa03 100644 --- a/content/documentation/bundles.md +++ b/content/documentation/bundles.md @@ -1,10 +1,7 @@ -title=TODO title for bundles.md -date=1900-01-01 -type=post -tags=blog +title=Bundles +type=page status=published ~~~~~~ -Title: Bundles ## Content http://git-wip-us.apache.org/repos/asf/sling-site/blob/88e80480/content/documentation/bundles/accessing-filesystem-resources-extensions-fsresource.md ---------------------------------------------------------------------- diff --git a/content/documentation/bundles/accessing-filesystem-resources-extensions-fsresource.md b/content/documentation/bundles/accessing-filesystem-resources-extensions-fsresource.md index 188b994..dd34c28 100644 --- a/content/documentation/bundles/accessing-filesystem-resources-extensions-fsresource.md +++ b/content/documentation/bundles/accessing-filesystem-resources-extensions-fsresource.md @@ -1,10 +1,7 @@ -title=TODO title for accessing-filesystem-resources-extensions-fsresource.md -date=1900-01-01 -type=post -tags=blog +title=Accessing File System Resources (org.apache.sling.fsresource) +type=page status=published ~~~~~~ -Title: Accessing File System Resources (org.apache.sling.fsresource) [TOC] @@ -24,8 +21,8 @@ Currently two major versions are maintained - choose the correct version dependi Files and directories are mapped into the resource tree as regular `Resource` instances whose resource type depends on the actual nature of the mapped file system resource: - * Regular files are assigned the `nt:file` resource type - * Directories are assigned the `nt:folder` resource type +* Regular files are assigned the `nt:file` resource type +* Directories are assigned the `nt:folder` resource type Content stored in JSON or FileVault XML files are mapped with the resource type stored in the files. If a resource type is missing `nt:unstructured` is used as fallback. @@ -34,9 +31,9 @@ Content stored in JSON or FileVault XML files are mapped with the resource type File system resources extend from Sling's `AbstractResource` class and thus are adaptable to any type for which an `AdapterFactory` is registered supporting file system resources. In addition File system Resources support the following adapters natively: - * `java.io.File` -- The Java file object providing access to the file system file - * `java.net.URL` -- A valid `file://` URL to the file. This URL is derived from the `java.io.File` object by calling the `File.toURI().toURL()` sequence. - * `java.io.InputStream` -- If the `java.io.File` can be read from (as per `File.canRead()` an `InputStream` to read from the file is returned. +* `java.io.File` -- The Java file object providing access to the file system file +* `java.net.URL` -- A valid `file://` URL to the file. This URL is derived from the `java.io.File` object by calling the `File.toURI().toURL()` sequence. +* `java.io.InputStream` -- If the `java.io.File` can be read from (as per `File.canRead()` an `InputStream` to read from the file is returned. @@ -81,15 +78,15 @@ This mode is best use together with the [Maven Sling Plugin][maven-sling-plugin] Usage - deploy OSGi bundle from current maven project and register the appropriate OSGi configuration mappings: - $ mvn -Dsling.mountByFS=true sling:install +$ mvn -Dsling.mountByFS=true sling:install Only register the appropriate mappings: - $ mvn sling:fsmount +$ mvn sling:fsmount Remove the mappings: - $ mvn sling:fsunmount +$ mvn sling:fsunmount Notes: @@ -106,11 +103,11 @@ This mode is best use together with the [Maven Sling Plugin][maven-sling-plugin] Usage - register the appropriate mappings: - $ mvn sling:fsmount +$ mvn sling:fsmount Remove the mappings: - $ mvn sling:fsunmount +$ mvn sling:fsunmount Notes: http://git-wip-us.apache.org/repos/asf/sling-site/blob/88e80480/content/documentation/bundles/apache-sling-commons-thread-pool.md ---------------------------------------------------------------------- diff --git a/content/documentation/bundles/apache-sling-commons-thread-pool.md b/content/documentation/bundles/apache-sling-commons-thread-pool.md index 0c0be1d..67c6743 100644 --- a/content/documentation/bundles/apache-sling-commons-thread-pool.md +++ b/content/documentation/bundles/apache-sling-commons-thread-pool.md @@ -1,10 +1,7 @@ -title=TODO title for apache-sling-commons-thread-pool.md -date=1900-01-01 -type=post -tags=blog +title=Apache Sling Commons Thread Pool +type=page status=published ~~~~~~ -Title: Apache Sling Commons Thread Pool The Apache Sling Commons Thread Pool bundle provides a thread pool services. All thread pools are managed by the `org.apache.sling.commons.threads.ThreadPoolManager`. This service can be used to get a thread pool. http://git-wip-us.apache.org/repos/asf/sling-site/blob/88e80480/content/documentation/bundles/apache-sling-eventing-and-job-handling.md ---------------------------------------------------------------------- diff --git a/content/documentation/bundles/apache-sling-eventing-and-job-handling.md b/content/documentation/bundles/apache-sling-eventing-and-job-handling.md index 4372c23..b8183f4 100644 --- a/content/documentation/bundles/apache-sling-eventing-and-job-handling.md +++ b/content/documentation/bundles/apache-sling-eventing-and-job-handling.md @@ -1,10 +1,7 @@ -title=TODO title for apache-sling-eventing-and-job-handling.md -date=1900-01-01 -type=post -tags=blog +title=Apache Sling Eventing and Job Handling +type=page status=published ~~~~~~ -Title: Apache Sling Eventing and Job Handling ## Overview @@ -28,9 +25,9 @@ In general, the eventing mechanism (OSGi EventAdmin) has no knowledge about the On the other hand, there are use cases where the guarantee of processing is a must and usually this comes with the requirement of processing exactly once. Typical examples are sending notification emails (or sms), post processing of content (like thumbnail generation of images or documents), workflow steps etc. -The Sling Event Support adds the notion of a job. A job is a special event that has to be processed exactly once. +The Sling Event Support adds the notion of a job. A job is a special event that has to be processed exactly once. To be precise, the processing guarantee is at least once. However, the time window for a single job where exactly -once can't be guaranteed is very small. It happens if the instance which processes a job crashes after the job +once can't be guaranteed is very small. It happens if the instance which processes a job crashes after the job processing is finished but before this state is persisted. Therefore a job consumer should be prepared to process a job more than once. Of course, if there is no job consumer for a job, the job is never processed. However this is considered a deployment error. @@ -41,26 +38,26 @@ While older versions of the job handling were based on sending and receiving eve A job consists of two parts, the job topic describing the nature of the job and the payload which is a key value map of serializable objects. A client can initiate a job by calling the *JobManager.addJob* method: - import org.apache.sling.jobs.JobManager; - import org.apache.felix.scr.annotations.Component; - import org.apache.felix.scr.annotations.Reference; - import java.util.Map; - import java.util.HashMap; - - @Component - public class MyComponent { - - @Reference - private JobManager jobManager; - - public void startJob() { - final Map<String, Object> props = new HashMap<String, Object>(); - props.put("item1", "/something"); - props.put("count", 5); - - jobManager.addJob("my/special/jobtopic", props); - } - } +import org.apache.sling.jobs.JobManager; +import org.apache.felix.scr.annotations.Component; +import org.apache.felix.scr.annotations.Reference; +import java.util.Map; +import java.util.HashMap; + +@Component +public class MyComponent { + +@Reference +private JobManager jobManager; + +public void startJob() { +final Map<String, Object> props = new HashMap<String, Object>(); +props.put("item1", "/something"); +props.put("count", 5); + +jobManager.addJob("my/special/jobtopic", props); +} +} The job topic follows the conventions for the topic of an OSGi event. All objects in the payload must be serializable and publically available (exported by a bundle). This is required as the job is persisted and unmarshalled before processing. @@ -77,25 +74,25 @@ Scheduled Jobs are put in the queue at a specific time (optionally periodically) An example code for scheduling a job looks like this: - import org.apache.sling.jobs.JobManager; - import org.apache.sling.event.jobs.JobBuilder.ScheduleBuilder; - import org.apache.felix.scr.annotations.Component; - import org.apache.felix.scr.annotations.Reference; +import org.apache.sling.jobs.JobManager; +import org.apache.sling.event.jobs.JobBuilder.ScheduleBuilder; +import org.apache.felix.scr.annotations.Component; +import org.apache.felix.scr.annotations.Reference; - @Component - public class MyComponent { +@Component +public class MyComponent { - @Reference - private JobManager jobManager; +@Reference +private JobManager jobManager; - public void startScheduledJob() { - ScheduleBuilder scheduleBuilder = jobManager.startJob("my/special/jobtopic").schedule(); - scheduleBuilder.daily(0,0); // execute daily at midnight - if (scheduleBuilder.add() == null) { - // something went wrong here, use scheduleBuilder.add(List<String>) instead to get further information about the error - } - } - } +public void startScheduledJob() { +ScheduleBuilder scheduleBuilder = jobManager.startJob("my/special/jobtopic").schedule(); +scheduleBuilder.daily(0,0); // execute daily at midnight +if (scheduleBuilder.add() == null) { +// something went wrong here, use scheduleBuilder.add(List<String>) instead to get further information about the error +} +} +} Internally the scheduled Jobs use the [Commons Scheduler Service](/documentation/bundles/scheduler-service-commons-scheduler.html). But in addition they are persisted (by default below `/var/eventing/scheduled-jobs`) and survive therefore even server restarts. When the scheduled time is reached, the job is automatically added as regular Sling Job through the `JobManager`. @@ -105,21 +102,21 @@ Internally the scheduled Jobs use the [Commons Scheduler Service](/documentation A job consumer is a service consuming and processing a job. It registers itself as an OSGi service together with a property defining which topics this consumer can process: - import org.apache.felix.scr.annotations.Component; - import org.apache.felix.scr.annotations.Service; - import org.apache.sling.event.jobs.Job; - import org.apache.sling.event.jobs.consumer.JobConsumer; +import org.apache.felix.scr.annotations.Component; +import org.apache.felix.scr.annotations.Service; +import org.apache.sling.event.jobs.Job; +import org.apache.sling.event.jobs.consumer.JobConsumer; - @Component - @Service(value={JobConsumer.class}) - @Property(name=JobConsumer.PROPERTY_TOPICS, value="my/special/jobtopic",) - public class MyJobConsumer implements JobConsumer { +@Component +@Service(value={JobConsumer.class}) +@Property(name=JobConsumer.PROPERTY_TOPICS, value="my/special/jobtopic",) +public class MyJobConsumer implements JobConsumer { - public JobResult process(final Job job) { - // process the job and return the result - return JobResult.OK; - } - } +public JobResult process(final Job job) { +// process the job and return the result +return JobResult.OK; +} +} The *Job* interface allows to query the topic, the payload and additional information about the current job. The consumer can either return *JobResult.OK* indicating that the job has been processed, *JobResult.FAILED* indicating the processing failed, but can be retried or *JobResult.CANCEL* the processing has failed permanently. @@ -179,7 +176,7 @@ If a user action results in the creation of a job, the thread processing the use If an observation event or any other OSGi event results in the creation of a job, special care needs to be taken in a clustered installation to avoid the job is created on all cluster instances. The easiest way to avoid this, is to use the topology api and make sure the job is only created on the leader instance. - + ## Distributed Events In addition to the job handling, the Sling Event support adds handling for distributed events. A distributed event is an OSGi event which is sent across JVM boundaries to a different VM. A potential use case is to broadcast information in a clustered environment. http://git-wip-us.apache.org/repos/asf/sling-site/blob/88e80480/content/documentation/bundles/bundle-resources-extensions-bundleresource.md ---------------------------------------------------------------------- diff --git a/content/documentation/bundles/bundle-resources-extensions-bundleresource.md b/content/documentation/bundles/bundle-resources-extensions-bundleresource.md index d320689..0dd16cb 100644 --- a/content/documentation/bundles/bundle-resources-extensions-bundleresource.md +++ b/content/documentation/bundles/bundle-resources-extensions-bundleresource.md @@ -1,52 +1,49 @@ -title=TODO title for bundle-resources-extensions-bundleresource.md -date=1900-01-01 -type=post -tags=blog +title=Bundle Resources (extensions.bundleresource) +type=page status=published ~~~~~~ -Title: Bundle Resources (extensions.bundleresource) [TOC] ## Introduction -The Bundle Resource Provider provides access to files/directories included in an OSGi bundle through the Sling `ResourceResolver`. +The Bundle Resource Provider provides access to files/directories included in an 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 +* 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 file contents. Doesn't apply to folders. +* `java.net.URL` -- A valid `bundle://` URL to the resource in the bundle. +* `java.io.InputStream` -- An `InputStream` to read file contents. Doesn't apply to folders. ## Configuration -Providing bundles have a Bundle manifest header `Sling-Bundle-Resources` containing a list of absolute paths provided by the bundle. The paths are separated by comma or whitespace (SP, TAB, VTAB, CR, LF). +Providing bundles have a Bundle manifest header `Sling-Bundle-Resources` containing a list of absolute paths provided by the bundle. The paths are separated by comma or whitespace (SP, TAB, VTAB, CR, LF). Example (manifest.mf): - ... - Sling-Bundle-Resources: /libs/sling/explorer, - /libs/sling/servlet/default/explorer - ... +... +Sling-Bundle-Resources: /libs/sling/explorer, +/libs/sling/servlet/default/explorer +... 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: - ... - Sling-Bundle-Resources: /somepath/inthe/resourcetree;path:=/path/inthe/bundle - ... +... +Sling-Bundle-Resources: /somepath/inthe/resourcetree;path:=/path/inthe/bundle +... The Bundle Resource Provider also has a web console plugin through which the currently installed bundles can be seen. http://git-wip-us.apache.org/repos/asf/sling-site/blob/88e80480/content/documentation/bundles/caching-services.md ---------------------------------------------------------------------- diff --git a/content/documentation/bundles/caching-services.md b/content/documentation/bundles/caching-services.md index 5a1bad9..76fa334 100644 --- a/content/documentation/bundles/caching-services.md +++ b/content/documentation/bundles/caching-services.md @@ -1,10 +1,7 @@ -title=TODO title for caching-services.md -date=1900-01-01 -type=post -tags=blog +title=Sling Caching Services +type=page status=published ~~~~~~ -Title: Sling Caching Services Caching services are available as a contribution at [https://svn.apache.org/repos/asf/sling/trunk/contrib/extensions/cache](https://svn.apache.org/repos/asf/sling/trunk/contrib/extensions/cache) http://git-wip-us.apache.org/repos/asf/sling-site/blob/88e80480/content/documentation/bundles/commons-html-utilities.md ---------------------------------------------------------------------- diff --git a/content/documentation/bundles/commons-html-utilities.md b/content/documentation/bundles/commons-html-utilities.md index 4c24adb..b7b1075 100644 --- a/content/documentation/bundles/commons-html-utilities.md +++ b/content/documentation/bundles/commons-html-utilities.md @@ -1,9 +1,6 @@ -title=TODO title for commons-html-utilities.md -date=1900-01-01 -type=post -tags=blog +title=Commons HTML Utilities (org.apache.sling.commons.html) +type=page status=published ~~~~~~ -Title: Commons HTML Utilities (org.apache.sling.commons.html) The Apache Sling Commons HTML Utilities bundle provides an HTML parser which can be used to parse HTML and either generate a DOM or SAX events out of the HTML. Therefore the parser transforms the HTML into proper XHTML. http://git-wip-us.apache.org/repos/asf/sling-site/blob/88e80480/content/documentation/bundles/configuration-installer-factory.md ---------------------------------------------------------------------- diff --git a/content/documentation/bundles/configuration-installer-factory.md b/content/documentation/bundles/configuration-installer-factory.md index 371705f..3e9a551 100644 --- a/content/documentation/bundles/configuration-installer-factory.md +++ b/content/documentation/bundles/configuration-installer-factory.md @@ -1,31 +1,28 @@ -title=TODO title for configuration-installer-factory.md -date=1900-01-01 -type=post -tags=blog +title=Configuration Installer Factory +type=page status=published ~~~~~~ -Title: Configuration Installer Factory The configuration installer factory provides support for configurations to the [OSGI installer](/documentation/bundles/osgi-installer.html). The provisioning of artifacts is handled by installer providers like the file installer or the JCR installer. ## Configurations - + Configuration file names are related to the PID and factory PID. The structure of the file name is as follows: - - filename ::= <pid> ( '-' <subname> )? ('.cfg'|'.config') - +filename ::= <pid> ( '-' <subname> )? ('.cfg'|'.config') + + If the form is `<pid>('.cfg'|'.config')`, the file contains the properties for a Managed Service. The `<pid>` is then the PID of the Managed Service. See the Configuration Admin service for details. - + When a Managed Service Factory is used, the situation is different. The `<pid>` part then describes the PID of the Managed Service Factory. You can pick any `<subname>`, the installer will then create an instance for the factory for each unique name. For example: - - com.acme.xyz.cfg // configuration for Managed Service - // com.acme.xyz - com.acme.abc-default.cfg // Managed Service Factory, - // creates an instance for com.acme.abc + +com.acme.xyz.cfg // configuration for Managed Service +// com.acme.xyz +com.acme.abc-default.cfg // Managed Service Factory, +// creates an instance for com.acme.abc If a configuration is modified, the file installer will write the configuration back to a file to ensure peristence across restarts (if `sling.fileinstall.writeback` is enabled). @@ -33,16 +30,16 @@ If a configuration is modified, the file installer will write the configuration ### Property Files (.cfg) Configuration files ending in '.cfg' are plain property files (`java.util.Property`). The format is simple: - - file ::= ( header | comment ) * - header ::= <header> ( ':' | '=' ) <value> ( '\<nl> <value> ) * - comment ::= '#' <any> + +file ::= ( header | comment ) * +header ::= <header> ( ':' | '=' ) <value> ( '<nl> <value> ) * +comment ::= '#' <any> Notice that this model only supports string properties. For example: - - # default port - ftp.port = 21 + +# default port +ftp.port = 21 ### Configuration Files (.config) @@ -52,17 +49,17 @@ The first line of such a file might start with a comment line (a line starting w The format is: - file ::= (comment) (header) * - comment ::= '#' <any> - header ::= prop '=' value - prop ::= symbolic-name // 1.4.2 of OSGi Core Specification - symbolic-name ::= token { '.' token } - token ::= { [ 0..9 ] | [ a..z ] | [ A..Z ] | '_' | '-' } - value ::= [ type ] ( '[' values ']' | '(' values ')' | simple ) - values ::= simple { ',' simple } - simple ::= '"' stringsimple '"' - type ::= <1-char type code> - stringsimple ::= <quoted string representation of the value where both '"' and '=' need to be escaped> +file ::= (comment) (header) * +comment ::= '#' <any> +header ::= prop '=' value +prop ::= symbolic-name // 1.4.2 of OSGi Core Specification +symbolic-name ::= token { '.' token } +token ::= { [ 0..9 ] | [ a..z ] | [ A..Z ] | '_' | '-' } +value ::= [ type ] ( '[' values ']' | '(' values ')' | simple ) +values ::= simple { ',' simple } +simple ::= '"' stringsimple '"' +type ::= <1-char type code> +stringsimple ::= <quoted string representation of the value where both '"' and '=' need to be escaped> The quoted string format is equal to the definition from HTTP 1.1 ([RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec2.html)), except that both '"' and '=' need to be escaped. http://git-wip-us.apache.org/repos/asf/sling-site/blob/88e80480/content/documentation/bundles/content-distribution.md ---------------------------------------------------------------------- diff --git a/content/documentation/bundles/content-distribution.md b/content/documentation/bundles/content-distribution.md index 426280b..b0605f9 100644 --- a/content/documentation/bundles/content-distribution.md +++ b/content/documentation/bundles/content-distribution.md @@ -1,10 +1,7 @@ -title=TODO title for content-distribution.md -date=1900-01-01 -type=post -tags=blog +title=Content Distribution (org.apache.sling.distribution) +type=page status=published ~~~~~~ -Title: Content Distribution (org.apache.sling.distribution) [TOC] @@ -22,22 +19,22 @@ A forward distribution setup allows one to transfer content from a source instan #### Setup overview * one source instance - * one distribution agent connected to importer endpoints for all target instances. +* one distribution agent connected to importer endpoints for all target instances. * N target instances - * one distribution importer on each target instance used to import packages into the local instance. +* one distribution importer on each target instance used to import packages into the local instance. #### Sample configuration * on source instance: one forward agent - org.apache.sling.distribution.agent.impl.ForwardDistributionAgentFactory-publish.json - name="publish" - packageImporter.endpoints=["http://localhost:4503/libs/sling/distribution/services/importers/default";] +org.apache.sling.distribution.agent.impl.ForwardDistributionAgentFactory-publish.json +name="publish" +packageImporter.endpoints=["http://localhost:4503/libs/sling/distribution/services/importers/default";] * on target instance: one local importer - org.apache.sling.distribution.packaging.impl.importer.LocalDistributionPackageImporterFactory-default - name="default" +org.apache.sling.distribution.packaging.impl.importer.LocalDistributionPackageImporterFactory-default +name="default" ### Reverse distribution @@ -46,29 +43,29 @@ A reverse distribution setup allows one to transfer content from a farm of sourc #### Setup overview * one target instance - * one distribution agent connected to exporter endpoints for all target instances. +* one distribution agent connected to exporter endpoints for all target instances. * N source instances - * one distribution (queue) agent on each source instance; changes from the source instances are placed in the queues of these agents. - * one distribution exporter on each source instance that exports packages from the queue agent. +* one distribution (queue) agent on each source instance; changes from the source instances are placed in the queues of these agents. +* one distribution exporter on each source instance that exports packages from the queue agent. #### Sample configuration * on target instance: one reverse agent - org.apache.sling.distribution.agent.impl.ReverseDistributionAgentFactory-reverse.json - name="reverse" - packageExporter.endpoints=["http://localhost:4503/libs/sling/distribution/services/exporters/reverse";] +org.apache.sling.distribution.agent.impl.ReverseDistributionAgentFactory-reverse.json +name="reverse" +packageExporter.endpoints=["http://localhost:4503/libs/sling/distribution/services/exporters/reverse";] * on source instance: one queue agent and one exporter for that agent - - org.apache.sling.distribution.agent.impl.QueueDistributionAgentFactory-reverse.json - name="reverse" - - org.apache.sling.distribution.packaging.impl.exporter.AgentDistributionPackageExporterFactory-reverse - name="reverse" - agent.target="(name=reverse)" - - + +org.apache.sling.distribution.agent.impl.QueueDistributionAgentFactory-reverse.json +name="reverse" + +org.apache.sling.distribution.packaging.impl.exporter.AgentDistributionPackageExporterFactory-reverse +name="reverse" +agent.target="(name=reverse)" + + ### Sync distribution @@ -76,36 +73,36 @@ A sync distribution setup allows one to synchronize content in a farm of instanc #### Setup overview: * one coordinator instance - * one distribution agent connected to exporter/importer endpoints for all farm instances. +* one distribution agent connected to exporter/importer endpoints for all farm instances. * N farm instances - * one distribution (queue) agent on each farm instance; changes from these instances are placed in the queues of the queue agents. - * one distribution exporter on each farm instance that exports packages from the queue agent. - * one distribution importer on each farm instance used to import packages into the local instance. +* one distribution (queue) agent on each farm instance; changes from these instances are placed in the queues of the queue agents. +* one distribution exporter on each farm instance that exports packages from the queue agent. +* one distribution importer on each farm instance used to import packages into the local instance. #### Sample configuration * on coordinator instance: one sync agent - org.apache.sling.distribution.agent.impl.SyncDistributionAgentFactory-sync.json - name="sync" - packageExporter.endpoints=["http://localhost:4503/libs/sling/distribution/services/exporters/reverse";, "http://localhost:4504/libs/sling/distribution/services/exporters/reverse";] - packageImporter.endpoints=["http://localhost:4503/libs/sling/distribution/services/importers/default";, "http://localhost:4504/libs/sling/distribution/services/importers/default";] +org.apache.sling.distribution.agent.impl.SyncDistributionAgentFactory-sync.json +name="sync" +packageExporter.endpoints=["http://localhost:4503/libs/sling/distribution/services/exporters/reverse";, "http://localhost:4504/libs/sling/distribution/services/exporters/reverse";] +packageImporter.endpoints=["http://localhost:4503/libs/sling/distribution/services/importers/default";, "http://localhost:4504/libs/sling/distribution/services/importers/default";] * on each farm instance: one local exporter and one local importer - - org.apache.sling.distribution.agent.impl.QueueDistributionAgentFactory-reverse.json - name="reverse" - - org.apache.sling.distribution.packaging.impl.exporter.AgentDistributionPackageExporterFactory-reverse - name="reverse" - agent.target="(name=reverse)" - - org.apache.sling.distribution.packaging.impl.importer.LocalDistributionPackageImporterFactory-default - name="reverse" - agent.target="(name=reverse)" - +org.apache.sling.distribution.agent.impl.QueueDistributionAgentFactory-reverse.json +name="reverse" + +org.apache.sling.distribution.packaging.impl.exporter.AgentDistributionPackageExporterFactory-reverse +name="reverse" +agent.target="(name=reverse)" + +org.apache.sling.distribution.packaging.impl.importer.LocalDistributionPackageImporterFactory-default +name="reverse" +agent.target="(name=reverse)" + + ### Multidatacenter sync distribution @@ -115,52 +112,52 @@ A multidatacenter sync distribution setup allows one to synchronize content in a #### Setup overview * one coordinator instance in each datacenter - * one distribution agent for intra-datacenter synchronization. Like a regular sync agent it connects to all farm instances in its datacenter and syncronizes them. In addition to a regular sync agent it keeps the packages also in dedicated queues for the other DCs, so that the coordinators from the other DCs can pull the updates. - * one distribution exporter for each queue dedicated for the remote DCs. The inter-dc coordinators from the other DCs will connect to these exporter endpoints. - * one distribution agent for inter-datacenter synchronization; it conntects to the dedicated queues exposed by intra-dc coordinators from the other datacenters. +* one distribution agent for intra-datacenter synchronization. Like a regular sync agent it connects to all farm instances in its datacenter and syncronizes them. In addition to a regular sync agent it keeps the packages also in dedicated queues for the other DCs, so that the coordinators from the other DCs can pull the updates. +* one distribution exporter for each queue dedicated for the remote DCs. The inter-dc coordinators from the other DCs will connect to these exporter endpoints. +* one distribution agent for inter-datacenter synchronization; it conntects to the dedicated queues exposed by intra-dc coordinators from the other datacenters. * N farm instances in each datacenter - * one distribution (queue) agent on each farm instance; changes from these instances are placed in the queues of the queue agents. - * one distribution exporter on each farm instance that exports packages from the queue agent. - * one distribution importer on each farm instance used to import packages into the local instance. +* one distribution (queue) agent on each farm instance; changes from these instances are placed in the queues of the queue agents. +* one distribution exporter on each farm instance that exports packages from the queue agent. +* one distribution importer on each farm instance used to import packages into the local instance. #### Sample configuration * on coordinator instance: one intradcsync agent with two exporters for the other dcs, and one interdcsync agent that connects to remote exporters. - org.apache.sling.distribution.agent.impl.SyncDistributionAgentFactory-intradcsync - name="intradcsync" - packageExporter.endpoints=["http://localhost:4503/libs/sling/distribution/services/exporters/reverse";, "http://localhost:4504/libs/sling/distribution/services/exporters/reverse";] - packageImporter.endpoints=["http://localhost:4503/libs/sling/distribution/services/importers/default";, "http://localhost:4504/libs/sling/distribution/services/importers/default";] - passiveQueues=["dc2queue", "dc3queue"] - - org.apache.sling.distribution.packaging.impl.exporter.AgentDistributionPackageExporterFactory-dc2queue - name="dc2queue" - agent.target="(name=intradcsync)" - queue="dc2queue" - - org.apache.sling.distribution.packaging.impl.exporter.AgentDistributionPackageExporterFactory-dc3queue - name="dc3queue" - agent.target="(name=intradcsync)" - queue="dc3queue" - - org.apache.sling.distribution.agent.impl.SyncDistributionAgentFactory-interdcsync - name="interdcsync" - packageExporter.endpoints=["http://localhost:5502/libs/sling/distribution/services/exporters/dc1queue";, "http://localhost:6502/libs/sling/distribution/services/exporters/dc1queue";] - packageImporter.endpoints=["http://localhost:4503/libs/sling/distribution/services/importers/default";, "http://localhost:4504/libs/sling/distribution/services/importers/default";] +org.apache.sling.distribution.agent.impl.SyncDistributionAgentFactory-intradcsync +name="intradcsync" +packageExporter.endpoints=["http://localhost:4503/libs/sling/distribution/services/exporters/reverse";, "http://localhost:4504/libs/sling/distribution/services/exporters/reverse";] +packageImporter.endpoints=["http://localhost:4503/libs/sling/distribution/services/importers/default";, "http://localhost:4504/libs/sling/distribution/services/importers/default";] +passiveQueues=["dc2queue", "dc3queue"] + +org.apache.sling.distribution.packaging.impl.exporter.AgentDistributionPackageExporterFactory-dc2queue +name="dc2queue" +agent.target="(name=intradcsync)" +queue="dc2queue" + +org.apache.sling.distribution.packaging.impl.exporter.AgentDistributionPackageExporterFactory-dc3queue +name="dc3queue" +agent.target="(name=intradcsync)" +queue="dc3queue" + +org.apache.sling.distribution.agent.impl.SyncDistributionAgentFactory-interdcsync +name="interdcsync" +packageExporter.endpoints=["http://localhost:5502/libs/sling/distribution/services/exporters/dc1queue";, "http://localhost:6502/libs/sling/distribution/services/exporters/dc1queue";] +packageImporter.endpoints=["http://localhost:4503/libs/sling/distribution/services/importers/default";, "http://localhost:4504/libs/sling/distribution/services/importers/default";] * on each farm instance: one local exporter and one local importer - - org.apache.sling.distribution.agent.impl.QueueDistributionAgentFactory-reverse.json - name="reverse" - - org.apache.sling.distribution.packaging.impl.exporter.AgentDistributionPackageExporterFactory-reverse - name="reverse" - agent.target="(name=reverse)" - - org.apache.sling.distribution.packaging.impl.importer.LocalDistributionPackageImporterFactory-default - name="default" + +org.apache.sling.distribution.agent.impl.QueueDistributionAgentFactory-reverse.json +name="reverse" + +org.apache.sling.distribution.packaging.impl.exporter.AgentDistributionPackageExporterFactory-reverse +name="reverse" +agent.target="(name=reverse)" + +org.apache.sling.distribution.packaging.impl.importer.LocalDistributionPackageImporterFactory-default +name="default" http://git-wip-us.apache.org/repos/asf/sling-site/blob/88e80480/content/documentation/bundles/content-loading-jcr-contentloader.md ---------------------------------------------------------------------- diff --git a/content/documentation/bundles/content-loading-jcr-contentloader.md b/content/documentation/bundles/content-loading-jcr-contentloader.md index ac3421c..b6f6998 100644 --- a/content/documentation/bundles/content-loading-jcr-contentloader.md +++ b/content/documentation/bundles/content-loading-jcr-contentloader.md @@ -1,10 +1,7 @@ -title=TODO title for content-loading-jcr-contentloader.md -date=1900-01-01 -type=post -tags=blog +title=Content Loading and Nodetype Support (jcr.contentloader) +type=page status=published ~~~~~~ -Title: Content Loading and Nodetype Support (jcr.contentloader) Apache Sling provides support for initial content loading into a repository and for registering node types. The `sling-jcr-contentloader` bundle provides loading of content from a bundle into the repository and the `sling-jcr-base` bundle provides node type registration. @@ -18,7 +15,7 @@ Adding this content preserves the paths of the entries as shown in this table, w |---|---| | `SLING-INF/content/home` | `/home` | | `SLING-INF/content/content/playground/en/home` | `/content/playground/en/home` | -| `SLING-INF/someothercontent/playground/en/home` | not installed at all, because not below the `Sling-Initial-Content` header entry | +| `SLING-INF/someothercontent/playground/en/home` | not installed at all, because not below the `Sling-Initial-Content` header entry | Bundle entries are installed as follows: @@ -73,147 +70,147 @@ The MIME type is derived from the file name extension by first trying to resolve Nodes, Properties and in fact complete subtrees may be described in XML files using either the JCR SystemView format, or the format described below. In either case, the file must have the .xml extension. - <node> - <!-- - optional on top level, defaults to XML file name without .xml extension - required for child nodes - --> - <name>xyz</name> - - <!-- - optional, defaults to nt:unstructured - --> - <primaryNodeType>nt:file</primaryNodeType> - - <!-- - optional mixin node type - may be repeated for multiple mixin node types - --> - <mixinNodeType>mix:versionable</mixinNodeType> - <mixinNodeType>mix:lockable</mixinNodeType> - - <!-- - Optional properties for the node. Each <property> element defines - a single property of the node. The element may be repeated. - --> - <property> - <!-- - required property name - --> - <name>prop</name> - - <!-- - value of the property. - For multi-value properties, the values are defined by multiple - <value> elements nested inside a <values> element instead of a - single <value> element - --> - <value>property value as string</value> - - <!-- - Optional type of the property value, defaults to String. - This must be one of the property type strings defined in the - JCR PropertyType interface. - --> - <type>String</type> - </property> - - <!-- - Additional child nodes. May be further nested. - --> - <node> - .... - </node> - </node> +<node> +<!-- +optional on top level, defaults to XML file name without .xml extension +required for child nodes +--> +<name>xyz</name> + +<!-- +optional, defaults to nt:unstructured +--> +<primaryNodeType>nt:file</primaryNodeType> + +<!-- +optional mixin node type +may be repeated for multiple mixin node types +--> +<mixinNodeType>mix:versionable</mixinNodeType> +<mixinNodeType>mix:lockable</mixinNodeType> + +<!-- +Optional properties for the node. Each <property> element defines +a single property of the node. The element may be repeated. +--> +<property> +<!-- +required property name +--> +<name>prop</name> + +<!-- +value of the property. +For multi-value properties, the values are defined by multiple +<value> elements nested inside a <values> element instead of a +single <value> element +--> +<value>property value as string</value> + +<!-- +Optional type of the property value, defaults to String. +This must be one of the property type strings defined in the +JCR PropertyType interface. +--> +<type>String</type> +</property> + +<!-- +Additional child nodes. May be further nested. +--> +<node> +.... +</node> +</node> #### Using a custom XML format -By writing an XSLT stylesheet file, you can use whatever XML format you prefer. The XML file references an XSLT stylesheet by using the xml-stylesheet processing instruction: +By writing an XSLT stylesheet file, you can use whatever XML format you prefer. The XML file references an XSLT stylesheet by using the xml-stylesheet processing instruction: - <?xml version="1.0" encoding="UTF-8"?> - <?xml-stylesheet href="my-transform.xsl" type="text/xsl"?> <!-- The path to my-transform.xsl is relative to this file --> - - <your_custom_root_node> - <your_custom_element> - ... - </your_custom_element> - ... - </your_custom_root_node> +<?xml version="1.0" encoding="UTF-8"?> +<?xml-stylesheet href="my-transform.xsl" type="text/xsl"?> <!-- The path to my-transform.xsl is relative to this file --> + +<your_custom_root_node> +<your_custom_element> +... +</your_custom_element> +... +</your_custom_root_node> The my-transform.xsl file is then responsible for translating your format into one of the supported XML formats: - - <xsl:stylesheet version="1.0" xmlns:jcr="http://www.jcp.org/jcr/1.0"; xmlns:mix="http://www.jcp.org/jcr/mix/1.0"; - xmlns:sv="http://www.jcp.org/jcr/sv/1.0"; xmlns:sling="http://sling.apache.org/jcr/sling/1.0"; - xmlns:rep="internal" xmlns:nt="http://www.jcp.org/jcr/nt/1.0"; xmlns:xsl="http://www.w3.org/1999/XSL/Transform";> - - <xsl:template match="your_custom_element"> - <node> - ... - </node> - </xsl:template> - ... - </xsl:stylesheet> - + +<xsl:stylesheet version="1.0" xmlns:jcr="http://www.jcp.org/jcr/1.0"; xmlns:mix="http://www.jcp.org/jcr/mix/1.0"; +xmlns:sv="http://www.jcp.org/jcr/sv/1.0"; xmlns:sling="http://sling.apache.org/jcr/sling/1.0"; +xmlns:rep="internal" xmlns:nt="http://www.jcp.org/jcr/nt/1.0"; xmlns:xsl="http://www.w3.org/1999/XSL/Transform";> + +<xsl:template match="your_custom_element"> +<node> +... +</node> +</xsl:template> +... +</xsl:stylesheet> + ### JSON Descriptor Files Nodes, Properties and in fact complete subtrees may be described in JSON files using the following skeleton structure (see [http://www.json.org](http://www.json.org) or information on the syntax of JSON) : - { - // child node name - "nodename" : { +{ +// child node name +"nodename" : { + +// optional primary node type, default "nt:unstructured" +"jcr:primaryType": "sling:ScriptedComponent", - // optional primary node type, default "nt:unstructured" - "jcr:primaryType": "sling:ScriptedComponent", +// optional mixin node types as array +"jcr:mixinTypes": [ ], - // optional mixin node types as array - "jcr:mixinTypes": [ ], - - // additional properties as name value pairs. - // Multi-value properties are defined as JSON array. - // Property type is derived from the value +// additional properties as name value pairs. +// Multi-value properties are defined as JSON array. +// Property type is derived from the value - // String value (default) - "sling:contentClass": "com.day.sling.jcr.test.Test", +// String value (default) +"sling:contentClass": "com.day.sling.jcr.test.Test", - // Multi-value String - "sampleMulti": [ "v1", "v2" ], +// Multi-value String +"sampleMulti": [ "v1", "v2" ], - // Long value, single and multi - "sampleStruct": 1, - "sampleStructMulti": [ 1, 2, 3 ], +// Long value, single and multi +"sampleStruct": 1, +"sampleStructMulti": [ 1, 2, 3 ], - // Date follows pattern yyyy-mm-ddTHH:MM:SS.sss±HH:MM - "sampleDate": "2014-11-27T13:26:00.000+01:00", +// Date follows pattern yyyy-mm-ddTHH:MM:SS.sss±HH:MM +"sampleDate": "2014-11-27T13:26:00.000+01:00", - // JCR Node Reference with name prefix (removed to derive node name) - "jcr:reference:sampleRef": "386b0f48-49c3-4c58-8735-ceee6bfc1933", +// JCR Node Reference with name prefix (removed to derive node name) +"jcr:reference:sampleRef": "386b0f48-49c3-4c58-8735-ceee6bfc1933", - // JCR Path with name prefix (removed to derive node name) - "jcr:path:samplePath": "/content/data", +// JCR Path with name prefix (removed to derive node name) +"jcr:path:samplePath": "/content/data", - // JCR Name with name prefix (removed to derive node name) - "jcr:name:sampleName": "data", +// JCR Name with name prefix (removed to derive node name) +"jcr:name:sampleName": "data", - // URI with name prefix (removed to derive node name) - "jcr:uri:sampleUri": "http://sling.apache.org/";, +// URI with name prefix (removed to derive node name) +"jcr:uri:sampleUri": "http://sling.apache.org/";, - // Child nodes are simple JSON objects - "sling:scripts": { - "jcr:primaryType": "sling:ScriptList", - "sling:Script": { - "jcr:primaryType": "sling:Script", - "sling:name": "/test/content/jsp/start.jsp", - "sling:type": "jsp", - "sling:glob": "*" - } - } - } +// Child nodes are simple JSON objects +"sling:scripts": { +"jcr:primaryType": "sling:ScriptList", +"sling:Script": { +"jcr:primaryType": "sling:Script", +"sling:name": "/test/content/jsp/start.jsp", +"sling:type": "jsp", +"sling:glob": "*" +} +} +} ### Extractors @@ -222,7 +219,7 @@ By default, the `sling-jcr-contentloader` bundle tries to extract certain file t ### Workspace Targetting -By default, initial content will be loaded into the default workspace. To override this, add a `Sling-Initial-Content-Workspace` bundle manifest header to specify the workspace. Note that *all* content from a bundle will be loaded into the same workspace. +By default, initial content will be loaded into the default workspace. To override this, add a `Sling-Initial-Content-Workspace` bundle manifest header to specify the workspace. Note that *all* content from a bundle will be loaded into the same workspace. ### Example: Load i18n JSON files @@ -234,9 +231,9 @@ This is an example how such an i18n file can be loaded from an OSGi bundle with Within your bundle header you have to define a separate path for the i18n files where you have to explicitly disable the JSON provider: - <Sling-Initial-Content> - SLING-INF/i18n;overwrite:=true;ignoreImportProviders:=json;path:=/apps/myapp/i18n - </Sling-Initial-Content> +<Sling-Initial-Content> +SLING-INF/i18n;overwrite:=true;ignoreImportProviders:=json;path:=/apps/myapp/i18n +</Sling-Initial-Content> The folder `SLING-INF/i18n` from your bundles contains a pair of files for each language, e.g.: @@ -245,28 +242,28 @@ The folder `SLING-INF/i18n` from your bundles contains a pair of files for each Example for the content descriptor: - <?xml version="1.0" encoding="UTF-8"?> - <node> - <name>en.json</name> - <mixinNodeType>mix:language</mixinNodeType> - <property> - <name>jcr:language</name> - <value>en</value> - <type>String</type> - </property> - </node> - +<?xml version="1.0" encoding="UTF-8"?> +<node> +<name>en.json</name> +<mixinNodeType>mix:language</mixinNodeType> +<property> +<name>jcr:language</name> +<value>en</value> +<type>String</type> +</property> +</node> + ## Declared Node Type Registration The `sling-jcr-base` bundle provides low-level repository operations which are at the heart of the functionality of Sling: -* *Node Type Definitions* \- The class `org.apache.sling.content.jcr.base.NodeTypeLoader` provides methods to register custom node types with a repository given a repository session and a node type definition file in CND format. This class is also used by this bundle to register node types on behalf of other bundles. +* *Node Type Definitions* - The class `org.apache.sling.content.jcr.base.NodeTypeLoader` provides methods to register custom node types with a repository given a repository session and a node type definition file in CND format. This class is also used by this bundle to register node types on behalf of other bundles. Bundles may list node type definition files in CND format in the `Sling-Nodetypes` bundle header. This header is a comma-separated list of resources in the respective bundle. Each resource is taken and fed to the `NodeTypeLoader` to define the node types. After a bundle has entered the *resolved* state, the node types listed in the `Sling-Nodetypes` bundle header are registered with the repository. -Node types installed by this mechanism will never be removed again by the `sling-jcr-base` bundle. +Node types installed by this mechanism will never be removed again by the `sling-jcr-base` bundle. Starting with revision 911430, re-registration of existing node types is enabled by default. To disable this, add `;rereigster:=false` to the resource names for which re-registration should be disabled. http://git-wip-us.apache.org/repos/asf/sling-site/blob/88e80480/content/documentation/bundles/context-aware-configuration/context-aware-configuration-default-implementation.md ---------------------------------------------------------------------- diff --git a/content/documentation/bundles/context-aware-configuration/context-aware-configuration-default-implementation.md b/content/documentation/bundles/context-aware-configuration/context-aware-configuration-default-implementation.md index 2dcd84b..7df5413 100644 --- a/content/documentation/bundles/context-aware-configuration/context-aware-configuration-default-implementation.md +++ b/content/documentation/bundles/context-aware-configuration/context-aware-configuration-default-implementation.md @@ -1,10 +1,7 @@ -title=TODO title for context-aware-configuration-default-implementation.md -date=1900-01-01 -type=post -tags=blog +title=Apache Sling Context-Aware Configuration - Default Implementation +type=page status=published ~~~~~~ -Title: Apache Sling Context-Aware Configuration - Default Implementation [TOC] @@ -55,13 +52,13 @@ So the basic rules are: Example for the resource structure for a configuration resource at `/conf/mysite`: - /conf - /mysite - /sling:configs - /x.y.z.MyConfig - @prop1 = 'value1' - @prop2 = 123 - @prop3= true +/conf +/mysite +/sling:configs +/x.y.z.MyConfig +@prop1 = 'value1' +@prop2 = 123 +@prop3= true Explanation: @@ -71,7 +68,7 @@ Explanation: * It is possible to use deeper hierarchies below `sling:configs` as well. * Nested configurations are supported as well. This can be mapped to annotation classes referencing other annotation classes. - + # Resource inheritance We distinguish between: http://git-wip-us.apache.org/repos/asf/sling-site/blob/88e80480/content/documentation/bundles/context-aware-configuration/context-aware-configuration-override.md ---------------------------------------------------------------------- diff --git a/content/documentation/bundles/context-aware-configuration/context-aware-configuration-override.md b/content/documentation/bundles/context-aware-configuration/context-aware-configuration-override.md index e700501..97373cd 100644 --- a/content/documentation/bundles/context-aware-configuration/context-aware-configuration-override.md +++ b/content/documentation/bundles/context-aware-configuration/context-aware-configuration-override.md @@ -1,10 +1,7 @@ -title=TODO title for context-aware-configuration-override.md -date=1900-01-01 -type=post -tags=blog +title=Apache Sling Context-Aware Configuration - Override +type=page status=published ~~~~~~ -Title: Apache Sling Context-Aware Configuration - Override [TOC] @@ -22,10 +19,10 @@ Via the [SPI](http://sling.apache.org/documentation/bundles/context-aware-config Generally an override consists of one single line. Syntax examples: - {configName}/{propertyName}={propertyJsonValue} - {configName}={propertyJsonObject} - [{contextPath}]{configName}/{propertyName}={propertyJsonValue} - [{contextPath}]{configName}={propertyJsonObject} +{configName}/{propertyName}={propertyJsonValue} +{configName}={propertyJsonObject} +[{contextPath}]{configName}/{propertyName}={propertyJsonValue} +[{contextPath}]{configName}={propertyJsonObject} The different parts: @@ -39,17 +36,17 @@ When the syntax `{configName}/{propertyName}={propertyJsonValue}` is used, only Override string examples with real values: - my-config/property1="value 1" - my-config/sub1/property1="value 1" - my-config/property1=["value 1","value 2"] - my-config/property1=123 - x.y.z.MyConfig={"prop1"="value1","prop2"=[1,2,3],"prop3"=true,"prop4"=1.23} - [/content/region1]my-config/property1="value 1" - [/content/region1]my-config/sub1={"prop1":"value 1"} +my-config/property1="value 1" +my-config/sub1/property1="value 1" +my-config/property1=["value 1","value 2"] +my-config/property1=123 +x.y.z.MyConfig={"prop1"="value1","prop2"=[1,2,3],"prop3"=true,"prop4"=1.23} +[/content/region1]my-config/property1="value 1" +[/content/region1]my-config/sub1={"prop1":"value 1"} If multiple statements are defined affecting the same content path, configuration name and property name, they overwrite each other. That means the override string defined last wins. - + # Built-in override providers ## Override via system properties @@ -60,9 +57,9 @@ The parameters are defined when starting the JVM using the -D command line param Example: - -Dsling.caconfig.override.my-config/sub1/property1=123 - -D"sling.caconfig.override.my-config/property1=[\"value 1\",\"value 2\"]" - -D"sling.caconfig.override.[/content/region1]x.y.z.MyConfig={\"prop1\"=\"value1\",\"prop2\"=[1,2,3],\"prop3\"=true,\"prop4\"=1.23}" +-Dsling.caconfig.override.my-config/sub1/property1=123 +-D"sling.caconfig.override.my-config/property1=["value 1","value 2"]" +-D"sling.caconfig.override.[/content/region1]x.y.z.MyConfig={"prop1"="value1","prop2"=[1,2,3],"prop3"=true,"prop4"=1.23}" This provider is not active by default, it has to be activated via OSGi configuration ("Apache Sling Context-Aware System Property Configuration Override Provider"). http://git-wip-us.apache.org/repos/asf/sling-site/blob/88e80480/content/documentation/bundles/context-aware-configuration/context-aware-configuration-spi.md ---------------------------------------------------------------------- diff --git a/content/documentation/bundles/context-aware-configuration/context-aware-configuration-spi.md b/content/documentation/bundles/context-aware-configuration/context-aware-configuration-spi.md index 2ba1876..8981ed2 100644 --- a/content/documentation/bundles/context-aware-configuration/context-aware-configuration-spi.md +++ b/content/documentation/bundles/context-aware-configuration/context-aware-configuration-spi.md @@ -1,10 +1,7 @@ -title=TODO title for context-aware-configuration-spi.md -date=1900-01-01 -type=post -tags=blog +title=Apache Sling Context-Aware Configuration - SPI +type=page status=published ~~~~~~ -Title: Apache Sling Context-Aware Configuration - SPI [TOC] http://git-wip-us.apache.org/repos/asf/sling-site/blob/88e80480/content/documentation/bundles/context-aware-configuration/context-aware-configuration.md ---------------------------------------------------------------------- diff --git a/content/documentation/bundles/context-aware-configuration/context-aware-configuration.md b/content/documentation/bundles/context-aware-configuration/context-aware-configuration.md index 0e1a7fd..a092cfa 100644 --- a/content/documentation/bundles/context-aware-configuration/context-aware-configuration.md +++ b/content/documentation/bundles/context-aware-configuration/context-aware-configuration.md @@ -1,10 +1,7 @@ -title=TODO title for context-aware-configuration.md -date=1900-01-01 -type=post -tags=blog +title=Apache Sling Context-Aware Configuration +type=page status=published ~~~~~~ -Title: Apache Sling Context-Aware Configuration [TOC] @@ -44,15 +41,15 @@ The service for getting the configuration resources is called the ConfigurationR For example to get a configuration resource for a content resource at /content/mysite/page1, you would get a reference to the OSGi service `org.apache.sling.caconfig.resource.ConfigurationResourceResolver` and write: - #!java - Resource contentResource = resourceResolver.getResource("/content/mysite/page1"); +#!java +Resource contentResource = resourceResolver.getResource("/content/mysite/page1"); - Resource configResource = configurationResourceResolver.getResource(contentResource, "my-bucket", "my-config"); +Resource configResource = configurationResourceResolver.getResource(contentResource, "my-bucket", "my-config"); Or if you have several configuration resources of the same type and you need all of them: - #!java - Collection<Resource> configResources = configurationResourceResolver.getResourceCollection(contentResource, "my-bucket", "my-config"); +#!java +Collection<Resource> configResources = configurationResourceResolver.getResourceCollection(contentResource, "my-bucket", "my-config"); The ConfigurationResourceResolver has a concept of "buckets" (2nd parameter in the method signatures) that allows to separate different types of configuration resources into different resource hierarchies, so you have a separate "namespaces" for the named configuration resources. For example one bucket for workflow definitions, one bucket for template definitions, one for key/value-pairs. @@ -71,15 +68,15 @@ named and the service to get them is the ConfigurationResolver. You can get a re `org.apache.sling.caconfig.ConfigurationResolver` - it has a single method to get a ConfigurationBuilder. Alternatively you can directly adapt your content resource directly to the ConfigurationBuilder interface and get the configuration: - #!java - Resource contentResource = resourceResolver.getResource("/content/mysite/page1"); +#!java +Resource contentResource = resourceResolver.getResource("/content/mysite/page1"); + +MyConfig config = contentResource.adaptTo(ConfigurationBuilder.class).as(MyConfig.class); - MyConfig config = contentResource.adaptTo(ConfigurationBuilder.class).as(MyConfig.class); - Or if you want to get a list of configurations: - #!java - Collection<MyConfig> configs = contentResource.adaptTo(ConfigurationBuilder.class).asCollection(MyConfig.class); +#!java +Collection<MyConfig> configs = contentResource.adaptTo(ConfigurationBuilder.class).asCollection(MyConfig.class); The ConfigurationBuilder also supports getting the configurations as ValueMap or by adapting the configuration resources e.g. to a Sling Model. In this case you have to specify a configuration name which is otherwise derived automatically from the annotation class. @@ -104,22 +101,22 @@ the applications/libraries you use, or you can define your own annotation classe The annotation class may look like this: - #!java - @Configuration(label="My Configuration", description="Describe me") - public @interface MyConfig { - - @Property(label="Parameter #1", description="Describe me") - String param1(); - - @Property(label="Parameter with Default value", description="Describe me") - String paramWithDefault() default "defValue"; - - @Property(label="Integer parameter", description="Describe me") - int intParam(); - - } - -The `@Configuration` annotation is mandatory. All properties on the `@Configuration` annotation and the `@Property` annotations are optional - they provide additional metadata for tooling e.g. configuration editors. +#!java +@Configuration(label="My Configuration", description="Describe me") +public @interface MyConfig { + +@Property(label="Parameter #1", description="Describe me") +String param1(); + +@Property(label="Parameter with Default value", description="Describe me") +String paramWithDefault() default "defValue"; + +@Property(label="Integer parameter", description="Describe me") +int intParam(); + +} + +The `@Configuration` annotation is mandatory. All properties on the `@Configuration` annotation and the `@Property` annotations are optional - they provide additional metadata for tooling e.g. configuration editors. By default the annotation class name is used as configuration name, which is also the recommended option. If you want to use an arbitrary configuration name you can specify it via a `name` property on the `@Configuration` annotation. @@ -127,9 +124,9 @@ You may specify custom properties (via `property` string array) for the configur If you provide your own configuration annotation classes in your bundle, you have to export them and list all class names in a bundle header named `Sling-ContextAware-Configuration-Classes` - example: - Sling-ContextAware-Configuration-Classes: x.y.z.MyConfig, x.y.z.MyConfig2 +Sling-ContextAware-Configuration-Classes: x.y.z.MyConfig, x.y.z.MyConfig2 -To automate this you can use the Context-Aware Configuration bnd plugin (see next chapter). +To automate this you can use the Context-Aware Configuration bnd plugin (see next chapter). # Accessing configuration from HTL/Sightly templates @@ -138,23 +135,23 @@ Context-Aware configuration contains a Scripting Binding Values provider with au Example for accessing a property of a singleton configuration (with a config name `x.y.z.ConfigSample`): - #!html - <dl> - <dt>stringParam:</dt> - <dd>${caconfig['x.y.z.ConfigSample'].stringParam}</dd> - </dl> +#!html +<dl> +<dt>stringParam:</dt> +<dd>${caconfig['x.y.z.ConfigSample'].stringParam}</dd> +</dl> Example for accessing a property of a configuration list (with a config name `x.y.z.ConfigSampleList`): - #!html - <ul data-sly-list.item="${caconfig['x.y.z.ConfigSampleList']}"> - <li>stringParam: ${item.stringParam}</li> - </ul> +#!html +<ul data-sly-list.item="${caconfig['x.y.z.ConfigSampleList']}"> +<li>stringParam: ${item.stringParam}</li> +</ul> If you want to access nested configurations you have to use a slash "/" as separator in the property name. Example: - #!html - ${caconfig['x.y.z.ConfigSample']['nestedConfig/stringParam']} +#!html +${caconfig['x.y.z.ConfigSample']['nestedConfig/stringParam']} # Context-Aware Configuration bnd plugin @@ -163,25 +160,25 @@ A [bnd](http://bnd.bndtools.org/) plugin is provided that scans the classpath of Example configuration: - #!xml - <plugin> - <groupId>org.apache.felix</groupId> - <artifactId>maven-bundle-plugin</artifactId> - <extensions>true</extensions> - <configuration> - <instructions> - <!-- Generate bundle header containing all configuration annotation classes --> - <_plugin>org.apache.sling.caconfig.bndplugin.ConfigurationClassScannerPlugin</_plugin> - </instructions> - </configuration> - <dependencies> - <dependency> - <groupId>org.apache.sling</groupId> - <artifactId>org.apache.sling.caconfig.bnd-plugin</artifactId> - <version>1.0.2</version> - </dependency> - </dependencies> - </plugin> +#!xml +<plugin> +<groupId>org.apache.felix</groupId> +<artifactId>maven-bundle-plugin</artifactId> +<extensions>true</extensions> +<configuration> +<instructions> +<!-- Generate bundle header containing all configuration annotation classes --> +<_plugin>org.apache.sling.caconfig.bndplugin.ConfigurationClassScannerPlugin</_plugin> +</instructions> +</configuration> +<dependencies> +<dependency> +<groupId>org.apache.sling</groupId> +<artifactId>org.apache.sling.caconfig.bnd-plugin</artifactId> +<version>1.0.2</version> +</dependency> +</dependencies> +</plugin> # Unit Tests with Context-Aware Configuration @@ -190,29 +187,29 @@ When your code depends on Sling Context-Aware Configuration and you want to writ Example for setting up the unit test context rule: - #!java - import static org.apache.sling.testing.mock.caconfig.ContextPlugins.CACONFIG; +#!java +import static org.apache.sling.testing.mock.caconfig.ContextPlugins.CACONFIG; - public class MyTest { +public class MyTest { - @Rule - public SlingContext context = new SlingContextBuilder().plugin(CACONFIG).build(); +@Rule +public SlingContext context = new SlingContextBuilder().plugin(CACONFIG).build(); - @Before - public void setUp() { - // register configuration annotation class - MockContextAwareConfig.registerAnnotationClasses(context, SimpleConfig.class); - } - ... +@Before +public void setUp() { +// register configuration annotation class +MockContextAwareConfig.registerAnnotationClasses(context, SimpleConfig.class); +} +... In you project define a test dependency (additionally the sling-mock dependency is required): - #!xml - <dependency> - <groupId>org.apache.sling</groupId> - <artifactId>org.apache.sling.testing.caconfig-mock-plugin</artifactId> - <scope>test</scope> - </dependency> +#!xml +<dependency> +<groupId>org.apache.sling</groupId> +<artifactId>org.apache.sling.testing.caconfig-mock-plugin</artifactId> +<scope>test</scope> +</dependency> Full example: [Apache Sling Context-Aware Configuration Mock Plugin Test](https://github.com/apache/sling/blob/trunk/testing/mocks/caconfig-mock-plugin/src/test/java/org/apache/sling/testing/mock/caconfig/ContextPluginsTest.java) @@ -251,7 +248,7 @@ Whenever configuration data is read or written from the configuration resources * [Context-Aware Configuration - SPI][spi] * [Context-Aware Configuration - Override][override] * [Sling Context-Aware Configuration - Talk from adaptTo() 2016](https://adapt.to/2016/en/schedule/sling-context-aware-configuration.html) - + [default-impl]: http://sling.apache.org/documentation/bundles/context-aware-configuration/context-aware-configuration-default-implementation.html [spi]: http://sling.apache.org/documentation/bundles/context-aware-configuration/context-aware-configuration-spi.html http://git-wip-us.apache.org/repos/asf/sling-site/blob/88e80480/content/documentation/bundles/datasource-providers.md ---------------------------------------------------------------------- diff --git a/content/documentation/bundles/datasource-providers.md b/content/documentation/bundles/datasource-providers.md index a7da52a..64942c8 100644 --- a/content/documentation/bundles/datasource-providers.md +++ b/content/documentation/bundles/datasource-providers.md @@ -1,10 +1,7 @@ -title=TODO title for datasource-providers.md -date=1900-01-01 -type=post -tags=blog +title=DataSource Provider +type=page status=published ~~~~~~ -Title: DataSource Provider DataSource provider bundle supports creation of `DataSource` instance and registering them with the OSGi service registry. Application using the DataSource just obtains it from OSGi while @@ -33,7 +30,7 @@ the name of the JDBC driver's implementation of java.sql.Driver. For example, to driver to connect to a Apache Derby database, the META-INF/services/java.sql.Driver file would contain the following entry: - org.apache.derby.jdbc.EmbeddedDriver +org.apache.derby.jdbc.EmbeddedDriver Sling DataSource Provider bundles maintains a `DriverRegistry` which contains mapping of Driver bundle to Driver class supported by it. With this feature there is no need to wrap the Driver @@ -61,15 +58,15 @@ converted to OSGi bundles. For them we can use the [Bnd Wrap][2] command. For example to convert the Postgres driver jar follow the steps below - $ wget https://github.com/bndtools/bnd/releases/download/2.3.0.REL/biz.aQute.bnd-2.3.0.jar -O bnd.jar - $ wget http://jdbc.postgresql.org/download/postgresql-9.3-1101.jdbc41.jar - $ cat > bnd.bnd <<EOT - Bundle-Version: 9.3.1101 - Bundle-SymbolicName: org.postgresql - Export-Package: org.postgresql - Include-Resource: @postgresql-9.3-1101.jdbc41.jar - EOT - $ java -jar bnd.jar bnd.bnd +$ wget https://github.com/bndtools/bnd/releases/download/2.3.0.REL/biz.aQute.bnd-2.3.0.jar -O bnd.jar +$ wget http://jdbc.postgresql.org/download/postgresql-9.3-1101.jdbc41.jar +$ cat > bnd.bnd <<EOT +Bundle-Version: 9.3.1101 +Bundle-SymbolicName: org.postgresql +Export-Package: org.postgresql +Include-Resource: @postgresql-9.3-1101.jdbc41.jar +EOT +$ java -jar bnd.jar bnd.bnd In the steps above we @@ -100,26 +97,26 @@ OSGi config. Following snippet demonstrates accessing the DataSource named `foo` via DS annotation - ::java - import javax.sql.DataSource; - import org.apache.felix.scr.annotations.Reference; +::java +import javax.sql.DataSource; +import org.apache.felix.scr.annotations.Reference; - public class DSExample { +public class DSExample { - @Reference(target = "(&(objectclass=javax.sql.DataSource)(datasource.name=foo))") - private DataSource dataSource; - } +@Reference(target = "(&(objectclass=javax.sql.DataSource)(datasource.name=foo))") +private DataSource dataSource; +} ## Installation Download the bundle from [here][3] or use following Maven dependency - ::xml - <dependency> - <groupId>org.apache.sling</groupId> - <artifactId>org.apache.sling.datasource</artifactId> - <version>1.0.0</version> - </dependency> +::xml +<dependency> +<groupId>org.apache.sling</groupId> +<artifactId>org.apache.sling.datasource</artifactId> +<version>1.0.0</version> +</dependency> [1]: http://tomcat.apache.org/tomcat-7.0-doc/jdbc-pool.html [2]: http://bnd.bndtools.org/chapters/390-wrapping.html
