This is an automated email from the ASF dual-hosted git repository.
git-site-role pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/sling-site.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 54e2591 Automatic website deployment
54e2591 is described below
commit 54e2591b297190c310f896ac3445bcecf69f13bf
Author: jenkins <[email protected]>
AuthorDate: Tue Jun 25 10:21:53 2019 +0000
Automatic website deployment
---
.../bundles/configuration-installer-factory.html | 24 +++++++++++++++-------
1 file changed, 17 insertions(+), 7 deletions(-)
diff --git a/documentation/bundles/configuration-installer-factory.html
b/documentation/bundles/configuration-installer-factory.html
index bc11d4c..6785dad 100644
--- a/documentation/bundles/configuration-installer-factory.html
+++ b/documentation/bundles/configuration-installer-factory.html
@@ -74,20 +74,21 @@
</div><h1 class="pagetitle">
Configuration Installer Factory
</h1><div id="generatedToC"></div><script
src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script
src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script
type='text/javascript'>$(document).ready(function() {
$('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script>
-<div class="row"><div class="small-12 columns"><section class="wrap"><p>The
configuration installer factory provides support for configurations to the <a
href="/documentation/bundles/osgi-installer.html">OSGI installer</a>. The
provisioning of artifacts is handled by installer providers like the file
installer or the JCR installer.</p>
+<div class="row"><div class="small-12 columns"><section class="wrap"><p>The
configuration installer factory provides support for configurations to the <a
href="/documentation/bundles/osgi-installer.html">OSGI installer</a>. The
provisioning of artifacts is handled by installer providers like the <a
href="/documentation/bundles/file-installer-provider.html">file installer</a>
or the <a href="/documentation/bundles/jcr-installer-provider.html">JCR
installer</a>.</p>
<h2><a href="#configurations" name="configurations">Configurations</a></h2>
<p>Configuration file names are related to the PID and factory PID. The
structure of the file name is as follows:</p>
-<pre><code>filename ::= <pid> ( '-' <subname> )?
('.cfg'|'.config')
+<pre><code>filename ::= <pid> ( ( '-' | '~' )
<subname> ) ? ( '.cfg' | '.config' | '.cfg.json')
</code></pre>
-<p>If the form is <code><pid>('.cfg'|'.config')</code>,
the file contains the properties for a Managed Service. The
<code><pid></code> is then the PID of the Managed Service. See the
Configuration Admin service for details.</p>
+<p>If the form is
<code><pid>('.cfg'|'.config'|'.cfg.json')</code>,
the file contains the properties for a Managed Service. The
<code><pid></code> is then the PID of the Managed Service. See the
Configuration Admin service for details.</p>
<p>When a Managed Service Factory is used, the situation is different. The
<code><pid></code> part then describes the PID of the Managed Service
Factory. You can pick any <code><subname></code>, the installer will then
create an instance for the factory for each unique name. For example:</p>
<pre><code>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
</code></pre>
+<p>Since Installer Configuration Factory 1.2.0 (<a
href="https://jira.apache.org/jira/browse/SLING-7786";>SLING-7786</a>) you
should use the tilde <code>~</code> as separator between
<code><pid></code> and <code><subname></code> instead of the
<code>-</code>.</p>
<p>If a configuration is modified, the file installer will write the
configuration back to a file to ensure persistence across restarts (if
<code>sling.fileinstall.writeback</code> is enabled). A similar writeback
mechanism is supported by the <a href="jcr-installer-provider.html">JCR
installer</a>.</p>
-<p>The code for parsing the configuration files is in <a
href="https://github.com/apache/sling-org-apache-sling-installer-core/blob/0a34e33dd26092437be5180e34979abbf9a88300/src/main/java/org/apache/sling/installer/core/impl/InternalResource.java#L221";>InternalResource#readDictionary</a>.</p>
+<p>The code for parsing the configuration files is in <a
href="https://github.com/apache/sling-org-apache-sling-installer-core/blob/7b2e4407baa45b79d954dd20c53bb2077c3a5e49/src/main/java/org/apache/sling/installer/core/impl/InternalResource.java#L230";>InternalResource#readDictionary</a>.</p>
<h3><a href="#property-files-cfg-" name="property-files-cfg-">Property Files
(.cfg)</a></h3>
<p>Configuration files ending in <code>.cfg</code> are plain property files
(<code>java.util.Property</code>). The format is simple:</p>
<pre><code>file ::= ( header | comment ) *
@@ -98,12 +99,13 @@ comment ::= '#' <any>
<pre><code># default port
ftp.port = 21
</code></pre>
-<p>In addition the XML format defined by
[java.util.Property](https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html#loadFromXML(java.io.InputStream))
is supported if the file starts with the character <code><</code>.</p>
+<p>In addition the XML format defined by <a
href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html#loadFromXML%28java.io.InputStream%29";>java.util.Property</a>
is supported if the file starts with the character <code><</code>.</p>
<h4><a href="#limitations" name="limitations">Limitations</a></h4>
<ul>
<li>Only String types are supported</li>
<li>Only ISO 8859-1 character encoding supported</li>
<li>No multi-values</li>
+ <li>No writeback support</li>
</ul>
<h3><a href="#configuration-files-config-"
name="configuration-files-config-">Configuration Files (.config)</a></h3>
<p>Configuration files ending in <code>.config</code> use the format of the <a
href="http://svn.apache.org/viewvc/felix/releases/org.apache.felix.configadmin-1.8.12/src/main/java/org/apache/felix/cm/file/ConfigurationHandler.java?view=markup";>Apache
Felix ConfigAdmin implementation</a> (in version 1.8.12). This format allows
to specify the type and cardinality of a configuration property and is not
limited to string values. It must be stored in UTF-8 encoding.</p>
@@ -167,7 +169,15 @@ stringsimple ::= <quoted string representation of the
value where both '&
</ul>
<h4><a href="#limitations" name="limitations">Limitations</a></h4>
<ul>
- <li>None known so far</li>
+ <li>No writeback support yet (<a
href="https://issues.apache.org/jira/browse/SLING-8419";>SLING-8419</a>)</li>
+</ul>
+<h3><a href="#sling-osgiconfig-resources"
name="sling-osgiconfig-resources">sling:OsgiConfig resources</a></h3>
+<p>Only the <a
href="/documentation/bundles/jcr-installer-provider.html#configuration-and-scanning">JCR
Installer</a> supports also configurations given as resources with properties
of type <code>sling:OsgiConfig</code>. Internally those are converted directly
into the Dictionary format being supported by the <a
href="https://osgi.org/javadoc/r4v42/org/osgi/service/cm/Configuration.html#update%28java.util.Dictionary%29";>OSGi
Configuration Admin</a> in <a href="https://github.com/apache/s [...]
+<h4><a href="#limitations" name="limitations">Limitations</a></h4>
+<ul>
+ <li>Not all types supported (<a
href="https://issues.apache.org/jira/browse/SLING-2477";>SLING-2477</a>)</li>
+ <li>No writeback support</li>
+ <li>Only array multivalue support (<a
href="https://issues.apache.org/jira/browse/SLING-4183";>SLING-4183</a>)</li>
</ul>
<h1><a href="#project-info" name="project-info">Project Info</a></h1>
<ul>
@@ -175,7 +185,7 @@ stringsimple ::= <quoted string representation of the
value where both '&
</ul></section></div></div>
<footer class="footer">
<div class="revisionInfo">
- Last modified by <span class="author">Konrad
Windszus</span> on <span class="comment">Mon Mar 18 16:08:32 2019 +0100</span>
+ Last modified by <span class="author">Konrad
Windszus</span> on <span class="comment">Tue Jun 25 12:07:56 2019 +0200</span>
</div> <p>
Apache Sling, Sling, Apache, the Apache feather logo, and
the Apache Sling project logo are trademarks of The Apache Software Foundation.
All other marks mentioned may be trademarks or registered trademarks of their
respective owners.
</p><p>
