http://git-wip-us.apache.org/repos/asf/sling-site/blob/757222a6/assets/apidocs/sling5/org/apache/sling/api/package-use.html ---------------------------------------------------------------------- diff --git a/assets/apidocs/sling5/org/apache/sling/api/package-use.html b/assets/apidocs/sling5/org/apache/sling/api/package-use.html new file mode 100644 index 0000000..f57ad81 --- /dev/null +++ b/assets/apidocs/sling5/org/apache/sling/api/package-use.html @@ -0,0 +1,495 @@ +<!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:11 CEST 2009 --> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<TITLE> +Uses of Package org.apache.sling.api (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="Uses of Package org.apache.sling.api (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="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Use</B></FONT> </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"> + PREV + NEXT</FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/apache/sling/api/package-use.html" target="_top"><B>FRAMES</B></A> + <A HREF="package-use.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> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<CENTER> +<H2> +<B>Uses of Package<br>org.apache.sling.api</B></H2> +</CENTER> + +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +Packages that use <A HREF="../../../../org/apache/sling/api/package-summary.html">org.apache.sling.api</A></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><A HREF="#org.apache.sling.api"><B>org.apache.sling.api</B></A></TD> +<TD> </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><A HREF="#org.apache.sling.api.request"><B>org.apache.sling.api.request</B></A></TD> +<TD> </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><A HREF="#org.apache.sling.api.resource"><B>org.apache.sling.api.resource</B></A></TD> +<TD> </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><A HREF="#org.apache.sling.api.scripting"><B>org.apache.sling.api.scripting</B></A></TD> +<TD> </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><A HREF="#org.apache.sling.api.servlets"><B>org.apache.sling.api.servlets</B></A></TD> +<TD> </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><A HREF="#org.apache.sling.api.wrappers"><B>org.apache.sling.api.wrappers</B></A></TD> +<TD> </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><A HREF="#org.apache.sling.commons.testing.sling"><B>org.apache.sling.commons.testing.sling</B></A></TD> +<TD> </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><A HREF="#org.apache.sling.engine.auth"><B>org.apache.sling.engine.auth</B></A></TD> +<TD> </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><A HREF="#org.apache.sling.engine.servlets"><B>org.apache.sling.engine.servlets</B></A></TD> +<TD> </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><A HREF="#org.apache.sling.jackrabbit.usermanager.post"><B>org.apache.sling.jackrabbit.usermanager.post</B></A></TD> +<TD> </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><A HREF="#org.apache.sling.jcr.jackrabbit.accessmanager.post"><B>org.apache.sling.jcr.jackrabbit.accessmanager.post</B></A></TD> +<TD> </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><A HREF="#org.apache.sling.launchpad.testservices.servlets"><B>org.apache.sling.launchpad.testservices.servlets</B></A></TD> +<TD> </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><A HREF="#org.apache.sling.scripting.core"><B>org.apache.sling.scripting.core</B></A></TD> +<TD> </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><A HREF="#org.apache.sling.servlets.post"><B>org.apache.sling.servlets.post</B></A></TD> +<TD> </TD> +</TR> +</TABLE> + +<P> +<A NAME="org.apache.sling.api"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +Classes in <A HREF="../../../../org/apache/sling/api/package-summary.html">org.apache.sling.api</A> used by <A HREF="../../../../org/apache/sling/api/package-summary.html">org.apache.sling.api</A></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../../../org/apache/sling/api/class-use/SlingException.html#org.apache.sling.api"><B>SlingException</B></A></B> + +<BR> + The <code>SlingException</code> is the base exception used throughout the + Sling API.</TD> +</TR> +</TABLE> + +<P> +<A NAME="org.apache.sling.api.request"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +Classes in <A HREF="../../../../org/apache/sling/api/package-summary.html">org.apache.sling.api</A> used by <A HREF="../../../../org/apache/sling/api/request/package-summary.html">org.apache.sling.api.request</A></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../../../org/apache/sling/api/class-use/SlingException.html#org.apache.sling.api.request"><B>SlingException</B></A></B> + +<BR> + The <code>SlingException</code> is the base exception used throughout the + Sling API.</TD> +</TR> +</TABLE> + +<P> +<A NAME="org.apache.sling.api.resource"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +Classes in <A HREF="../../../../org/apache/sling/api/package-summary.html">org.apache.sling.api</A> used by <A HREF="../../../../org/apache/sling/api/resource/package-summary.html">org.apache.sling.api.resource</A></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../../../org/apache/sling/api/class-use/SlingException.html#org.apache.sling.api.resource"><B>SlingException</B></A></B> + +<BR> + The <code>SlingException</code> is the base exception used throughout the + Sling API.</TD> +</TR> +</TABLE> + +<P> +<A NAME="org.apache.sling.api.scripting"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +Classes in <A HREF="../../../../org/apache/sling/api/package-summary.html">org.apache.sling.api</A> used by <A HREF="../../../../org/apache/sling/api/scripting/package-summary.html">org.apache.sling.api.scripting</A></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../../../org/apache/sling/api/class-use/SlingException.html#org.apache.sling.api.scripting"><B>SlingException</B></A></B> + +<BR> + The <code>SlingException</code> is the base exception used throughout the + Sling API.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../../../org/apache/sling/api/class-use/SlingHttpServletRequest.html#org.apache.sling.api.scripting"><B>SlingHttpServletRequest</B></A></B> + +<BR> + The <code>SlingHttpServletRequest</code> defines the interface to provide + client request information to a servlet.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../../../org/apache/sling/api/class-use/SlingHttpServletResponse.html#org.apache.sling.api.scripting"><B>SlingHttpServletResponse</B></A></B> + +<BR> + The <code>SlingHttpServletResponse</code> defines the interface to assist a + servlet in creating and sending a response to the client.</TD> +</TR> +</TABLE> + +<P> +<A NAME="org.apache.sling.api.servlets"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +Classes in <A HREF="../../../../org/apache/sling/api/package-summary.html">org.apache.sling.api</A> used by <A HREF="../../../../org/apache/sling/api/servlets/package-summary.html">org.apache.sling.api.servlets</A></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../../../org/apache/sling/api/class-use/SlingHttpServletRequest.html#org.apache.sling.api.servlets"><B>SlingHttpServletRequest</B></A></B> + +<BR> + The <code>SlingHttpServletRequest</code> defines the interface to provide + client request information to a servlet.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../../../org/apache/sling/api/class-use/SlingHttpServletResponse.html#org.apache.sling.api.servlets"><B>SlingHttpServletResponse</B></A></B> + +<BR> + The <code>SlingHttpServletResponse</code> defines the interface to assist a + servlet in creating and sending a response to the client.</TD> +</TR> +</TABLE> + +<P> +<A NAME="org.apache.sling.api.wrappers"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +Classes in <A HREF="../../../../org/apache/sling/api/package-summary.html">org.apache.sling.api</A> used by <A HREF="../../../../org/apache/sling/api/wrappers/package-summary.html">org.apache.sling.api.wrappers</A></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../../../org/apache/sling/api/class-use/SlingHttpServletRequest.html#org.apache.sling.api.wrappers"><B>SlingHttpServletRequest</B></A></B> + +<BR> + The <code>SlingHttpServletRequest</code> defines the interface to provide + client request information to a servlet.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../../../org/apache/sling/api/class-use/SlingHttpServletResponse.html#org.apache.sling.api.wrappers"><B>SlingHttpServletResponse</B></A></B> + +<BR> + The <code>SlingHttpServletResponse</code> defines the interface to assist a + servlet in creating and sending a response to the client.</TD> +</TR> +</TABLE> + +<P> +<A NAME="org.apache.sling.commons.testing.sling"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +Classes in <A HREF="../../../../org/apache/sling/api/package-summary.html">org.apache.sling.api</A> used by <A HREF="../../../../org/apache/sling/commons/testing/sling/package-summary.html">org.apache.sling.commons.testing.sling</A></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../../../org/apache/sling/api/class-use/SlingHttpServletRequest.html#org.apache.sling.commons.testing.sling"><B>SlingHttpServletRequest</B></A></B> + +<BR> + The <code>SlingHttpServletRequest</code> defines the interface to provide + client request information to a servlet.</TD> +</TR> +</TABLE> + +<P> +<A NAME="org.apache.sling.engine.auth"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +Classes in <A HREF="../../../../org/apache/sling/api/package-summary.html">org.apache.sling.api</A> used by <A HREF="../../../../org/apache/sling/engine/auth/package-summary.html">org.apache.sling.engine.auth</A></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../../../org/apache/sling/api/class-use/SlingException.html#org.apache.sling.engine.auth"><B>SlingException</B></A></B> + +<BR> + The <code>SlingException</code> is the base exception used throughout the + Sling API.</TD> +</TR> +</TABLE> + +<P> +<A NAME="org.apache.sling.engine.servlets"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +Classes in <A HREF="../../../../org/apache/sling/api/package-summary.html">org.apache.sling.api</A> used by <A HREF="../../../../org/apache/sling/engine/servlets/package-summary.html">org.apache.sling.engine.servlets</A></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../../../org/apache/sling/api/class-use/SlingHttpServletRequest.html#org.apache.sling.engine.servlets"><B>SlingHttpServletRequest</B></A></B> + +<BR> + The <code>SlingHttpServletRequest</code> defines the interface to provide + client request information to a servlet.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../../../org/apache/sling/api/class-use/SlingHttpServletResponse.html#org.apache.sling.engine.servlets"><B>SlingHttpServletResponse</B></A></B> + +<BR> + The <code>SlingHttpServletResponse</code> defines the interface to assist a + servlet in creating and sending a response to the client.</TD> +</TR> +</TABLE> + +<P> +<A NAME="org.apache.sling.jackrabbit.usermanager.post"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +Classes in <A HREF="../../../../org/apache/sling/api/package-summary.html">org.apache.sling.api</A> used by <A HREF="../../../../org/apache/sling/jackrabbit/usermanager/post/package-summary.html">org.apache.sling.jackrabbit.usermanager.post</A></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../../../org/apache/sling/api/class-use/SlingHttpServletRequest.html#org.apache.sling.jackrabbit.usermanager.post"><B>SlingHttpServletRequest</B></A></B> + +<BR> + The <code>SlingHttpServletRequest</code> defines the interface to provide + client request information to a servlet.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../../../org/apache/sling/api/class-use/SlingHttpServletResponse.html#org.apache.sling.jackrabbit.usermanager.post"><B>SlingHttpServletResponse</B></A></B> + +<BR> + The <code>SlingHttpServletResponse</code> defines the interface to assist a + servlet in creating and sending a response to the client.</TD> +</TR> +</TABLE> + +<P> +<A NAME="org.apache.sling.jcr.jackrabbit.accessmanager.post"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +Classes in <A HREF="../../../../org/apache/sling/api/package-summary.html">org.apache.sling.api</A> used by <A HREF="../../../../org/apache/sling/jcr/jackrabbit/accessmanager/post/package-summary.html">org.apache.sling.jcr.jackrabbit.accessmanager.post</A></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../../../org/apache/sling/api/class-use/SlingHttpServletRequest.html#org.apache.sling.jcr.jackrabbit.accessmanager.post"><B>SlingHttpServletRequest</B></A></B> + +<BR> + The <code>SlingHttpServletRequest</code> defines the interface to provide + client request information to a servlet.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../../../org/apache/sling/api/class-use/SlingHttpServletResponse.html#org.apache.sling.jcr.jackrabbit.accessmanager.post"><B>SlingHttpServletResponse</B></A></B> + +<BR> + The <code>SlingHttpServletResponse</code> defines the interface to assist a + servlet in creating and sending a response to the client.</TD> +</TR> +</TABLE> + +<P> +<A NAME="org.apache.sling.launchpad.testservices.servlets"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +Classes in <A HREF="../../../../org/apache/sling/api/package-summary.html">org.apache.sling.api</A> used by <A HREF="../../../../org/apache/sling/launchpad/testservices/servlets/package-summary.html">org.apache.sling.launchpad.testservices.servlets</A></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../../../org/apache/sling/api/class-use/SlingHttpServletRequest.html#org.apache.sling.launchpad.testservices.servlets"><B>SlingHttpServletRequest</B></A></B> + +<BR> + The <code>SlingHttpServletRequest</code> defines the interface to provide + client request information to a servlet.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../../../org/apache/sling/api/class-use/SlingHttpServletResponse.html#org.apache.sling.launchpad.testservices.servlets"><B>SlingHttpServletResponse</B></A></B> + +<BR> + The <code>SlingHttpServletResponse</code> defines the interface to assist a + servlet in creating and sending a response to the client.</TD> +</TR> +</TABLE> + +<P> +<A NAME="org.apache.sling.scripting.core"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +Classes in <A HREF="../../../../org/apache/sling/api/package-summary.html">org.apache.sling.api</A> used by <A HREF="../../../../org/apache/sling/scripting/core/package-summary.html">org.apache.sling.scripting.core</A></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../../../org/apache/sling/api/class-use/SlingHttpServletRequest.html#org.apache.sling.scripting.core"><B>SlingHttpServletRequest</B></A></B> + +<BR> + The <code>SlingHttpServletRequest</code> defines the interface to provide + client request information to a servlet.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../../../org/apache/sling/api/class-use/SlingHttpServletResponse.html#org.apache.sling.scripting.core"><B>SlingHttpServletResponse</B></A></B> + +<BR> + The <code>SlingHttpServletResponse</code> defines the interface to assist a + servlet in creating and sending a response to the client.</TD> +</TR> +</TABLE> + +<P> +<A NAME="org.apache.sling.servlets.post"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +Classes in <A HREF="../../../../org/apache/sling/api/package-summary.html">org.apache.sling.api</A> used by <A HREF="../../../../org/apache/sling/servlets/post/package-summary.html">org.apache.sling.servlets.post</A></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../../../org/apache/sling/api/class-use/SlingHttpServletRequest.html#org.apache.sling.servlets.post"><B>SlingHttpServletRequest</B></A></B> + +<BR> + The <code>SlingHttpServletRequest</code> defines the interface to provide + client request information to a servlet.</TD> +</TR> +</TABLE> + +<P> +<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="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Use</B></FONT> </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"> + PREV + NEXT</FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/apache/sling/api/package-use.html" target="_top"><B>FRAMES</B></A> + <A HREF="package-use.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> +</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/request/RecursionTooDeepException.html ---------------------------------------------------------------------- diff --git a/assets/apidocs/sling5/org/apache/sling/api/request/RecursionTooDeepException.html b/assets/apidocs/sling5/org/apache/sling/api/request/RecursionTooDeepException.html new file mode 100644 index 0000000..c5ea4a7 --- /dev/null +++ b/assets/apidocs/sling5/org/apache/sling/api/request/RecursionTooDeepException.html @@ -0,0 +1,260 @@ +<!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:05 CEST 2009 --> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<TITLE> +RecursionTooDeepException (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="RecursionTooDeepException (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/RecursionTooDeepException.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"> + PREV CLASS + <A HREF="../../../../../org/apache/sling/api/request/RequestDispatcherOptions.html" title="class in org.apache.sling.api.request"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/sling/api/request/RecursionTooDeepException.html" target="_top"><B>FRAMES</B></A> + <A HREF="RecursionTooDeepException.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#methods_inherited_from_class_java.lang.Throwable">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | METHOD</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.request</FONT> +<BR> +Class RecursionTooDeepException</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.Exception + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.RuntimeException + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/sling/api/SlingException.html" title="class in org.apache.sling.api">org.apache.sling.api.SlingException</A> + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.sling.api.request.RecursionTooDeepException</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD> +</DL> +<HR> +<DL> +<DT><PRE>public class <B>RecursionTooDeepException</B><DT>extends <A HREF="../../../../../org/apache/sling/api/SlingException.html" title="class in org.apache.sling.api">SlingException</A></DL> +</PRE> + +<P> +The <code>RecursionTooDeepException</code> is thrown by the Sling + implementation if to many recursive content inclusions take place. The limit + of recursive inclusions is implementation dependent. +<P> + +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../serialized-form.html#org.apache.sling.api.request.RecursionTooDeepException">Serialized Form</A></DL> +<HR> + +<P> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_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>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/request/RecursionTooDeepException.html#RecursionTooDeepException(java.lang.String)">RecursionTooDeepException</A></B>(java.lang.String resourcePath)</CODE> + +<BR> + Creates a new instance of this class reporting the exception occurred + while trying to include the output for rendering the resource at the + given path.</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> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.Throwable</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</CODE></TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_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>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="RecursionTooDeepException(java.lang.String)"><!-- --></A><H3> +RecursionTooDeepException</H3> +<PRE> +public <B>RecursionTooDeepException</B>(java.lang.String resourcePath)</PRE> +<DL> +<DD>Creates a new instance of this class reporting the exception occurred + while trying to include the output for rendering the resource at the + given path. + <p> + The resource path is the actual message of the exception. +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>resourcePath</CODE> - The path of the resource whose output inclusion + causes this exception.</DL> +</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/RecursionTooDeepException.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"> + PREV CLASS + <A HREF="../../../../../org/apache/sling/api/request/RequestDispatcherOptions.html" title="class in org.apache.sling.api.request"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/sling/api/request/RecursionTooDeepException.html" target="_top"><B>FRAMES</B></A> + <A HREF="RecursionTooDeepException.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#methods_inherited_from_class_java.lang.Throwable">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | METHOD</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/request/RequestDispatcherOptions.html ---------------------------------------------------------------------- diff --git a/assets/apidocs/sling5/org/apache/sling/api/request/RequestDispatcherOptions.html b/assets/apidocs/sling5/org/apache/sling/api/request/RequestDispatcherOptions.html new file mode 100644 index 0000000..a63254c --- /dev/null +++ b/assets/apidocs/sling5/org/apache/sling/api/request/RequestDispatcherOptions.html @@ -0,0 +1,632 @@ +<!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:05 CEST 2009 --> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<TITLE> +RequestDispatcherOptions (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="RequestDispatcherOptions (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/RequestDispatcherOptions.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/request/RecursionTooDeepException.html" title="class in org.apache.sling.api.request"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/sling/api/request/RequestParameter.html" title="interface in org.apache.sling.api.request"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/sling/api/request/RequestDispatcherOptions.html" target="_top"><B>FRAMES</B></A> + <A HREF="RequestDispatcherOptions.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: <A HREF="#nested_classes_inherited_from_class_java.util.AbstractMap">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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.request</FONT> +<BR> +Class RequestDispatcherOptions</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.util.AbstractMap<K,V> + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.util.HashMap<java.lang.String,java.lang.String> + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.sling.api.request.RequestDispatcherOptions</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.String></DD> +</DL> +<HR> +<DL> +<DT><PRE>public class <B>RequestDispatcherOptions</B><DT>extends java.util.HashMap<java.lang.String,java.lang.String></DL> +</PRE> + +<P> +<code>RequestDispatcherOptions</code> are used in the + <A HREF="../../../../../org/apache/sling/api/SlingHttpServletRequest.html#getRequestDispatcher(org.apache.sling.api.resource.Resource, org.apache.sling.api.request.RequestDispatcherOptions)"><CODE>SlingHttpServletRequest.getRequestDispatcher(org.apache.sling.api.resource.Resource, RequestDispatcherOptions)</CODE></A> + method, to give more control on some aspects of the include/forward + mechanism. Typical use cases include: + <ul> + <li> Forcing a resource type, to render a Resource in a specific way, like + for example <em>render myself in a suitable way for a navigation box</em>. + </li> + <li> Adding selectors when including a Resource, like for example <em>add + a "teaser" selector to the request that I'm including here</em>. + </li> + </ul> + This class currently only inherits from Map, and defines some constants for + well-known options. +<P> + +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../serialized-form.html#org.apache.sling.api.request.RequestDispatcherOptions">Serialized Form</A></DL> +<HR> + +<P> +<!-- ======== NESTED CLASS SUMMARY ======== --> + +<A NAME="nested_class_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>Nested Class Summary</B></FONT></TH> +</TR> +</TABLE> + <A NAME="nested_classes_inherited_from_class_java.util.AbstractMap"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Nested classes/interfaces inherited from class java.util.AbstractMap</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V></CODE></TD> +</TR> +</TABLE> + +<!-- =========== 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/request/RequestDispatcherOptions.html#OPT_ADD_SELECTORS">OPT_ADD_SELECTORS</A></B></CODE> + +<BR> + When dispatching, add the value provided by this option to the + <A HREF="../../../../../org/apache/sling/api/request/RequestPathInfo.html" title="interface in org.apache.sling.api.request"><CODE>RequestPathInfo</CODE></A> selectors.</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/request/RequestDispatcherOptions.html#OPT_FORCE_RESOURCE_TYPE">OPT_FORCE_RESOURCE_TYPE</A></B></CODE> + +<BR> + When dispatching, use the value provided by this option as the resource + type, instead of the one defined by the + <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A>.</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/request/RequestDispatcherOptions.html#OPT_REPLACE_SELECTORS">OPT_REPLACE_SELECTORS</A></B></CODE> + +<BR> + When dispatching, replace <A HREF="../../../../../org/apache/sling/api/request/RequestPathInfo.html" title="interface in org.apache.sling.api.request"><CODE>RequestPathInfo</CODE></A> selectors by the value + provided by this option.</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/request/RequestDispatcherOptions.html#OPT_REPLACE_SUFFIX">OPT_REPLACE_SUFFIX</A></B></CODE> + +<BR> + When dispatching, replace the <A HREF="../../../../../org/apache/sling/api/request/RequestPathInfo.html" title="interface in org.apache.sling.api.request"><CODE>RequestPathInfo</CODE></A> suffix by the value + provided by this option</TD> +</TR> +</TABLE> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_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>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/request/RequestDispatcherOptions.html#RequestDispatcherOptions()">RequestDispatcherOptions</A></B>()</CODE> + +<BR> + Creates an instance with no options set.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/request/RequestDispatcherOptions.html#RequestDispatcherOptions(java.lang.String)">RequestDispatcherOptions</A></B>(java.lang.String options)</CODE> + +<BR> + Creates a new instances setting options by parsing the given + <code>options</code> string as follows: + + If the string is empty or <code>null</code> no options are set.</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> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/request/RequestDispatcherOptions.html#getAddSelectors()">getAddSelectors</A></B>()</CODE> + +<BR> + Returns the <A HREF="../../../../../org/apache/sling/api/request/RequestDispatcherOptions.html#OPT_ADD_SELECTORS"><CODE>OPT_ADD_SELECTORS</CODE></A> option or <code>null</code> if + not set.</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/request/RequestDispatcherOptions.html#getForceResourceType()">getForceResourceType</A></B>()</CODE> + +<BR> + Returns the <A HREF="../../../../../org/apache/sling/api/request/RequestDispatcherOptions.html#OPT_FORCE_RESOURCE_TYPE"><CODE>OPT_FORCE_RESOURCE_TYPE</CODE></A> option or <code>null</code> + if not set.</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/request/RequestDispatcherOptions.html#getReplaceSelectors()">getReplaceSelectors</A></B>()</CODE> + +<BR> + Returns the <A HREF="../../../../../org/apache/sling/api/request/RequestDispatcherOptions.html#OPT_REPLACE_SELECTORS"><CODE>OPT_REPLACE_SELECTORS</CODE></A> option or <code>null</code> + if not set.</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/request/RequestDispatcherOptions.html#getReplaceSuffix()">getReplaceSuffix</A></B>()</CODE> + +<BR> + Returns the <A HREF="../../../../../org/apache/sling/api/request/RequestDispatcherOptions.html#OPT_REPLACE_SUFFIX"><CODE>OPT_REPLACE_SUFFIX</CODE></A> option or <code>null</code> if + not set.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/request/RequestDispatcherOptions.html#setAddSelectors(java.lang.String)">setAddSelectors</A></B>(java.lang.String additionalSelectors)</CODE> + +<BR> + Sets the <A HREF="../../../../../org/apache/sling/api/request/RequestDispatcherOptions.html#OPT_ADD_SELECTORS"><CODE>OPT_ADD_SELECTORS</CODE></A> option to the given + <code>additionalSelectors</code> if not <code>null</code>.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/request/RequestDispatcherOptions.html#setForceResourceType(java.lang.String)">setForceResourceType</A></B>(java.lang.String resourceType)</CODE> + +<BR> + Sets the <A HREF="../../../../../org/apache/sling/api/request/RequestDispatcherOptions.html#OPT_FORCE_RESOURCE_TYPE"><CODE>OPT_FORCE_RESOURCE_TYPE</CODE></A> option to the given + <code>resourceType</code> if not <code>null</code>.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/request/RequestDispatcherOptions.html#setReplaceSelectors(java.lang.String)">setReplaceSelectors</A></B>(java.lang.String replaceSelectors)</CODE> + +<BR> + Sets the <A HREF="../../../../../org/apache/sling/api/request/RequestDispatcherOptions.html#OPT_REPLACE_SELECTORS"><CODE>OPT_REPLACE_SELECTORS</CODE></A> option to the given + <code>replaceSelectors</code> if not <code>null</code>.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/request/RequestDispatcherOptions.html#setReplaceSuffix(java.lang.String)">setReplaceSuffix</A></B>(java.lang.String replaceSuffix)</CODE> + +<BR> + Sets the <A HREF="../../../../../org/apache/sling/api/request/RequestDispatcherOptions.html#OPT_REPLACE_SUFFIX"><CODE>OPT_REPLACE_SUFFIX</CODE></A> option to the given + <code>replaceSuffix</code> if not <code>null</code>.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.util.HashMap"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.util.HashMap</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values</CODE></TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.util.AbstractMap"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.util.AbstractMap</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>equals, hashCode, toString</CODE></TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>finalize, getClass, notify, notifyAll, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.util.Map"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from interface java.util.Map</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>equals, hashCode</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="OPT_FORCE_RESOURCE_TYPE"><!-- --></A><H3> +OPT_FORCE_RESOURCE_TYPE</H3> +<PRE> +public static final java.lang.String <B>OPT_FORCE_RESOURCE_TYPE</B></PRE> +<DL> +<DD>When dispatching, use the value provided by this option as the resource + type, instead of the one defined by the + <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A>. +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.request.RequestDispatcherOptions.OPT_FORCE_RESOURCE_TYPE">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="OPT_REPLACE_SELECTORS"><!-- --></A><H3> +OPT_REPLACE_SELECTORS</H3> +<PRE> +public static final java.lang.String <B>OPT_REPLACE_SELECTORS</B></PRE> +<DL> +<DD>When dispatching, replace <A HREF="../../../../../org/apache/sling/api/request/RequestPathInfo.html" title="interface in org.apache.sling.api.request"><CODE>RequestPathInfo</CODE></A> selectors by the value + provided by this option. +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.request.RequestDispatcherOptions.OPT_REPLACE_SELECTORS">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="OPT_ADD_SELECTORS"><!-- --></A><H3> +OPT_ADD_SELECTORS</H3> +<PRE> +public static final java.lang.String <B>OPT_ADD_SELECTORS</B></PRE> +<DL> +<DD>When dispatching, add the value provided by this option to the + <A HREF="../../../../../org/apache/sling/api/request/RequestPathInfo.html" title="interface in org.apache.sling.api.request"><CODE>RequestPathInfo</CODE></A> selectors. +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.request.RequestDispatcherOptions.OPT_ADD_SELECTORS">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="OPT_REPLACE_SUFFIX"><!-- --></A><H3> +OPT_REPLACE_SUFFIX</H3> +<PRE> +public static final java.lang.String <B>OPT_REPLACE_SUFFIX</B></PRE> +<DL> +<DD>When dispatching, replace the <A HREF="../../../../../org/apache/sling/api/request/RequestPathInfo.html" title="interface in org.apache.sling.api.request"><CODE>RequestPathInfo</CODE></A> suffix by the value + provided by this option +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.request.RequestDispatcherOptions.OPT_REPLACE_SUFFIX">Constant Field Values</A></DL> +</DL> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_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>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="RequestDispatcherOptions()"><!-- --></A><H3> +RequestDispatcherOptions</H3> +<PRE> +public <B>RequestDispatcherOptions</B>()</PRE> +<DL> +<DD>Creates an instance with no options set. +<P> +</DL> +<HR> + +<A NAME="RequestDispatcherOptions(java.lang.String)"><!-- --></A><H3> +RequestDispatcherOptions</H3> +<PRE> +public <B>RequestDispatcherOptions</B>(java.lang.String options)</PRE> +<DL> +<DD>Creates a new instances setting options by parsing the given + <code>options</code> string as follows: + <ul> + <li>If the string is empty or <code>null</code> no options are set.</li> + <li>If the string neither contains a comma nor an equals sign, the + string is assumed to be a resource type. Hence a + <code>RequestDispatcherOptions</code> object is created with the + <A HREF="../../../../../org/apache/sling/api/request/RequestDispatcherOptions.html#OPT_FORCE_RESOURCE_TYPE"><CODE>OPT_FORCE_RESOURCE_TYPE</CODE></A> field set to the + string.</li> + <li>Otherwise the string is assumed to be a comma separated list of name + value pairs where the equals sign is used to separate the name from its + value. Hence a <code>RequestDispatcherOptions</code> object is created + from the name value pair list.</li> + </ul> +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>options</CODE> - The options to set.</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="setForceResourceType(java.lang.String)"><!-- --></A><H3> +setForceResourceType</H3> +<PRE> +public void <B>setForceResourceType</B>(java.lang.String resourceType)</PRE> +<DL> +<DD>Sets the <A HREF="../../../../../org/apache/sling/api/request/RequestDispatcherOptions.html#OPT_FORCE_RESOURCE_TYPE"><CODE>OPT_FORCE_RESOURCE_TYPE</CODE></A> option to the given + <code>resourceType</code> if not <code>null</code>. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getForceResourceType()"><!-- --></A><H3> +getForceResourceType</H3> +<PRE> +public java.lang.String <B>getForceResourceType</B>()</PRE> +<DL> +<DD>Returns the <A HREF="../../../../../org/apache/sling/api/request/RequestDispatcherOptions.html#OPT_FORCE_RESOURCE_TYPE"><CODE>OPT_FORCE_RESOURCE_TYPE</CODE></A> option or <code>null</code> + if not set. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setAddSelectors(java.lang.String)"><!-- --></A><H3> +setAddSelectors</H3> +<PRE> +public void <B>setAddSelectors</B>(java.lang.String additionalSelectors)</PRE> +<DL> +<DD>Sets the <A HREF="../../../../../org/apache/sling/api/request/RequestDispatcherOptions.html#OPT_ADD_SELECTORS"><CODE>OPT_ADD_SELECTORS</CODE></A> option to the given + <code>additionalSelectors</code> if not <code>null</code>. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getAddSelectors()"><!-- --></A><H3> +getAddSelectors</H3> +<PRE> +public java.lang.String <B>getAddSelectors</B>()</PRE> +<DL> +<DD>Returns the <A HREF="../../../../../org/apache/sling/api/request/RequestDispatcherOptions.html#OPT_ADD_SELECTORS"><CODE>OPT_ADD_SELECTORS</CODE></A> option or <code>null</code> if + not set. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setReplaceSelectors(java.lang.String)"><!-- --></A><H3> +setReplaceSelectors</H3> +<PRE> +public void <B>setReplaceSelectors</B>(java.lang.String replaceSelectors)</PRE> +<DL> +<DD>Sets the <A HREF="../../../../../org/apache/sling/api/request/RequestDispatcherOptions.html#OPT_REPLACE_SELECTORS"><CODE>OPT_REPLACE_SELECTORS</CODE></A> option to the given + <code>replaceSelectors</code> if not <code>null</code>. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getReplaceSelectors()"><!-- --></A><H3> +getReplaceSelectors</H3> +<PRE> +public java.lang.String <B>getReplaceSelectors</B>()</PRE> +<DL> +<DD>Returns the <A HREF="../../../../../org/apache/sling/api/request/RequestDispatcherOptions.html#OPT_REPLACE_SELECTORS"><CODE>OPT_REPLACE_SELECTORS</CODE></A> option or <code>null</code> + if not set. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setReplaceSuffix(java.lang.String)"><!-- --></A><H3> +setReplaceSuffix</H3> +<PRE> +public void <B>setReplaceSuffix</B>(java.lang.String replaceSuffix)</PRE> +<DL> +<DD>Sets the <A HREF="../../../../../org/apache/sling/api/request/RequestDispatcherOptions.html#OPT_REPLACE_SUFFIX"><CODE>OPT_REPLACE_SUFFIX</CODE></A> option to the given + <code>replaceSuffix</code> if not <code>null</code>. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getReplaceSuffix()"><!-- --></A><H3> +getReplaceSuffix</H3> +<PRE> +public java.lang.String <B>getReplaceSuffix</B>()</PRE> +<DL> +<DD>Returns the <A HREF="../../../../../org/apache/sling/api/request/RequestDispatcherOptions.html#OPT_REPLACE_SUFFIX"><CODE>OPT_REPLACE_SUFFIX</CODE></A> option or <code>null</code> if + not set. +<P> +<DD><DL> +</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/RequestDispatcherOptions.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/request/RecursionTooDeepException.html" title="class in org.apache.sling.api.request"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/sling/api/request/RequestParameter.html" title="interface in org.apache.sling.api.request"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/sling/api/request/RequestDispatcherOptions.html" target="_top"><B>FRAMES</B></A> + <A HREF="RequestDispatcherOptions.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: <A HREF="#nested_classes_inherited_from_class_java.util.AbstractMap">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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/request/RequestParameter.html ---------------------------------------------------------------------- diff --git a/assets/apidocs/sling5/org/apache/sling/api/request/RequestParameter.html b/assets/apidocs/sling5/org/apache/sling/api/request/RequestParameter.html new file mode 100644 index 0000000..769d6d7 --- /dev/null +++ b/assets/apidocs/sling5/org/apache/sling/api/request/RequestParameter.html @@ -0,0 +1,402 @@ +<!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:05 CEST 2009 --> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<TITLE> +RequestParameter (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="RequestParameter (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/RequestParameter.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/request/RequestDispatcherOptions.html" title="class in org.apache.sling.api.request"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/sling/api/request/RequestParameterMap.html" title="interface in org.apache.sling.api.request"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/sling/api/request/RequestParameter.html" target="_top"><B>FRAMES</B></A> + <A HREF="RequestParameter.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.request</FONT> +<BR> +Interface RequestParameter</H2> +<HR> +<DL> +<DT><PRE>public interface <B>RequestParameter</B></DL> +</PRE> + +<P> +The <code>RequestParameter</code> class represents a single parameter sent + with the client request. Instances of this class are returned by the + <A HREF="../../../../../org/apache/sling/api/SlingHttpServletRequest.html#getRequestParameter(java.lang.String)"><CODE>SlingHttpServletRequest.getRequestParameter(String)</CODE></A>, + <A HREF="../../../../../org/apache/sling/api/SlingHttpServletRequest.html#getRequestParameters(java.lang.String)"><CODE>SlingHttpServletRequest.getRequestParameters(String)</CODE></A> and + <A HREF="../../../../../org/apache/sling/api/SlingHttpServletRequest.html#getRequestParameterMap()"><CODE>SlingHttpServletRequest.getRequestParameterMap()</CODE></A> method. +<P> + +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/sling/api/SlingHttpServletRequest.html#getRequestParameter(java.lang.String)"><CODE>SlingHttpServletRequest.getRequestParameter(String)</CODE></A>, +<A HREF="../../../../../org/apache/sling/api/SlingHttpServletRequest.html#getRequestParameters(java.lang.String)"><CODE>SlingHttpServletRequest.getRequestParameters(String)</CODE></A>, +<A HREF="../../../../../org/apache/sling/api/SlingHttpServletRequest.html#getRequestParameterMap()"><CODE>SlingHttpServletRequest.getRequestParameterMap()</CODE></A></DL> +<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> byte[]</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/request/RequestParameter.html#get()">get</A></B>()</CODE> + +<BR> + Returns the contents of the parameter as an array of bytes.</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/request/RequestParameter.html#getContentType()">getContentType</A></B>()</CODE> + +<BR> + Returns the content type passed by the browser or <code>null</code> if + not defined.</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/request/RequestParameter.html#getFileName()">getFileName</A></B>()</CODE> + +<BR> + Returns the original filename in the client's filesystem, as provided by + the browser (or other client software).</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.io.InputStream</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/request/RequestParameter.html#getInputStream()">getInputStream</A></B>()</CODE> + +<BR> + Returns an InputStream that can be used to retrieve the contents of the + file.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> long</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/request/RequestParameter.html#getSize()">getSize</A></B>()</CODE> + +<BR> + Returns the size in bytes of the parameter.</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/request/RequestParameter.html#getString()">getString</A></B>()</CODE> + +<BR> + Returns the contents of the parameter as a String, using the default + character encoding.</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/request/RequestParameter.html#getString(java.lang.String)">getString</A></B>(java.lang.String encoding)</CODE> + +<BR> + Returns the contents of the parameter as a String, using the specified + encoding.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/request/RequestParameter.html#isFormField()">isFormField</A></B>()</CODE> + +<BR> + Determines whether or not this instance represents a simple form field or + an uploaded file.</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="isFormField()"><!-- --></A><H3> +isFormField</H3> +<PRE> +boolean <B>isFormField</B>()</PRE> +<DL> +<DD>Determines whether or not this instance represents a simple form field or + an uploaded file. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD><code>true</code> if the instance represents a simple form + field; <code>false</code> if it represents an uploaded file.</DL> +</DD> +</DL> +<HR> + +<A NAME="getContentType()"><!-- --></A><H3> +getContentType</H3> +<PRE> +java.lang.String <B>getContentType</B>()</PRE> +<DL> +<DD>Returns the content type passed by the browser or <code>null</code> if + not defined. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>The content type passed by the browser or <code>null</code> if + not defined.</DL> +</DD> +</DL> +<HR> + +<A NAME="getSize()"><!-- --></A><H3> +getSize</H3> +<PRE> +long <B>getSize</B>()</PRE> +<DL> +<DD>Returns the size in bytes of the parameter. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>The size in bytes of the parameter.</DL> +</DD> +</DL> +<HR> + +<A NAME="get()"><!-- --></A><H3> +get</H3> +<PRE> +byte[] <B>get</B>()</PRE> +<DL> +<DD>Returns the contents of the parameter as an array of bytes. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>The contents of the parameter as an array of bytes.</DL> +</DD> +</DL> +<HR> + +<A NAME="getInputStream()"><!-- --></A><H3> +getInputStream</H3> +<PRE> +java.io.InputStream <B>getInputStream</B>() + throws java.io.IOException</PRE> +<DL> +<DD>Returns an InputStream that can be used to retrieve the contents of the + file. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>An InputStream that can be used to retrieve the contents of the + file. +<DT><B>Throws:</B> +<DD><CODE>java.io.IOException</CODE> - if an error occurs.</DL> +</DD> +</DL> +<HR> + +<A NAME="getFileName()"><!-- --></A><H3> +getFileName</H3> +<PRE> +java.lang.String <B>getFileName</B>()</PRE> +<DL> +<DD>Returns the original filename in the client's filesystem, as provided by + the browser (or other client software). In most cases, this will be the + base file name, without path information. However, some clients, such as + the Opera browser, do include path information. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>The original filename in the client's filesystem.</DL> +</DD> +</DL> +<HR> + +<A NAME="getString()"><!-- --></A><H3> +getString</H3> +<PRE> +java.lang.String <B>getString</B>()</PRE> +<DL> +<DD>Returns the contents of the parameter as a String, using the default + character encoding. This method uses <A HREF="../../../../../org/apache/sling/api/request/RequestParameter.html#get()"><CODE>get()</CODE></A> to retrieve the + contents of the item. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>The contents of the parameter, as a string.</DL> +</DD> +</DL> +<HR> + +<A NAME="getString(java.lang.String)"><!-- --></A><H3> +getString</H3> +<PRE> +java.lang.String <B>getString</B>(java.lang.String encoding) + throws java.io.UnsupportedEncodingException</PRE> +<DL> +<DD>Returns the contents of the parameter as a String, using the specified + encoding. This method uses link <A HREF="../../../../../org/apache/sling/api/request/RequestParameter.html#get()"><CODE>get()</CODE></A> to retrieve the contents + of the item. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>encoding</CODE> - The character encoding to use. +<DT><B>Returns:</B><DD>The contents of the parameter, as a string. +<DT><B>Throws:</B> +<DD><CODE>java.io.UnsupportedEncodingException</CODE> - if the requested character encoding + is not available.</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/RequestParameter.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/request/RequestDispatcherOptions.html" title="class in org.apache.sling.api.request"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/sling/api/request/RequestParameterMap.html" title="interface in org.apache.sling.api.request"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/sling/api/request/RequestParameter.html" target="_top"><B>FRAMES</B></A> + <A HREF="RequestParameter.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>
