Author: kwin
Date: Fri Jan 8 16:45:58 2016
New Revision: 1723756
URL: http://svn.apache.org/viewvc?rev=1723756&view=rev
Log:
SLING-4478 clarify documentation with regard to run mode support and start
level support
Modified:
sling/site/trunk/content/documentation/bundles/file-installer-provider.mdtext
Modified:
sling/site/trunk/content/documentation/bundles/file-installer-provider.mdtext
URL:
http://svn.apache.org/viewvc/sling/site/trunk/content/documentation/bundles/file-installer-provider.mdtext?rev=1723756&r1=1723755&r2=1723756&view=diff
==============================================================================
---
sling/site/trunk/content/documentation/bundles/file-installer-provider.mdtext
(original)
+++
sling/site/trunk/content/documentation/bundles/file-installer-provider.mdtext
Fri Jan 8 16:45:58 2016
@@ -9,7 +9,7 @@ The file installer can be configured wit
|Property|Default|Description|
|--|--|--|
-|`sling.fileinstall.dir`| |The name/path of the directories to watch. Several
directories can be specified by using a comma separated list.|
+|`sling.fileinstall.dir`| |The name/path of the directories to watch. Several
directories can be specified by using a comma separated list. Each directory
might have arbitrarily many sub directories (even nested ones) which may
contain the artifacts|
|`sling.fileinstall.interval`|5000 ms|Number of milliseconds between 2 polls
of the directory|
|`sling.fileinstall.writeback`|true|If the file provider supports writeback of
changed artifacts, e.g. if a configuration is changed through Config Admin the
change is written back to the file system.|
@@ -18,10 +18,10 @@ The file installer can be configured wit
Bundles are supported by the OSGi installer. If a bundle jar is added to a
scanned directory, this bundle is installed. If the file is updated/changed,
the bundle is updated. If the file is removed, the bundle gets removed.
Of course, these are the simple rules. The actual action depends by the
overall state of the system and is controlled by the OSGi installer. For
example if already the same bundle with a higher version is installed, when a
bundle is dropped into the install folder, the OSGi installer will perform no
operation.
-Start levels are supported as well by creating a directory with the name of
the start level within the scan directory and putting the bundles within this
directory. For example, if the 'install' folder is scanned, the bundle
'install/3/mybundle.jar' will be installed with start level 3. Without such a
directory the default start level is used.
+Start levels are supported as well by creating a directory with the name of
the start level within the scan directory and putting the bundles within this
directory. For example, if the `install` folder is scanned, the bundle
`install/3/mybundle.jar` will be installed with start level 3. Without such a
directory the default start level is used.
## Configurations
-
+
Configurations are handled by the [Configuration Installer Factory]({{
refs.configuration-installer-factory.path }}). The different formats are
described there.
## Custom Artifacts
@@ -30,7 +30,9 @@ Custom artifacts are handled by the OSGi
## Runmode Support
-The file installer supports run modes for installing artifacts. Within the
scanned directory, a folder named with the run mode will only provisioning
these artifacts if the respective run mode is active. If an artifact is
associated with several run modes, the name of the directory contains all of
them separated by a dot, for example *a1.dev*.
+The file installer supports run modes for installing artifacts (added with
(SLING-4478)[https://issues.apache.org/jira/browse/SLING-4478]). Within the
scanned directory, a folder prefixed with "install." and followed by one or
more run modes (separated by ".") will only be considered if all the respective
run modes are active. For example artifacts below a folder named
`install.a1.dev` are only taken into account if the run modes `a1` and `dev`
are both active.
+
+You can even combine start level and run mode support. Just pay attention that
the run mode foldername must be set on a direct child folder of
`sling.fileinstall.dir` while the start level must be set directly on the
parent folder of the artifact you want to install. E.g.
`<sling.fileinstall.dir>/install.a1.dev/3/mybundle.jar` will only be considered
if both run modes `a1` and `dev` are set. If this is the case then the
according artifact will be installed in start level 3.
# Project Info
