http://git-wip-us.apache.org/repos/asf/sling-site/blob/757222a6/assets/apidocs/sling5/org/apache/sling/api/resource/ResourceProvider.html ---------------------------------------------------------------------- diff --git a/assets/apidocs/sling5/org/apache/sling/api/resource/ResourceProvider.html b/assets/apidocs/sling5/org/apache/sling/api/resource/ResourceProvider.html new file mode 100644 index 0000000..61a8c12 --- /dev/null +++ b/assets/apidocs/sling5/org/apache/sling/api/resource/ResourceProvider.html @@ -0,0 +1,407 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.6.0_10) on Mon May 11 08:55:04 CEST 2009 --> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<TITLE> +ResourceProvider (Apache Sling Aggregate 5-incubator API) +</TITLE> + +<META NAME="date" CONTENT="2009-05-11"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ResourceProvider (Apache Sling Aggregate 5-incubator API)"; + } +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> +<HR> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ResourceProvider.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../org/apache/sling/api/resource/ResourceNotFoundException.html" title="class in org.apache.sling.api.resource"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html" title="interface in org.apache.sling.api.resource"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/sling/api/resource/ResourceProvider.html" target="_top"><B>FRAMES</B></A> + <A HREF="ResourceProvider.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +org.apache.sling.api.resource</FONT> +<BR> +Interface ResourceProvider</H2> +<DL> +<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/apache/sling/jackrabbit/usermanager/resource/AuthorizableResourceProvider.html" title="class in org.apache.sling.jackrabbit.usermanager.resource">AuthorizableResourceProvider</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public interface <B>ResourceProvider</B></DL> +</PRE> + +<P> +API for providers of resources. Used by the <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html" title="interface in org.apache.sling.api.resource"><CODE>ResourceResolver</CODE></A> to + transparently access resources from different locations such as a JCR + repository (the default) or OSGi bundles. + <p> + This interface is intended to be implemented by providers of Resource + instances on behalf of the <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html" title="interface in org.apache.sling.api.resource"><CODE>ResourceResolver</CODE></A>. It is not intended to + be used by client applications directly. +<P> + +<P> +<HR> + +<P> +<!-- =========== FIELD SUMMARY =========== --> + +<A NAME="field_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Field Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/resource/ResourceProvider.html#RESOURCE_TYPE_SYNTHETIC">RESOURCE_TYPE_SYNTHETIC</A></B></CODE> + +<BR> + The resource type be set on resources returned by the + <A HREF="../../../../../org/apache/sling/api/resource/ResourceProvider.html#listChildren(org.apache.sling.api.resource.Resource)"><CODE>listChildren(Resource)</CODE></A> method to enable traversing the resource + tree down to a deeply nested provided resource which has no concrete + parent hierarchy (value is"sling:syntheticResourceProviderResource").</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/resource/ResourceProvider.html#ROOTS">ROOTS</A></B></CODE> + +<BR> + The name of the service registration property containing the root paths + of the resources provided by this provider (value is "provider.roots").</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/resource/ResourceProvider.html#SERVICE_NAME">SERVICE_NAME</A></B></CODE> + +<BR> + The service name to use when registering implementations of this + interface as services (value is + "org.apache.sling.api.resource.ResourceProvider").</TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/resource/ResourceProvider.html#getResource(org.apache.sling.api.resource.ResourceResolver, javax.servlet.http.HttpServletRequest, java.lang.String)">getResource</A></B>(<A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html" title="interface in org.apache.sling.api.resource">ResourceResolver</A> resourceResolver, + javax.servlet.http.HttpServletRequest request, + java.lang.String path)</CODE> + +<BR> + Returns a resource from this resource provider or <code>null</code> if + the resource provider cannot find it.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/resource/ResourceProvider.html#getResource(org.apache.sling.api.resource.ResourceResolver, java.lang.String)">getResource</A></B>(<A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html" title="interface in org.apache.sling.api.resource">ResourceResolver</A> resourceResolver, + java.lang.String path)</CODE> + +<BR> + Returns a resource from this resource provider or <code>null</code> if + the resource provider cannot find it.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.Iterator<<A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A>></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/resource/ResourceProvider.html#listChildren(org.apache.sling.api.resource.Resource)">listChildren</A></B>(<A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A> parent)</CODE> + +<BR> + Returns an <code>Iterator</code> of <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A> objects loaded + from the children of the given <code>Resource</code>.</TD> +</TR> +</TABLE> + +<P> + +<!-- ============ FIELD DETAIL =========== --> + +<A NAME="field_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Field Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="SERVICE_NAME"><!-- --></A><H3> +SERVICE_NAME</H3> +<PRE> +static final java.lang.String <B>SERVICE_NAME</B></PRE> +<DL> +<DD>The service name to use when registering implementations of this + interface as services (value is + "org.apache.sling.api.resource.ResourceProvider"). +<P> +<DL> +</DL> +</DL> +<HR> + +<A NAME="ROOTS"><!-- --></A><H3> +ROOTS</H3> +<PRE> +static final java.lang.String <B>ROOTS</B></PRE> +<DL> +<DD>The name of the service registration property containing the root paths + of the resources provided by this provider (value is "provider.roots"). +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.resource.ResourceProvider.ROOTS">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="RESOURCE_TYPE_SYNTHETIC"><!-- --></A><H3> +RESOURCE_TYPE_SYNTHETIC</H3> +<PRE> +static final java.lang.String <B>RESOURCE_TYPE_SYNTHETIC</B></PRE> +<DL> +<DD>The resource type be set on resources returned by the + <A HREF="../../../../../org/apache/sling/api/resource/ResourceProvider.html#listChildren(org.apache.sling.api.resource.Resource)"><CODE>listChildren(Resource)</CODE></A> method to enable traversing the resource + tree down to a deeply nested provided resource which has no concrete + parent hierarchy (value is"sling:syntheticResourceProviderResource"). +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/sling/api/resource/ResourceProvider.html#listChildren(org.apache.sling.api.resource.Resource)"><CODE>listChildren(Resource)</CODE></A>, +<A HREF="../../../../../constant-values.html#org.apache.sling.api.resource.ResourceProvider.RESOURCE_TYPE_SYNTHETIC">Constant Field Values</A></DL> +</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="getResource(org.apache.sling.api.resource.ResourceResolver, javax.servlet.http.HttpServletRequest, java.lang.String)"><!-- --></A><H3> +getResource</H3> +<PRE> +<A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A> <B>getResource</B>(<A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html" title="interface in org.apache.sling.api.resource">ResourceResolver</A> resourceResolver, + javax.servlet.http.HttpServletRequest request, + java.lang.String path)</PRE> +<DL> +<DD>Returns a resource from this resource provider or <code>null</code> if + the resource provider cannot find it. The path should have one of the + <A HREF="../../../../../org/apache/sling/api/resource/ResourceProvider.html#ROOTS"><CODE>ROOTS</CODE></A> strings as its prefix. + <p> + This method is called to resolve a resource for the given request. The + properties of the request, such as request parameters, may be use to + parametrize the resource resolution. An example of such parametrization + is support for a JSR-311 style resource provider to support the + parametrized URL patterns. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>resourceResolver</CODE> - The <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html" title="interface in org.apache.sling.api.resource"><CODE>ResourceResolver</CODE></A> to which the + returned <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A> is attached. +<DT><B>Returns:</B><DD><code>null</code> If this provider does not have a resource for + the path. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../../../org/apache/sling/api/SlingException.html" title="class in org.apache.sling.api">SlingException</A></CODE> - may be thrown in case of any problem creating the + <code>Resource</code> instance.</DL> +</DD> +</DL> +<HR> + +<A NAME="getResource(org.apache.sling.api.resource.ResourceResolver, java.lang.String)"><!-- --></A><H3> +getResource</H3> +<PRE> +<A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A> <B>getResource</B>(<A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html" title="interface in org.apache.sling.api.resource">ResourceResolver</A> resourceResolver, + java.lang.String path)</PRE> +<DL> +<DD>Returns a resource from this resource provider or <code>null</code> if + the resource provider cannot find it. The path should have one of the + <A HREF="../../../../../org/apache/sling/api/resource/ResourceProvider.html#ROOTS"><CODE>ROOTS</CODE></A> strings as its prefix. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>resourceResolver</CODE> - The <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html" title="interface in org.apache.sling.api.resource"><CODE>ResourceResolver</CODE></A> to which the + returned <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A> is attached. +<DT><B>Returns:</B><DD><code>null</code> If this provider does not have a resource for + the path. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../../../org/apache/sling/api/SlingException.html" title="class in org.apache.sling.api">SlingException</A></CODE> - may be thrown in case of any problem creating the + <code>Resource</code> instance.</DL> +</DD> +</DL> +<HR> + +<A NAME="listChildren(org.apache.sling.api.resource.Resource)"><!-- --></A><H3> +listChildren</H3> +<PRE> +java.util.Iterator<<A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A>> <B>listChildren</B>(<A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A> parent)</PRE> +<DL> +<DD>Returns an <code>Iterator</code> of <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A> objects loaded + from the children of the given <code>Resource</code>. The returned + <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A> instances are attached to the same + <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html" title="interface in org.apache.sling.api.resource"><CODE>ResourceResolver</CODE></A> as the given <code>parent</code> resource. + <p> + This method may be called for resource providers whose root path list + contains a path such that the resource path is a prefix of the list + entry. This allows for the enumeration of deeply nested provided + resources for which no actual parent hierarchy exists. + <p> + The returned iterator may in turn contain resources which do not actually + exist but are required to traverse the resource tree. Such resources + SHOULD be <A HREF="../../../../../org/apache/sling/api/resource/SyntheticResource.html" title="class in org.apache.sling.api.resource"><CODE>SyntheticResource</CODE></A> objects whose resource type MUST be + set to <A HREF="../../../../../org/apache/sling/api/resource/ResourceProvider.html#RESOURCE_TYPE_SYNTHETIC"><CODE>RESOURCE_TYPE_SYNTHETIC</CODE></A>. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>parent</CODE> - The <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A> whose children are requested. +<DT><B>Returns:</B><DD>An <code>Iterator</code> of <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A> objects or + <code>null</code> if the resource provider has no children for + the given resource. +<DT><B>Throws:</B> +<DD><CODE>java.lang.NullPointerException</CODE> - If <code>parent</code> is + <code>null</code>. +<DD><CODE><A HREF="../../../../../org/apache/sling/api/SlingException.html" title="class in org.apache.sling.api">SlingException</A></CODE> - If any error occurs acquiring the child resource + iterator.</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ResourceProvider.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../org/apache/sling/api/resource/ResourceNotFoundException.html" title="class in org.apache.sling.api.resource"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html" title="interface in org.apache.sling.api.resource"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/sling/api/resource/ResourceProvider.html" target="_top"><B>FRAMES</B></A> + <A HREF="ResourceProvider.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> +Copyright © 2007-2009. All Rights Reserved. +</BODY> +</HTML>
http://git-wip-us.apache.org/repos/asf/sling-site/blob/757222a6/assets/apidocs/sling5/org/apache/sling/api/resource/ResourceResolver.html ---------------------------------------------------------------------- diff --git a/assets/apidocs/sling5/org/apache/sling/api/resource/ResourceResolver.html b/assets/apidocs/sling5/org/apache/sling/api/resource/ResourceResolver.html new file mode 100644 index 0000000..f59c2fc --- /dev/null +++ b/assets/apidocs/sling5/org/apache/sling/api/resource/ResourceResolver.html @@ -0,0 +1,726 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.6.0_10) on Mon May 11 08:55:04 CEST 2009 --> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<TITLE> +ResourceResolver (Apache Sling Aggregate 5-incubator API) +</TITLE> + +<META NAME="date" CONTENT="2009-05-11"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ResourceResolver (Apache Sling Aggregate 5-incubator API)"; + } +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> +<HR> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ResourceResolver.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../org/apache/sling/api/resource/ResourceProvider.html" title="interface in org.apache.sling.api.resource"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/sling/api/resource/ResourceUtil.html" title="class in org.apache.sling.api.resource"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/sling/api/resource/ResourceResolver.html" target="_top"><B>FRAMES</B></A> + <A HREF="ResourceResolver.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +org.apache.sling.api.resource</FONT> +<BR> +Interface ResourceResolver</H2> +<DL> +<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../../org/apache/sling/api/adapter/Adaptable.html" title="interface in org.apache.sling.api.adapter">Adaptable</A></DD> +</DL> +<DL> +<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/apache/sling/commons/testing/sling/MockResourceResolver.html" title="class in org.apache.sling.commons.testing.sling">MockResourceResolver</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public interface <B>ResourceResolver</B><DT>extends <A HREF="../../../../../org/apache/sling/api/adapter/Adaptable.html" title="interface in org.apache.sling.api.adapter">Adaptable</A></DL> +</PRE> + +<P> +The <code>ResourceResolver</code> defines the service API which may be used + to resolve <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A> objects. The resource resolver is available to + the request processing servlet through the + <A HREF="../../../../../org/apache/sling/api/SlingHttpServletRequest.html#getResourceResolver()"><CODE>SlingHttpServletRequest.getResourceResolver()</CODE></A> + method. + <p> + The <code>ResourceResolver</code> is also an <A HREF="../../../../../org/apache/sling/api/adapter/Adaptable.html" title="interface in org.apache.sling.api.adapter"><CODE>Adaptable</CODE></A> to get + adapters to other types. A JCR based resource resolver might support adapting + to the JCR Session used by the resolver to access the JCR Repository. + <p> + This interface defines two kinds of methods to access resources: The + <code>resolve</code> methods and the <code>getResource</code> methods. The + difference lies in the algorithm applied to find the requested resource and + in the behaviour in case a resource cannot be found: + <table> + <tr> + <th>Method Kind</th> + <th>Access Algorithm</th> + <th>Missing Resource</th> + </tr> + <tr> + <td>resolve</td> + <td>Path is always assumed to be absolute. Uses elaborate resource resolution + algorithm. This kind of method is intended to resolve request URLs to + resources.</td> + <td>Returns <A HREF="../../../../../org/apache/sling/api/resource/NonExistingResource.html" title="class in org.apache.sling.api.resource"><CODE>NonExistingResource</CODE></A></td> + </tr> + <tr> + <td>getResource</td> + <td>Directly access resources with absolute path. For relative paths, the + <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#getSearchPath()"><CODE>search path</CODE></A> is applied. This method is intended to + be used by request processing scripts to access further resources as + required.</td> + <td>Returns <code>null</code></td> + </tr> + </table> +<P> + +<P> +<HR> + +<P> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.Iterator<<A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A>></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#findResources(java.lang.String, java.lang.String)">findResources</A></B>(java.lang.String query, + java.lang.String language)</CODE> + +<BR> + Searches for resources using the given query formulated in the given + language.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#getResource(org.apache.sling.api.resource.Resource, java.lang.String)">getResource</A></B>(<A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A> base, + java.lang.String path)</CODE> + +<BR> + Returns a <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A> object for data located at the given path.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#getResource(java.lang.String)">getResource</A></B>(java.lang.String path)</CODE> + +<BR> + Returns a <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A> object for data located at the given path.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String[]</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#getSearchPath()">getSearchPath</A></B>()</CODE> + +<BR> + Returns the search path used by the <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#getResource(java.lang.String)"><CODE>getResource(String)</CODE></A> method + to search for resources by relative path.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.Iterator<<A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A>></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#listChildren(org.apache.sling.api.resource.Resource)">listChildren</A></B>(<A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A> parent)</CODE> + +<BR> + Returns an <code>Iterator</code> of <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A> objects loaded from + the children of the given <code>Resource</code>.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#map(javax.servlet.http.HttpServletRequest, java.lang.String)">map</A></B>(javax.servlet.http.HttpServletRequest request, + java.lang.String resourcePath)</CODE> + +<BR> + Returns an URL mapped from the (resource) path applying the reverse + mapping used by the <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#resolve(javax.servlet.http.HttpServletRequest, java.lang.String)"><CODE>resolve(HttpServletRequest, String)</CODE></A> such + that when the path is given to the + <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#resolve(javax.servlet.http.HttpServletRequest, java.lang.String)"><CODE>resolve(HttpServletRequest, String)</CODE></A> method the same resource is + returned.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#map(java.lang.String)">map</A></B>(java.lang.String resourcePath)</CODE> + +<BR> + Returns a path mapped from the (resource) path applying the reverse + mapping used by the <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#resolve(java.lang.String)"><CODE>resolve(String)</CODE></A> such that when the path is + given to the <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#resolve(java.lang.String)"><CODE>resolve(String)</CODE></A> method the same resource is + returned.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#queryResources(java.lang.String, java.lang.String)">queryResources</A></B>(java.lang.String query, + java.lang.String language)</CODE> + +<BR> + Queries the storage using the given query formulated in the given + language.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#resolve(javax.servlet.http.HttpServletRequest)">resolve</A></B>(javax.servlet.http.HttpServletRequest request)</CODE> + +<BR> + <B>Deprecated.</B> <I>as of 2.0.4, use <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#resolve(javax.servlet.http.HttpServletRequest, java.lang.String)"><CODE>resolve(HttpServletRequest, String)</CODE></A> + instead.</I></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#resolve(javax.servlet.http.HttpServletRequest, java.lang.String)">resolve</A></B>(javax.servlet.http.HttpServletRequest request, + java.lang.String absPath)</CODE> + +<BR> + Resolves the resource from the given <code>absPath</code> optionally + taking <code>HttpServletRequest</code> into account, such as the value of + the <code>Host</code> request header.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#resolve(java.lang.String)">resolve</A></B>(java.lang.String absPath)</CODE> + +<BR> + Resolves the resource from the given absolute path.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_org.apache.sling.api.adapter.Adaptable"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from interface org.apache.sling.api.adapter.<A HREF="../../../../../org/apache/sling/api/adapter/Adaptable.html" title="interface in org.apache.sling.api.adapter">Adaptable</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="../../../../../org/apache/sling/api/adapter/Adaptable.html#adaptTo(java.lang.Class)">adaptTo</A></CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="resolve(javax.servlet.http.HttpServletRequest, java.lang.String)"><!-- --></A><H3> +resolve</H3> +<PRE> +<A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A> <B>resolve</B>(javax.servlet.http.HttpServletRequest request, + java.lang.String absPath)</PRE> +<DL> +<DD>Resolves the resource from the given <code>absPath</code> optionally + taking <code>HttpServletRequest</code> into account, such as the value of + the <code>Host</code> request header. Returns a + <A HREF="../../../../../org/apache/sling/api/resource/NonExistingResource.html" title="class in org.apache.sling.api.resource"><CODE>NonExistingResource</CODE></A> if the path cannot be resolved to an existing + and accessible resource. + <p> + The difference between this method and the <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#resolve(java.lang.String)"><CODE>resolve(String)</CODE></A> + method is, that this method may take request properties like the scheme, + the host header or request parameters into account to resolve the + resource. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>request</CODE> - The http servlet request object providing more hints at + how to resolve the <code>absPath</code>. This parameter may be + <code>null</code> in which case the implementation should use + reasonable defaults.<DD><CODE>absPath</CODE> - The absolute path to be resolved to a resource. If this + parameter is <code>null</code>, it is assumed to address the + root of the resource tree. If the path is relative it is + assumed relative to the root, that is a slash is prepended to + the path before resolving it. +<DT><B>Returns:</B><DD>The <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A> addressed by the <code>absPath</code> or a + <A HREF="../../../../../org/apache/sling/api/resource/NonExistingResource.html" title="class in org.apache.sling.api.resource"><CODE>NonExistingResource</CODE></A> if no such resource can be resolved. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../../../org/apache/sling/api/SlingException.html" title="class in org.apache.sling.api">SlingException</A></CODE> - Or a subclass thereof may be + thrown if an error occurrs trying to resolve the resource.<DT><B>Since:</B></DT> + <DD>2.0.4</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="resolve(java.lang.String)"><!-- --></A><H3> +resolve</H3> +<PRE> +<A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A> <B>resolve</B>(java.lang.String absPath)</PRE> +<DL> +<DD>Resolves the resource from the given absolute path. Returns a + <A HREF="../../../../../org/apache/sling/api/resource/NonExistingResource.html" title="class in org.apache.sling.api.resource"><CODE>NonExistingResource</CODE></A> if the path cannot be resolved to an existing + and accessible resource. + <p> + This method is intended to apply the same algorithm to the absolute path + as is used by the <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#resolve(javax.servlet.http.HttpServletRequest)"><CODE>resolve(HttpServletRequest)</CODE></A> method except for + cases where the latter uses request property such as request headers or + request parameters to resolve a resource. + <p> + It is ok for the implementation of this method to just call the + <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#resolve(javax.servlet.http.HttpServletRequest, java.lang.String)"><CODE>resolve(HttpServletRequest, String)</CODE></A> method with + <code>null</code> as the request argument. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>absPath</CODE> - The absolute path to be resolved to a resource. If this + parameter is <code>null</code>, it is assumed to address the + root of the resource tree. If the path is relative it is + assumed relative to the root, that is a slash is prepended to + the path before resolving it. +<DT><B>Returns:</B><DD>The <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A> addressed by the <code>absPath</code> or a + <A HREF="../../../../../org/apache/sling/api/resource/NonExistingResource.html" title="class in org.apache.sling.api.resource"><CODE>NonExistingResource</CODE></A> if no such resource can be resolved. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../../../org/apache/sling/api/SlingException.html" title="class in org.apache.sling.api">SlingException</A></CODE> - Or a subclass thereof may be + thrown if an error occurrs trying to resolve the resource.</DL> +</DD> +</DL> +<HR> + +<A NAME="resolve(javax.servlet.http.HttpServletRequest)"><!-- --></A><H3> +resolve</H3> +<PRE> +<FONT SIZE="-1">@Deprecated +</FONT><A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A> <B>resolve</B>(javax.servlet.http.HttpServletRequest request)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>as of 2.0.4, use <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#resolve(javax.servlet.http.HttpServletRequest, java.lang.String)"><CODE>resolve(HttpServletRequest, String)</CODE></A> + instead.</I> +<P> +<DD>Resolves the resource from the given <code>HttpServletRequest</code>. + Returns a <A HREF="../../../../../org/apache/sling/api/resource/NonExistingResource.html" title="class in org.apache.sling.api.resource"><CODE>NonExistingResource</CODE></A> if the path cannot be resolved to + an existing and accessible resource. + <p> + This method is deprecated as of API version 2.0.4 and should not be used + anymore. Implementations are expected to implement this method calling + the <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#resolve(javax.servlet.http.HttpServletRequest, java.lang.String)"><CODE>resolve(HttpServletRequest, String)</CODE></A> where the + <code>absPath</code> argument is the result of calling the + <code>getPathInfo()</code> on the <code>request</code> object. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>request</CODE> - The http servlet request object used to resolve the + resource for. This must not be <code>null</code>. +<DT><B>Returns:</B><DD>The <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A> addressed by + <code>HttpServletRequest.getPathInfo()</code> or a + <A HREF="../../../../../org/apache/sling/api/resource/NonExistingResource.html" title="class in org.apache.sling.api.resource"><CODE>NonExistingResource</CODE></A> if no such resource can be resolved. +<DT><B>Throws:</B> +<DD><CODE>java.lang.NullPointerException</CODE> - If <code>request</code> is <code>null</code> + . +<DD><CODE><A HREF="../../../../../org/apache/sling/api/SlingException.html" title="class in org.apache.sling.api">SlingException</A></CODE> - Or a subclass thereof may be + thrown if an error occurrs trying to resolve the resource.</DL> +</DD> +</DL> +<HR> + +<A NAME="map(java.lang.String)"><!-- --></A><H3> +map</H3> +<PRE> +java.lang.String <B>map</B>(java.lang.String resourcePath)</PRE> +<DL> +<DD>Returns a path mapped from the (resource) path applying the reverse + mapping used by the <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#resolve(java.lang.String)"><CODE>resolve(String)</CODE></A> such that when the path is + given to the <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#resolve(java.lang.String)"><CODE>resolve(String)</CODE></A> method the same resource is + returned. + <p> + Note, that technically the <code>resourcePath</code> need not refer to an + existing resource. This method just applies the mappings and returns the + resulting string. If the <code>resourcePath</code> does not address an + existing resource roundtripping may of course not work and calling + <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#resolve(java.lang.String)"><CODE>resolve(String)</CODE></A> with the path returned may return + <code>null</code>. + <p> + This method is intended as the reverse operation of the + <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#resolve(java.lang.String)"><CODE>resolve(String)</CODE></A> method. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>resourcePath</CODE> - The path for which to return a mapped path. +<DT><B>Returns:</B><DD>The mapped path.</DL> +</DD> +</DL> +<HR> + +<A NAME="map(javax.servlet.http.HttpServletRequest, java.lang.String)"><!-- --></A><H3> +map</H3> +<PRE> +java.lang.String <B>map</B>(javax.servlet.http.HttpServletRequest request, + java.lang.String resourcePath)</PRE> +<DL> +<DD>Returns an URL mapped from the (resource) path applying the reverse + mapping used by the <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#resolve(javax.servlet.http.HttpServletRequest, java.lang.String)"><CODE>resolve(HttpServletRequest, String)</CODE></A> such + that when the path is given to the + <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#resolve(javax.servlet.http.HttpServletRequest, java.lang.String)"><CODE>resolve(HttpServletRequest, String)</CODE></A> method the same resource is + returned. + <p> + Note, that technically the <code>resourcePath</code> need not refer to an + existing resource. This method just applies the mappings and returns the + resulting string. If the <code>resourcePath</code> does not address an + existing resource roundtripping may of course not work and calling + <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#resolve(javax.servlet.http.HttpServletRequest, java.lang.String)"><CODE>resolve(HttpServletRequest, String)</CODE></A> with the path returned may + return <code>null</code>. + <p> + This method is intended as the reverse operation of the + <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#resolve(javax.servlet.http.HttpServletRequest, java.lang.String)"><CODE>resolve(HttpServletRequest, String)</CODE></A> method. As such the URL + returned is expected to be an absolute URL including scheme, host, any + servlet context path and the actual path used to resolve the resource. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>request</CODE> - The http servlet request object which may be used to apply + more mapping functionality.<DD><CODE>resourcePath</CODE> - The path for which to return a mapped path. +<DT><B>Returns:</B><DD>The mapped URL.<DT><B>Since:</B></DT> + <DD>2.0.4</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getResource(java.lang.String)"><!-- --></A><H3> +getResource</H3> +<PRE> +<A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A> <B>getResource</B>(java.lang.String path)</PRE> +<DL> +<DD>Returns a <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A> object for data located at the given path. + <p> + This specification does not define the location for resources or the + semantics for resource paths. For an implementation reading content from + a Java Content Repository, the path could be a + <code>javax.jcr.Item</code> path from which the resource object is + loaded. In contrast to the <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#resolve(java.lang.String)"><CODE>resolve(String)</CODE></A> method, this method + does not apply any logic to the path, so the path is used as-is to fetch + the content. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>path</CODE> - The absolute path to the resource object to be loaded. The + path may contain relative path specifiers like <code>.</code> + (current location) and <code>..</code> (parent location), + which are resolved by this method. If the path is relative, + that is the first character is not a slash, implementations + are expected to apply a search path algorithm to resolve the + relative path to a resource. +<DT><B>Returns:</B><DD>The <code>Resource</code> object loaded from the path or + <code>null</code> if the path does not resolve to a resource. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../../../org/apache/sling/api/SlingException.html" title="class in org.apache.sling.api">SlingException</A></CODE> - If an error occurrs trying to + load the resource object from the path.</DL> +</DD> +</DL> +<HR> + +<A NAME="getResource(org.apache.sling.api.resource.Resource, java.lang.String)"><!-- --></A><H3> +getResource</H3> +<PRE> +<A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A> <B>getResource</B>(<A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A> base, + java.lang.String path)</PRE> +<DL> +<DD>Returns a <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A> object for data located at the given path. + <p> + This specification does not define the location for resources or the + semantics for resource paths. For an implementation reading content from + a Java Content Repository, the path could be a + <code>javax.jcr.Item</code> path from which the resource object is + loaded. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>base</CODE> - The base <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A> against which a relative path + argument given by <code>path</code> is resolved. This + parameter may be <code>null</code> if the <code>path</code> is + known to be absolute.<DD><CODE>path</CODE> - The path to the resource object to be loaded. If the path is + relative, i.e. does not start with a slash (<code>/</code>), + the resource relative to the given <code>base</code> resource + is returned. The path may contain relative path specifiers + like <code>.</code> (current location) and <code>..</code> + (parent location), which are resolved by this method. +<DT><B>Returns:</B><DD>The <code>Resource</code> object loaded from the path or + <code>null</code> if the path does not resolve to a resource. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../../../org/apache/sling/api/SlingException.html" title="class in org.apache.sling.api">SlingException</A></CODE> - If an error occurrs trying to + load the resource object from the path or if + <code>base</code> is <code>null</code> and <code>path</code> + is relative.</DL> +</DD> +</DL> +<HR> + +<A NAME="getSearchPath()"><!-- --></A><H3> +getSearchPath</H3> +<PRE> +java.lang.String[] <B>getSearchPath</B>()</PRE> +<DL> +<DD>Returns the search path used by the <A HREF="../../../../../org/apache/sling/api/resource/ResourceResolver.html#getResource(java.lang.String)"><CODE>getResource(String)</CODE></A> method + to search for resources by relative path. If no search path is set an + empty array is returned. + <p> + The returns array of Strings is a copy of the internal value, so + modifications to this array have no influence on the operation of the + ResourceResolver. + <p> + Each entry in the array is an absolute path terminated with a slash + character. Thus to create an absolute path from a search path entry and a + relative path, the search path entry and relative path may just be + concatenated. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="listChildren(org.apache.sling.api.resource.Resource)"><!-- --></A><H3> +listChildren</H3> +<PRE> +java.util.Iterator<<A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A>> <B>listChildren</B>(<A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A> parent)</PRE> +<DL> +<DD>Returns an <code>Iterator</code> of <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A> objects loaded from + the children of the given <code>Resource</code>. + <p> + This specification does not define what the term "child" means. This is + left to the implementation to define. For example an implementation + reading content from a Java Content Repository, the children could be the + <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A> objects loaded from child items of the <code>Item</code> + of the given <code>Resource</code>. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>parent</CODE> - The <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A> whose children are requested. +<DT><B>Returns:</B><DD>An <code>Iterator</code> of <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A> objects. +<DT><B>Throws:</B> +<DD><CODE>java.lang.NullPointerException</CODE> - If <code>parent</code> is <code>null</code>. +<DD><CODE><A HREF="../../../../../org/apache/sling/api/SlingException.html" title="class in org.apache.sling.api">SlingException</A></CODE> - If any error occurs acquiring + the child resource iterator.</DL> +</DD> +</DL> +<HR> + +<A NAME="findResources(java.lang.String, java.lang.String)"><!-- --></A><H3> +findResources</H3> +<PRE> +java.util.Iterator<<A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A>> <B>findResources</B>(java.lang.String query, + java.lang.String language)</PRE> +<DL> +<DD>Searches for resources using the given query formulated in the given + language. + <p> + The semantic meaning of the query and language depend on the actual + implementation and storage used for the resources. For JCR repository + being used as storage, the query and lanuage parameters are used to + create a JCR <code>Query</code> through the <code>QueryManager</code>. + The result returned is then based on the <code>NodeIterator</code> + provided by the query result. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>query</CODE> - The query string to use to find the resources.<DD><CODE>language</CODE> - The language in which the query is formulated. +<DT><B>Returns:</B><DD>An <code>Iterator</code> of <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A> objects matching the + query. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../../../org/apache/sling/api/resource/QuerySyntaxException.html" title="class in org.apache.sling.api.resource">QuerySyntaxException</A></CODE> - If the query is not syntactically correct + according to the query language indicator of if the query + language is not supported. +<DD><CODE><A HREF="../../../../../org/apache/sling/api/SlingException.html" title="class in org.apache.sling.api">SlingException</A></CODE> - If an error occurrs querying + for the resources.</DL> +</DD> +</DL> +<HR> + +<A NAME="queryResources(java.lang.String, java.lang.String)"><!-- --></A><H3> +queryResources</H3> +<PRE> +java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>> <B>queryResources</B>(java.lang.String query, + java.lang.String language)</PRE> +<DL> +<DD>Queries the storage using the given query formulated in the given + language. + <p> + The semantic meaning of the query and language depend on the actual + implementation and storage used for the resources. For JCR repository + being used as storage, the query and lanuage parameters are used to + create a JCR <code>Query</code> through the <code>QueryManager</code>. + The result returned is then based on the <code>RowIterator</code> + provided by the query result. The map returned for each row is indexed by + the column name and the column value is the JCR <code>Value</code> object + converted into the respective Java object, such as <code>Boolean</code> + for a value of property type <em>Boolean</em>. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>query</CODE> - The query string to use to find the resources.<DD><CODE>language</CODE> - The language in which the query is formulated. +<DT><B>Returns:</B><DD>An <code>Iterator</code> of <code>Map</code> instances providing + access to the query result. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../../../org/apache/sling/api/resource/QuerySyntaxException.html" title="class in org.apache.sling.api.resource">QuerySyntaxException</A></CODE> - If the query is not syntactically correct + according to the query language indicator of if the query + language is not supported. +<DD><CODE><A HREF="../../../../../org/apache/sling/api/SlingException.html" title="class in org.apache.sling.api">SlingException</A></CODE> - If an error occurrs querying + for the resources.</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ResourceResolver.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../org/apache/sling/api/resource/ResourceProvider.html" title="interface in org.apache.sling.api.resource"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/sling/api/resource/ResourceUtil.html" title="class in org.apache.sling.api.resource"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/sling/api/resource/ResourceResolver.html" target="_top"><B>FRAMES</B></A> + <A HREF="ResourceResolver.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> +Copyright © 2007-2009. All Rights Reserved. +</BODY> +</HTML>