http://git-wip-us.apache.org/repos/asf/sling-site/blob/3a935d04/documentation/bundles/subsystem-installer-factory.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/subsystem-installer-factory.html b/documentation/bundles/subsystem-installer-factory.html index 777a35e..9c84480 100644 --- a/documentation/bundles/subsystem-installer-factory.html +++ b/documentation/bundles/subsystem-installer-factory.html @@ -2,22 +2,22 @@ <head> <meta charset="utf-8"/> <title>Apache Sling on JBake</title> - <link rel="stylesheet" href="/res/css/site.css"/> - <link rel="stylesheet" href="/res/css/codehilite.css"/> + <link rel="stylesheet" href="/ng/res/css/site.css"/> + <link rel="icon" href="/ng/res/favicon.ico"/> <div class="title"> <div class="logo"> <a href="http://sling.apache.org";> - <img border="0" alt="Apache Sling" src="/res/logos/sling.svg"/> + <img border="0" alt="Apache Sling" src="/ng/res/logos/sling.svg"/> </a> </div><div class="header"> <a href="http://www.apache.org";> - <img border="0" alt="Apache" src="/res/logos/apache.png"/> + <img border="0" alt="Apache" src="/ng/res/logos/apache.png"/> </a> </div> </div> </head><body> <div class="menu"> - <strong><a href="/documentation.html">Documentation</a></strong><br/><a href="/documentation/getting-started.html">Getting Started</a><br/><a href="/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/documentation/development.html">Development</a><br/><a href="/documentation/bundles.html">Bundles</a><br/><a href="/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki";>Wiki</a><br/><a href="http://s.apache.org/sling.faq";>FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/apidocs/sling9/index.html">Sling 9</a><br/><a href="/apidocs/sling8/index.html">Sling 8</a><br/><a href="/apidocs/sling7/index.html">Sling 7</a><br/><a href="/apidocs/sling6/index.html">Sling 6</a><br/><a href="/apidocs/sling5/index.html">Sling 5</a><br/><a href="/javadoc-io.html">Archive at javadoc.io</a><br/><p></p><strong>Project info</strong><br/><a h ref="/downloads.cgi">Downloads</a><br/><a href="http://www.apache.org/licenses/";>License</a><br/><a href="/contributing.html">Contributing</a><br/><a href="/news.html">News</a><br/><a href="/links.html">Links</a><br/><a href="/project-information.html">Project Information</a><br/><a href="https://issues.apache.org/jira/browse/SLING";>Issue Tracker</a><br/><a href="http://ci.apache.org/builders/sling-trunk";>Build Server</a><br/><a href="/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a href="http://svn.apache.org/viewvc/sling/trunk";>Subversion</a><br/><a href="git://git.apache.org/sling.git">Git</a><br/><a href="https://github.com/apache/sling";>Github Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a><br/><a href="http://www.apache.org/foundation/sponsorship.html";>Become a Sponsor</a><br/><a href="https://donate.apache.org/";>Donate!</a><br/><a href="http://www.apache.org/foun dation/buy_stuff.html">Buy Stuff</a><br/><p></p><strong><a href="/sitemap.html">Site Map</a></strong> + <strong><a href="/ng/documentation.html">Documentation</a></strong><br/><a href="/ng/documentation/getting-started.html">Getting Started</a><br/><a href="/ng/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/ng/documentation/development.html">Development</a><br/><a href="/ng/documentation/bundles.html">Bundles</a><br/><a href="/ng/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/ng/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki";>Wiki</a><br/><a href="http://s.apache.org/sling.faq";>FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/ng/apidocs/sling9/index.html">Sling 9</a><br/><a href="/ng/apidocs/sling8/index.html">Sling 8</a><br/><a href="/ng/apidocs/sling7/index.html">Sling 7</a><br/><a href="/ng/apidocs/sling6/index.html">Sling 6</a><br/><a href="/ng/apidocs/sling5/index.html">Sling 5</a><br/><a href="/ng/javadoc-io.html">Archive at javadoc.io</a><br/><p></p ><strong>Project info</strong><br/><a >href="/ng/downloads.cgi">Downloads</a><br/><a >href="http://www.apache.org/licenses/";>License</a><br/><a >href="/ng/contributing.html">Contributing</a><br/><a >href="/ng/news.html">News</a><br/><a href="/ng/links.html">Links</a><br/><a >href="/ng/project-information.html">Project Information</a><br/><a >href="https://issues.apache.org/jira/browse/SLING";>Issue Tracker</a><br/><a >href="http://ci.apache.org/builders/sling-trunk";>Build Server</a><br/><a >href="/ng/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a > href="http://svn.apache.org/viewvc/sling/trunk";>Subversion</a><br/><a >href="git://git.apache.org/sling.git">Git</a><br/><a >href="https://github.com/apache/sling";>Github >Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a >href="http://www.apache.org/foundation/thanks.html";>Thanks</a><br/><a >href="http://www.apache.org/foundation/sponsorship.html";>Become a >Sponsor</a><br/><a href="https://donate.apache. org/">Donate!</a><br/><a href="http://www.apache.org/foundation/buy_stuff.html";>Buy Stuff</a><br/><p></p><strong><a href="/ng/sitemap.html">Site Map</a></strong> </div> <div class="main"> <div class="row"><div class="small-12 columns"><section class="wrap"><header><h1>Subsystems Installer Factory</h1></header><p>The subsystems installer factory provides support for subsystems 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> <h2>Subsystems</h2>
http://git-wip-us.apache.org/repos/asf/sling-site/blob/3a935d04/documentation/bundles/validation.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/validation.html b/documentation/bundles/validation.html index 3684e21..c196983 100644 --- a/documentation/bundles/validation.html +++ b/documentation/bundles/validation.html @@ -2,22 +2,22 @@ <head> <meta charset="utf-8"/> <title>Apache Sling on JBake</title> - <link rel="stylesheet" href="/res/css/site.css"/> - <link rel="stylesheet" href="/res/css/codehilite.css"/> + <link rel="stylesheet" href="/ng/res/css/site.css"/> + <link rel="icon" href="/ng/res/favicon.ico"/> <div class="title"> <div class="logo"> <a href="http://sling.apache.org";> - <img border="0" alt="Apache Sling" src="/res/logos/sling.svg"/> + <img border="0" alt="Apache Sling" src="/ng/res/logos/sling.svg"/> </a> </div><div class="header"> <a href="http://www.apache.org";> - <img border="0" alt="Apache" src="/res/logos/apache.png"/> + <img border="0" alt="Apache" src="/ng/res/logos/apache.png"/> </a> </div> </div> </head><body> <div class="menu"> - <strong><a href="/documentation.html">Documentation</a></strong><br/><a href="/documentation/getting-started.html">Getting Started</a><br/><a href="/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/documentation/development.html">Development</a><br/><a href="/documentation/bundles.html">Bundles</a><br/><a href="/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki";>Wiki</a><br/><a href="http://s.apache.org/sling.faq";>FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/apidocs/sling9/index.html">Sling 9</a><br/><a href="/apidocs/sling8/index.html">Sling 8</a><br/><a href="/apidocs/sling7/index.html">Sling 7</a><br/><a href="/apidocs/sling6/index.html">Sling 6</a><br/><a href="/apidocs/sling5/index.html">Sling 5</a><br/><a href="/javadoc-io.html">Archive at javadoc.io</a><br/><p></p><strong>Project info</strong><br/><a h ref="/downloads.cgi">Downloads</a><br/><a href="http://www.apache.org/licenses/";>License</a><br/><a href="/contributing.html">Contributing</a><br/><a href="/news.html">News</a><br/><a href="/links.html">Links</a><br/><a href="/project-information.html">Project Information</a><br/><a href="https://issues.apache.org/jira/browse/SLING";>Issue Tracker</a><br/><a href="http://ci.apache.org/builders/sling-trunk";>Build Server</a><br/><a href="/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a href="http://svn.apache.org/viewvc/sling/trunk";>Subversion</a><br/><a href="git://git.apache.org/sling.git">Git</a><br/><a href="https://github.com/apache/sling";>Github Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a><br/><a href="http://www.apache.org/foundation/sponsorship.html";>Become a Sponsor</a><br/><a href="https://donate.apache.org/";>Donate!</a><br/><a href="http://www.apache.org/foun dation/buy_stuff.html">Buy Stuff</a><br/><p></p><strong><a href="/sitemap.html">Site Map</a></strong> + <strong><a href="/ng/documentation.html">Documentation</a></strong><br/><a href="/ng/documentation/getting-started.html">Getting Started</a><br/><a href="/ng/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/ng/documentation/development.html">Development</a><br/><a href="/ng/documentation/bundles.html">Bundles</a><br/><a href="/ng/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/ng/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki";>Wiki</a><br/><a href="http://s.apache.org/sling.faq";>FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/ng/apidocs/sling9/index.html">Sling 9</a><br/><a href="/ng/apidocs/sling8/index.html">Sling 8</a><br/><a href="/ng/apidocs/sling7/index.html">Sling 7</a><br/><a href="/ng/apidocs/sling6/index.html">Sling 6</a><br/><a href="/ng/apidocs/sling5/index.html">Sling 5</a><br/><a href="/ng/javadoc-io.html">Archive at javadoc.io</a><br/><p></p ><strong>Project info</strong><br/><a >href="/ng/downloads.cgi">Downloads</a><br/><a >href="http://www.apache.org/licenses/";>License</a><br/><a >href="/ng/contributing.html">Contributing</a><br/><a >href="/ng/news.html">News</a><br/><a href="/ng/links.html">Links</a><br/><a >href="/ng/project-information.html">Project Information</a><br/><a >href="https://issues.apache.org/jira/browse/SLING";>Issue Tracker</a><br/><a >href="http://ci.apache.org/builders/sling-trunk";>Build Server</a><br/><a >href="/ng/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a > href="http://svn.apache.org/viewvc/sling/trunk";>Subversion</a><br/><a >href="git://git.apache.org/sling.git">Git</a><br/><a >href="https://github.com/apache/sling";>Github >Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a >href="http://www.apache.org/foundation/thanks.html";>Thanks</a><br/><a >href="http://www.apache.org/foundation/sponsorship.html";>Become a >Sponsor</a><br/><a href="https://donate.apache. org/">Donate!</a><br/><a href="http://www.apache.org/foundation/buy_stuff.html";>Buy Stuff</a><br/><p></p><strong><a href="/ng/sitemap.html">Site Map</a></strong> </div> <div class="main"> <div class="row"><div class="small-12 columns"><section class="wrap"><header><h1>Sling Validation</h1></header><p>[TOC]</p> <p>Many Sling projects want to be able to validate both Resources and request parameters. Through the Sling Validation framework this is possible with the help of validation model resources which define validation rules for a certain resourceType.</p> @@ -30,10 +30,39 @@ <p>In addition a <a href="/documentation/the-sling-engine/service-authentication.html">service resolver mapping</a> needs to be configured for the service name <code>org.apache.sling.validation.core</code>. The bound service user needs to have at least read access to all resources within the resource resolver's search paths (usually <code>/apps</code> and <code>/libs</code>).</p> <h1>Basic Usage</h1> <p>To validate a resource one first needs to get a <code>ValidationModel</code> and then validate the resource with that model. Both functionalities are provided by the <code>ValidationService</code> OSGi service:</p> -<p>::java try { ValidationModel validationModel = validationService.getValidationModel(resource, true); if (validationModel != null) { ValidationResult result = validationService.validate(resource, validationModel); if (!result.isValid()) { // give out validation messages from result.get } } } catch (IllegalStateException e) { // give out error message that the validation model is invalid! }</p> +<pre><code>::java +try { + ValidationModel validationModel = validationService.getValidationModel(resource, true); + if (validationModel != null) { + ValidationResult result = validationService.validate(resource, validationModel); + if (!result.isValid()) { + // give out validation messages from result.get + } + } +} catch (IllegalStateException e) { + // give out error message that the validation model is invalid! +} +</code></pre> <p>Apart from that it is also possible to validate resources including all child resources having their own validation model (i.e. a merged view of the validation models is applied). The appropriate validation model is being looked up by getting the resource type for each node. Since by default the JCR will return the primary type in case there is no <code>sling:resourceType</code> property found on the node, either the 2nd parameter <code>enforceValidation</code> should be set to <code>false</code> or some resource types must be explicitly ignored by the given filter in the 3rd parameter <code>filter</code> to also properly support validation models which have children resources on their own.</p> -<p>::java try { final Predicate ignoreResourceType1Predicate = new Predicate<Resource>() { @Override public boolean test(final Resource resource) { return !"resourcetype1".equals(resource.getResourceType()); } }; ValidationResult result = validationService.validateResourceRecursively(resource, false, ignoreResourceType1Predicate, false); if (!result.isValid()) { // give out validation messages from result.getFailureMessages() }</p> -<p>} catch (IllegalStateException e) { // give out error message that an invalid validation model for at least one sub resource was found } catch (IllegalArgumentException e) { // one of the resource types is absolute or there was no validation model found for at least one sub resource }</p> +<pre><code>::java +try { + final Predicate ignoreResourceType1Predicate = new Predicate<Resource>() { + @Override + public boolean test(final Resource resource) { + return !"resourcetype1".equals(resource.getResourceType()); + } + }; + ValidationResult result = validationService.validateResourceRecursively(resource, false, ignoreResourceType1Predicate, false); + if (!result.isValid()) { + // give out validation messages from result.getFailureMessages() + } + +} catch (IllegalStateException e) { + // give out error message that an invalid validation model for at least one sub resource was found +} catch (IllegalArgumentException e) { + // one of the resource types is absolute or there was no validation model found for at least one sub resource +} +</code></pre> <p>All methods to retrieve a validation model support a boolean parameter <code>considerResourceSuperTypeModels</code>. If this is set to true, the validation model is not only being looked up for exactly the given resource type but also for all its resource super types. The returned model is then a merged model of all found validation model along the resource type hierarchy.</p> <h2>ValidationResult</h2> <p>The <code>ValidationResult</code> indicates whether a given <code>Resource</code> or <code>ValueMap</code> is valid or invalid according to a given validation model. In the latter case it aggregates one or more <code>ValidationFailure</code>s. Each <code>ValidationFailure</code> is encapsulating an error message and a severity. The severity may be set on the following locations (where locations on top may overwrite severity from locations below):</p> @@ -84,7 +113,7 @@ </tr> </tbody> </table> -<p><code>properties<propertyName></code> | Resource | - | This resource ensures that the property with the name <code><propertyName></code> is there. The resource name has no longer a meaning if the property <code>nameRegex</code> is set on this node. | no | <code>false</code> <code>properties<propertyName>optional</code> | Property | <code>Boolean</code> | If <code>true</code> it is not an error if there is no property with the given <code><propertyName></code> or none matching the <code>nameRegex</code>. If not set or <code>false</code> the property must be there. | no | <code>false</code> <code>properties<propertyName>propertyMultiple</code> | Property | <code>Boolean</code> | If <code>true</code> only multivalue properties are allowed with the name <code><propertyName></code> or matching the <code>nameRegex</code>. If not set or <code>false</code>, multi- and single-value properties are accepted. | no | <code>false</code> <code>properties<p ropertyName>nameRegex</code> | Property | <code>String</code> | If set the <code><propertyName></code> has no longer a meaning. Rather all properties which match the given regular expression are considered. At least one match is required, otherwise the validated resource/valuemap is considered invalid. | no | <code>property[0-8]</code> <code>properties<propertyName>validators<validatorId></code> | Resource | - | The <code><validatorId></code> must be the id of a validator. The id is given by the OSGi service property <code>validator.id</code> set in the validator. Each validators node might have arbitrarily many child resources (one per validator). | no | <code>false</code> <code>properties<propertyName>validators<validatorId>validatorArguments</code> | Property | <code>String[]</code> | The parametrization for the validator with the id <code><validatorId></code>. Each value must have the pattern <code>key=value</code>. The parametrizatio n differs per validator. | no | <code>regex=^[a-z]*$</code> <code>properties<propertyName>validators<validatorId>severity</code> | Property | <code>Integer</code> | The severity which should be set on all emitted validation failures by this validator. | no | <code>0</code> <code>children<resourceName></code> | Resource | - | This resource ensures that the resource with the name <code><resourceName></code> is there. The resource name has no longer a meaning if the property <code>nameRegex</code> is set on this node. | no | <code>child1</code> <code>children<resourceName>nameRegex</code> | Property | <code>String</code> | If set the <code><resourceName></code> has no longer a meaning. Rather all resources whose name match the given regular expression are considered. At least one match is required, otherwise the validated resource/valuemap is considered invalid. | no | <code>child[1-9]</code> <code>children<resourceName>optional</code> | Proper ty | <code>Boolean</code> | If <code>true</code> it is not an error if there is no resource with the given <code><resourceName></code> or none matching the <code>nameRegex</code>. If not set or <code>false</code> the resource must be there. | no | <code>false</code> <code>children<resourceName>properties</code> | Resource | - | The properties can be configured on the child level in the same way as on the root level. | no | -</p> +<p><code>properties\<propertyName></code> | Resource | - | This resource ensures that the property with the name <code><propertyName></code> is there. The resource name has no longer a meaning if the property <code>nameRegex</code> is set on this node. | no | <code>false</code> <code>properties\<propertyName>\optional</code> | Property | <code>Boolean</code> | If <code>true</code> it is not an error if there is no property with the given <code><propertyName></code> or none matching the <code>nameRegex</code>. If not set or <code>false</code> the property must be there. | no | <code>false</code> <code>properties\<propertyName>\propertyMultiple</code> | Property | <code>Boolean</code> | If <code>true</code> only multivalue properties are allowed with the name <code><propertyName></code> or matching the <code>nameRegex</code>. If not set or <code>false</code>, multi- and single-value properties are accepted. | no | <code>false</code> <code>properties \<propertyName>\nameRegex</code> | Property | <code>String</code> | If set the <code><propertyName></code> has no longer a meaning. Rather all properties which match the given regular expression are considered. At least one match is required, otherwise the validated resource/valuemap is considered invalid. | no | <code>property[0-8]</code><br/><code>properties\<propertyName>\validators\<validatorId></code> | Resource | - | The <code><validatorId></code> must be the id of a validator. The id is given by the OSGi service property <code>validator.id</code> set in the validator. Each validators node might have arbitrarily many child resources (one per validator). | no | <code>false</code><br/><code>properties\<propertyName>\validators\<validatorId>\validatorArguments</code> | Property | <code>String[]</code> | The parametrization for the validator with the id <code><validatorId></code>. Each value must have the pattern <code>key=value</cod e>. The parametrization differs per validator. | no | <code>regex=^[a-z]*$</code> <code>properties\<propertyName>\validators\<validatorId>\severity</code> | Property | <code>Integer</code> | The severity which should be set on all emitted validation failures by this validator. | no | <code>0</code> <code>children\<resourceName></code> | Resource | - | This resource ensures that the resource with the name <code><resourceName></code> is there. The resource name has no longer a meaning if the property <code>nameRegex</code> is set on this node. | no | <code>child1</code> <code>children\<resourceName>\nameRegex</code> | Property | <code>String</code> | If set the <code><resourceName></code> has no longer a meaning. Rather all resources whose name match the given regular expression are considered. At least one match is required, otherwise the validated resource/valuemap is considered invalid. | no | <code>child[1-9]</code> <code>children\<resourceNa me>\optional</code> | Property | <code>Boolean</code> | If <code>true</code> it is not an error if there is no resource with the given <code><resourceName></code> or none matching the <code>nameRegex</code>. If not set or <code>false</code> the resource must be there. | no | <code>false</code> <code>children\<resourceName>\properties</code> | Resource | - | The properties can be configured on the child level in the same way as on the root level. | no | -</p> <h2>Validation Model Inheritance</h2> <p>Sling Validation optionally supports the inheritance of Sling Validation Models. This means not only the model for exactly the given resource type is considered, but also the models for all resource super types. To overwrite some property or child from one of the super type models, just define a property/child on the same level and with the same name in a model for a resource type which is more specific. That way the property/child on the super validation model is no longer effective.</p> <h2>Precedence of Validation Models</h2> @@ -94,10 +123,31 @@ <p>See <a href="/documentation/bundles/models.html#validation">Sling Models validation</a></p> <h2>Before Sling Models 1.2.0</h2> <p>One needs to call the validate method within the PostConstruct method of the according Sling Model</p> -<p>::java @SlingObject protected Resource resource;</p> -<p>@OSGiService protected ValidationService validation;</p> -<p>@PostConstruct public void validate() { try { ValidationModel validationModel = validation.getValidationModel(resource); if (validationModel == null) { LOG.warn("No validation defined for resource '{}' with type '{}'", resource.getPath(), resource.getResourceType());</p> -<p>} else { ValidationResult result = validation.validate(resource, validationModel); if (!result.isValid()) { // give out the validation result } } } catch (IllegalStateException e) { LOG.warn("Invalid validation model for resource '{}' with type '{}'", resource.getPath(), resource.getResourceType()); } }</p> +<pre><code>::java +@SlingObject +protected Resource resource; + +@OSGiService +protected ValidationService validation; + +@PostConstruct +public void validate() { + try { + ValidationModel validationModel = validation.getValidationModel(resource); + if (validationModel == null) { + LOG.warn("No validation defined for resource '{}' with type '{}'", resource.getPath(), resource.getResourceType()); + + } else { + ValidationResult result = validation.validate(resource, validationModel); + if (!result.isValid()) { + // give out the validation result + } + } + } catch (IllegalStateException e) { + LOG.warn("Invalid validation model for resource '{}' with type '{}'", resource.getPath(), resource.getResourceType()); + } +} +</code></pre> <h1>Validators</h1> <table> <thead> http://git-wip-us.apache.org/repos/asf/sling-site/blob/3a935d04/documentation/bundles/web-console-extensions.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/web-console-extensions.html b/documentation/bundles/web-console-extensions.html index 8ba13cc..60f925e 100644 --- a/documentation/bundles/web-console-extensions.html +++ b/documentation/bundles/web-console-extensions.html @@ -2,22 +2,22 @@ <head> <meta charset="utf-8"/> <title>Apache Sling on JBake</title> - <link rel="stylesheet" href="/res/css/site.css"/> - <link rel="stylesheet" href="/res/css/codehilite.css"/> + <link rel="stylesheet" href="/ng/res/css/site.css"/> + <link rel="icon" href="/ng/res/favicon.ico"/> <div class="title"> <div class="logo"> <a href="http://sling.apache.org";> - <img border="0" alt="Apache Sling" src="/res/logos/sling.svg"/> + <img border="0" alt="Apache Sling" src="/ng/res/logos/sling.svg"/> </a> </div><div class="header"> <a href="http://www.apache.org";> - <img border="0" alt="Apache" src="/res/logos/apache.png"/> + <img border="0" alt="Apache" src="/ng/res/logos/apache.png"/> </a> </div> </div> </head><body> <div class="menu"> - <strong><a href="/documentation.html">Documentation</a></strong><br/><a href="/documentation/getting-started.html">Getting Started</a><br/><a href="/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/documentation/development.html">Development</a><br/><a href="/documentation/bundles.html">Bundles</a><br/><a href="/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki";>Wiki</a><br/><a href="http://s.apache.org/sling.faq";>FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/apidocs/sling9/index.html">Sling 9</a><br/><a href="/apidocs/sling8/index.html">Sling 8</a><br/><a href="/apidocs/sling7/index.html">Sling 7</a><br/><a href="/apidocs/sling6/index.html">Sling 6</a><br/><a href="/apidocs/sling5/index.html">Sling 5</a><br/><a href="/javadoc-io.html">Archive at javadoc.io</a><br/><p></p><strong>Project info</strong><br/><a h ref="/downloads.cgi">Downloads</a><br/><a href="http://www.apache.org/licenses/";>License</a><br/><a href="/contributing.html">Contributing</a><br/><a href="/news.html">News</a><br/><a href="/links.html">Links</a><br/><a href="/project-information.html">Project Information</a><br/><a href="https://issues.apache.org/jira/browse/SLING";>Issue Tracker</a><br/><a href="http://ci.apache.org/builders/sling-trunk";>Build Server</a><br/><a href="/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a href="http://svn.apache.org/viewvc/sling/trunk";>Subversion</a><br/><a href="git://git.apache.org/sling.git">Git</a><br/><a href="https://github.com/apache/sling";>Github Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a><br/><a href="http://www.apache.org/foundation/sponsorship.html";>Become a Sponsor</a><br/><a href="https://donate.apache.org/";>Donate!</a><br/><a href="http://www.apache.org/foun dation/buy_stuff.html">Buy Stuff</a><br/><p></p><strong><a href="/sitemap.html">Site Map</a></strong> + <strong><a href="/ng/documentation.html">Documentation</a></strong><br/><a href="/ng/documentation/getting-started.html">Getting Started</a><br/><a href="/ng/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/ng/documentation/development.html">Development</a><br/><a href="/ng/documentation/bundles.html">Bundles</a><br/><a href="/ng/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/ng/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki";>Wiki</a><br/><a href="http://s.apache.org/sling.faq";>FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/ng/apidocs/sling9/index.html">Sling 9</a><br/><a href="/ng/apidocs/sling8/index.html">Sling 8</a><br/><a href="/ng/apidocs/sling7/index.html">Sling 7</a><br/><a href="/ng/apidocs/sling6/index.html">Sling 6</a><br/><a href="/ng/apidocs/sling5/index.html">Sling 5</a><br/><a href="/ng/javadoc-io.html">Archive at javadoc.io</a><br/><p></p ><strong>Project info</strong><br/><a >href="/ng/downloads.cgi">Downloads</a><br/><a >href="http://www.apache.org/licenses/";>License</a><br/><a >href="/ng/contributing.html">Contributing</a><br/><a >href="/ng/news.html">News</a><br/><a href="/ng/links.html">Links</a><br/><a >href="/ng/project-information.html">Project Information</a><br/><a >href="https://issues.apache.org/jira/browse/SLING";>Issue Tracker</a><br/><a >href="http://ci.apache.org/builders/sling-trunk";>Build Server</a><br/><a >href="/ng/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a > href="http://svn.apache.org/viewvc/sling/trunk";>Subversion</a><br/><a >href="git://git.apache.org/sling.git">Git</a><br/><a >href="https://github.com/apache/sling";>Github >Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a >href="http://www.apache.org/foundation/thanks.html";>Thanks</a><br/><a >href="http://www.apache.org/foundation/sponsorship.html";>Become a >Sponsor</a><br/><a href="https://donate.apache. org/">Donate!</a><br/><a href="http://www.apache.org/foundation/buy_stuff.html";>Buy Stuff</a><br/><p></p><strong><a href="/ng/sitemap.html">Site Map</a></strong> </div> <div class="main"> <div class="row"><div class="small-12 columns"><section class="wrap"><header><h1>Web Console Extensions</h1></header><p>The Apache Sling project provides two extensions to the <a href="http://felix.apache.org/site/apache-felix-web-console.html";>Apache Felix Web Console</a> (in addition to a number of plugins, of course):</p> <p>[TOC]</p> http://git-wip-us.apache.org/repos/asf/sling-site/blob/3a935d04/documentation/bundles/xml-support.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/xml-support.html b/documentation/bundles/xml-support.html index 283529d..0eb4db0 100644 --- a/documentation/bundles/xml-support.html +++ b/documentation/bundles/xml-support.html @@ -2,22 +2,22 @@ <head> <meta charset="utf-8"/> <title>Apache Sling on JBake</title> - <link rel="stylesheet" href="/res/css/site.css"/> - <link rel="stylesheet" href="/res/css/codehilite.css"/> + <link rel="stylesheet" href="/ng/res/css/site.css"/> + <link rel="icon" href="/ng/res/favicon.ico"/> <div class="title"> <div class="logo"> <a href="http://sling.apache.org";> - <img border="0" alt="Apache Sling" src="/res/logos/sling.svg"/> + <img border="0" alt="Apache Sling" src="/ng/res/logos/sling.svg"/> </a> </div><div class="header"> <a href="http://www.apache.org";> - <img border="0" alt="Apache" src="/res/logos/apache.png"/> + <img border="0" alt="Apache" src="/ng/res/logos/apache.png"/> </a> </div> </div> </head><body> <div class="menu"> - <strong><a href="/documentation.html">Documentation</a></strong><br/><a href="/documentation/getting-started.html">Getting Started</a><br/><a href="/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/documentation/development.html">Development</a><br/><a href="/documentation/bundles.html">Bundles</a><br/><a href="/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki";>Wiki</a><br/><a href="http://s.apache.org/sling.faq";>FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/apidocs/sling9/index.html">Sling 9</a><br/><a href="/apidocs/sling8/index.html">Sling 8</a><br/><a href="/apidocs/sling7/index.html">Sling 7</a><br/><a href="/apidocs/sling6/index.html">Sling 6</a><br/><a href="/apidocs/sling5/index.html">Sling 5</a><br/><a href="/javadoc-io.html">Archive at javadoc.io</a><br/><p></p><strong>Project info</strong><br/><a h ref="/downloads.cgi">Downloads</a><br/><a href="http://www.apache.org/licenses/";>License</a><br/><a href="/contributing.html">Contributing</a><br/><a href="/news.html">News</a><br/><a href="/links.html">Links</a><br/><a href="/project-information.html">Project Information</a><br/><a href="https://issues.apache.org/jira/browse/SLING";>Issue Tracker</a><br/><a href="http://ci.apache.org/builders/sling-trunk";>Build Server</a><br/><a href="/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a href="http://svn.apache.org/viewvc/sling/trunk";>Subversion</a><br/><a href="git://git.apache.org/sling.git">Git</a><br/><a href="https://github.com/apache/sling";>Github Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a><br/><a href="http://www.apache.org/foundation/sponsorship.html";>Become a Sponsor</a><br/><a href="https://donate.apache.org/";>Donate!</a><br/><a href="http://www.apache.org/foun dation/buy_stuff.html">Buy Stuff</a><br/><p></p><strong><a href="/sitemap.html">Site Map</a></strong> + <strong><a href="/ng/documentation.html">Documentation</a></strong><br/><a href="/ng/documentation/getting-started.html">Getting Started</a><br/><a href="/ng/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/ng/documentation/development.html">Development</a><br/><a href="/ng/documentation/bundles.html">Bundles</a><br/><a href="/ng/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/ng/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki";>Wiki</a><br/><a href="http://s.apache.org/sling.faq";>FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/ng/apidocs/sling9/index.html">Sling 9</a><br/><a href="/ng/apidocs/sling8/index.html">Sling 8</a><br/><a href="/ng/apidocs/sling7/index.html">Sling 7</a><br/><a href="/ng/apidocs/sling6/index.html">Sling 6</a><br/><a href="/ng/apidocs/sling5/index.html">Sling 5</a><br/><a href="/ng/javadoc-io.html">Archive at javadoc.io</a><br/><p></p ><strong>Project info</strong><br/><a >href="/ng/downloads.cgi">Downloads</a><br/><a >href="http://www.apache.org/licenses/";>License</a><br/><a >href="/ng/contributing.html">Contributing</a><br/><a >href="/ng/news.html">News</a><br/><a href="/ng/links.html">Links</a><br/><a >href="/ng/project-information.html">Project Information</a><br/><a >href="https://issues.apache.org/jira/browse/SLING";>Issue Tracker</a><br/><a >href="http://ci.apache.org/builders/sling-trunk";>Build Server</a><br/><a >href="/ng/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a > href="http://svn.apache.org/viewvc/sling/trunk";>Subversion</a><br/><a >href="git://git.apache.org/sling.git">Git</a><br/><a >href="https://github.com/apache/sling";>Github >Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a >href="http://www.apache.org/foundation/thanks.html";>Thanks</a><br/><a >href="http://www.apache.org/foundation/sponsorship.html";>Become a >Sponsor</a><br/><a href="https://donate.apache. org/">Donate!</a><br/><a href="http://www.apache.org/foundation/buy_stuff.html";>Buy Stuff</a><br/><p></p><strong><a href="/ng/sitemap.html">Site Map</a></strong> </div> <div class="main"> <div class="row"><div class="small-12 columns"><section class="wrap"><header><h1>XML support</h1></header><p>Excerpt: XML mechanisms supported by Sling</p> <p>Out of the box, Sling provides no special bundles for XML. However, Sling supports multiple mechanisms and libraries. The ones we have validated with integration tests are:</p> http://git-wip-us.apache.org/repos/asf/sling-site/blob/3a935d04/documentation/configuration.html ---------------------------------------------------------------------- diff --git a/documentation/configuration.html b/documentation/configuration.html index ba94b3d..4659b45 100644 --- a/documentation/configuration.html +++ b/documentation/configuration.html @@ -2,36 +2,35 @@ <head> <meta charset="utf-8"/> <title>Apache Sling on JBake</title> - <link rel="stylesheet" href="/res/css/site.css"/> - <link rel="stylesheet" href="/res/css/codehilite.css"/> + <link rel="stylesheet" href="/ng/res/css/site.css"/> + <link rel="icon" href="/ng/res/favicon.ico"/> <div class="title"> <div class="logo"> <a href="http://sling.apache.org";> - <img border="0" alt="Apache Sling" src="/res/logos/sling.svg"/> + <img border="0" alt="Apache Sling" src="/ng/res/logos/sling.svg"/> </a> </div><div class="header"> <a href="http://www.apache.org";> - <img border="0" alt="Apache" src="/res/logos/apache.png"/> + <img border="0" alt="Apache" src="/ng/res/logos/apache.png"/> </a> </div> </div> </head><body> <div class="menu"> - <strong><a href="/documentation.html">Documentation</a></strong><br/><a href="/documentation/getting-started.html">Getting Started</a><br/><a href="/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/documentation/development.html">Development</a><br/><a href="/documentation/bundles.html">Bundles</a><br/><a href="/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki";>Wiki</a><br/><a href="http://s.apache.org/sling.faq";>FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/apidocs/sling9/index.html">Sling 9</a><br/><a href="/apidocs/sling8/index.html">Sling 8</a><br/><a href="/apidocs/sling7/index.html">Sling 7</a><br/><a href="/apidocs/sling6/index.html">Sling 6</a><br/><a href="/apidocs/sling5/index.html">Sling 5</a><br/><a href="/javadoc-io.html">Archive at javadoc.io</a><br/><p></p><strong>Project info</strong><br/><a h ref="/downloads.cgi">Downloads</a><br/><a href="http://www.apache.org/licenses/";>License</a><br/><a href="/contributing.html">Contributing</a><br/><a href="/news.html">News</a><br/><a href="/links.html">Links</a><br/><a href="/project-information.html">Project Information</a><br/><a href="https://issues.apache.org/jira/browse/SLING";>Issue Tracker</a><br/><a href="http://ci.apache.org/builders/sling-trunk";>Build Server</a><br/><a href="/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a href="http://svn.apache.org/viewvc/sling/trunk";>Subversion</a><br/><a href="git://git.apache.org/sling.git">Git</a><br/><a href="https://github.com/apache/sling";>Github Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a><br/><a href="http://www.apache.org/foundation/sponsorship.html";>Become a Sponsor</a><br/><a href="https://donate.apache.org/";>Donate!</a><br/><a href="http://www.apache.org/foun dation/buy_stuff.html">Buy Stuff</a><br/><p></p><strong><a href="/sitemap.html">Site Map</a></strong> + <strong><a href="/ng/documentation.html">Documentation</a></strong><br/><a href="/ng/documentation/getting-started.html">Getting Started</a><br/><a href="/ng/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/ng/documentation/development.html">Development</a><br/><a href="/ng/documentation/bundles.html">Bundles</a><br/><a href="/ng/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/ng/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki";>Wiki</a><br/><a href="http://s.apache.org/sling.faq";>FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/ng/apidocs/sling9/index.html">Sling 9</a><br/><a href="/ng/apidocs/sling8/index.html">Sling 8</a><br/><a href="/ng/apidocs/sling7/index.html">Sling 7</a><br/><a href="/ng/apidocs/sling6/index.html">Sling 6</a><br/><a href="/ng/apidocs/sling5/index.html">Sling 5</a><br/><a href="/ng/javadoc-io.html">Archive at javadoc.io</a><br/><p></p ><strong>Project info</strong><br/><a >href="/ng/downloads.cgi">Downloads</a><br/><a >href="http://www.apache.org/licenses/";>License</a><br/><a >href="/ng/contributing.html">Contributing</a><br/><a >href="/ng/news.html">News</a><br/><a href="/ng/links.html">Links</a><br/><a >href="/ng/project-information.html">Project Information</a><br/><a >href="https://issues.apache.org/jira/browse/SLING";>Issue Tracker</a><br/><a >href="http://ci.apache.org/builders/sling-trunk";>Build Server</a><br/><a >href="/ng/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a > href="http://svn.apache.org/viewvc/sling/trunk";>Subversion</a><br/><a >href="git://git.apache.org/sling.git">Git</a><br/><a >href="https://github.com/apache/sling";>Github >Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a >href="http://www.apache.org/foundation/thanks.html";>Thanks</a><br/><a >href="http://www.apache.org/foundation/sponsorship.html";>Become a >Sponsor</a><br/><a href="https://donate.apache. org/">Donate!</a><br/><a href="http://www.apache.org/foundation/buy_stuff.html";>Buy Stuff</a><br/><p></p><strong><a href="/ng/sitemap.html">Site Map</a></strong> </div> <div class="main"> <div class="row"><div class="small-12 columns"><section class="wrap"><header><h1>Configuration</h1></header><h2>Introduction</h2> <p>Configuration in Sling is aligned with respective support by the OSGi specification:</p> <ul> <li>Framework and Java system properties are available through the <code>BundleContext.getProperty(String)</code> method. These properties are provided in Sling through the Sling launcher.</li> <li>Bundle Header values are available through the <code>Bundle.getHeaders()</code> and <code>Bundle.getHeaders(String)</code> methods. These header values are set by the bundle developer in the <code>META-INF/MANIFEST.MF</code> file. In fact, all main manifest attributes are available through these methods.</li> - <li>Components managed by the Service Component Runtime and declared in component descriptor files listed in the <code>Service-Component</code> manifest header access configuration properties through the <code>ComponentContext.getProperties()</code> method. These properties have three sources:</li> -</ul> -<ol> - <li>Configuration specified specifically for factory components</li> - <li>Properties retrieved from the Configuration Admin Service</li> - <li>Properties set in the component descriptor</li> -</ol> -<ul> + <li>Components managed by the Service Component Runtime and declared in component descriptor files listed in the <code>Service-Component</code> manifest header access configuration properties through the <code>ComponentContext.getProperties()</code> method. These properties have three sources: + <ol> + <li>Configuration specified specifically for factory components</li> + <li>Properties retrieved from the Configuration Admin Service</li> + <li>Properties set in the component descriptor</li> + </ol> + </li> <li>Configuration properties provided to <code>ManagedService</code> and <code>ManagedServiceFactory</code> instances by the Configuration Admin Service.</li> </ul> <p>For the discussion to follow we differentiate between initial configuration provided by Framework and system properties and managed configuration provided by the Configuration Admin Service.</p> @@ -49,13 +48,12 @@ <li>Resolve any property file inclusions. This may be used to provide more configurability depending on the integration.</li> <li>Handle OSGi boot delegation support (see below).</li> <li>Resolve property references of the form <code>${propName</code>}</li> - <li>For each property value starting with <code>ontext:/</code> do the following, assuming the value to be an URL with scheme <code>context:</code>:</li> -</ol> -<ul> - <li>Copy the application resource to <code>${sling.home</code>} preserving the URL path unless such a file already exists.</li> - <li>Replace the property value with the path to the newly created file. The path has the form <code>${sling.home}/relpath</code>.</li> -</ul> -<ol> + <li>For each property value starting with <code>ontext:/</code> do the following, assuming the value to be an URL with scheme <code>context:</code>: + <ul> + <li>Copy the application resource to <code>${sling.home</code>} preserving the URL path unless such a file already exists.</li> + <li>Replace the property value with the path to the newly created file. The path has the form <code>${sling.home}/relpath</code>.</li> + </ul> + </li> <li>Store the properties as <code>${sling.home}/sling.properties</code> to be re-used on next startup</li> <li>Setup Bundle auto installation for the Felix Framework</li> </ol> @@ -109,7 +107,8 @@ </ol> <p><em>Example</em></p> <p>The packaged <code>sling.properties</code> file contains the following properties file inclusion setting:</p> -<p>sling.include.jre = jre-${java.specification.version}.properties</p> +<pre><code>sling.include.jre = jre-${java.specification.version}.properties +</code></pre> <p>This is used to include the JRE package list to be made visible inside the OSGi framework.</p> <h3>OSGi Boot Delegation Support</h3> <p>Some packages may have to be shared between bundles in an OSGi framework and the rest of Java VM in which the framework has been launched. This is especially true for OSGi framework instances launched in embedding such as Servlet Containers. In the case of a Sling Application accessing a JCR Repository launched in a different Web Application, this mainly concerns an API packages as well as the JNDI Initial Factory package(s).</p> http://git-wip-us.apache.org/repos/asf/sling-site/blob/3a935d04/documentation/development.html ---------------------------------------------------------------------- diff --git a/documentation/development.html b/documentation/development.html index 9e4455f..6a8add9 100644 --- a/documentation/development.html +++ b/documentation/development.html @@ -2,22 +2,22 @@ <head> <meta charset="utf-8"/> <title>Apache Sling on JBake</title> - <link rel="stylesheet" href="/res/css/site.css"/> - <link rel="stylesheet" href="/res/css/codehilite.css"/> + <link rel="stylesheet" href="/ng/res/css/site.css"/> + <link rel="icon" href="/ng/res/favicon.ico"/> <div class="title"> <div class="logo"> <a href="http://sling.apache.org";> - <img border="0" alt="Apache Sling" src="/res/logos/sling.svg"/> + <img border="0" alt="Apache Sling" src="/ng/res/logos/sling.svg"/> </a> </div><div class="header"> <a href="http://www.apache.org";> - <img border="0" alt="Apache" src="/res/logos/apache.png"/> + <img border="0" alt="Apache" src="/ng/res/logos/apache.png"/> </a> </div> </div> </head><body> <div class="menu"> - <strong><a href="/documentation.html">Documentation</a></strong><br/><a href="/documentation/getting-started.html">Getting Started</a><br/><a href="/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/documentation/development.html">Development</a><br/><a href="/documentation/bundles.html">Bundles</a><br/><a href="/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki";>Wiki</a><br/><a href="http://s.apache.org/sling.faq";>FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/apidocs/sling9/index.html">Sling 9</a><br/><a href="/apidocs/sling8/index.html">Sling 8</a><br/><a href="/apidocs/sling7/index.html">Sling 7</a><br/><a href="/apidocs/sling6/index.html">Sling 6</a><br/><a href="/apidocs/sling5/index.html">Sling 5</a><br/><a href="/javadoc-io.html">Archive at javadoc.io</a><br/><p></p><strong>Project info</strong><br/><a h ref="/downloads.cgi">Downloads</a><br/><a href="http://www.apache.org/licenses/";>License</a><br/><a href="/contributing.html">Contributing</a><br/><a href="/news.html">News</a><br/><a href="/links.html">Links</a><br/><a href="/project-information.html">Project Information</a><br/><a href="https://issues.apache.org/jira/browse/SLING";>Issue Tracker</a><br/><a href="http://ci.apache.org/builders/sling-trunk";>Build Server</a><br/><a href="/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a href="http://svn.apache.org/viewvc/sling/trunk";>Subversion</a><br/><a href="git://git.apache.org/sling.git">Git</a><br/><a href="https://github.com/apache/sling";>Github Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a><br/><a href="http://www.apache.org/foundation/sponsorship.html";>Become a Sponsor</a><br/><a href="https://donate.apache.org/";>Donate!</a><br/><a href="http://www.apache.org/foun dation/buy_stuff.html">Buy Stuff</a><br/><p></p><strong><a href="/sitemap.html">Site Map</a></strong> + <strong><a href="/ng/documentation.html">Documentation</a></strong><br/><a href="/ng/documentation/getting-started.html">Getting Started</a><br/><a href="/ng/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/ng/documentation/development.html">Development</a><br/><a href="/ng/documentation/bundles.html">Bundles</a><br/><a href="/ng/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/ng/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki";>Wiki</a><br/><a href="http://s.apache.org/sling.faq";>FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/ng/apidocs/sling9/index.html">Sling 9</a><br/><a href="/ng/apidocs/sling8/index.html">Sling 8</a><br/><a href="/ng/apidocs/sling7/index.html">Sling 7</a><br/><a href="/ng/apidocs/sling6/index.html">Sling 6</a><br/><a href="/ng/apidocs/sling5/index.html">Sling 5</a><br/><a href="/ng/javadoc-io.html">Archive at javadoc.io</a><br/><p></p ><strong>Project info</strong><br/><a >href="/ng/downloads.cgi">Downloads</a><br/><a >href="http://www.apache.org/licenses/";>License</a><br/><a >href="/ng/contributing.html">Contributing</a><br/><a >href="/ng/news.html">News</a><br/><a href="/ng/links.html">Links</a><br/><a >href="/ng/project-information.html">Project Information</a><br/><a >href="https://issues.apache.org/jira/browse/SLING";>Issue Tracker</a><br/><a >href="http://ci.apache.org/builders/sling-trunk";>Build Server</a><br/><a >href="/ng/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a > href="http://svn.apache.org/viewvc/sling/trunk";>Subversion</a><br/><a >href="git://git.apache.org/sling.git">Git</a><br/><a >href="https://github.com/apache/sling";>Github >Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a >href="http://www.apache.org/foundation/thanks.html";>Thanks</a><br/><a >href="http://www.apache.org/foundation/sponsorship.html";>Become a >Sponsor</a><br/><a href="https://donate.apache. org/">Donate!</a><br/><a href="http://www.apache.org/foundation/buy_stuff.html";>Buy Stuff</a><br/><p></p><strong><a href="/ng/sitemap.html">Site Map</a></strong> </div> <div class="main"> <div class="row"><div class="small-12 columns"><section class="wrap"><header><h1>Development</h1></header><p>Welcome to the wonderful world of extending Sling. Refer to these pages to find out how we envision the extension of Sling and how to do it.</p> <h2>Using Sling as your Development Framework</h2> http://git-wip-us.apache.org/repos/asf/sling-site/blob/3a935d04/documentation/development/client-request-logging.html ---------------------------------------------------------------------- diff --git a/documentation/development/client-request-logging.html b/documentation/development/client-request-logging.html index 0504b59..c076619 100644 --- a/documentation/development/client-request-logging.html +++ b/documentation/development/client-request-logging.html @@ -2,22 +2,22 @@ <head> <meta charset="utf-8"/> <title>Apache Sling on JBake</title> - <link rel="stylesheet" href="/res/css/site.css"/> - <link rel="stylesheet" href="/res/css/codehilite.css"/> + <link rel="stylesheet" href="/ng/res/css/site.css"/> + <link rel="icon" href="/ng/res/favicon.ico"/> <div class="title"> <div class="logo"> <a href="http://sling.apache.org";> - <img border="0" alt="Apache Sling" src="/res/logos/sling.svg"/> + <img border="0" alt="Apache Sling" src="/ng/res/logos/sling.svg"/> </a> </div><div class="header"> <a href="http://www.apache.org";> - <img border="0" alt="Apache" src="/res/logos/apache.png"/> + <img border="0" alt="Apache" src="/ng/res/logos/apache.png"/> </a> </div> </div> </head><body> <div class="menu"> - <strong><a href="/documentation.html">Documentation</a></strong><br/><a href="/documentation/getting-started.html">Getting Started</a><br/><a href="/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/documentation/development.html">Development</a><br/><a href="/documentation/bundles.html">Bundles</a><br/><a href="/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki";>Wiki</a><br/><a href="http://s.apache.org/sling.faq";>FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/apidocs/sling9/index.html">Sling 9</a><br/><a href="/apidocs/sling8/index.html">Sling 8</a><br/><a href="/apidocs/sling7/index.html">Sling 7</a><br/><a href="/apidocs/sling6/index.html">Sling 6</a><br/><a href="/apidocs/sling5/index.html">Sling 5</a><br/><a href="/javadoc-io.html">Archive at javadoc.io</a><br/><p></p><strong>Project info</strong><br/><a h ref="/downloads.cgi">Downloads</a><br/><a href="http://www.apache.org/licenses/";>License</a><br/><a href="/contributing.html">Contributing</a><br/><a href="/news.html">News</a><br/><a href="/links.html">Links</a><br/><a href="/project-information.html">Project Information</a><br/><a href="https://issues.apache.org/jira/browse/SLING";>Issue Tracker</a><br/><a href="http://ci.apache.org/builders/sling-trunk";>Build Server</a><br/><a href="/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a href="http://svn.apache.org/viewvc/sling/trunk";>Subversion</a><br/><a href="git://git.apache.org/sling.git">Git</a><br/><a href="https://github.com/apache/sling";>Github Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a><br/><a href="http://www.apache.org/foundation/sponsorship.html";>Become a Sponsor</a><br/><a href="https://donate.apache.org/";>Donate!</a><br/><a href="http://www.apache.org/foun dation/buy_stuff.html">Buy Stuff</a><br/><p></p><strong><a href="/sitemap.html">Site Map</a></strong> + <strong><a href="/ng/documentation.html">Documentation</a></strong><br/><a href="/ng/documentation/getting-started.html">Getting Started</a><br/><a href="/ng/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/ng/documentation/development.html">Development</a><br/><a href="/ng/documentation/bundles.html">Bundles</a><br/><a href="/ng/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/ng/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki";>Wiki</a><br/><a href="http://s.apache.org/sling.faq";>FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/ng/apidocs/sling9/index.html">Sling 9</a><br/><a href="/ng/apidocs/sling8/index.html">Sling 8</a><br/><a href="/ng/apidocs/sling7/index.html">Sling 7</a><br/><a href="/ng/apidocs/sling6/index.html">Sling 6</a><br/><a href="/ng/apidocs/sling5/index.html">Sling 5</a><br/><a href="/ng/javadoc-io.html">Archive at javadoc.io</a><br/><p></p ><strong>Project info</strong><br/><a >href="/ng/downloads.cgi">Downloads</a><br/><a >href="http://www.apache.org/licenses/";>License</a><br/><a >href="/ng/contributing.html">Contributing</a><br/><a >href="/ng/news.html">News</a><br/><a href="/ng/links.html">Links</a><br/><a >href="/ng/project-information.html">Project Information</a><br/><a >href="https://issues.apache.org/jira/browse/SLING";>Issue Tracker</a><br/><a >href="http://ci.apache.org/builders/sling-trunk";>Build Server</a><br/><a >href="/ng/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a > href="http://svn.apache.org/viewvc/sling/trunk";>Subversion</a><br/><a >href="git://git.apache.org/sling.git">Git</a><br/><a >href="https://github.com/apache/sling";>Github >Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a >href="http://www.apache.org/foundation/thanks.html";>Thanks</a><br/><a >href="http://www.apache.org/foundation/sponsorship.html";>Become a >Sponsor</a><br/><a href="https://donate.apache. org/">Donate!</a><br/><a href="http://www.apache.org/foundation/buy_stuff.html";>Buy Stuff</a><br/><p></p><strong><a href="/ng/sitemap.html">Site Map</a></strong> </div> <div class="main"> <div class="row"><div class="small-12 columns"><section class="wrap"><header><h1>Client Request Logging</h1></header><p>Sling provides extensive support to log various information at the before and after processing client requests. Out of the box, there are two loggers configured to write traditional <code>access.log</code> and <code>request.log</code> files. In addition more logging can be configured by providing OSGi Configuration Admin configuration.</p> <h2>Traditional access.log and request.log Files</h2> @@ -37,7 +37,7 @@ <td>Request Log Name </td> <td><code>request.log.output</code> </td> <td>logs/request.log </td> - <td>Name of the destination for the request log. The request log logs the entry and exit of each request into and out of the system together with the entry time, exit time, time to process the request, a request counter as well as the final status code and response content type. In terms of Request Logger Service formats, request entry is logged with the format <code>%t [%R] -> %m %U%q %H</code> and request exit is logged with the format <code>%{end}t [%R] <- %s %{Content-Type}o %Dms</code> (See <a href="#log-format-specification">Log Format Specification</a> below for the specification of the format). </td> + <td>Name of the destination for the request log. The request log logs the entry and exit of each request into and out of the system together with the entry time, exit time, time to process the request, a request counter as well as the final status code and response content type. In terms of Request Logger Service formats, request entry is logged with the format <code>%t \[%R\] \-> %m %U%q %H</code> and request exit is logged with the format <code>%\{end}t \[%R] <\- %s %\{Content-Type}o %Dms</code> (See <a href="#log-format-specification">Log Format Specification</a> below for the specification of the format). </td> </tr> <tr> <td>Request Log Type </td> @@ -55,7 +55,7 @@ <td>Access Log Name </td> <td><code>access.log.output</code> </td> <td>logs/access.log </td> - <td>Name of the destination for the access log. The access log writes an entry for each request as the request terminates using the NCSA extended/combined log format. In terms of Request Logger Service formats the access log is written with the format <code>%h %l %u %t "%r" %>s %b "%{Referer}i" "%{User-Agent}i"</code> (See <a href="#log-format-specification">Log Format Specification</a> below for the specification of the format). </td> + <td>Name of the destination for the access log. The access log writes an entry for each request as the request terminates using the NCSA extended/combined log format. In terms of Request Logger Service formats the access log is written with the format <code>%h %l %u %t "%r" %>s %b "%\{Referer}i" "%\{User-Agent}i"</code> (See <a href="#log-format-specification">Log Format Specification</a> below for the specification of the format). </td> </tr> <tr> <td>Access Log Type </td> @@ -171,7 +171,7 @@ <td>Size of response in bytes, excluding HTTP headers. In CLF format, i.e. a '-' rather than a 0 when no bytes are sent. </td> </tr> <tr> - <td><code>%{Foobar}C</code> </td> + <td><code>%\{Foobar}C</code> </td> <td>The contents of cookie Foobar in the request sent to the server. </td> </tr> <tr> @@ -179,7 +179,7 @@ <td>The time taken to serve the request, in milliseconds. Please note that this deviates from the Apache httpd format. </td> </tr> <tr> - <td><code>%{FOOBAR}e</code> </td> + <td><code>%\{FOOBAR}e</code> </td> <td>Not supported in Sling; prints nothing. </td> </tr> <tr> @@ -195,7 +195,7 @@ <td>The request protocol </td> </tr> <tr> - <td><code>%{Foobar}i</code> </td> + <td><code>%\{Foobar}i</code> </td> <td>The contents of Foobar: header line(s) in the request sent to the server. </td> </tr> <tr> @@ -211,11 +211,11 @@ <td>The request method </td> </tr> <tr> - <td><code>%{Foobar}n</code> </td> + <td><code>%\{Foobar}n</code> </td> <td>Not supported in Sling; prints nothing. </td> </tr> <tr> - <td><code>%{Foobar}o</code> </td> + <td><code>%\{Foobar}o</code> </td> <td>The contents of Foobar: header line(s) in the reply. </td> </tr> <tr> @@ -223,7 +223,7 @@ <td>The canonical port of the server serving the request </td> </tr> <tr> - <td><code>%{format}p</code> </td> + <td><code>%\{format}p</code> </td> <td>The canonical port of the server serving the request or the server's actual port or the client's actual port. Valid formats are canonical, local, or remote. </td> </tr> <tr> @@ -231,7 +231,7 @@ <td>The <em>name of the thread</em> ~~process ID of the child~~ that serviced the request. </td> </tr> <tr> - <td><code>%{format}P</code> </td> + <td><code>%\{format}P</code> </td> <td>Same as <code>%P</code>; the <code>format</code> parameter is ignored. </td> </tr> <tr> @@ -255,7 +255,7 @@ <td>Time the request was received (standard english format) </td> </tr> <tr> - <td><code>%{format}t</code> </td> + <td><code>%\{format}t</code> </td> <td>Same as <code>%t</code>; the <code>format</code> parameter is ignored unless it is the literal value <em>end</em> indicating to use the time of request terminating (instead of the time of request receipt). </td> </tr> <tr> @@ -296,20 +296,19 @@ <p>Particular items can be restricted to print only for responses with specific HTTP status codes by placing a comma-separated list of status codes immediately following the "%". For example, "%400,501{User-agent}i" logs User-agent on 400 errors and 501 errors only. For other status codes, the literal string "-" will be logged. The status code list may be preceded by a "!" to indicate negation: "%!200,304,302{Referer}i" logs Referer on all requests that do not return one of the three specified codes.</p> <p>The Apache httpd modifiers "<" and ">" are not supported by Sling and currently ignored.</p> <p><strong>Some Notes</strong></p> -<p>For security reasons non-printable and other special characters in %C, %i and %o are escaped using uhhhh sequences, where hhhh stands for the hexadecimal representation of the character's unicode value. Exceptions from this rule are " and , which are escaped by prepending a backslash, and all whitespace characters, which are written in their Java-style notation (n, t, etc).</p> +<p>For security reasons non-printable and other special characters in %C, %i and %o are escaped using \uhhhh sequences, where hhhh stands for the hexadecimal representation of the character's unicode value. Exceptions from this rule are " and \, which are escaped by prepending a backslash, and all whitespace characters, which are written in their Java-style notation (\n, \t, etc).</p> <h4>Rotating Logger Files</h4> <p>If you want to write the request (and access) logging information into a rotated file, you should configure as follows:</p> <ol> <li>Configure the Log Type to be a <em>Logger Name</em> and some usefull Logger name. For example <code>clientlog.request</code>.</li> - <li>Create an <em>Apache Sling Logging Logger Configuration</em> for this Logger name according to [Logging Configuration]({{ refs.logging-logger-configuration.path }}) with the following setup:</li> -</ol> -<ul> - <li>Allow message at INFO (Information) level to be logged which is the level used by the request loggers</li> - <li>Define the appropriate log file name, for example <code>logs/client.request.log</code></li> - <li>Use only <code>{5</code>} as the message format because request logger messages are generally already fully formated with required timestamp etc.</li> - <li>Add any Logger names used for the client request log configuration, <code>clientlog.request</code> in the example above, to the Logger field. By clicking on the <code>+</code> (plus) button you may add more than a single logger name whose messages are written to this file.</li> -</ul> -<ol> + <li>Create an <em>Apache Sling Logging Logger Configuration</em> for this Logger name according to [Logging Configuration]({{ refs.logging-logger-configuration.path }}) with the following setup: + <ul> + <li>Allow message at INFO (Information) level to be logged which is the level used by the request loggers</li> + <li>Define the appropriate log file name, for example <code>logs/client.request.log</code></li> + <li>Use only <code>\{5</code>} as the message format because request logger messages are generally already fully formated with required timestamp etc.</li> + <li>Add any Logger names used for the client request log configuration, <code>clientlog.request</code> in the example above, to the Logger field. By clicking on the <code>+</code> (plus) button you may add more than a single logger name whose messages are written to this file.</li> + </ul> + </li> <li>Optionally, you may create an <em>Apache Sling Logging Writer Configuration</em> for the log file defined in the previous step to better control rotation setup. See [Log Writer Configuration]({{ refs.logging-log-writer-configuration.path }}) for full details.</li> </ol></section></div></div> <div class="footer"> http://git-wip-us.apache.org/repos/asf/sling-site/blob/3a935d04/documentation/development/dependency-management.html ---------------------------------------------------------------------- diff --git a/documentation/development/dependency-management.html b/documentation/development/dependency-management.html index 99cab4e..eff6bbb 100644 --- a/documentation/development/dependency-management.html +++ b/documentation/development/dependency-management.html @@ -2,22 +2,22 @@ <head> <meta charset="utf-8"/> <title>Apache Sling on JBake</title> - <link rel="stylesheet" href="/res/css/site.css"/> - <link rel="stylesheet" href="/res/css/codehilite.css"/> + <link rel="stylesheet" href="/ng/res/css/site.css"/> + <link rel="icon" href="/ng/res/favicon.ico"/> <div class="title"> <div class="logo"> <a href="http://sling.apache.org";> - <img border="0" alt="Apache Sling" src="/res/logos/sling.svg"/> + <img border="0" alt="Apache Sling" src="/ng/res/logos/sling.svg"/> </a> </div><div class="header"> <a href="http://www.apache.org";> - <img border="0" alt="Apache" src="/res/logos/apache.png"/> + <img border="0" alt="Apache" src="/ng/res/logos/apache.png"/> </a> </div> </div> </head><body> <div class="menu"> - <strong><a href="/documentation.html">Documentation</a></strong><br/><a href="/documentation/getting-started.html">Getting Started</a><br/><a href="/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/documentation/development.html">Development</a><br/><a href="/documentation/bundles.html">Bundles</a><br/><a href="/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki";>Wiki</a><br/><a href="http://s.apache.org/sling.faq";>FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/apidocs/sling9/index.html">Sling 9</a><br/><a href="/apidocs/sling8/index.html">Sling 8</a><br/><a href="/apidocs/sling7/index.html">Sling 7</a><br/><a href="/apidocs/sling6/index.html">Sling 6</a><br/><a href="/apidocs/sling5/index.html">Sling 5</a><br/><a href="/javadoc-io.html">Archive at javadoc.io</a><br/><p></p><strong>Project info</strong><br/><a h ref="/downloads.cgi">Downloads</a><br/><a href="http://www.apache.org/licenses/";>License</a><br/><a href="/contributing.html">Contributing</a><br/><a href="/news.html">News</a><br/><a href="/links.html">Links</a><br/><a href="/project-information.html">Project Information</a><br/><a href="https://issues.apache.org/jira/browse/SLING";>Issue Tracker</a><br/><a href="http://ci.apache.org/builders/sling-trunk";>Build Server</a><br/><a href="/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a href="http://svn.apache.org/viewvc/sling/trunk";>Subversion</a><br/><a href="git://git.apache.org/sling.git">Git</a><br/><a href="https://github.com/apache/sling";>Github Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a><br/><a href="http://www.apache.org/foundation/sponsorship.html";>Become a Sponsor</a><br/><a href="https://donate.apache.org/";>Donate!</a><br/><a href="http://www.apache.org/foun dation/buy_stuff.html">Buy Stuff</a><br/><p></p><strong><a href="/sitemap.html">Site Map</a></strong> + <strong><a href="/ng/documentation.html">Documentation</a></strong><br/><a href="/ng/documentation/getting-started.html">Getting Started</a><br/><a href="/ng/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/ng/documentation/development.html">Development</a><br/><a href="/ng/documentation/bundles.html">Bundles</a><br/><a href="/ng/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/ng/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki";>Wiki</a><br/><a href="http://s.apache.org/sling.faq";>FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/ng/apidocs/sling9/index.html">Sling 9</a><br/><a href="/ng/apidocs/sling8/index.html">Sling 8</a><br/><a href="/ng/apidocs/sling7/index.html">Sling 7</a><br/><a href="/ng/apidocs/sling6/index.html">Sling 6</a><br/><a href="/ng/apidocs/sling5/index.html">Sling 5</a><br/><a href="/ng/javadoc-io.html">Archive at javadoc.io</a><br/><p></p ><strong>Project info</strong><br/><a >href="/ng/downloads.cgi">Downloads</a><br/><a >href="http://www.apache.org/licenses/";>License</a><br/><a >href="/ng/contributing.html">Contributing</a><br/><a >href="/ng/news.html">News</a><br/><a href="/ng/links.html">Links</a><br/><a >href="/ng/project-information.html">Project Information</a><br/><a >href="https://issues.apache.org/jira/browse/SLING";>Issue Tracker</a><br/><a >href="http://ci.apache.org/builders/sling-trunk";>Build Server</a><br/><a >href="/ng/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a > href="http://svn.apache.org/viewvc/sling/trunk";>Subversion</a><br/><a >href="git://git.apache.org/sling.git">Git</a><br/><a >href="https://github.com/apache/sling";>Github >Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a >href="http://www.apache.org/foundation/thanks.html";>Thanks</a><br/><a >href="http://www.apache.org/foundation/sponsorship.html";>Become a >Sponsor</a><br/><a href="https://donate.apache. org/">Donate!</a><br/><a href="http://www.apache.org/foundation/buy_stuff.html";>Buy Stuff</a><br/><p></p><strong><a href="/ng/sitemap.html">Site Map</a></strong> </div> <div class="main"> <div class="row"><div class="small-12 columns"><section class="wrap"><header><h1>Dependency Management</h1></header><p>Excerpt: This page is about how we do and don't do dependency management in the Sling project.</p> <p>This page is about how we do and don't do dependency management in the Sling project.</p> http://git-wip-us.apache.org/repos/asf/sling-site/blob/3a935d04/documentation/development/embedding-sling.html ---------------------------------------------------------------------- diff --git a/documentation/development/embedding-sling.html b/documentation/development/embedding-sling.html index beefd32..01bdca6 100644 --- a/documentation/development/embedding-sling.html +++ b/documentation/development/embedding-sling.html @@ -2,30 +2,33 @@ <head> <meta charset="utf-8"/> <title>Apache Sling on JBake</title> - <link rel="stylesheet" href="/res/css/site.css"/> - <link rel="stylesheet" href="/res/css/codehilite.css"/> + <link rel="stylesheet" href="/ng/res/css/site.css"/> + <link rel="icon" href="/ng/res/favicon.ico"/> <div class="title"> <div class="logo"> <a href="http://sling.apache.org";> - <img border="0" alt="Apache Sling" src="/res/logos/sling.svg"/> + <img border="0" alt="Apache Sling" src="/ng/res/logos/sling.svg"/> </a> </div><div class="header"> <a href="http://www.apache.org";> - <img border="0" alt="Apache" src="/res/logos/apache.png"/> + <img border="0" alt="Apache" src="/ng/res/logos/apache.png"/> </a> </div> </div> </head><body> <div class="menu"> - <strong><a href="/documentation.html">Documentation</a></strong><br/><a href="/documentation/getting-started.html">Getting Started</a><br/><a href="/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/documentation/development.html">Development</a><br/><a href="/documentation/bundles.html">Bundles</a><br/><a href="/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki";>Wiki</a><br/><a href="http://s.apache.org/sling.faq";>FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/apidocs/sling9/index.html">Sling 9</a><br/><a href="/apidocs/sling8/index.html">Sling 8</a><br/><a href="/apidocs/sling7/index.html">Sling 7</a><br/><a href="/apidocs/sling6/index.html">Sling 6</a><br/><a href="/apidocs/sling5/index.html">Sling 5</a><br/><a href="/javadoc-io.html">Archive at javadoc.io</a><br/><p></p><strong>Project info</strong><br/><a h ref="/downloads.cgi">Downloads</a><br/><a href="http://www.apache.org/licenses/";>License</a><br/><a href="/contributing.html">Contributing</a><br/><a href="/news.html">News</a><br/><a href="/links.html">Links</a><br/><a href="/project-information.html">Project Information</a><br/><a href="https://issues.apache.org/jira/browse/SLING";>Issue Tracker</a><br/><a href="http://ci.apache.org/builders/sling-trunk";>Build Server</a><br/><a href="/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a href="http://svn.apache.org/viewvc/sling/trunk";>Subversion</a><br/><a href="git://git.apache.org/sling.git">Git</a><br/><a href="https://github.com/apache/sling";>Github Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a><br/><a href="http://www.apache.org/foundation/sponsorship.html";>Become a Sponsor</a><br/><a href="https://donate.apache.org/";>Donate!</a><br/><a href="http://www.apache.org/foun dation/buy_stuff.html">Buy Stuff</a><br/><p></p><strong><a href="/sitemap.html">Site Map</a></strong> + <strong><a href="/ng/documentation.html">Documentation</a></strong><br/><a href="/ng/documentation/getting-started.html">Getting Started</a><br/><a href="/ng/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/ng/documentation/development.html">Development</a><br/><a href="/ng/documentation/bundles.html">Bundles</a><br/><a href="/ng/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/ng/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki";>Wiki</a><br/><a href="http://s.apache.org/sling.faq";>FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/ng/apidocs/sling9/index.html">Sling 9</a><br/><a href="/ng/apidocs/sling8/index.html">Sling 8</a><br/><a href="/ng/apidocs/sling7/index.html">Sling 7</a><br/><a href="/ng/apidocs/sling6/index.html">Sling 6</a><br/><a href="/ng/apidocs/sling5/index.html">Sling 5</a><br/><a href="/ng/javadoc-io.html">Archive at javadoc.io</a><br/><p></p ><strong>Project info</strong><br/><a >href="/ng/downloads.cgi">Downloads</a><br/><a >href="http://www.apache.org/licenses/";>License</a><br/><a >href="/ng/contributing.html">Contributing</a><br/><a >href="/ng/news.html">News</a><br/><a href="/ng/links.html">Links</a><br/><a >href="/ng/project-information.html">Project Information</a><br/><a >href="https://issues.apache.org/jira/browse/SLING";>Issue Tracker</a><br/><a >href="http://ci.apache.org/builders/sling-trunk";>Build Server</a><br/><a >href="/ng/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a > href="http://svn.apache.org/viewvc/sling/trunk";>Subversion</a><br/><a >href="git://git.apache.org/sling.git">Git</a><br/><a >href="https://github.com/apache/sling";>Github >Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a >href="http://www.apache.org/foundation/thanks.html";>Thanks</a><br/><a >href="http://www.apache.org/foundation/sponsorship.html";>Become a >Sponsor</a><br/><a href="https://donate.apache. org/">Donate!</a><br/><a href="http://www.apache.org/foundation/buy_stuff.html";>Buy Stuff</a><br/><p></p><strong><a href="/ng/sitemap.html">Site Map</a></strong> </div> <div class="main"> <div class="row"><div class="small-12 columns"><section class="wrap"><header><h1>Embedding Sling</h1></header><p>translation_pending: true</p> <p>The Sling Launchpad Launcher can be used to embed the OSGi Framework startup in your own Java application. This functionality is implemented in the <a href="http://svn.apache.org/repos/asf/sling/trunk/launchpad/base";>Sling Launchpad Base project</a>. This project has the following features:</p> <ul> - <li>Builds three artifacts:</li> - <li>A standalone Java Application with the artifact qualifier <em>app</em>; e.g. <code>org.apache.sling.launchpad.base-2.3.1-SNAPSHOT-app.jar</code></li> - <li>A Web Application with the artifact qualifier <em>webapp</em>; e.g <code>org.apache.sling.launchpad.base-2.3.1-SNAPSHOT-wepabb.war</code></li> - <li>The primary artifact without an artifact qualifier; e.g. <code>org.apache.sling.launchpad.base-2.3.1-SNAPSHOT.jar</code></li> + <li>Builds three artifacts: + <ul> + <li>A standalone Java Application with the artifact qualifier <em>app</em>; e.g. <code>org.apache.sling.launchpad.base-2.3.1-SNAPSHOT-app.jar</code></li> + <li>A Web Application with the artifact qualifier <em>webapp</em>; e.g <code>org.apache.sling.launchpad.base-2.3.1-SNAPSHOT-wepabb.war</code></li> + <li>The primary artifact without an artifact qualifier; e.g. <code>org.apache.sling.launchpad.base-2.3.1-SNAPSHOT.jar</code></li> + </ul> + </li> <li>Embeds the OSGi Framework (Apache Felix) in the primary artifact</li> <li>Encapsulates the OSGi Framework in its own <code>URLClassLoader</code></li> <li>Supports Framework restart</li>
