http://git-wip-us.apache.org/repos/asf/sling-site/blob/757222a6/assets/apidocs/sling5/org/apache/sling/api/servlets/HtmlResponse.html ---------------------------------------------------------------------- diff --git a/assets/apidocs/sling5/org/apache/sling/api/servlets/HtmlResponse.html b/assets/apidocs/sling5/org/apache/sling/api/servlets/HtmlResponse.html new file mode 100644 index 0000000..33f73ba --- /dev/null +++ b/assets/apidocs/sling5/org/apache/sling/api/servlets/HtmlResponse.html @@ -0,0 +1,1102 @@ +<!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> +HtmlResponse (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="HtmlResponse (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/HtmlResponse.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/servlets/HttpConstants.html" title="class in org.apache.sling.api.servlets"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/sling/api/servlets/HtmlResponse.html" target="_top"><B>FRAMES</B></A> + <A HREF="HtmlResponse.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="#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.servlets</FONT> +<BR> +Class HtmlResponse</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.sling.api.servlets.HtmlResponse</B> +</PRE> +<HR> +<DL> +<DT><PRE>public class <B>HtmlResponse</B><DT>extends java.lang.Object</DL> +</PRE> + +<P> +Generator for a HTML status response that displays the changes made in a post + request. see <a href="HtmlResponse.html">HtmlResponse.html</a> for the + format. +<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/servlets/HtmlResponse.html#PN_CHANGE_LOG">PN_CHANGE_LOG</A></B></CODE> + +<BR> + human readable changelog</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/servlets/HtmlResponse.html#PN_ERROR">PN_ERROR</A></B></CODE> + +<BR> + The Throwable caught while processing the request.</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/servlets/HtmlResponse.html#PN_IS_CREATED">PN_IS_CREATED</A></B></CODE> + +<BR> + Indicating whether request processing created new data.</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/servlets/HtmlResponse.html#PN_LOCATION">PN_LOCATION</A></B></CODE> + +<BR> + externally mapped location url of the modified path</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/servlets/HtmlResponse.html#PN_PARENT_LOCATION">PN_PARENT_LOCATION</A></B></CODE> + +<BR> + externally mapped location url of the parent of the modified path</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/servlets/HtmlResponse.html#PN_PATH">PN_PATH</A></B></CODE> + +<BR> + the path of the modified item. this is usually the addressed resource or + in case of a creation request (eg: /foo/*) the path of the newly created + node.</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/servlets/HtmlResponse.html#PN_REFERER">PN_REFERER</A></B></CODE> + +<BR> + the referrer of the request</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/servlets/HtmlResponse.html#PN_STATUS_CODE">PN_STATUS_CODE</A></B></CODE> + +<BR> + status code. more or less http response status codes</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/servlets/HtmlResponse.html#PN_STATUS_MESSAGE">PN_STATUS_MESSAGE</A></B></CODE> + +<BR> + some human readable status 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/servlets/HtmlResponse.html#PN_TITLE">PN_TITLE</A></B></CODE> + +<BR> + some human readable title like: 200 Created /foo/bar</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/servlets/HtmlResponse.html#HtmlResponse()">HtmlResponse</A></B>()</CODE> + +<BR> + Creates a new html response with default settings, which is + <code>null</code> for almost all properties except the + <A HREF="../../../../../org/apache/sling/api/servlets/HtmlResponse.html#isCreateRequest()"><CODE>isCreateRequest()</CODE></A> which defaults to <code>false</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> java.lang.Throwable</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/servlets/HtmlResponse.html#getError()">getError</A></B>()</CODE> + +<BR> + Returns any recorded error or <code>null</code></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/servlets/HtmlResponse.html#getLocation()">getLocation</A></B>()</CODE> + +<BR> + Returns the location of the modification. this is the externalized form + of the current path.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/servlets/HtmlResponse.html#getParentLocation()">getParentLocation</A></B>()</CODE> + +<BR> + Returns the parent location of the modification. this is the externalized + form of the parent node of the current path.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/servlets/HtmlResponse.html#getPath()">getPath</A></B>()</CODE> + +<BR> + Returns the absolute path of the item upon which the request operated.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Object</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/servlets/HtmlResponse.html#getProperty(java.lang.String)">getProperty</A></B>(java.lang.String name)</CODE> + +<BR> + Returns the generic response property with the given name and type or + <code>null</code> if no such property exists.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> +<TR ALIGN="right" VALIGN=""> +<TD NOWRAP><FONT SIZE="-1"> +<CODE><Type> Type</CODE></FONT></TD> +</TR> +</TABLE> +</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/servlets/HtmlResponse.html#getProperty(java.lang.String, java.lang.Class)">getProperty</A></B>(java.lang.String name, + java.lang.Class<Type> type)</CODE> + +<BR> + Returns the generic response property with the given name and type or + <code>null</code> if no such property exists or the property is not of + the requested type.</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/servlets/HtmlResponse.html#getReferer()">getReferer</A></B>()</CODE> + +<BR> + Returns the referer as from the 'referer' request header.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/servlets/HtmlResponse.html#getStatusCode()">getStatusCode</A></B>()</CODE> + +<BR> + Returns the status code of this instance.</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/servlets/HtmlResponse.html#getStatusMessage()">getStatusMessage</A></B>()</CODE> + +<BR> + </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/servlets/HtmlResponse.html#isCreateRequest()">isCreateRequest</A></B>()</CODE> + +<BR> + Returns <code>true</code> if this was a create request.</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/servlets/HtmlResponse.html#isSuccessful()">isSuccessful</A></B>()</CODE> + +<BR> + Returns <code>true</code> if no <A HREF="../../../../../org/apache/sling/api/servlets/HtmlResponse.html#getError()"><CODE>error</CODE></A> is set and if + the <A HREF="../../../../../org/apache/sling/api/servlets/HtmlResponse.html#getStatusCode()"><CODE>status code</CODE></A> is one of the 2xx codes.</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/servlets/HtmlResponse.html#onChange(java.lang.String, java.lang.String...)">onChange</A></B>(java.lang.String type, + java.lang.String... arguments)</CODE> + +<BR> + Records a generic change of the given <code>type</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/servlets/HtmlResponse.html#onCopied(java.lang.String, java.lang.String)">onCopied</A></B>(java.lang.String srcPath, + java.lang.String dstPath)</CODE> + +<BR> + Records a 'copied' change.</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/servlets/HtmlResponse.html#onCreated(java.lang.String)">onCreated</A></B>(java.lang.String path)</CODE> + +<BR> + Records a 'created' change</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/servlets/HtmlResponse.html#onDeleted(java.lang.String)">onDeleted</A></B>(java.lang.String path)</CODE> + +<BR> + Records a 'deleted' change</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/servlets/HtmlResponse.html#onModified(java.lang.String)">onModified</A></B>(java.lang.String path)</CODE> + +<BR> + Records a 'modified' change</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/servlets/HtmlResponse.html#onMoved(java.lang.String, java.lang.String)">onMoved</A></B>(java.lang.String srcPath, + java.lang.String dstPath)</CODE> + +<BR> + Records a 'moved' change.</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/servlets/HtmlResponse.html#send(javax.servlet.http.HttpServletResponse, boolean)">send</A></B>(javax.servlet.http.HttpServletResponse response, + boolean setStatus)</CODE> + +<BR> + Writes the response to the given writer and replaces all ${var} patterns + by the value of the respective property. if the property is not defined + the pattern is not modified.</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/servlets/HtmlResponse.html#setCreateRequest(boolean)">setCreateRequest</A></B>(boolean isCreateRequest)</CODE> + +<BR> + Sets whether the request was a create request or not.</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/servlets/HtmlResponse.html#setError(java.lang.Throwable)">setError</A></B>(java.lang.Throwable error)</CODE> + +<BR> + </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/servlets/HtmlResponse.html#setLocation(java.lang.String)">setLocation</A></B>(java.lang.String location)</CODE> + +<BR> + </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/servlets/HtmlResponse.html#setParentLocation(java.lang.String)">setParentLocation</A></B>(java.lang.String parentLocation)</CODE> + +<BR> + </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/servlets/HtmlResponse.html#setPath(java.lang.String)">setPath</A></B>(java.lang.String path)</CODE> + +<BR> + Sets the absolute path of the item upon which the request operated.</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/servlets/HtmlResponse.html#setProperty(java.lang.String, java.lang.Object)">setProperty</A></B>(java.lang.String name, + java.lang.Object value)</CODE> + +<BR> + Sets a generic response property with the given</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/servlets/HtmlResponse.html#setReferer(java.lang.String)">setReferer</A></B>(java.lang.String referer)</CODE> + +<BR> + Sets the referer property</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/servlets/HtmlResponse.html#setStatus(int, java.lang.String)">setStatus</A></B>(int code, + java.lang.String message)</CODE> + +<BR> + sets the response status code properties</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/servlets/HtmlResponse.html#setTitle(java.lang.String)">setTitle</A></B>(java.lang.String title)</CODE> + +<BR> + Sets the title of the response message</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, 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="PN_TITLE"><!-- --></A><H3> +PN_TITLE</H3> +<PRE> +public static final java.lang.String <B>PN_TITLE</B></PRE> +<DL> +<DD>some human readable title like: 200 Created /foo/bar +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.servlets.HtmlResponse.PN_TITLE">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="PN_STATUS_CODE"><!-- --></A><H3> +PN_STATUS_CODE</H3> +<PRE> +public static final java.lang.String <B>PN_STATUS_CODE</B></PRE> +<DL> +<DD>status code. more or less http response status codes +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.servlets.HtmlResponse.PN_STATUS_CODE">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="PN_STATUS_MESSAGE"><!-- --></A><H3> +PN_STATUS_MESSAGE</H3> +<PRE> +public static final java.lang.String <B>PN_STATUS_MESSAGE</B></PRE> +<DL> +<DD>some human readable status message +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.servlets.HtmlResponse.PN_STATUS_MESSAGE">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="PN_LOCATION"><!-- --></A><H3> +PN_LOCATION</H3> +<PRE> +public static final java.lang.String <B>PN_LOCATION</B></PRE> +<DL> +<DD>externally mapped location url of the modified path +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.servlets.HtmlResponse.PN_LOCATION">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="PN_PARENT_LOCATION"><!-- --></A><H3> +PN_PARENT_LOCATION</H3> +<PRE> +public static final java.lang.String <B>PN_PARENT_LOCATION</B></PRE> +<DL> +<DD>externally mapped location url of the parent of the modified path +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.servlets.HtmlResponse.PN_PARENT_LOCATION">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="PN_PATH"><!-- --></A><H3> +PN_PATH</H3> +<PRE> +public static final java.lang.String <B>PN_PATH</B></PRE> +<DL> +<DD>the path of the modified item. this is usually the addressed resource or + in case of a creation request (eg: /foo/*) the path of the newly created + node. +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.servlets.HtmlResponse.PN_PATH">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="PN_REFERER"><!-- --></A><H3> +PN_REFERER</H3> +<PRE> +public static final java.lang.String <B>PN_REFERER</B></PRE> +<DL> +<DD>the referrer of the request +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.servlets.HtmlResponse.PN_REFERER">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="PN_IS_CREATED"><!-- --></A><H3> +PN_IS_CREATED</H3> +<PRE> +public static final java.lang.String <B>PN_IS_CREATED</B></PRE> +<DL> +<DD>Indicating whether request processing created new data. This property + is initialized to <code>false</code> and may be changed by calling + the <A HREF="../../../../../org/apache/sling/api/servlets/HtmlResponse.html#setCreateRequest(boolean)"><CODE>setCreateRequest(boolean)</CODE></A> method. +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.servlets.HtmlResponse.PN_IS_CREATED">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="PN_CHANGE_LOG"><!-- --></A><H3> +PN_CHANGE_LOG</H3> +<PRE> +public static final java.lang.String <B>PN_CHANGE_LOG</B></PRE> +<DL> +<DD>human readable changelog +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.servlets.HtmlResponse.PN_CHANGE_LOG">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="PN_ERROR"><!-- --></A><H3> +PN_ERROR</H3> +<PRE> +public static final java.lang.String <B>PN_ERROR</B></PRE> +<DL> +<DD>The Throwable caught while processing the request. This property is not + set unless the <A HREF="../../../../../org/apache/sling/api/servlets/HtmlResponse.html#setError(java.lang.Throwable)"><CODE>setError(Throwable)</CODE></A> method is called. +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.servlets.HtmlResponse.PN_ERROR">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="HtmlResponse()"><!-- --></A><H3> +HtmlResponse</H3> +<PRE> +public <B>HtmlResponse</B>()</PRE> +<DL> +<DD>Creates a new html response with default settings, which is + <code>null</code> for almost all properties except the + <A HREF="../../../../../org/apache/sling/api/servlets/HtmlResponse.html#isCreateRequest()"><CODE>isCreateRequest()</CODE></A> which defaults to <code>false</code>. +<P> +</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="getReferer()"><!-- --></A><H3> +getReferer</H3> +<PRE> +public java.lang.String <B>getReferer</B>()</PRE> +<DL> +<DD>Returns the referer as from the 'referer' request header. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setReferer(java.lang.String)"><!-- --></A><H3> +setReferer</H3> +<PRE> +public void <B>setReferer</B>(java.lang.String referer)</PRE> +<DL> +<DD>Sets the referer property +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getPath()"><!-- --></A><H3> +getPath</H3> +<PRE> +public java.lang.String <B>getPath</B>()</PRE> +<DL> +<DD>Returns the absolute path of the item upon which the request operated. + <p> + If the <A HREF="../../../../../org/apache/sling/api/servlets/HtmlResponse.html#setPath(java.lang.String)"><CODE>setPath(String)</CODE></A> method has not been called yet, this + method returns <code>null</code>. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setPath(java.lang.String)"><!-- --></A><H3> +setPath</H3> +<PRE> +public void <B>setPath</B>(java.lang.String path)</PRE> +<DL> +<DD>Sets the absolute path of the item upon which the request operated. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="isCreateRequest()"><!-- --></A><H3> +isCreateRequest</H3> +<PRE> +public boolean <B>isCreateRequest</B>()</PRE> +<DL> +<DD>Returns <code>true</code> if this was a create request. + <p> + Before calling the <A HREF="../../../../../org/apache/sling/api/servlets/HtmlResponse.html#setCreateRequest(boolean)"><CODE>setCreateRequest(boolean)</CODE></A> method, this method + always returns <code>false</code>. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setCreateRequest(boolean)"><!-- --></A><H3> +setCreateRequest</H3> +<PRE> +public void <B>setCreateRequest</B>(boolean isCreateRequest)</PRE> +<DL> +<DD>Sets whether the request was a create request or not. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getLocation()"><!-- --></A><H3> +getLocation</H3> +<PRE> +public java.lang.String <B>getLocation</B>()</PRE> +<DL> +<DD>Returns the location of the modification. this is the externalized form + of the current path. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>the location of the modification.</DL> +</DD> +</DL> +<HR> + +<A NAME="setLocation(java.lang.String)"><!-- --></A><H3> +setLocation</H3> +<PRE> +public void <B>setLocation</B>(java.lang.String location)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getParentLocation()"><!-- --></A><H3> +getParentLocation</H3> +<PRE> +public java.lang.String <B>getParentLocation</B>()</PRE> +<DL> +<DD>Returns the parent location of the modification. this is the externalized + form of the parent node of the current path. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>the location of the modification.</DL> +</DD> +</DL> +<HR> + +<A NAME="setParentLocation(java.lang.String)"><!-- --></A><H3> +setParentLocation</H3> +<PRE> +public void <B>setParentLocation</B>(java.lang.String parentLocation)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setTitle(java.lang.String)"><!-- --></A><H3> +setTitle</H3> +<PRE> +public void <B>setTitle</B>(java.lang.String title)</PRE> +<DL> +<DD>Sets the title of the response message +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>title</CODE> - the title</DL> +</DD> +</DL> +<HR> + +<A NAME="setStatus(int, java.lang.String)"><!-- --></A><H3> +setStatus</H3> +<PRE> +public void <B>setStatus</B>(int code, + java.lang.String message)</PRE> +<DL> +<DD>sets the response status code properties +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>code</CODE> - the code<DD><CODE>message</CODE> - the message</DL> +</DD> +</DL> +<HR> + +<A NAME="getStatusCode()"><!-- --></A><H3> +getStatusCode</H3> +<PRE> +public int <B>getStatusCode</B>()</PRE> +<DL> +<DD>Returns the status code of this instance. If the status code has never + been set by calling the <A HREF="../../../../../org/apache/sling/api/servlets/HtmlResponse.html#setStatus(int, java.lang.String)"><CODE>setStatus(int, String)</CODE></A> method, the + response is assumed to be successful and 200 is returned. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getStatusMessage()"><!-- --></A><H3> +getStatusMessage</H3> +<PRE> +public java.lang.String <B>getStatusMessage</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getError()"><!-- --></A><H3> +getError</H3> +<PRE> +public java.lang.Throwable <B>getError</B>()</PRE> +<DL> +<DD>Returns any recorded error or <code>null</code> +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>an error or <code>null</code></DL> +</DD> +</DL> +<HR> + +<A NAME="setError(java.lang.Throwable)"><!-- --></A><H3> +setError</H3> +<PRE> +public void <B>setError</B>(java.lang.Throwable error)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="isSuccessful()"><!-- --></A><H3> +isSuccessful</H3> +<PRE> +public boolean <B>isSuccessful</B>()</PRE> +<DL> +<DD>Returns <code>true</code> if no <A HREF="../../../../../org/apache/sling/api/servlets/HtmlResponse.html#getError()"><CODE>error</CODE></A> is set and if + the <A HREF="../../../../../org/apache/sling/api/servlets/HtmlResponse.html#getStatusCode()"><CODE>status code</CODE></A> is one of the 2xx codes. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="onModified(java.lang.String)"><!-- --></A><H3> +onModified</H3> +<PRE> +public void <B>onModified</B>(java.lang.String path)</PRE> +<DL> +<DD>Records a 'modified' change +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>path</CODE> - path of the item that was modified</DL> +</DD> +</DL> +<HR> + +<A NAME="onCreated(java.lang.String)"><!-- --></A><H3> +onCreated</H3> +<PRE> +public void <B>onCreated</B>(java.lang.String path)</PRE> +<DL> +<DD>Records a 'created' change +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>path</CODE> - path of the item that was created</DL> +</DD> +</DL> +<HR> + +<A NAME="onDeleted(java.lang.String)"><!-- --></A><H3> +onDeleted</H3> +<PRE> +public void <B>onDeleted</B>(java.lang.String path)</PRE> +<DL> +<DD>Records a 'deleted' change +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>path</CODE> - path of the item that was deleted</DL> +</DD> +</DL> +<HR> + +<A NAME="onMoved(java.lang.String, java.lang.String)"><!-- --></A><H3> +onMoved</H3> +<PRE> +public void <B>onMoved</B>(java.lang.String srcPath, + java.lang.String dstPath)</PRE> +<DL> +<DD>Records a 'moved' change. <p/> Note: the moved change only records the + basic move command. the implied changes on the moved properties and sub + nodes are not recorded. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>srcPath</CODE> - source path of the node that was moved<DD><CODE>dstPath</CODE> - destination path of the node that was moved.</DL> +</DD> +</DL> +<HR> + +<A NAME="onCopied(java.lang.String, java.lang.String)"><!-- --></A><H3> +onCopied</H3> +<PRE> +public void <B>onCopied</B>(java.lang.String srcPath, + java.lang.String dstPath)</PRE> +<DL> +<DD>Records a 'copied' change. <p/> Note: the copy change only records the + basic copy command. the implied changes on the copied properties and sub + nodes are not recorded. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>srcPath</CODE> - source path of the node that was copied<DD><CODE>dstPath</CODE> - destination path of the node that was copied.</DL> +</DD> +</DL> +<HR> + +<A NAME="onChange(java.lang.String, java.lang.String...)"><!-- --></A><H3> +onChange</H3> +<PRE> +public void <B>onChange</B>(java.lang.String type, + java.lang.String... arguments)</PRE> +<DL> +<DD>Records a generic change of the given <code>type</code>. + <p> + The change is added to the internal list of changes with the syntax of a + method call, where the <code>type</code> is the method name and the + <code>arguments</code> are the string arguments to the method enclosed in + double quotes. For example, the the call + + <pre> + onChange("sameple", "arg1", "arg2"); + </pre> + + is aded as + + <pre> + sample("arg1", "arg2") + </pre> + + to the internal list of changes. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>type</CODE> - The type of the modification<DD><CODE>arguments</CODE> - The arguments to the modifications</DL> +</DD> +</DL> +<HR> + +<A NAME="setProperty(java.lang.String, java.lang.Object)"><!-- --></A><H3> +setProperty</H3> +<PRE> +public void <B>setProperty</B>(java.lang.String name, + java.lang.Object value)</PRE> +<DL> +<DD>Sets a generic response property with the given +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>name</CODE> - name of the property<DD><CODE>value</CODE> - value of the property</DL> +</DD> +</DL> +<HR> + +<A NAME="getProperty(java.lang.String, java.lang.Class)"><!-- --></A><H3> +getProperty</H3> +<PRE> +public <Type> Type <B>getProperty</B>(java.lang.String name, + java.lang.Class<Type> type)</PRE> +<DL> +<DD>Returns the generic response property with the given name and type or + <code>null</code> if no such property exists or the property is not of + the requested type. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getProperty(java.lang.String)"><!-- --></A><H3> +getProperty</H3> +<PRE> +public java.lang.Object <B>getProperty</B>(java.lang.String name)</PRE> +<DL> +<DD>Returns the generic response property with the given name and type or + <code>null</code> if no such property exists. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="send(javax.servlet.http.HttpServletResponse, boolean)"><!-- --></A><H3> +send</H3> +<PRE> +public void <B>send</B>(javax.servlet.http.HttpServletResponse response, + boolean setStatus) + throws java.io.IOException</PRE> +<DL> +<DD>Writes the response to the given writer and replaces all ${var} patterns + by the value of the respective property. if the property is not defined + the pattern is not modified. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>response</CODE> - to send to<DD><CODE>setStatus</CODE> - whether to set the status code on the response +<DT><B>Throws:</B> +<DD><CODE>java.io.IOException</CODE> - if an i/o exception occurs</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/HtmlResponse.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/servlets/HttpConstants.html" title="class in org.apache.sling.api.servlets"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/sling/api/servlets/HtmlResponse.html" target="_top"><B>FRAMES</B></A> + <A HREF="HtmlResponse.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="#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/servlets/HttpConstants.html ---------------------------------------------------------------------- diff --git a/assets/apidocs/sling5/org/apache/sling/api/servlets/HttpConstants.html b/assets/apidocs/sling5/org/apache/sling/api/servlets/HttpConstants.html new file mode 100644 index 0000000..9dd6565 --- /dev/null +++ b/assets/apidocs/sling5/org/apache/sling/api/servlets/HttpConstants.html @@ -0,0 +1,481 @@ +<!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> +HttpConstants (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="HttpConstants (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/HttpConstants.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/servlets/HtmlResponse.html" title="class in org.apache.sling.api.servlets"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/sling/api/servlets/OptingServlet.html" title="interface in org.apache.sling.api.servlets"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/sling/api/servlets/HttpConstants.html" target="_top"><B>FRAMES</B></A> + <A HREF="HttpConstants.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.servlets</FONT> +<BR> +Class HttpConstants</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.sling.api.servlets.HttpConstants</B> +</PRE> +<HR> +<DL> +<DT><PRE>public class <B>HttpConstants</B><DT>extends java.lang.Object</DL> +</PRE> + +<P> +HTTP-related constants +<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/servlets/HttpConstants.html#HEADER_ACCEPT">HEADER_ACCEPT</A></B></CODE> + +<BR> + </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/servlets/HttpConstants.html#HEADER_ETAG">HEADER_ETAG</A></B></CODE> + +<BR> + </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/servlets/HttpConstants.html#HEADER_IF_MATCH">HEADER_IF_MATCH</A></B></CODE> + +<BR> + </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/servlets/HttpConstants.html#HEADER_IF_MODIFIED_SINCE">HEADER_IF_MODIFIED_SINCE</A></B></CODE> + +<BR> + </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/servlets/HttpConstants.html#HEADER_LAST_MODIFIED">HEADER_LAST_MODIFIED</A></B></CODE> + +<BR> + </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/servlets/HttpConstants.html#METHOD_CONNECT">METHOD_CONNECT</A></B></CODE> + +<BR> + </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/servlets/HttpConstants.html#METHOD_DELETE">METHOD_DELETE</A></B></CODE> + +<BR> + </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/servlets/HttpConstants.html#METHOD_GET">METHOD_GET</A></B></CODE> + +<BR> + </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/servlets/HttpConstants.html#METHOD_HEAD">METHOD_HEAD</A></B></CODE> + +<BR> + </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/servlets/HttpConstants.html#METHOD_OPTIONS">METHOD_OPTIONS</A></B></CODE> + +<BR> + </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/servlets/HttpConstants.html#METHOD_POST">METHOD_POST</A></B></CODE> + +<BR> + </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/servlets/HttpConstants.html#METHOD_PUT">METHOD_PUT</A></B></CODE> + +<BR> + </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/servlets/HttpConstants.html#METHOD_TRACE">METHOD_TRACE</A></B></CODE> + +<BR> + </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/servlets/HttpConstants.html#HttpConstants()">HttpConstants</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="METHOD_OPTIONS"><!-- --></A><H3> +METHOD_OPTIONS</H3> +<PRE> +public static final java.lang.String <B>METHOD_OPTIONS</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.servlets.HttpConstants.METHOD_OPTIONS">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="METHOD_GET"><!-- --></A><H3> +METHOD_GET</H3> +<PRE> +public static final java.lang.String <B>METHOD_GET</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.servlets.HttpConstants.METHOD_GET">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="METHOD_HEAD"><!-- --></A><H3> +METHOD_HEAD</H3> +<PRE> +public static final java.lang.String <B>METHOD_HEAD</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.servlets.HttpConstants.METHOD_HEAD">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="METHOD_POST"><!-- --></A><H3> +METHOD_POST</H3> +<PRE> +public static final java.lang.String <B>METHOD_POST</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.servlets.HttpConstants.METHOD_POST">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="METHOD_PUT"><!-- --></A><H3> +METHOD_PUT</H3> +<PRE> +public static final java.lang.String <B>METHOD_PUT</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.servlets.HttpConstants.METHOD_PUT">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="METHOD_DELETE"><!-- --></A><H3> +METHOD_DELETE</H3> +<PRE> +public static final java.lang.String <B>METHOD_DELETE</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.servlets.HttpConstants.METHOD_DELETE">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="METHOD_TRACE"><!-- --></A><H3> +METHOD_TRACE</H3> +<PRE> +public static final java.lang.String <B>METHOD_TRACE</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.servlets.HttpConstants.METHOD_TRACE">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="METHOD_CONNECT"><!-- --></A><H3> +METHOD_CONNECT</H3> +<PRE> +public static final java.lang.String <B>METHOD_CONNECT</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.servlets.HttpConstants.METHOD_CONNECT">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="HEADER_ACCEPT"><!-- --></A><H3> +HEADER_ACCEPT</H3> +<PRE> +public static final java.lang.String <B>HEADER_ACCEPT</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.servlets.HttpConstants.HEADER_ACCEPT">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="HEADER_ETAG"><!-- --></A><H3> +HEADER_ETAG</H3> +<PRE> +public static final java.lang.String <B>HEADER_ETAG</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.servlets.HttpConstants.HEADER_ETAG">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="HEADER_IF_MATCH"><!-- --></A><H3> +HEADER_IF_MATCH</H3> +<PRE> +public static final java.lang.String <B>HEADER_IF_MATCH</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.servlets.HttpConstants.HEADER_IF_MATCH">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="HEADER_IF_MODIFIED_SINCE"><!-- --></A><H3> +HEADER_IF_MODIFIED_SINCE</H3> +<PRE> +public static final java.lang.String <B>HEADER_IF_MODIFIED_SINCE</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.servlets.HttpConstants.HEADER_IF_MODIFIED_SINCE">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="HEADER_LAST_MODIFIED"><!-- --></A><H3> +HEADER_LAST_MODIFIED</H3> +<PRE> +public static final java.lang.String <B>HEADER_LAST_MODIFIED</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.servlets.HttpConstants.HEADER_LAST_MODIFIED">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="HttpConstants()"><!-- --></A><H3> +HttpConstants</H3> +<PRE> +public <B>HttpConstants</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/HttpConstants.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/servlets/HtmlResponse.html" title="class in org.apache.sling.api.servlets"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/sling/api/servlets/OptingServlet.html" title="interface in org.apache.sling.api.servlets"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/sling/api/servlets/HttpConstants.html" target="_top"><B>FRAMES</B></A> + <A HREF="HttpConstants.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/757222a6/assets/apidocs/sling5/org/apache/sling/api/servlets/OptingServlet.html ---------------------------------------------------------------------- diff --git a/assets/apidocs/sling5/org/apache/sling/api/servlets/OptingServlet.html b/assets/apidocs/sling5/org/apache/sling/api/servlets/OptingServlet.html new file mode 100644 index 0000000..85a02dd --- /dev/null +++ b/assets/apidocs/sling5/org/apache/sling/api/servlets/OptingServlet.html @@ -0,0 +1,237 @@ +<!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> +OptingServlet (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="OptingServlet (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/OptingServlet.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/servlets/HttpConstants.html" title="class in org.apache.sling.api.servlets"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/sling/api/servlets/ServletResolver.html" title="interface in org.apache.sling.api.servlets"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/sling/api/servlets/OptingServlet.html" target="_top"><B>FRAMES</B></A> + <A HREF="OptingServlet.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.servlets</FONT> +<BR> +Interface OptingServlet</H2> +<DL> +<DT><B>All Superinterfaces:</B> <DD>javax.servlet.Servlet</DD> +</DL> +<HR> +<DL> +<DT><PRE>public interface <B>OptingServlet</B><DT>extends javax.servlet.Servlet</DL> +</PRE> + +<P> +The <code>OptingServlet</code> interface may be implemented by + <code>Servlets</code> used by Sling which may choose to not handle all + requests for which they would be selected based on their registration + properties. +<P> + +<P> +<HR> + +<P> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/servlets/OptingServlet.html#accepts(org.apache.sling.api.SlingHttpServletRequest)">accepts</A></B>(<A HREF="../../../../../org/apache/sling/api/SlingHttpServletRequest.html" title="interface in org.apache.sling.api">SlingHttpServletRequest</A> request)</CODE> + +<BR> + Examines the request, and return <code>true</code> if this servlet is + willing to handle the request.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_javax.servlet.Servlet"><!-- --></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.Servlet</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>destroy, getServletConfig, getServletInfo, init, service</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="accepts(org.apache.sling.api.SlingHttpServletRequest)"><!-- --></A><H3> +accepts</H3> +<PRE> +boolean <B>accepts</B>(<A HREF="../../../../../org/apache/sling/api/SlingHttpServletRequest.html" title="interface in org.apache.sling.api">SlingHttpServletRequest</A> request)</PRE> +<DL> +<DD>Examines the request, and return <code>true</code> if this servlet is + willing to handle the request. If <code>false</code> is returned, the + request will be ignored by this servlet, and may be handled by other + servlets. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>request</CODE> - The request to examine +<DT><B>Returns:</B><DD><code>true</code> if this servlet will handle the request, + <code>false</code> otherwise</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/OptingServlet.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/servlets/HttpConstants.html" title="class in org.apache.sling.api.servlets"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/sling/api/servlets/ServletResolver.html" title="interface in org.apache.sling.api.servlets"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/sling/api/servlets/OptingServlet.html" target="_top"><B>FRAMES</B></A> + <A HREF="OptingServlet.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> http://git-wip-us.apache.org/repos/asf/sling-site/blob/757222a6/assets/apidocs/sling5/org/apache/sling/api/servlets/ServletResolver.html ---------------------------------------------------------------------- diff --git a/assets/apidocs/sling5/org/apache/sling/api/servlets/ServletResolver.html b/assets/apidocs/sling5/org/apache/sling/api/servlets/ServletResolver.html new file mode 100644 index 0000000..8520a09 --- /dev/null +++ b/assets/apidocs/sling5/org/apache/sling/api/servlets/ServletResolver.html @@ -0,0 +1,241 @@ +<!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> +ServletResolver (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="ServletResolver (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/ServletResolver.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/servlets/OptingServlet.html" title="interface in org.apache.sling.api.servlets"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/sling/api/servlets/SlingAllMethodsServlet.html" title="class in org.apache.sling.api.servlets"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/sling/api/servlets/ServletResolver.html" target="_top"><B>FRAMES</B></A> + <A HREF="ServletResolver.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.servlets</FONT> +<BR> +Interface ServletResolver</H2> +<HR> +<DL> +<DT><PRE>public interface <B>ServletResolver</B></DL> +</PRE> + +<P> +The <code>ServletResolver</code> defines the API for a service capable of + resolving <code>javax.servlet.Servlet</code> instances to handle the + processing of a request or resource. + <p> + Applications of the Sling Framework generally do not need the servlet + resolver as resolution of the servlets to process requests and sub-requests + through a <code>RequestDispatcher</code> is handled by the Sling Framework. + <p> +<P> + +<P> +<HR> + +<P> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> javax.servlet.Servlet</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/servlets/ServletResolver.html#resolveServlet(org.apache.sling.api.SlingHttpServletRequest)">resolveServlet</A></B>(<A HREF="../../../../../org/apache/sling/api/SlingHttpServletRequest.html" title="interface in org.apache.sling.api">SlingHttpServletRequest</A> request)</CODE> + +<BR> + Resolves a <code>javax.servlet.Servlet</code> whose + <code>service</code> method may be used to handle the given + <code>request</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="resolveServlet(org.apache.sling.api.SlingHttpServletRequest)"><!-- --></A><H3> +resolveServlet</H3> +<PRE> +javax.servlet.Servlet <B>resolveServlet</B>(<A HREF="../../../../../org/apache/sling/api/SlingHttpServletRequest.html" title="interface in org.apache.sling.api">SlingHttpServletRequest</A> request)</PRE> +<DL> +<DD>Resolves a <code>javax.servlet.Servlet</code> whose + <code>service</code> method may be used to handle the given + <code>request</code>. + <p> + The returned servlet must be assumed to be initialized and ready to run. + That is, the <code>init</code> nor the <code>destroy</code> methods + must <em>NOT</em> be called on the returned servlet. + <p> + This method must not return a <code>Servlet</code> instance + implementing the <A HREF="../../../../../org/apache/sling/api/servlets/OptingServlet.html" title="interface in org.apache.sling.api.servlets"><CODE>OptingServlet</CODE></A> interface and returning + <code>false</code> when the + <A HREF="../../../../../org/apache/sling/api/servlets/OptingServlet.html#accepts(org.apache.sling.api.SlingHttpServletRequest)"><CODE>OptingServlet.accepts(SlingHttpServletRequest)</CODE></A> method is called. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>request</CODE> - The <A HREF="../../../../../org/apache/sling/api/SlingHttpServletRequest.html" title="interface in org.apache.sling.api"><CODE>SlingHttpServletRequest</CODE></A> object used to drive + selection of the servlet. +<DT><B>Returns:</B><DD>The servlet whose <code>service</code> method may be called to + handle the request. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../../../org/apache/sling/api/SlingException.html" title="class in org.apache.sling.api">SlingException</A></CODE> - Is thrown if an error occurrs + while trying to find an appropriate servlet to handle the + request or if no servlet could be resolved to handle the + request.</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/ServletResolver.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/servlets/OptingServlet.html" title="interface in org.apache.sling.api.servlets"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/sling/api/servlets/SlingAllMethodsServlet.html" title="class in org.apache.sling.api.servlets"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/sling/api/servlets/ServletResolver.html" target="_top"><B>FRAMES</B></A> + <A HREF="ServletResolver.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>