[CONF] Apache Sling Website > JCR Installer Provider

[confluence]

JCR Installer Provider Page edited by Carsten Ziegeler Changes (7) The JCR installer modules (collectively known as _JCRInstall_) install OSGi bundles and configurations found in the JCR repository. The JCR installer provider scans the JCR repository for artifacts and provides them to the [OSGI installer|SLINGxSITE:OSGi Installer]. The goal is to allow Sling applications to be distributed as "content packages", which install additional services and configurations when copied to the JCR repository. h2. Configuration and Scanning The JCR installer provider can be configured with weighted paths which are scanned. By default, the installer scans in */apps* and */libs* where artifacts found in */apps* get a higher priority. The installer does a deep scan and uses a regular _expression_ to detect folders containing artifacts to be installed. By default, artifacts from within a folder named _install_ are provided to the OSGi installer. 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. h1. Example Here's a quick walkthrough of the JCR installer functionality. ... Start the Sling [launchpad/app|http://svn.apache.org/repos/asf/sling/trunk/launchpad/app] and install and start the following additional bundles: * [RunMode service|Run Modes (org.apache.sling.runmode)] * OSGi installer service ([org.apache.sling.osgi.installer|http://svn.apache.org/repos/asf/sling/trunk/installer/osgi/installer]) ([org.apache.sling.osgi.installer|http://svn.apache.org/repos/asf/sling/trunk/installer/core]) * JCR installer service ([org.apache.sling.jcr.jcrinstall|http://svn.apache.org/repos/asf/sling/trunk/installer/jcr/jcrinstall]) provider ([org.apache.sling.jcr.jcrinstall|http://svn.apache.org/repos/asf/sling/trunk/installer/providers/jcr]) To watch the logs produced by these modules, you can filter {{sling/logs/error.log}} using {{egrep 'jcrinstall|osgi.installer'}}. ... Full Content The JCR installer provider scans the JCR repository for artifacts and provides them to the OSGI installer. Configuration and Scanning The JCR installer provider can be configured with weighted paths which are scanned. By default, the installer scans in /apps and /libs where artifacts found in /apps get a higher priority. The installer does a deep scan and uses a regular _expression_ to detect folders containing artifacts to be installed. By default, artifacts from within a folder named install are provided to the OSGi installer. 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. Example Here's a quick walkthrough of the JCR installer functionality. Installation Start the Sling launchpad/app and install and start the following additional bundles: RunMode service OSGi installer service (org.apache.sling.osgi.installer) JCR installer provider (org.apache.sling.jcr.jcrinstall) To watch the logs produced by these modules, you can filter sling/logs/error.log using egrep 'jcrinstall|osgi.installer'. Install and remove a bundle We'll use the Knopflerfish Desktop bundle for this example, it is convenient as it displays a graphical user interface when started. We use curl to create content, to make it easy to reproduce the example by copying and pasting the curl commands. Any other way to create content in the repository will work, of course. By default, JCRInstall picks up bundles found in folders named install under /libs and /apps, so we start by creating such a folder: curl -X MKCOL http://admin:admin@localhost:8888/apps/jcrtest curl -X MKCOL http://admin:admin@localhost:8888/apps/jcrtest/install And we copy the bundle to install in that folder (a backslash in command lines means continued on next line): curl -T desktop_awt_all-2.0.0.jar \ http://admin:admin@localhost:8888/apps/jcrtest/install/desktop_awt_all-2.0.0.jar That's it. After 2-3 seconds, the bundle should be picked up by JCRInstall, installed and started. If this works you'll see a small Knopflerfish Desktop window on your desktop, and Sling's OSGi console can of course be used to check the details. Removing the bundle from the repository will cause it to be uninstalled, so: curl -X DELETE \ http://admin:admin@localhost:8888/apps/jcrtest/install/desktop_awt_all-2.0.0.jar Should cause the Knopflerfish Desktop window to disappear as the bundle is uninstalled. TODO: document folder priorities (/apps over /libs), SNAPSHOT handling, bundle start retries. Install, modify and remove a configuration JCRInstall installs OSGi configurations from nodes having the sling:OsgiConfig node type, found in folders named install under the installation roots (/apps and /libs). Let's try this feature by creating a configuration with two properties: curl \ -F "jcr:primaryType=sling:OsgiConfig" \ -F foo=bar -F works=yes \ http://admin:admin@localhost:8888/apps/jcrtest/install/some.config.pid And verify the contents of our config node: curl \ http://admin:admin@localhost:8888/apps/jcrtest/install/some.config.pid.json Which should display something like {"foo":"bar", "jcr:created":"Wed Aug 26 2009 17:06:40GMT+0200", "jcr:primaryType":"sling:OsgiConfig","works":"yes"} At this point, JCRInstall should have picked up our new config and installed it. The logs would confirm that, but we can also use the OSGi console's config status page (http://localhost:8888/system/console/config) to check it. That page should now contain: PID=some.config.pid BundleLocation=Unbound _jcr_config_path=jcrinstall:/apps/jcrtest/install/some.config.pid foo=bars service.pid=some.config.pid works=yes Indicating that the configuration has been installed. Let's try modifying the configuration parameters: curl \ -F works=updated -F even=more \ http://admin:admin@localhost:8888/apps/jcrtest/install/some.config.pid And check the changes in the console page: PID=some.config.pid BundleLocation=Unbound _jcr_config_path=jcrinstall:/apps/jcrtest/install/some.config.pid even=more foo=bars service.pid=some.config.pid works=updated We can now delete the configuration node: curl -X DELETE \ http://admin:admin@localhost:8888/apps/jcrtest/install/some.config.pid 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. Run Modes TODO: folder names like install.dev are included in the repository scanning if the dev run mode is active - describe this feature. Automated Tests The following modules contain lots of automated tests (under src/test, as usual): OSGi installer integration tests (org.apache.sling.installer.it) JCR installer service (org.apache.sling.installer.providers.jcr) Many of these tests are fairly readable, and can be used to find out in more detail how these modules work. Change Notification Preferences View Online | View Changes | Add Comment