blob: 7b211bc64028be86ccacbefa11e165547ba65dbd [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_60) on Mon Oct 12 15:59:31 EEST 2015 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Overview (Apache Sling 8 API)</title>
<meta name="date" content="2015-10-12">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Overview (Apache Sling 8 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li class="navBarCell1Rev">Overview</li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-summary.html" target="_top">Frames</a></li>
<li><a href="overview-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 class="title">Apache Sling 8 API</h1>
</div>
<div class="header">
<div class="subTitle">
<div class="block"><b>Apache Sling &#0153;</b>
is an innovative web framework that is intended to bring back the fun to web development.</div>
</div>
<p>See: <a href="#overview.description">Description</a></p>
</div>
<div class="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Packages table, listing packages, and an explanation">
<caption><span>Packages</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/adapter/package-summary.html">org.apache.sling.adapter</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/api/package-summary.html">org.apache.sling.api</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/api/adapter/package-summary.html">org.apache.sling.api.adapter</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/api/auth/package-summary.html">org.apache.sling.api.auth</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/api/request/package-summary.html">org.apache.sling.api.request</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/api/resource/package-summary.html">org.apache.sling.api.resource</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/api/scripting/package-summary.html">org.apache.sling.api.scripting</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/api/security/package-summary.html">org.apache.sling.api.security</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/api/servlets/package-summary.html">org.apache.sling.api.servlets</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/api/wrappers/package-summary.html">org.apache.sling.api.wrappers</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/auth/core/package-summary.html">org.apache.sling.auth.core</a></td>
<td class="colLast">
<div class="block">Provides the authentication helper service as well as a number
of utility functions in the <a href="org/apache/sling/auth/core/AuthUtil.html" title="class in org.apache.sling.auth.core"><code>AuthUtil</code></a>
class.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/auth/core/spi/package-summary.html">org.apache.sling.auth.core.spi</a></td>
<td class="colLast">
<div class="block">Provides API to be implemented by provides of authentication
mechanisms.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/commons/classloader/package-summary.html">org.apache.sling.commons.classloader</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/commons/compiler/package-summary.html">org.apache.sling.commons.compiler</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/commons/json/package-summary.html">org.apache.sling.commons.json</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/commons/json/http/package-summary.html">org.apache.sling.commons.json.http</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/commons/json/io/package-summary.html">org.apache.sling.commons.json.io</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/commons/json/jcr/package-summary.html">org.apache.sling.commons.json.jcr</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/commons/json/sling/package-summary.html">org.apache.sling.commons.json.sling</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/commons/json/util/package-summary.html">org.apache.sling.commons.json.util</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/commons/json/xml/package-summary.html">org.apache.sling.commons.json.xml</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/commons/log/logback/package-summary.html">org.apache.sling.commons.log.logback</a></td>
<td class="colLast">
<div class="block">Provides configuration support for the Logback based logging in Sling</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/commons/mime/package-summary.html">org.apache.sling.commons.mime</a></td>
<td class="colLast">
<div class="block">Provides the <a href="org/apache/sling/commons/mime/MimeTypeService.html" title="interface in org.apache.sling.commons.mime"><code>MimeTypeService</code></a>
service used by client to resolve MIME type information as well as the
<a href="org/apache/sling/commons/mime/MimeTypeProvider.html" title="interface in org.apache.sling.commons.mime"><code>MimeTypeProvider</code></a> service
interface for providers to extend the MIME type setup provided by the
<a href="org/apache/sling/commons/mime/MimeTypeService.html" title="interface in org.apache.sling.commons.mime"><code>MimeTypeService</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/commons/osgi/package-summary.html">org.apache.sling.commons.osgi</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/commons/osgi/bundleversion/package-summary.html">org.apache.sling.commons.osgi.bundleversion</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/commons/scheduler/package-summary.html">org.apache.sling.commons.scheduler</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/commons/threads/package-summary.html">org.apache.sling.commons.threads</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/commons/threads/jmx/package-summary.html">org.apache.sling.commons.threads.jmx</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/discovery/package-summary.html">org.apache.sling.discovery</a></td>
<td class="colLast">
<div class="block">Provides a service to interface which may be implemented by applications
to get notified on cluster topology changes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/engine/package-summary.html">org.apache.sling.engine</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/engine/auth/package-summary.html">org.apache.sling.engine.auth</a></td>
<td class="colLast">
<div class="block">Provides the original authentication handler service API initially
bundled with the Sling Engine bundle.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/engine/jmx/package-summary.html">org.apache.sling.engine.jmx</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/engine/servlets/package-summary.html">org.apache.sling.engine.servlets</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/event/package-summary.html">org.apache.sling.event</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/event/dea/package-summary.html">org.apache.sling.event.dea</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/event/jobs/package-summary.html">org.apache.sling.event.jobs</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/event/jobs/consumer/package-summary.html">org.apache.sling.event.jobs.consumer</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/event/jobs/jmx/package-summary.html">org.apache.sling.event.jobs.jmx</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/i18n/package-summary.html">org.apache.sling.i18n</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/installer/api/package-summary.html">org.apache.sling.installer.api</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/installer/api/event/package-summary.html">org.apache.sling.installer.api.event</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/installer/api/info/package-summary.html">org.apache.sling.installer.api.info</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/installer/api/jmx/package-summary.html">org.apache.sling.installer.api.jmx</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/installer/api/tasks/package-summary.html">org.apache.sling.installer.api.tasks</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/installer/factories/configuration/package-summary.html">org.apache.sling.installer.factories.configuration</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/jackrabbit/usermanager/package-summary.html">org.apache.sling.jackrabbit.usermanager</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/jcr/api/package-summary.html">org.apache.sling.jcr.api</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/jcr/base/package-summary.html">org.apache.sling.jcr.base</a></td>
<td class="colLast">
<div class="block">The <code>org.apache.sling.jcr.base</code> package provides basic support
to expose JCR repositories in Sling.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/jcr/base/util/package-summary.html">org.apache.sling.jcr.base.util</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/jcr/contentloader/package-summary.html">org.apache.sling.jcr.contentloader</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/jcr/jackrabbit/accessmanager/package-summary.html">org.apache.sling.jcr.jackrabbit.accessmanager</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/jcr/jackrabbit/accessmanager/post/package-summary.html">org.apache.sling.jcr.jackrabbit.accessmanager.post</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/jcr/registration/package-summary.html">org.apache.sling.jcr.registration</a></td>
<td class="colLast">
<div class="block">The <code>org.apache.sling.jcr.registration</code> package exports
the <a href="org/apache/sling/jcr/registration/AbstractRegistrationSupport.html" title="class in org.apache.sling.jcr.registration"><code>AbstractRegistrationSupport</code></a>
class which may be extended by service exposing JCR Repository services
in any one non-OSGi registry such as RMI or JNDI.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/jcr/resource/package-summary.html">org.apache.sling.jcr.resource</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/launchpad/app/package-summary.html">org.apache.sling.launchpad.app</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/launchpad/base/app/package-summary.html">org.apache.sling.launchpad.base.app</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/launchpad/base/shared/package-summary.html">org.apache.sling.launchpad.base.shared</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/launchpad/base/webapp/package-summary.html">org.apache.sling.launchpad.base.webapp</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/launchpad/webapp/package-summary.html">org.apache.sling.launchpad.webapp</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/models/annotations/package-summary.html">org.apache.sling.models.annotations</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/models/annotations/injectorspecific/package-summary.html">org.apache.sling.models.annotations.injectorspecific</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/models/factory/package-summary.html">org.apache.sling.models.factory</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/models/spi/package-summary.html">org.apache.sling.models.spi</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/models/spi/injectorspecific/package-summary.html">org.apache.sling.models.spi.injectorspecific</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/oak/server/package-summary.html">org.apache.sling.oak.server</a></td>
<td class="colLast">
<div class="block">Contains in implementation of a SlingRepository based on Apache Oak.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/scripting/api/package-summary.html">org.apache.sling.scripting.api</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/scripting/core/package-summary.html">org.apache.sling.scripting.core</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/scripting/core/servlet/package-summary.html">org.apache.sling.scripting.core.servlet</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/serviceusermapping/package-summary.html">org.apache.sling.serviceusermapping</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/servlets/post/package-summary.html">org.apache.sling.servlets.post</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/sling/servlets/resolver/jmx/package-summary.html">org.apache.sling.servlets.resolver.jmx</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/sling/settings/package-summary.html">org.apache.sling.settings</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
<div class="contentContainer"><a name="overview.description">
<!-- -->
</a>
<div class="block"><p><b>Apache Sling &#0153;</b>
is an innovative web framework that is intended to bring back the fun to web development.</p>
<h1>Apache Sling in five bullets points</h1>
<uL>
<li>REST based web framework</li>
<li>Content-driven, using a JCR content repository</li>
<li>Powered by OSGi</li>
<li>Scripting inside, multiple languages (JSP, server-side javascript, Scala, etc.)</li>
<li>Apache Open Source project</li>
</ul>
<h1>Apache Sling in a hundred words</h1>
<p>Apache Sling is a web framework that uses a <a
href="http://en.wikipedia.org/wiki/JSR-170">Java Content Repository</a>,
such as <a href="http://jackrabbit.apache.org/" class="external-link"
rel="nofollow">Apache Jackrabbit</a>, to store and manage content.</p>
<p>Sling applications use either scripts or Java servlets, selected based
on simple name conventions, to process HTTP requests in a RESTful way.</p>
<p>The embedded <a href="http://felix.apache.org/">Apache Felix</a> OSGi
framework and console provide a dynamic runtime environment, where code and
content bundles can be loaded, unloaded and reconfigured at runtime.</p>
<p>As the first web framework dedicated to <a
href="http://jcp.org/en/jsr/detail?id=170">JSR-170</a> Java Content
Repositories, Sling makes it very simple to implement simple applications,
while providing an enterprise-level framework for more complex
applications. </p>
<h1>JavaDoc generation</h1>
<p>
This documentation has been created using the <a href="https://svn.apache.org/repos/asf/sling/trunk/tooling/release/generate_javadoc_for_release.sh">generate_javadoc_for_release.sh</a>
script.
</p></div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li class="navBarCell1Rev">Overview</li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-summary.html" target="_top">Frames</a></li>
<li><a href="overview-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2015 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>