Author: cziegeler
Date: Wed Sep 30 08:31:31 2015
New Revision: 1705980
URL: http://svn.apache.org/viewvc?rev=1705980&view=rev
Log:
Update JCR installer docs
Modified:
sling/site/trunk/content/documentation/bundles/jcr-installer-provider.mdtext
Modified:
sling/site/trunk/content/documentation/bundles/jcr-installer-provider.mdtext
URL:
http://svn.apache.org/viewvc/sling/site/trunk/content/documentation/bundles/jcr-installer-provider.mdtext?rev=1705980&r1=1705979&r2=1705980&view=diff
==============================================================================
---
sling/site/trunk/content/documentation/bundles/jcr-installer-provider.mdtext
(original)
+++
sling/site/trunk/content/documentation/bundles/jcr-installer-provider.mdtext
Wed Sep 30 08:31:31 2015
@@ -8,7 +8,7 @@ The JCR installer provider can be config
If such an install folder contains a binary artifact (e.g. a bundle) this is
provided to the OSGi installer. In addition a node of type *sling:OsgiConfig*
is provided as a configuration to the installer.
-The jcr installer provider does not check or scan the artifacts itself, the
detection and installation is deferred to the OSGi installer.
+The JCR installer provider does not check or scan the artifacts itself, the
detection and installation is deferred to the OSGi installer.
### Runmode Support
@@ -16,6 +16,14 @@ The JCR installer supports run modes for
Artifacts from folders with a run mode get a higher priority. For example by
default, an *install* folder underneath */libs* gets the priority *50*. For
each run mode in the folder name, this priority is increased by *1*, so
*install.dev* has *51* and *install.a1.dev* is *52*.
+## Write Back Support
+
+The JCR installer supports writing back of configurations which are changed by
some other ways, e.g by using the Apache Felix web console. If this is a new
configuration which was not originally stored in the repository, a new
configuration is stored under */apps/sling/install*. The highest search path is
used together with a configurable folder (*sling/install* in this case).
+If a configuration is changed which already exists in the repository, then it
depends where the original configuration is stored. If its under */libs* a new
configuration at the same path under */apps* is created. Otherwise the
configuration is directly modified.
+As JCR properties do not support all Java primitive types like Integer, the
write back does not generate a node in the repository but a properties file.
+
+Write back can be turned off by configuration.
+
### Start Level Support
If the parent folder of a bundle has a name which is a number, this is used as
the start level (when installing the bundle for the first time, compare with
[SLING-2011](https://issues.apache.org/jira/browse/SLING-2011)). So e.g. a
bundle in the path `/libs/sling/install/15/somebundle.jar` is having the start
level **15**.
@@ -129,7 +137,7 @@ We can now delete the configuration node
And verify that the corresponding configuration is gone in the console page
(after 1-2 seconds, like for all other JCRInstall operations).
-*TODO:* A node named like `o.a.s.foo.bar-a` uses *o.a.s.foo.bar* as its
factory PID creating a configuration with an automatically generated PID. The
value of *a* is stored as an alias property in the configuration to correlate
the configuration object with the repository node - demonstrate that.
+A node named like `o.a.s.foo.bar-a` uses *o.a.s.foo.bar* as its factory PID
creating a configuration with an automatically generated PID. The value of *a*
is stored as an alias in the OSGi installer to correlate the configuration
object with the repository node.
# Automated Tests
The following modules contain lots of automated tests (under `src/test`, as
usual):
