http://git-wip-us.apache.org/repos/asf/sling-site/blob/f2bd90f5/assets/apidocs/sling5/index.html ---------------------------------------------------------------------- diff --git a/assets/apidocs/sling5/index.html b/assets/apidocs/sling5/index.html deleted file mode 100644 index 45e4bac..0000000 --- a/assets/apidocs/sling5/index.html +++ /dev/null @@ -1,40 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd";> -<!--NewPage--> -<HTML> -<HEAD> -<!-- Generated by javadoc on Mon May 11 08:55:12 CEST 2009--> -<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<TITLE> -Apache Sling Aggregate 5-incubator API -</TITLE> -<SCRIPT type="text/javascript"> - targetPage = "" + window.location.search; - if (targetPage != "" && targetPage != "undefined") - targetPage = targetPage.substring(1); - if (targetPage.indexOf(":") != -1) - targetPage = "undefined"; - function loadFrames() { - if (targetPage != "" && targetPage != "undefined") - top.classFrame.location = top.targetPage; - } -</SCRIPT> -<NOSCRIPT> -</NOSCRIPT> -</HEAD> -<FRAMESET cols="20%,80%" title="" onLoad="top.loadFrames()"> -<FRAMESET rows="30%,70%" title="" onLoad="top.loadFrames()"> -<FRAME src="overview-frame.html" name="packageListFrame" title="All Packages"> -<FRAME src="allclasses-frame.html" name="packageFrame" title="All classes and interfaces (except non-static nested types)"> -</FRAMESET> -<FRAME src="overview-summary.html" name="classFrame" title="Package, class and interface descriptions" scrolling="yes"> -<NOFRAMES> -<H2> -Frame Alert</H2> - -<P> -This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. -<BR> -Link to<A HREF="overview-summary.html">Non-frame version.</A> -</NOFRAMES> -</FRAMESET> -</HTML>
http://git-wip-us.apache.org/repos/asf/sling-site/blob/f2bd90f5/assets/apidocs/sling5/org/apache/sling/api/SlingConstants.html ---------------------------------------------------------------------- diff --git a/assets/apidocs/sling5/org/apache/sling/api/SlingConstants.html b/assets/apidocs/sling5/org/apache/sling/api/SlingConstants.html deleted file mode 100644 index 0b37638..0000000 --- a/assets/apidocs/sling5/org/apache/sling/api/SlingConstants.html +++ /dev/null @@ -1,534 +0,0 @@ -<!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> -SlingConstants (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="SlingConstants (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/SlingConstants.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/SlingException.html" title="class in org.apache.sling.api"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../index.html?org/apache/sling/api/SlingConstants.html" target="_top"><B>FRAMES</B></A> - <A HREF="SlingConstants.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> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#methods_inherited_from_class_java.lang.Object">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> | 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</FONT> -<BR> -Class SlingConstants</H2> -<PRE> -java.lang.Object - <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.sling.api.SlingConstants</B> -</PRE> -<HR> -<DL> -<DT><PRE>public class <B>SlingConstants</B><DT>extends java.lang.Object</DL> -</PRE> - -<P> -The <code>SlingConstants</code> interface provides some symbolic constants - for well known constant strings in Sling. Even though these constants will - never change, it is recommended that applications refer to the symbolic - constants instead of code the strings themselves. -<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/SlingConstants.html#ATTR_REQUEST_CONTENT">ATTR_REQUEST_CONTENT</A></B></CODE> - -<BR> - The name of the request attribute containing the <code>Resource</code> - underlying the <code>Servlet</code> which included the servlet - currently being active (value is - "org.apache.sling.api.include.resource").</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/SlingConstants.html#ATTR_REQUEST_SERVLET">ATTR_REQUEST_SERVLET</A></B></CODE> - -<BR> - The name of the request attribute containing the <code>Servlet</code> - which included the servlet currently being active (value is - "org.apache.sling.api.include.servlet").</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/SlingConstants.html#ERROR_EXCEPTION">ERROR_EXCEPTION</A></B></CODE> - -<BR> - The name of the request attribute containing the exception thrown causing - the error handler to be called (value is - "javax.servlet.error.exception").</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/SlingConstants.html#ERROR_EXCEPTION_TYPE">ERROR_EXCEPTION_TYPE</A></B></CODE> - -<BR> - The name of the request attribute containing the fully qualified class - name of the exception thrown causing the error handler to be called - (value is "javax.servlet.error.exception_type").</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/SlingConstants.html#ERROR_MESSAGE">ERROR_MESSAGE</A></B></CODE> - -<BR> - The name of the request attribute containing the message of the error - situation (value is "javax.servlet.error.message").</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/SlingConstants.html#ERROR_REQUEST_URI">ERROR_REQUEST_URI</A></B></CODE> - -<BR> - The name of the request attribute containing the URL requested by the - client during whose processing the error handling was caused (value is - "javax.servlet.error.request_uri").</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/SlingConstants.html#ERROR_SERVLET_NAME">ERROR_SERVLET_NAME</A></B></CODE> - -<BR> - The name of the request attribute containing the name of the servlet - which caused the error handling (value is - "javax.servlet.error.servlet_name").</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/SlingConstants.html#ERROR_STATUS">ERROR_STATUS</A></B></CODE> - -<BR> - The name of the request attribute containing the status code sent to the - client (value is "javax.servlet.error.status_code").</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/SlingConstants.html#NAMESPACE_PREFIX">NAMESPACE_PREFIX</A></B></CODE> - -<BR> - The namespace prefix used throughout Sling (value is "sling").</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/SlingConstants.html#NAMESPACE_URI_ROOT">NAMESPACE_URI_ROOT</A></B></CODE> - -<BR> - The namespace URI prefix to be used by Sling projects to define - namespaces (value is "http://sling.apache.org/";).</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/SlingConstants.html#SlingConstants()">SlingConstants</A></B>()</CODE> - -<BR> - </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.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, toString, wait, wait, wait</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="NAMESPACE_PREFIX"><!-- --></A><H3> -NAMESPACE_PREFIX</H3> -<PRE> -public static final java.lang.String <B>NAMESPACE_PREFIX</B></PRE> -<DL> -<DD>The namespace prefix used throughout Sling (value is "sling"). - <p> - The actual use depends on the environment. For example a - <A HREF="../../../../org/apache/sling/api/resource/ResourceResolver.html" title="interface in org.apache.sling.api.resource"><CODE>ResourceResolver</CODE></A> using a JCR - repository may name Sling node types and items using namespaces mapped to - this prefix. A JSP tag library for Sling may use this prefix as the - namespace prefix for its tags. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.sling.api.SlingConstants.NAMESPACE_PREFIX">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="NAMESPACE_URI_ROOT"><!-- --></A><H3> -NAMESPACE_URI_ROOT</H3> -<PRE> -public static final java.lang.String <B>NAMESPACE_URI_ROOT</B></PRE> -<DL> -<DD>The namespace URI prefix to be used by Sling projects to define - namespaces (value is "http://sling.apache.org/";). - <p> - The actual namespace URI depends on the environment. For example a - <A HREF="../../../../org/apache/sling/api/resource/ResourceResolver.html" title="interface in org.apache.sling.api.resource"><CODE>ResourceResolver</CODE></A> using a JCR - repository may define its namespace as - <code><em>NAMESPACE_URI_ROOT + "jcr/sling/1.0"</em></code>. A JSP - tag library for Sling may define its namespace as - <code><em>NAMESPACE_URI_ROOT + "taglib/sling/1.0"</em></code>. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.sling.api.SlingConstants.NAMESPACE_URI_ROOT">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="ATTR_REQUEST_SERVLET"><!-- --></A><H3> -ATTR_REQUEST_SERVLET</H3> -<PRE> -public static final java.lang.String <B>ATTR_REQUEST_SERVLET</B></PRE> -<DL> -<DD>The name of the request attribute containing the <code>Servlet</code> - which included the servlet currently being active (value is - "org.apache.sling.api.include.servlet"). This attribute is - <code>null</code> if the current servlet is the servlet handling the - client request. - <p> - The type of the attribute value is <code>javax.servlet.Servlet</code>. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.sling.api.SlingConstants.ATTR_REQUEST_SERVLET">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="ATTR_REQUEST_CONTENT"><!-- --></A><H3> -ATTR_REQUEST_CONTENT</H3> -<PRE> -public static final java.lang.String <B>ATTR_REQUEST_CONTENT</B></PRE> -<DL> -<DD>The name of the request attribute containing the <code>Resource</code> - underlying the <code>Servlet</code> which included the servlet - currently being active (value is - "org.apache.sling.api.include.resource"). This attribute is - <code>null</code> if the current servlet is the servlet handling the - client request. - <p> - The type of the attribute value is - <code>org.apache.sling.api.resource.Resource</code>. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.sling.api.SlingConstants.ATTR_REQUEST_CONTENT">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="ERROR_EXCEPTION"><!-- --></A><H3> -ERROR_EXCEPTION</H3> -<PRE> -public static final java.lang.String <B>ERROR_EXCEPTION</B></PRE> -<DL> -<DD>The name of the request attribute containing the exception thrown causing - the error handler to be called (value is - "javax.servlet.error.exception"). This attribute is only available to - error handling servlets and only if an exception has been thrown causing - error handling. - <p> - The type of the attribute value is <code>java.lang.Throwable</code>. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.sling.api.SlingConstants.ERROR_EXCEPTION">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="ERROR_EXCEPTION_TYPE"><!-- --></A><H3> -ERROR_EXCEPTION_TYPE</H3> -<PRE> -public static final java.lang.String <B>ERROR_EXCEPTION_TYPE</B></PRE> -<DL> -<DD>The name of the request attribute containing the fully qualified class - name of the exception thrown causing the error handler to be called - (value is "javax.servlet.error.exception_type"). This attribute is only - available to error handling servlets and only if an exception has been - thrown causing error handling. This attribute is present for backwards - compatibility only. Error handling servlet implementors are advised to - use the <A HREF="../../../../org/apache/sling/api/SlingConstants.html#ERROR_EXCEPTION"><CODE>Throwable</CODE></A> itself. - <p> - The type of the attribute value is <code>java.lang.String</code>. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.sling.api.SlingConstants.ERROR_EXCEPTION_TYPE">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="ERROR_MESSAGE"><!-- --></A><H3> -ERROR_MESSAGE</H3> -<PRE> -public static final java.lang.String <B>ERROR_MESSAGE</B></PRE> -<DL> -<DD>The name of the request attribute containing the message of the error - situation (value is "javax.servlet.error.message"). If an exception - caused error handling, this is the exceptions message from - <code>Throwable.getMessage()</code>. If error handling is caused by a - call to one of the <code>SlingHttpServletResponse.sendError</code> - methods, this attribute contains the optional message. - <p> - The type of the attribute value is <code>java.lang.String</code>. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.sling.api.SlingConstants.ERROR_MESSAGE">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="ERROR_REQUEST_URI"><!-- --></A><H3> -ERROR_REQUEST_URI</H3> -<PRE> -public static final java.lang.String <B>ERROR_REQUEST_URI</B></PRE> -<DL> -<DD>The name of the request attribute containing the URL requested by the - client during whose processing the error handling was caused (value is - "javax.servlet.error.request_uri"). This property is retrieved calling - the <code>SlingHttpServletRequest.getRequestURI()</code> method. - <p> - The type of the attribute value is <code>java.lang.String</code>. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.sling.api.SlingConstants.ERROR_REQUEST_URI">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="ERROR_SERVLET_NAME"><!-- --></A><H3> -ERROR_SERVLET_NAME</H3> -<PRE> -public static final java.lang.String <B>ERROR_SERVLET_NAME</B></PRE> -<DL> -<DD>The name of the request attribute containing the name of the servlet - which caused the error handling (value is - "javax.servlet.error.servlet_name"). - <p> - The type of the attribute value is <code>java.lang.String</code>. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.sling.api.SlingConstants.ERROR_SERVLET_NAME">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="ERROR_STATUS"><!-- --></A><H3> -ERROR_STATUS</H3> -<PRE> -public static final java.lang.String <B>ERROR_STATUS</B></PRE> -<DL> -<DD>The name of the request attribute containing the status code sent to the - client (value is "javax.servlet.error.status_code"). Error handling - servlets may set this status code on their response to the client or they - may choose to set another status code. For example a handler for - NOT_FOUND status (404) may opt to redirect to a new location and thus not - set the 404 status but a MOVED_PERMANENTLY (301) status. If this - attribute is not set and the error handler is not configured to set its - own status code anyway, a default value of INTERNAL_SERVER_ERROR (500) - should be sent. - <p> - The type of the attribute value is <code>java.lang.Integer</code>. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.sling.api.SlingConstants.ERROR_STATUS">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="SlingConstants()"><!-- --></A><H3> -SlingConstants</H3> -<PRE> -public <B>SlingConstants</B>()</PRE> -<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/SlingConstants.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/SlingException.html" title="class in org.apache.sling.api"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../index.html?org/apache/sling/api/SlingConstants.html" target="_top"><B>FRAMES</B></A> - <A HREF="SlingConstants.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> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#methods_inherited_from_class_java.lang.Object">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> | 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/f2bd90f5/assets/apidocs/sling5/org/apache/sling/api/SlingException.html ---------------------------------------------------------------------- diff --git a/assets/apidocs/sling5/org/apache/sling/api/SlingException.html b/assets/apidocs/sling5/org/apache/sling/api/SlingException.html deleted file mode 100644 index c10c642..0000000 --- a/assets/apidocs/sling5/org/apache/sling/api/SlingException.html +++ /dev/null @@ -1,339 +0,0 @@ -<!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> -SlingException (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="SlingException (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/SlingException.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/SlingConstants.html" title="class in org.apache.sling.api"><B>PREV CLASS</B></A> - <A HREF="../../../../org/apache/sling/api/SlingHttpServletRequest.html" title="interface in org.apache.sling.api"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../index.html?org/apache/sling/api/SlingException.html" target="_top"><B>FRAMES</B></A> - <A HREF="SlingException.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</FONT> -<BR> -Class SlingException</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 "><B>org.apache.sling.api.SlingException</B> -</PRE> -<DL> -<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD> -</DL> -<DL> -<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/sling/api/scripting/InvalidServiceFilterSyntaxException.html" title="class in org.apache.sling.api.scripting">InvalidServiceFilterSyntaxException</A>, <A HREF="../../../../org/apache/sling/engine/auth/NoAuthenticationHandlerException.html" title="class in org.apache.sling.engine.auth">NoAuthenticationHandlerException</A>, <A HREF="../../../../org/apache/sling/api/resource/QuerySyntaxException.html" title="class in org.apache.sling.api.resource">QuerySyntaxException</A>, <A HREF="../../../../org/apache/sling/api/request/RecursionTooDeepException.html" title="class in org.apache.sling.api.request">RecursionTooDeepException</A>, <A HREF="../../../../org/apache/sling/api/resource/ResourceNotFoundException.html" title="class in org.apache.sling.api.resource">ResourceNotFoundException</A>, <A HREF="../../../../org/apache/sling/api/scripting/ScriptEvaluationException.html" title="class in org.apache.sling.api.scripting ">ScriptEvaluationException</A>, <A HREF="../../../../org/apache/sling/api/SlingIOException.html" title="class in org.apache.sling.api">SlingIOException</A>, <A HREF="../../../../org/apache/sling/api/SlingServletException.html" title="class in org.apache.sling.api">SlingServletException</A>, <A HREF="../../../../org/apache/sling/api/request/TooManyCallsException.html" title="class in org.apache.sling.api.request">TooManyCallsException</A></DD> -</DL> -<HR> -<DL> -<DT><PRE>public class <B>SlingException</B><DT>extends java.lang.RuntimeException</DL> -</PRE> - -<P> -The <code>SlingException</code> is the base exception used throughout the - Sling API. This exception should only be thrown if there is no more specific - exception defined in the Sling API for the cause and if a cause can be - supplied. Otherwise the more specific exception must be used. - <p> - The <code>SlingException</code> is a <code>RuntimeException</code> - because this exception is not intended to be caught by client code. Rather - this exception (and extensions thereof) should be passed through up to the - actual Sling error and exception handling. -<P> - -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#org.apache.sling.api.SlingException">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 ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>protected </CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/sling/api/SlingException.html#SlingException()">SlingException</A></B>()</CODE> - -<BR> - Constructs a new Sling exception.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>protected </CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/sling/api/SlingException.html#SlingException(java.lang.String)">SlingException</A></B>(java.lang.String text)</CODE> - -<BR> - Constructs a new Sling exception with the given text.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> </CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/sling/api/SlingException.html#SlingException(java.lang.String, java.lang.Throwable)">SlingException</A></B>(java.lang.String text, - java.lang.Throwable cause)</CODE> - -<BR> - Constructs a new Sling exception when the Servlet needs to do the - following: - - throw an exception - include the "root cause" exception - include a description message - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>protected </CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/sling/api/SlingException.html#SlingException(java.lang.Throwable)">SlingException</A></B>(java.lang.Throwable cause)</CODE> - -<BR> - Constructs a new Sling exception when the Servlet needs to throw an - exception.</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="SlingException()"><!-- --></A><H3> -SlingException</H3> -<PRE> -protected <B>SlingException</B>()</PRE> -<DL> -<DD>Constructs a new Sling exception. -<P> -</DL> -<HR> - -<A NAME="SlingException(java.lang.String)"><!-- --></A><H3> -SlingException</H3> -<PRE> -protected <B>SlingException</B>(java.lang.String text)</PRE> -<DL> -<DD>Constructs a new Sling exception with the given text. The Sling framework - may use the text to write it to a log. -<P> -<DL> -<DT><B>Parameters:</B><DD><CODE>text</CODE> - the exception text</DL> -</DL> -<HR> - -<A NAME="SlingException(java.lang.String, java.lang.Throwable)"><!-- --></A><H3> -SlingException</H3> -<PRE> -public <B>SlingException</B>(java.lang.String text, - java.lang.Throwable cause)</PRE> -<DL> -<DD>Constructs a new Sling exception when the Servlet needs to do the - following: - <ul> - <li>throw an exception - <li>include the "root cause" exception - <li>include a description message - </ul> -<P> -<DL> -<DT><B>Parameters:</B><DD><CODE>text</CODE> - the exception text<DD><CODE>cause</CODE> - the root cause</DL> -</DL> -<HR> - -<A NAME="SlingException(java.lang.Throwable)"><!-- --></A><H3> -SlingException</H3> -<PRE> -protected <B>SlingException</B>(java.lang.Throwable cause)</PRE> -<DL> -<DD>Constructs a new Sling exception when the Servlet needs to throw an - exception. The exception's message is based on the localized message of - the underlying exception. -<P> -<DL> -<DT><B>Parameters:</B><DD><CODE>cause</CODE> - the root cause</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/SlingException.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/SlingConstants.html" title="class in org.apache.sling.api"><B>PREV CLASS</B></A> - <A HREF="../../../../org/apache/sling/api/SlingHttpServletRequest.html" title="interface in org.apache.sling.api"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../index.html?org/apache/sling/api/SlingException.html" target="_top"><B>FRAMES</B></A> - <A HREF="SlingException.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/f2bd90f5/assets/apidocs/sling5/org/apache/sling/api/SlingHttpServletRequest.html ---------------------------------------------------------------------- diff --git a/assets/apidocs/sling5/org/apache/sling/api/SlingHttpServletRequest.html b/assets/apidocs/sling5/org/apache/sling/api/SlingHttpServletRequest.html deleted file mode 100644 index e4c120c..0000000 --- a/assets/apidocs/sling5/org/apache/sling/api/SlingHttpServletRequest.html +++ /dev/null @@ -1,717 +0,0 @@ -<!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> -SlingHttpServletRequest (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="SlingHttpServletRequest (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/SlingHttpServletRequest.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/SlingException.html" title="class in org.apache.sling.api"><B>PREV CLASS</B></A> - <A HREF="../../../../org/apache/sling/api/SlingHttpServletResponse.html" title="interface in org.apache.sling.api"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../index.html?org/apache/sling/api/SlingHttpServletRequest.html" target="_top"><B>FRAMES</B></A> - <A HREF="SlingHttpServletRequest.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</FONT> -<BR> -Interface SlingHttpServletRequest</H2> -<DL> -<DT><B>All Superinterfaces:</B> <DD>javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest</DD> -</DL> -<DL> -<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/sling/commons/testing/sling/MockSlingHttpServletRequest.html" title="class in org.apache.sling.commons.testing.sling">MockSlingHttpServletRequest</A>, <A HREF="../../../../org/apache/sling/api/wrappers/SlingHttpServletRequestWrapper.html" title="class in org.apache.sling.api.wrappers">SlingHttpServletRequestWrapper</A></DD> -</DL> -<HR> -<DL> -<DT><PRE>public interface <B>SlingHttpServletRequest</B><DT>extends javax.servlet.http.HttpServletRequest</DL> -</PRE> - -<P> -The <code>SlingHttpServletRequest</code> defines the interface to provide - client request information to a servlet. - <p> - <b>Request Parameters</b> Generally request parameters are transmitted as - part of the URL string such as <code>GET /some/path?<b>param=value</b></code> - or as request data of content type <i>application/x-www-form-urlencoded</i> - or <i>multipart/form-data</i>. The Sling Framework must decode parameters - transferred as request data and make them available through the various - parameter accessor methods. Generally parameters transferred as - <i>multipart/form-data</i> will be accessed by one of the methods returning - <A HREF="../../../../org/apache/sling/api/request/RequestParameter.html" title="interface in org.apache.sling.api.request"><CODE>RequestParameter</CODE></A> instances. - <p> - In any case, the <CODE>ServletRequest.getReader()</CODE> and <CODE>ServletRequest.getInputStream()</CODE> methods - will throw an <code>IllegalStateException</code> if called after any - methods returning request parameters if the request content type is either - <i>application/x-www-form-urlencoded</i> or <i>multipart/form-data</i> - because the request data has already been processed. -<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> -</TABLE> - <A NAME="fields_inherited_from_class_javax.servlet.http.HttpServletRequest"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Fields inherited from interface javax.servlet.http.HttpServletRequest</B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE>BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH</CODE></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> javax.servlet.http.Cookie</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/sling/api/SlingHttpServletRequest.html#getCookie(java.lang.String)">getCookie</A></B>(java.lang.String name)</CODE> - -<BR> - Returns the named cookie from the HTTP request or <code>null</code> if - no such cookie exists in the request.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> javax.servlet.RequestDispatcher</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/sling/api/SlingHttpServletRequest.html#getRequestDispatcher(org.apache.sling.api.resource.Resource)">getRequestDispatcher</A></B>(<A HREF="../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A> resource)</CODE> - -<BR> - Same as <A HREF="../../../../org/apache/sling/api/SlingHttpServletRequest.html#getRequestDispatcher(org.apache.sling.api.resource.Resource, org.apache.sling.api.request.RequestDispatcherOptions)"><CODE>getRequestDispatcher(Resource,RequestDispatcherOptions)</CODE></A> - but using empty options.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> javax.servlet.RequestDispatcher</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/sling/api/SlingHttpServletRequest.html#getRequestDispatcher(org.apache.sling.api.resource.Resource, org.apache.sling.api.request.RequestDispatcherOptions)">getRequestDispatcher</A></B>(<A HREF="../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A> resource, - <A HREF="../../../../org/apache/sling/api/request/RequestDispatcherOptions.html" title="class in org.apache.sling.api.request">RequestDispatcherOptions</A> options)</CODE> - -<BR> - Returns a <code>RequestDispatcher</code> object that acts as a wrapper - for the resource located at the given resource.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> javax.servlet.RequestDispatcher</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/sling/api/SlingHttpServletRequest.html#getRequestDispatcher(java.lang.String, org.apache.sling.api.request.RequestDispatcherOptions)">getRequestDispatcher</A></B>(java.lang.String path, - <A HREF="../../../../org/apache/sling/api/request/RequestDispatcherOptions.html" title="class in org.apache.sling.api.request">RequestDispatcherOptions</A> options)</CODE> - -<BR> - Returns a <code>RequestDispatcher</code> object that acts as a wrapper - for the resource 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/request/RequestParameter.html" title="interface in org.apache.sling.api.request">RequestParameter</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/sling/api/SlingHttpServletRequest.html#getRequestParameter(java.lang.String)">getRequestParameter</A></B>(java.lang.String name)</CODE> - -<BR> - Returns the value of a request parameter as a <A HREF="../../../../org/apache/sling/api/request/RequestParameter.html" title="interface in org.apache.sling.api.request"><CODE>RequestParameter</CODE></A>, - or <code>null</code> if the parameter does not exist.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../../org/apache/sling/api/request/RequestParameterMap.html" title="interface in org.apache.sling.api.request">RequestParameterMap</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/sling/api/SlingHttpServletRequest.html#getRequestParameterMap()">getRequestParameterMap</A></B>()</CODE> - -<BR> - Returns a <code>Map</code> of the parameters of this request.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../../org/apache/sling/api/request/RequestParameter.html" title="interface in org.apache.sling.api.request">RequestParameter</A>[]</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/sling/api/SlingHttpServletRequest.html#getRequestParameters(java.lang.String)">getRequestParameters</A></B>(java.lang.String name)</CODE> - -<BR> - Returns an array of <A HREF="../../../../org/apache/sling/api/request/RequestParameter.html" title="interface in org.apache.sling.api.request"><CODE>RequestParameter</CODE></A> objects containing all of - the values the given request parameter has, or <code>null</code> if the - parameter does not exist.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../../org/apache/sling/api/request/RequestPathInfo.html" title="interface in org.apache.sling.api.request">RequestPathInfo</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/sling/api/SlingHttpServletRequest.html#getRequestPathInfo()">getRequestPathInfo</A></B>()</CODE> - -<BR> - Returns the <A HREF="../../../../org/apache/sling/api/request/RequestPathInfo.html" title="interface in org.apache.sling.api.request"><CODE>RequestPathInfo</CODE></A> pertaining to this request.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../../org/apache/sling/api/request/RequestProgressTracker.html" title="interface in org.apache.sling.api.request">RequestProgressTracker</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/sling/api/SlingHttpServletRequest.html#getRequestProgressTracker()">getRequestProgressTracker</A></B>()</CODE> - -<BR> - Returns the <A HREF="../../../../org/apache/sling/api/request/RequestProgressTracker.html" title="interface in org.apache.sling.api.request"><CODE>RequestProgressTracker</CODE></A> of this request.</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/SlingHttpServletRequest.html#getResource()">getResource</A></B>()</CODE> - -<BR> - Returns the <A HREF="../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A> object on whose behalf the servlet acts.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> java.util.ResourceBundle</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/sling/api/SlingHttpServletRequest.html#getResourceBundle(java.util.Locale)">getResourceBundle</A></B>(java.util.Locale locale)</CODE> - -<BR> - Returns the resource bundle for the given locale.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> java.util.ResourceBundle</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/sling/api/SlingHttpServletRequest.html#getResourceBundle(java.lang.String, java.util.Locale)">getResourceBundle</A></B>(java.lang.String baseName, - java.util.Locale locale)</CODE> - -<BR> - Returns the resource bundle of the given base name for the given locale.</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/ResourceResolver.html" title="interface in org.apache.sling.api.resource">ResourceResolver</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/sling/api/SlingHttpServletRequest.html#getResourceResolver()">getResourceResolver</A></B>()</CODE> - -<BR> - Returns the <A HREF="../../../../org/apache/sling/api/resource/ResourceResolver.html" title="interface in org.apache.sling.api.resource"><CODE>ResourceResolver</CODE></A> which resolved the - <A HREF="../../../../org/apache/sling/api/SlingHttpServletRequest.html#getResource()"><CODE>resource</CODE></A> of this request.</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/SlingHttpServletRequest.html#getResponseContentType()">getResponseContentType</A></B>()</CODE> - -<BR> - Returns the framework preferred content type for the response.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> java.util.Enumeration<java.lang.String></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/sling/api/SlingHttpServletRequest.html#getResponseContentTypes()">getResponseContentTypes</A></B>()</CODE> - -<BR> - Gets a list of content types which the framework accepts for the - response.</TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_javax.servlet.http.HttpServletRequest"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from interface javax.servlet.http.HttpServletRequest</B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE>getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole</CODE></TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_javax.servlet.ServletRequest"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from interface javax.servlet.ServletRequest</B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE>getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding</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="getResource()"><!-- --></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>()</PRE> -<DL> -<DD>Returns the <A HREF="../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A> object on whose behalf the servlet acts. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The <code>Resource</code> object of this request.</DL> -</DD> -</DL> -<HR> - -<A NAME="getResourceResolver()"><!-- --></A><H3> -getResourceResolver</H3> -<PRE> -<A HREF="../../../../org/apache/sling/api/resource/ResourceResolver.html" title="interface in org.apache.sling.api.resource">ResourceResolver</A> <B>getResourceResolver</B>()</PRE> -<DL> -<DD>Returns the <A HREF="../../../../org/apache/sling/api/resource/ResourceResolver.html" title="interface in org.apache.sling.api.resource"><CODE>ResourceResolver</CODE></A> which resolved the - <A HREF="../../../../org/apache/sling/api/SlingHttpServletRequest.html#getResource()"><CODE>resource</CODE></A> of this request. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The resource resolver</DL> -</DD> -</DL> -<HR> - -<A NAME="getRequestPathInfo()"><!-- --></A><H3> -getRequestPathInfo</H3> -<PRE> -<A HREF="../../../../org/apache/sling/api/request/RequestPathInfo.html" title="interface in org.apache.sling.api.request">RequestPathInfo</A> <B>getRequestPathInfo</B>()</PRE> -<DL> -<DD>Returns the <A HREF="../../../../org/apache/sling/api/request/RequestPathInfo.html" title="interface in org.apache.sling.api.request"><CODE>RequestPathInfo</CODE></A> pertaining to this request. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the request path info.</DL> -</DD> -</DL> -<HR> - -<A NAME="getRequestParameter(java.lang.String)"><!-- --></A><H3> -getRequestParameter</H3> -<PRE> -<A HREF="../../../../org/apache/sling/api/request/RequestParameter.html" title="interface in org.apache.sling.api.request">RequestParameter</A> <B>getRequestParameter</B>(java.lang.String name)</PRE> -<DL> -<DD>Returns the value of a request parameter as a <A HREF="../../../../org/apache/sling/api/request/RequestParameter.html" title="interface in org.apache.sling.api.request"><CODE>RequestParameter</CODE></A>, - or <code>null</code> if the parameter does not exist. - <p> - This method should only be used if the parameter has only one value. If - the parameter might have more than one value, use - <A HREF="../../../../org/apache/sling/api/SlingHttpServletRequest.html#getRequestParameters(java.lang.String)"><CODE>getRequestParameters(String)</CODE></A>. - <p> - If this method is used with a multivalued parameter, the value returned - is equal to the first value in the array returned by - <code>getRequestParameters</code>. - <p> - This method is a shortcut for - <code>getRequestParameterMap().getValue(String)</code>. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>name</CODE> - a <code>String</code> specifying the name of the parameter -<DT><B>Returns:</B><DD>a <A HREF="../../../../org/apache/sling/api/request/RequestParameter.html" title="interface in org.apache.sling.api.request"><CODE>RequestParameter</CODE></A> representing the single value of the - parameter -<DT><B>Throws:</B> -<DD><CODE>java.lang.IllegalArgumentException</CODE> - if name is <code>null</code>.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/sling/api/SlingHttpServletRequest.html#getRequestParameters(java.lang.String)"><CODE>getRequestParameters(String)</CODE></A>, -<A HREF="../../../../org/apache/sling/api/request/RequestParameterMap.html#getValue(java.lang.String)"><CODE>RequestParameterMap.getValue(String)</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="getRequestParameters(java.lang.String)"><!-- --></A><H3> -getRequestParameters</H3> -<PRE> -<A HREF="../../../../org/apache/sling/api/request/RequestParameter.html" title="interface in org.apache.sling.api.request">RequestParameter</A>[] <B>getRequestParameters</B>(java.lang.String name)</PRE> -<DL> -<DD>Returns an array of <A HREF="../../../../org/apache/sling/api/request/RequestParameter.html" title="interface in org.apache.sling.api.request"><CODE>RequestParameter</CODE></A> objects containing all of - the values the given request parameter has, or <code>null</code> if the - parameter does not exist. - <p> - If the parameter has a single value, the array has a length of 1. - <p> - This method is a shortcut for - <code>getRequestParameterMap().getValues(String)</code>. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>name</CODE> - a <code>String</code> containing the name of the parameter - the value of which is requested -<DT><B>Returns:</B><DD>an array of <A HREF="../../../../org/apache/sling/api/request/RequestParameter.html" title="interface in org.apache.sling.api.request"><CODE>RequestParameter</CODE></A> objects containing the - parameter values. -<DT><B>Throws:</B> -<DD><CODE>java.lang.IllegalArgumentException</CODE> - if name is <code>null</code>.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/sling/api/SlingHttpServletRequest.html#getRequestParameter(java.lang.String)"><CODE>getRequestParameter(String)</CODE></A>, -<A HREF="../../../../org/apache/sling/api/request/RequestParameterMap.html#getValues(java.lang.String)"><CODE>RequestParameterMap.getValues(String)</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="getRequestParameterMap()"><!-- --></A><H3> -getRequestParameterMap</H3> -<PRE> -<A HREF="../../../../org/apache/sling/api/request/RequestParameterMap.html" title="interface in org.apache.sling.api.request">RequestParameterMap</A> <B>getRequestParameterMap</B>()</PRE> -<DL> -<DD>Returns a <code>Map</code> of the parameters of this request. - <p> - The values in the returned <code>Map</code> are from type - <A HREF="../../../../org/apache/sling/api/request/RequestParameter.html" title="interface in org.apache.sling.api.request"><CODE>RequestParameter</CODE></A> array (<code>RequestParameter[]</code>). - <p> - If no parameters exist this method returns an empty <code>Map</code>. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>an immutable <code>Map</code> containing parameter names as - keys and parameter values as map values, or an empty - <code>Map</code> if no parameters exist. The keys in the - parameter map are of type String. The values in the parameter map - are of type <A HREF="../../../../org/apache/sling/api/request/RequestParameter.html" title="interface in org.apache.sling.api.request"><CODE>RequestParameter</CODE></A> array (<code>RequestParameter[]</code>).</DL> -</DD> -</DL> -<HR> - -<A NAME="getRequestDispatcher(java.lang.String, org.apache.sling.api.request.RequestDispatcherOptions)"><!-- --></A><H3> -getRequestDispatcher</H3> -<PRE> -javax.servlet.RequestDispatcher <B>getRequestDispatcher</B>(java.lang.String path, - <A HREF="../../../../org/apache/sling/api/request/RequestDispatcherOptions.html" title="class in org.apache.sling.api.request">RequestDispatcherOptions</A> options)</PRE> -<DL> -<DD>Returns a <code>RequestDispatcher</code> object that acts as a wrapper - for the resource located at the given path. A - <code>RequestDispatcher</code> object can be used to include the - resource in a response. - <p> - Returns <code>null</code> if a <code>RequestDispatcher</code> cannot - be returned for any reason. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>path</CODE> - a <code>String</code> specifying the pathname to the - resource. If it is relative, it must be relative against the - current servlet.<DD><CODE>options</CODE> - influence the rendering of the included Resource -<DT><B>Returns:</B><DD>a <code>RequestDispatcher</code> object that acts as a wrapper - for the <code>resource</code> or <code>null</code> if an - error occurs preparing the dispatcher.</DL> -</DD> -</DL> -<HR> - -<A NAME="getRequestDispatcher(org.apache.sling.api.resource.Resource, org.apache.sling.api.request.RequestDispatcherOptions)"><!-- --></A><H3> -getRequestDispatcher</H3> -<PRE> -javax.servlet.RequestDispatcher <B>getRequestDispatcher</B>(<A HREF="../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A> resource, - <A HREF="../../../../org/apache/sling/api/request/RequestDispatcherOptions.html" title="class in org.apache.sling.api.request">RequestDispatcherOptions</A> options)</PRE> -<DL> -<DD>Returns a <code>RequestDispatcher</code> object that acts as a wrapper - for the resource located at the given resource. A - <code>RequestDispatcher</code> object can be used to include the - resource in a response. - <p> - Returns <code>null</code> if a <code>RequestDispatcher</code> cannot - be returned for any reason. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>resource</CODE> - The <A HREF="../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A> instance whose response content may - be included by the returned dispatcher.<DD><CODE>options</CODE> - influence the rendering of the included Resource -<DT><B>Returns:</B><DD>a <code>RequestDispatcher</code> object that acts as a wrapper - for the <code>resource</code> or <code>null</code> if an - error occurs preparing the dispatcher.</DL> -</DD> -</DL> -<HR> - -<A NAME="getRequestDispatcher(org.apache.sling.api.resource.Resource)"><!-- --></A><H3> -getRequestDispatcher</H3> -<PRE> -javax.servlet.RequestDispatcher <B>getRequestDispatcher</B>(<A HREF="../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A> resource)</PRE> -<DL> -<DD>Same as <A HREF="../../../../org/apache/sling/api/SlingHttpServletRequest.html#getRequestDispatcher(org.apache.sling.api.resource.Resource, org.apache.sling.api.request.RequestDispatcherOptions)"><CODE>getRequestDispatcher(Resource,RequestDispatcherOptions)</CODE></A> - but using empty options. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="getCookie(java.lang.String)"><!-- --></A><H3> -getCookie</H3> -<PRE> -javax.servlet.http.Cookie <B>getCookie</B>(java.lang.String name)</PRE> -<DL> -<DD>Returns the named cookie from the HTTP request or <code>null</code> if - no such cookie exists in the request. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the cookie to return. -<DT><B>Returns:</B><DD>The named cookie or <code>null</code> if no such cookie exists.</DL> -</DD> -</DL> -<HR> - -<A NAME="getResponseContentType()"><!-- --></A><H3> -getResponseContentType</H3> -<PRE> -java.lang.String <B>getResponseContentType</B>()</PRE> -<DL> -<DD>Returns the framework preferred content type for the response. The - content type only includes the MIME type, not the character set. - <p> - For included resources this method will returned the same string as - returned by the <code>ServletResponse.getContentType()</code> without - the character set. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>preferred MIME type of the response</DL> -</DD> -</DL> -<HR> - -<A NAME="getResponseContentTypes()"><!-- --></A><H3> -getResponseContentTypes</H3> -<PRE> -java.util.Enumeration<java.lang.String> <B>getResponseContentTypes</B>()</PRE> -<DL> -<DD>Gets a list of content types which the framework accepts for the - response. This list is ordered with the most preferable types listed - first. The content type only includes the MIME type, not the character - set. - <p> - For included resources this method will returned an enumeration - containing a single entry which is the same string as returned by the - <code>ServletResponse.getContentType()</code> without the character - set. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>ordered list of MIME types for the response</DL> -</DD> -</DL> -<HR> - -<A NAME="getResourceBundle(java.util.Locale)"><!-- --></A><H3> -getResourceBundle</H3> -<PRE> -java.util.ResourceBundle <B>getResourceBundle</B>(java.util.Locale locale)</PRE> -<DL> -<DD>Returns the resource bundle for the given locale. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>locale</CODE> - the locale for which to retrieve the resource bundle. If - this is <code>null</code>, the locale returned by - <CODE>ServletRequest.getLocale()</CODE> is used to select the resource bundle. -<DT><B>Returns:</B><DD>the resource bundle for the given locale</DL> -</DD> -</DL> -<HR> - -<A NAME="getResourceBundle(java.lang.String, java.util.Locale)"><!-- --></A><H3> -getResourceBundle</H3> -<PRE> -java.util.ResourceBundle <B>getResourceBundle</B>(java.lang.String baseName, - java.util.Locale locale)</PRE> -<DL> -<DD>Returns the resource bundle of the given base name for the given locale. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>baseName</CODE> - The base name of the resource bundle to returned. If this - parameter is <code>null</code>, the same resource bundle - must be returned as if the <A HREF="../../../../org/apache/sling/api/SlingHttpServletRequest.html#getResourceBundle(java.util.Locale)"><CODE>getResourceBundle(Locale)</CODE></A> - method is called.<DD><CODE>locale</CODE> - the locale for which to retrieve the resource bundle. If - this is <code>null</code>, the locale returned by - <CODE>ServletRequest.getLocale()</CODE> is used to select the resource bundle. -<DT><B>Returns:</B><DD>the resource bundle for the given locale</DL> -</DD> -</DL> -<HR> - -<A NAME="getRequestProgressTracker()"><!-- --></A><H3> -getRequestProgressTracker</H3> -<PRE> -<A HREF="../../../../org/apache/sling/api/request/RequestProgressTracker.html" title="interface in org.apache.sling.api.request">RequestProgressTracker</A> <B>getRequestProgressTracker</B>()</PRE> -<DL> -<DD>Returns the <A HREF="../../../../org/apache/sling/api/request/RequestProgressTracker.html" title="interface in org.apache.sling.api.request"><CODE>RequestProgressTracker</CODE></A> of this request. -<P> -<DD><DL> -</DL> -</DD> -<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/SlingHttpServletRequest.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/SlingException.html" title="class in org.apache.sling.api"><B>PREV CLASS</B></A> - <A HREF="../../../../org/apache/sling/api/SlingHttpServletResponse.html" title="interface in org.apache.sling.api"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../index.html?org/apache/sling/api/SlingHttpServletRequest.html" target="_top"><B>FRAMES</B></A> - <A HREF="SlingHttpServletRequest.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>
