/lib/docs/org/apache/xmlrpc/webserver/ServletWebServer.Exception.html
HTML | 335 lines | 276 code | 37 blank | 22 comment | 0 complexity | c78e7c2e37fb27867920c5303a58550e MD5 | raw file
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.6.0_0) on Mon Apr 20 21:45:59 CEST 2009 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8ServletWebServer.Exception (Apache XML-RPC 3.1.2 API) 9</TITLE> 10 11<META NAME="date" CONTENT="2009-04-20"> 12 13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> 14 15<SCRIPT type="text/javascript"> 16function windowTitle() 17{ 18 if (location.href.indexOf('is-external=true') == -1) { 19 parent.document.title="ServletWebServer.Exception (Apache XML-RPC 3.1.2 API)"; 20 } 21} 22</SCRIPT> 23<NOSCRIPT> 24</NOSCRIPT> 25 26</HEAD> 27 28<BODY BGCOLOR="white" onload="windowTitle();"> 29<HR> 30 31 32<!-- ========= START OF TOP NAVBAR ======= --> 33<A NAME="navbar_top"><!-- --></A> 34<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 35<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 36<TR> 37<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 38<A NAME="navbar_top_firstrow"><!-- --></A> 39<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 40 <TR ALIGN="center" VALIGN="top"> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 43 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ServletWebServer.Exception.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 48 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 49 </TR> 50</TABLE> 51</TD> 52<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 53</EM> 54</TD> 55</TR> 56 57<TR> 58<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 59 <A HREF="../../../../org/apache/xmlrpc/webserver/ServletWebServer.html" title="class in org.apache.xmlrpc.webserver"><B>PREV CLASS</B></A> 60 <A HREF="../../../../org/apache/xmlrpc/webserver/WebServer.html" title="class in org.apache.xmlrpc.webserver"><B>NEXT CLASS</B></A></FONT></TD> 61<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 62 <A HREF="../../../../index.html?org/apache/xmlrpc/webserver/ServletWebServer.Exception.html" target="_top"><B>FRAMES</B></A> 63 <A HREF="ServletWebServer.Exception.html" target="_top"><B>NO FRAMES</B></A> 64 <SCRIPT type="text/javascript"> 65 <!-- 66 if(window==top) { 67 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 68 } 69 //--> 70</SCRIPT> 71<NOSCRIPT> 72 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 73</NOSCRIPT> 74 75 76</FONT></TD> 77</TR> 78<TR> 79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 80 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 81<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 82DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 83</TR> 84</TABLE> 85<A NAME="skip-navbar_top"></A> 86<!-- ========= END OF TOP NAVBAR ========= --> 87 88<HR> 89<!-- ======== START OF CLASS DATA ======== --> 90<H2> 91<FONT SIZE="-1"> 92org.apache.xmlrpc.webserver</FONT> 93<BR> 94Class ServletWebServer.Exception</H2> 95<PRE> 96java.lang.Object 97 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable 98 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">java.lang.Exception 99 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">java.io.IOException 100 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.xmlrpc.webserver.ServletWebServer.Exception</B> 101</PRE> 102<DL> 103<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD> 104</DL> 105<DL> 106<DT><B>Enclosing class:</B><DD><A HREF="../../../../org/apache/xmlrpc/webserver/ServletWebServer.html" title="class in org.apache.xmlrpc.webserver">ServletWebServer</A></DD> 107</DL> 108<HR> 109<DL> 110<DT><PRE>public static class <B>ServletWebServer.Exception</B><DT>extends java.io.IOException</DL> 111</PRE> 112 113<P> 114This exception is thrown by the request handling classes, 115 advising the server, that it should return an error response. 116<P> 117 118<P> 119<DL> 120<DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#org.apache.xmlrpc.webserver.ServletWebServer.Exception">Serialized Form</A></DL> 121<HR> 122 123<P> 124 125<!-- ======== CONSTRUCTOR SUMMARY ======== --> 126 127<A NAME="constructor_summary"><!-- --></A> 128<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 129<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 130<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 131<B>Constructor Summary</B></FONT></TH> 132</TR> 133<TR BGCOLOR="white" CLASS="TableRowColor"> 134<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/webserver/ServletWebServer.Exception.html#ServletWebServer.Exception(int, java.lang.String, java.lang.String)">ServletWebServer.Exception</A></B>(int pStatusCode, 135 java.lang.String pMessage, 136 java.lang.String pDescription)</CODE> 137 138<BR> 139 Creates a new instance.</TD> 140</TR> 141</TABLE> 142 143<!-- ========== METHOD SUMMARY =========== --> 144 145<A NAME="method_summary"><!-- --></A> 146<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 147<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 148<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 149<B>Method Summary</B></FONT></TH> 150</TR> 151<TR BGCOLOR="white" CLASS="TableRowColor"> 152<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 153<CODE> java.lang.String</CODE></FONT></TD> 154<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/webserver/ServletWebServer.Exception.html#getDescription()">getDescription</A></B>()</CODE> 155 156<BR> 157 Returns the error description.</TD> 158</TR> 159<TR BGCOLOR="white" CLASS="TableRowColor"> 160<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 161<CODE> java.lang.String</CODE></FONT></TD> 162<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/webserver/ServletWebServer.Exception.html#getMessage()">getMessage</A></B>()</CODE> 163 164<BR> 165 </TD> 166</TR> 167<TR BGCOLOR="white" CLASS="TableRowColor"> 168<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 169<CODE> int</CODE></FONT></TD> 170<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/webserver/ServletWebServer.Exception.html#getStatusCode()">getStatusCode</A></B>()</CODE> 171 172<BR> 173 Returns the HTTP status code.</TD> 174</TR> 175</TABLE> 176 <A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></A> 177<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 178<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 179<TH ALIGN="left"><B>Methods inherited from class java.lang.Throwable</B></TH> 180</TR> 181<TR BGCOLOR="white" CLASS="TableRowColor"> 182<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</CODE></TD> 183</TR> 184</TABLE> 185 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 186<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 187<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 188<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> 189</TR> 190<TR BGCOLOR="white" CLASS="TableRowColor"> 191<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD> 192</TR> 193</TABLE> 194 195<P> 196 197<!-- ========= CONSTRUCTOR DETAIL ======== --> 198 199<A NAME="constructor_detail"><!-- --></A> 200<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 201<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 202<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 203<B>Constructor Detail</B></FONT></TH> 204</TR> 205</TABLE> 206 207<A NAME="ServletWebServer.Exception(int, java.lang.String, java.lang.String)"><!-- --></A><H3> 208ServletWebServer.Exception</H3> 209<PRE> 210public <B>ServletWebServer.Exception</B>(int pStatusCode, 211 java.lang.String pMessage, 212 java.lang.String pDescription)</PRE> 213<DL> 214<DD>Creates a new instance. 215<P> 216<DL> 217<DT><B>Parameters:</B><DD><CODE>pStatusCode</CODE> - The HTTP status code being sent to the client.<DD><CODE>pMessage</CODE> - The HTTP status message being sent to the client.<DD><CODE>pDescription</CODE> - The error description being sent to the client 218 in the response body.</DL> 219</DL> 220 221<!-- ============ METHOD DETAIL ========== --> 222 223<A NAME="method_detail"><!-- --></A> 224<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 225<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 226<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 227<B>Method Detail</B></FONT></TH> 228</TR> 229</TABLE> 230 231<A NAME="getMessage()"><!-- --></A><H3> 232getMessage</H3> 233<PRE> 234public java.lang.String <B>getMessage</B>()</PRE> 235<DL> 236<DD><DL> 237<DT><B>Overrides:</B><DD><CODE>getMessage</CODE> in class <CODE>java.lang.Throwable</CODE></DL> 238</DD> 239<DD><DL> 240</DL> 241</DD> 242</DL> 243<HR> 244 245<A NAME="getDescription()"><!-- --></A><H3> 246getDescription</H3> 247<PRE> 248public java.lang.String <B>getDescription</B>()</PRE> 249<DL> 250<DD>Returns the error description. The server will send the description 251 as plain text in the response body. 252<P> 253<DD><DL> 254 255<DT><B>Returns:</B><DD>The error description.</DL> 256</DD> 257</DL> 258<HR> 259 260<A NAME="getStatusCode()"><!-- --></A><H3> 261getStatusCode</H3> 262<PRE> 263public int <B>getStatusCode</B>()</PRE> 264<DL> 265<DD>Returns the HTTP status code. 266<P> 267<DD><DL> 268 269<DT><B>Returns:</B><DD>The status code.</DL> 270</DD> 271</DL> 272<!-- ========= END OF CLASS DATA ========= --> 273<HR> 274 275 276<!-- ======= START OF BOTTOM NAVBAR ====== --> 277<A NAME="navbar_bottom"><!-- --></A> 278<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 279<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 280<TR> 281<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 282<A NAME="navbar_bottom_firstrow"><!-- --></A> 283<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 284 <TR ALIGN="center" VALIGN="top"> 285 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 286 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 287 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 288 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ServletWebServer.Exception.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 289 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 290 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 291 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 292 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 293 </TR> 294</TABLE> 295</TD> 296<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 297</EM> 298</TD> 299</TR> 300 301<TR> 302<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 303 <A HREF="../../../../org/apache/xmlrpc/webserver/ServletWebServer.html" title="class in org.apache.xmlrpc.webserver"><B>PREV CLASS</B></A> 304 <A HREF="../../../../org/apache/xmlrpc/webserver/WebServer.html" title="class in org.apache.xmlrpc.webserver"><B>NEXT CLASS</B></A></FONT></TD> 305<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 306 <A HREF="../../../../index.html?org/apache/xmlrpc/webserver/ServletWebServer.Exception.html" target="_top"><B>FRAMES</B></A> 307 <A HREF="ServletWebServer.Exception.html" target="_top"><B>NO FRAMES</B></A> 308 <SCRIPT type="text/javascript"> 309 <!-- 310 if(window==top) { 311 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 312 } 313 //--> 314</SCRIPT> 315<NOSCRIPT> 316 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 317</NOSCRIPT> 318 319 320</FONT></TD> 321</TR> 322<TR> 323<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 324 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 325<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 326DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 327</TR> 328</TABLE> 329<A NAME="skip-navbar_bottom"></A> 330<!-- ======== END OF BOTTOM NAVBAR ======= --> 331 332<HR> 333Copyright © 2001-2009 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. 334</BODY> 335</HTML>