http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1809c234/content/site/apidocs/org/apache/juneau/rest/RestServlet.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/RestServlet.html b/content/site/apidocs/org/apache/juneau/rest/RestServlet.html index 1fc736c..393a35f 100644 --- a/content/site/apidocs/org/apache/juneau/rest/RestServlet.html +++ b/content/site/apidocs/org/apache/juneau/rest/RestServlet.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":10,"i71":10,"i72":10,"i73":10,"i74":10,"i75":10,"i76":10,"i77":10,"i78":10,"i79":10,"i80":10,"i81":10,"i82":10,"i83":10,"i84":10,"i85":10,"i86":10,"i87":10,"i88":10,"i89":10,"i90":10,"i91":10,"i92":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -49,7 +49,7 @@ var activeTableTab = "activeTableTab"; <div class="subNav"> <ul class="navList"> <li><a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/juneau/rest/RestServletContext.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/juneau/rest/RestServletDefault.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/juneau/rest/RestServlet.html" target="_top">Frames</a></li> @@ -126,7 +126,7 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>public abstract class <a href="../../../../src-html/org/apache/juneau/rest/RestServlet.html#line.65">RestServlet</a> +<pre>public abstract class <a href="../../../../src-html/org/apache/juneau/rest/RestServlet.html#line.34">RestServlet</a> extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServlet.html?is-external=true"; title="class or interface in javax.servlet.http">HttpServlet</a></pre> <div class="block">Servlet implementation of a REST resource. <p> @@ -171,527 +171,72 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <th class="colLast" scope="col">Method and Description</th> </tr> <tr id="i0" class="altColor"> -<td class="colFirst"><code>protected void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#addChildResource-java.lang.String-org.apache.juneau.rest.RestServlet-">addChildResource</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, - <a href="../../../../org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest">RestServlet</a> resource)</code> -<div class="block">Programmatically adds the specified resource as a child to this resource.</div> -</td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/BeanContext.html" title="class in org.apache.juneau">BeanContext</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#createBeanContext-org.apache.juneau.ObjectMap-java.lang.Class:A-java.lang.Class:A-">createBeanContext</a></span>(<a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> properties, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] beanFilters, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] pojoSwaps)</code> -<div class="block">Creates the <a href="../../../../org/apache/juneau/BeanContext.html" title="class in org.apache.juneau"><code>BeanContext</code></a> object used for parsing path variables and header values.</div> -</td> -</tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[]</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#createBeanFilters--">createBeanFilters</a></span>()</code> -<div class="block">Creates the class-level bean filters associated with this servlet.</div> -</td> -</tr> -<tr id="i3" class="rowColor"> -<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest">RestServlet</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#createChildren--">createChildren</a></span>()</code> -<div class="block">Creates instances of child resources for this servlet.</div> -</td> -</tr> -<tr id="i4" class="altColor"> -<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest">RestServlet</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#createChildrenMap--">createChildrenMap</a></span>()</code> -<div class="block">Creates the child resources of this resource.</div> -</td> -</tr> -<tr id="i5" class="rowColor"> -<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/ini/ConfigFile.html" title="class in org.apache.juneau.ini">ConfigFile</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#createConfigFile--">createConfigFile</a></span>()</code> -<div class="block">Returns the config file for this servlet.</div> -</td> -</tr> -<tr id="i6" class="altColor"> -<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/rest/RestConverter.html" title="interface in org.apache.juneau.rest">RestConverter</a>[]</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#createConverters-org.apache.juneau.ObjectMap-">createConverters</a></span>(<a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> properties)</code> -<div class="block">Creates the class-level converters associated with this servlet.</div> -</td> -</tr> -<tr id="i7" class="rowColor"> -<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#createDefaultRequestHeaders-org.apache.juneau.ObjectMap-">createDefaultRequestHeaders</a></span>(<a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> properties)</code> -<div class="block">Creates the set of default request headers for this servlet.</div> -</td> -</tr> -<tr id="i8" class="altColor"> -<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#createDefaultResponseHeaders-org.apache.juneau.ObjectMap-">createDefaultResponseHeaders</a></span>(<a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> properties)</code> -<div class="block">Creates the set of default response headers for this servlet.</div> -</td> -</tr> -<tr id="i9" class="rowColor"> -<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/encoders/EncoderGroup.html" title="class in org.apache.juneau.encoders">EncoderGroup</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#createEncoders-org.apache.juneau.ObjectMap-">createEncoders</a></span>(<a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> properties)</code> -<div class="block">Creates the <a href="../../../../org/apache/juneau/encoders/EncoderGroup.html" title="class in org.apache.juneau.encoders"><code>EncoderGroup</code></a> for this servlet for handling various encoding schemes.</div> -</td> -</tr> -<tr id="i10" class="altColor"> -<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/rest/StreamResource.html" title="class in org.apache.juneau.rest">StreamResource</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#createFavIcon--">createFavIcon</a></span>()</code> -<div class="block">Creates the favicon for this servlet.</div> -</td> -</tr> -<tr id="i11" class="rowColor"> -<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/rest/RestGuard.html" title="class in org.apache.juneau.rest">RestGuard</a>[]</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#createGuards-org.apache.juneau.ObjectMap-">createGuards</a></span>(<a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> properties)</code> -<div class="block">Creates the class-level guards associated with this servlet.</div> -</td> -</tr> -<tr id="i12" class="altColor"> -<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/javax/activation/MimetypesFileTypeMap.html?is-external=true"; title="class or interface in javax.activation">MimetypesFileTypeMap</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#createMimetypesFileTypeMap-org.apache.juneau.ObjectMap-">createMimetypesFileTypeMap</a></span>(<a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> properties)</code> -<div class="block">Creates an instance of <a href="http://docs.oracle.com/javase/7/docs/api/javax/activation/MimetypesFileTypeMap.html?is-external=true"; title="class or interface in javax.activation"><code>MimetypesFileTypeMap</code></a> that is used to determine - the media types of static files.</div> -</td> -</tr> -<tr id="i13" class="rowColor"> -<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/parser/ParserGroup.html" title="class in org.apache.juneau.parser">ParserGroup</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#createParsers-org.apache.juneau.ObjectMap-java.lang.Class:A-java.lang.Class:A-">createParsers</a></span>(<a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> properties, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] beanFilters, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] pojoSwaps)</code> -<div class="block">Creates the parser group containing parsers used for parsing input into POJOs from HTTP requests.</div> -</td> -</tr> -<tr id="i14" class="altColor"> -<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[]</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#createPojoSwaps--">createPojoSwaps</a></span>()</code> -<div class="block">Creates the class-level POJO swaps associated with this servlet.</div> -</td> -</tr> -<tr id="i15" class="rowColor"> -<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#createProperties--">createProperties</a></span>()</code> -<div class="block">Creates the class-level properties associated with this servlet.</div> -</td> -</tr> -<tr id="i16" class="altColor"> -<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#createRequest-javax.servlet.http.HttpServletRequest-">createRequest</a></span>(<a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true"; title="class or interface in javax.servlet.http">HttpServletRequest</a> req)</code> -<div class="block">Creates a <a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest"><code>RestRequest</code></a> object based on the specified incoming <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true"; title="class or interface in javax.servlet.http"><code>HttpServletRequest</code></a> object.</div> -</td> -</tr> -<tr id="i17" class="rowColor"> -<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#createRequestProperties-org.apache.juneau.ObjectMap-org.apache.juneau.rest.RestRequest-">createRequestProperties</a></span>(<a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> methodProperties, - <a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)</code> -<div class="block">Creates a properties map for the specified request.</div> -</td> -</tr> -<tr id="i18" class="altColor"> -<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#createResponse-org.apache.juneau.rest.RestRequest-javax.servlet.http.HttpServletResponse-">createResponse</a></span>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req, - <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true"; title="class or interface in javax.servlet.http">HttpServletResponse</a> res)</code> -<div class="block">Creates a <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest"><code>RestResponse</code></a> object based on the specified incoming <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true"; title="class or interface in javax.servlet.http"><code>HttpServletResponse</code></a> object - and the request returned by <a href="../../../../org/apache/juneau/rest/RestServlet.html#createRequest-javax.servlet.http.HttpServletRequest-"><code>createRequest(HttpServletRequest)</code></a>.</div> -</td> -</tr> -<tr id="i19" class="rowColor"> -<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/rest/ResponseHandler.html" title="interface in org.apache.juneau.rest">ResponseHandler</a>[]</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#createResponseHandlers-org.apache.juneau.ObjectMap-">createResponseHandlers</a></span>(<a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> properties)</code> -<div class="block">Creates the class-level response handlers associated with this servlet.</div> -</td> -</tr> -<tr id="i20" class="altColor"> -<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/serializer/SerializerGroup.html" title="class in org.apache.juneau.serializer">SerializerGroup</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#createSerializers-org.apache.juneau.ObjectMap-java.lang.Class:A-java.lang.Class:A-">createSerializers</a></span>(<a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> properties, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] beanFilters, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] pojoSwaps)</code> -<div class="block">Creates the serializer group containing serializers used for serializing output POJOs in HTTP responses.</div> -</td> -</tr> -<tr id="i21" class="rowColor"> -<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#createStaticFilesMap--">createStaticFilesMap</a></span>()</code> -<div class="block">Creates the static files map for this servlet.</div> -</td> -</tr> -<tr id="i22" class="altColor"> -<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/rest/StreamResource.html" title="class in org.apache.juneau.rest">StreamResource</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#createStyleSheet--">createStyleSheet</a></span>()</code> -<div class="block">Creates the stylesheet for this servlet.</div> -</td> -</tr> -<tr id="i23" class="rowColor"> -<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/urlencoding/UrlEncodingParser.html" title="class in org.apache.juneau.urlencoding">UrlEncodingParser</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#createUrlEncodingParser-org.apache.juneau.ObjectMap-java.lang.Class:A-java.lang.Class:A-">createUrlEncodingParser</a></span>(<a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> properties, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] beanFilters, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] pojoSwaps)</code> -<div class="block">Creates the URL-encoding parser used for parsing URL query parameters.</div> -</td> -</tr> -<tr id="i24" class="altColor"> -<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/urlencoding/UrlEncodingSerializer.html" title="class in org.apache.juneau.urlencoding">UrlEncodingSerializer</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#createUrlEncodingSerializer-org.apache.juneau.ObjectMap-java.lang.Class:A-java.lang.Class:A-">createUrlEncodingSerializer</a></span>(<a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> properties, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] beanFilters, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] pojoSwaps)</code> -<div class="block">Creates the URL-encoding serializer used for serializing object passed to <a href="../../../../org/apache/juneau/rest/Redirect.html" title="class in org.apache.juneau.rest"><code>Redirect</code></a>.</div> -</td> -</tr> -<tr id="i25" class="rowColor"> -<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/svl/VarResolver.html" title="class in org.apache.juneau.svl">VarResolver</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#createVarResolver--">createVarResolver</a></span>()</code> -<div class="block">Creates the reusable variable resolver for this servlet.</div> -</td> -</tr> -<tr id="i26" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#destroy--">destroy</a></span>()</code> </td> </tr> -<tr id="i27" class="rowColor"> +<tr id="i1" class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/juneau/BeanContext.html" title="class in org.apache.juneau">BeanContext</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getBeanContext--">getBeanContext</a></span>()</code> -<div class="block">Returns the <a href="../../../../org/apache/juneau/BeanContext.html" title="class in org.apache.juneau"><code>BeanContext</code></a> object used for parsing path variables and header values.</div> -</td> -</tr> -<tr id="i28" class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[]</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getBeanFilters--">getBeanFilters</a></span>()</code> -<div class="block">Returns the class-level bean filters associated with this servlet.</div> -</td> -</tr> -<tr id="i29" class="rowColor"> -<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[]</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getChildClasses--">getChildClasses</a></span>()</code> -<div class="block">Programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#children--"><code>@RestResource.children()</code></a> annotation.</div> -</td> -</tr> -<tr id="i30" class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest">RestServlet</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getChildResources--">getChildResources</a></span>()</code> -<div class="block">Returns the child resources associated with this servlet.</div> -</td> -</tr> -<tr id="i31" class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getClientVersionHeader--">getClientVersionHeader</a></span>()</code> -<div class="block">Returns the name of the header used to identify the client version.</div> -</td> -</tr> -<tr id="i32" class="altColor"> -<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/ini/ConfigFile.html" title="class in org.apache.juneau.ini">ConfigFile</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getConfig--">getConfig</a></span>()</code> -<div class="block">Returns the config file associated with this servlet.</div> -</td> -</tr> -<tr id="i33" class="rowColor"> -<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/ini/ConfigMgr.html" title="class in org.apache.juneau.ini">ConfigMgr</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getConfigMgr--">getConfigMgr</a></span>()</code> -<div class="block">Returns the config manager used to create the config file in <a href="../../../../org/apache/juneau/rest/RestServlet.html#createConfigFile--"><code>createConfigFile()</code></a>.</div> -</td> -</tr> -<tr id="i34" class="altColor"> -<td class="colFirst"><code><a href="../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger">Contact</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getContact-org.apache.juneau.rest.RestRequest-">getContact</a></span>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)</code> -<div class="block">Returns the localized contact information of this REST resource.</div> -</td> -</tr> -<tr id="i35" class="rowColor"> -<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestConverter.html" title="interface in org.apache.juneau.rest">RestConverter</a>[]</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getConverters--">getConverters</a></span>()</code> -<div class="block">Returns the class-level converters associated with this servlet.</div> -</td> -</tr> -<tr id="i36" class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true"; title="class or interface in java.util">TreeMap</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getDefaultRequestHeaders--">getDefaultRequestHeaders</a></span>()</code> -<div class="block">Returns the class-level default request headers associated with this servlet.</div> -</td> -</tr> -<tr id="i37" class="rowColor"> -<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getDefaultResponseHeaders--">getDefaultResponseHeaders</a></span>()</code> -<div class="block">Returns the class-level default response headers associated with this servlet.</div> -</td> -</tr> -<tr id="i38" class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getDescription-org.apache.juneau.rest.RestRequest-">getDescription</a></span>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)</code> -<div class="block">Returns the localized description of this REST resource.</div> -</td> -</tr> -<tr id="i39" class="rowColor"> -<td class="colFirst"><code><a href="../../../../org/apache/juneau/encoders/EncoderGroup.html" title="class in org.apache.juneau.encoders">EncoderGroup</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getEncoders--">getEncoders</a></span>()</code> -<div class="block">Returns the class-level encoder group associated with this servlet.</div> -</td> -</tr> -<tr id="i40" class="altColor"> -<td class="colFirst"><code><a href="../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getExternalDocs-org.apache.juneau.rest.RestRequest-">getExternalDocs</a></span>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)</code> -<div class="block">Returns the version information of this REST resource.</div> -</td> -</tr> -<tr id="i41" class="rowColor"> -<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestGuard.html" title="class in org.apache.juneau.rest">RestGuard</a>[]</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getGuards--">getGuards</a></span>()</code> -<div class="block">Returns the class-level guards associated with this servlet.</div> +<div class="block">Convenience method for calling <code>getContext().getBeanContext();</code></div> </td> </tr> -<tr id="i42" class="altColor"> -<td class="colFirst"><code><a href="../../../../org/apache/juneau/dto/swagger/License.html" title="class in org.apache.juneau.dto.swagger">License</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getLicense-org.apache.juneau.rest.RestRequest-">getLicense</a></span>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)</code> -<div class="block">Returns the localized license information of this REST resource.</div> -</td> -</tr> -<tr id="i43" class="rowColor"> -<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/internal/JuneauLogger.html" title="class in org.apache.juneau.internal">JuneauLogger</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getLogger--">getLogger</a></span>()</code> -<div class="block">Returns the logger associated with this servlet.</div> -</td> -</tr> -<tr id="i44" class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getMessage-java.util.Locale-java.lang.String-java.lang.Object...-">getMessage</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true"; title="class or interface in java.util">Locale</a> locale, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> key, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>... args)</code> -<div class="block">Gets a localized message from the resource bundle identified by the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#messages--"><code>@RestResource.messages()</code></a> annotation.</div> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/rest/RestContext.html" title="class in org.apache.juneau.rest">RestContext</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getContext--">getContext</a></span>()</code> +<div class="block">Returns the read-only context object that contains all the configuration information about this resource.</div> </td> </tr> -<tr id="i45" class="rowColor"> +<tr id="i3" class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/juneau/utils/MessageBundle.html" title="class in org.apache.juneau.utils">MessageBundle</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getMessages--">getMessages</a></span>()</code> -<div class="block">Returns the resource bundle identified by the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#messages--"><code>@RestResource.messages()</code></a> annotation for the default locale.</div> -</td> -</tr> -<tr id="i46" class="altColor"> -<td class="colFirst"><code><a href="../../../../org/apache/juneau/utils/MessageBundle.html" title="class in org.apache.juneau.utils">MessageBundle</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getMessages-java.util.Locale-">getMessages</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true"; title="class or interface in java.util">Locale</a> locale)</code> -<div class="block">Returns the resource bundle identified by the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#messages--"><code>@RestResource.messages()</code></a> annotation for the specified locale.</div> -</td> -</tr> -<tr id="i47" class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getMethodDescription-java.lang.String-org.apache.juneau.rest.RestRequest-">getMethodDescription</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> javaMethodName, - <a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)</code> -<div class="block">Returns the localized description of the specified java method on this servlet.</div> -</td> -</tr> -<tr id="i48" class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getMethodSummary-java.lang.String-org.apache.juneau.rest.RestRequest-">getMethodSummary</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> javaMethodName, - <a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)</code> -<div class="block">Returns the localized summary of the specified java method on this servlet.</div> -</td> -</tr> -<tr id="i49" class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/activation/MimetypesFileTypeMap.html?is-external=true"; title="class or interface in javax.activation">MimetypesFileTypeMap</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getMimetypesFileTypeMap--">getMimetypesFileTypeMap</a></span>()</code> -<div class="block">Returns the <a href="http://docs.oracle.com/javase/7/docs/api/javax/activation/MimetypesFileTypeMap.html?is-external=true"; title="class or interface in javax.activation"><code>MimetypesFileTypeMap</code></a> that is used to determine the media types of files served up through <code>/htdocs</code>.</div> -</td> -</tr> -<tr id="i50" class="altColor"> -<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest">RestServlet</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getParent--">getParent</a></span>()</code> -<div class="block">Returns the parent of this resource.</div> -</td> -</tr> -<tr id="i51" class="rowColor"> -<td class="colFirst"><code><a href="../../../../org/apache/juneau/parser/ParserGroup.html" title="class in org.apache.juneau.parser">ParserGroup</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getParsers--">getParsers</a></span>()</code> -<div class="block">Returns the parser group containing parsers used for parsing input into POJOs from HTTP requests.</div> -</td> -</tr> -<tr id="i52" class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getPath--">getPath</a></span>()</code> -<div class="block">Returns the path for this servlet as defined by the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#path--"><code>RestResource.path()</code></a> annotation - on this class concatenated with those on all parent classes.</div> -</td> -</tr> -<tr id="i53" class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[]</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getPojoSwaps--">getPojoSwaps</a></span>()</code> -<div class="block">Returns the class-level POJO swaps associated with this servlet.</div> +<div class="block">Convenience method for calling <code>getContext().getMessages();</code></div> </td> </tr> -<tr id="i54" class="altColor"> +<tr id="i4" class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getProperties--">getProperties</a></span>()</code> -<div class="block">Returns the class-level properties associated with this servlet.</div> -</td> -</tr> -<tr id="i55" class="rowColor"> -<td class="colFirst"><code><T> T</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getResource-java.lang.Class-org.apache.juneau.MediaType-java.lang.String-java.util.Locale-">getResource</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> c, - <a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a> mediaType, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, - <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true"; title="class or interface in java.util">Locale</a> locale)</code> -<div class="block">Reads the input stream from <a href="../../../../org/apache/juneau/rest/RestServlet.html#getResource-java.lang.String-java.util.Locale-"><code>getResource(String, Locale)</code></a> and parses it into a POJO - using the parser matched by the specified media type.</div> -</td> -</tr> -<tr id="i56" class="altColor"> -<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getResource-java.lang.String-java.util.Locale-">getResource</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, - <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true"; title="class or interface in java.util">Locale</a> locale)</code> -<div class="block">Same as <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true#getResourceAsStream-java.lang.String-"; title="class or interface in java.lang"><code>Class.getResourceAsStream(String)</code></a> except if it doesn't find the resource - on this class, searches up the parent hierarchy chain.</div> -</td> -</tr> -<tr id="i57" class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getResourceAsString-java.lang.String-java.util.Locale-">getResourceAsString</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, - <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true"; title="class or interface in java.util">Locale</a> locale)</code> -<div class="block">Reads the input stream from <a href="../../../../org/apache/juneau/rest/RestServlet.html#getResource-java.lang.String-java.util.Locale-"><code>getResource(String, Locale)</code></a> into a String.</div> -</td> -</tr> -<tr id="i58" class="altColor"> -<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/rest/ResponseHandler.html" title="interface in org.apache.juneau.rest">ResponseHandler</a>[]</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getResponseHandlers--">getResponseHandlers</a></span>()</code> -<div class="block">Returns the class-level response handlers associated with this servlet.</div> +<div class="block">Convenience method for calling <code>getContext().getProperties();</code></div> </td> </tr> -<tr id="i59" class="rowColor"> -<td class="colFirst"><code><a href="../../../../org/apache/juneau/serializer/SerializerGroup.html" title="class in org.apache.juneau.serializer">SerializerGroup</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getSerializers--">getSerializers</a></span>()</code> -<div class="block">Returns the serializer group containing serializers used for serializing output POJOs in HTTP responses.</div> -</td> -</tr> -<tr id="i60" class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletConfig.html?is-external=true"; title="class or interface in javax.servlet">ServletConfig</a></code></td> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getServletConfig--">getServletConfig</a></span>()</code> </td> </tr> -<tr id="i61" class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getSessionObjects-org.apache.juneau.rest.RestRequest-">getSessionObjects</a></span>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)</code> -<div class="block">Returns the session objects for the specified request.</div> -</td> -</tr> -<tr id="i62" class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getSupportedAcceptTypes--">getSupportedAcceptTypes</a></span>()</code> -<div class="block">Returns a list of valid <code>Accept</code> content types for this resource.</div> -</td> -</tr> -<tr id="i63" class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getSupportedContentTypes--">getSupportedContentTypes</a></span>()</code> -<div class="block">Returns a list of valid <code>Content-Types</code> for input for this resource.</div> -</td> -</tr> -<tr id="i64" class="altColor"> -<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getSwagger-org.apache.juneau.rest.RestRequest-">getSwagger</a></span>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)</code> -<div class="block">Returns the localized swagger for this REST resource.</div> -</td> -</tr> -<tr id="i65" class="rowColor"> -<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getSwaggerFromFile-java.util.Locale-">getSwaggerFromFile</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true"; title="class or interface in java.util">Locale</a> locale)</code> -<div class="block">Returns the localized Swagger from the file system.</div> -</td> -</tr> -<tr id="i66" class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/juneau/dto/swagger/Tag.html" title="class in org.apache.juneau.dto.swagger">Tag</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getTags-org.apache.juneau.rest.RestRequest-">getTags</a></span>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)</code> -<div class="block">Returns the version information of this REST resource.</div> -</td> -</tr> -<tr id="i67" class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getTermsOfService-org.apache.juneau.rest.RestRequest-">getTermsOfService</a></span>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)</code> -<div class="block">Returns the terms-of-service information of this REST resource.</div> -</td> -</tr> -<tr id="i68" class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getTitle-org.apache.juneau.rest.RestRequest-">getTitle</a></span>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)</code> -<div class="block">Returns the localized title of this REST resource.</div> -</td> -</tr> -<tr id="i69" class="rowColor"> -<td class="colFirst"><code><a href="../../../../org/apache/juneau/urlencoding/UrlEncodingParser.html" title="class in org.apache.juneau.urlencoding">UrlEncodingParser</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getUrlEncodingParser--">getUrlEncodingParser</a></span>()</code> -<div class="block">Returns the URL-encoding parser used for parsing URL query parameters.</div> -</td> -</tr> -<tr id="i70" class="altColor"> -<td class="colFirst"><code><a href="../../../../org/apache/juneau/urlencoding/UrlEncodingSerializer.html" title="class in org.apache.juneau.urlencoding">UrlEncodingSerializer</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getUrlEncodingSerializer--">getUrlEncodingSerializer</a></span>()</code> -<div class="block">Returns the URL-encoding serializer used for serializing arguments in <a href="../../../../org/apache/juneau/rest/Redirect.html" title="class in org.apache.juneau.rest"><code>Redirect</code></a> objects.</div> -</td> -</tr> -<tr id="i71" class="rowColor"> -<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/svl/VarResolver.html" title="class in org.apache.juneau.svl">VarResolver</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getVarResolver--">getVarResolver</a></span>()</code> -<div class="block">Returns the variable resolver for this servlet created by the <a href="../../../../org/apache/juneau/rest/RestServlet.html#createVarResolver--"><code>createVarResolver()</code></a> method.</div> -</td> -</tr> -<tr id="i72" class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#getVersion-org.apache.juneau.rest.RestRequest-">getVersion</a></span>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)</code> -<div class="block">Returns the version information of this REST resource.</div> -</td> -</tr> -<tr id="i73" class="rowColor"> -<td class="colFirst"><code>protected void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#handleNotFound-int-org.apache.juneau.rest.RestRequest-org.apache.juneau.rest.RestResponse-">handleNotFound</a></span>(int rc, - <a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req, - <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> res)</code> -<div class="block">Handle the case where a matching method was not found.</div> -</td> -</tr> -<tr id="i74" class="altColor"> -<td class="colFirst"><code>protected void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#handleResponse-org.apache.juneau.rest.RestRequest-org.apache.juneau.rest.RestResponse-java.lang.Object-">handleResponse</a></span>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req, - <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> res, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> output)</code> -<div class="block">The main method for serializing POJOs passed in through the <a href="../../../../org/apache/juneau/rest/RestResponse.html#setOutput-java.lang.Object-"><code>RestResponse.setOutput(Object)</code></a> method.</div> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#init-org.apache.juneau.rest.RestConfig-">init</a></span>(<a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> config)</code> +<div class="block">Resource initialization method.</div> </td> </tr> -<tr id="i75" class="rowColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#hasOptionsPage--">hasOptionsPage</a></span>()</code> -<div class="block">Returns whether this resource class can provide an OPTIONS page.</div> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#init-org.apache.juneau.rest.RestContext-">init</a></span>(<a href="../../../../org/apache/juneau/rest/RestContext.html" title="class in org.apache.juneau.rest">RestContext</a> context)</code> +<div class="block">Convenience method if you want to perform initialization on your resource after all configuration settings + have been made.</div> </td> </tr> -<tr id="i76" class="altColor"> +<tr id="i8" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#init-javax.servlet.ServletConfig-">init</a></span>(<a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletConfig.html?is-external=true"; title="class or interface in javax.servlet">ServletConfig</a> servletConfig)</code> </td> </tr> -<tr id="i77" class="rowColor"> +<tr id="i9" class="rowColor"> <td class="colFirst"><code>protected void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#log-java.util.logging.Level-java.lang.String-java.lang.Object...-">log</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/logging/Level.html?is-external=true"; title="class or interface in java.util.logging">Level</a> level, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> msg, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>... args)</code> -<div class="block">Log a message.</div> +<div class="block">Convenience method for calling <code>getContext().getLogger().log(level, msg, args);</code></div> </td> </tr> -<tr id="i78" class="altColor"> +<tr id="i10" class="altColor"> <td class="colFirst"><code>protected void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#log-java.util.logging.Level-java.lang.Throwable-java.lang.String-java.lang.Object...-">log</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/logging/Level.html?is-external=true"; title="class or interface in java.util.logging">Level</a> level, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> msg, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>... args)</code> -<div class="block">Log a message to the logger returned by <a href="../../../../org/apache/juneau/rest/RestServlet.html#getLogger--"><code>getLogger()</code></a>.</div> -</td> -</tr> -<tr id="i79" class="rowColor"> -<td class="colFirst"><code>protected void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#logObjects-java.util.logging.Level-java.lang.String-java.lang.Object...-">logObjects</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/logging/Level.html?is-external=true"; title="class or interface in java.util.logging">Level</a> level, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> msg, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>... args)</code> -<div class="block">Same as <a href="../../../../org/apache/juneau/rest/RestServlet.html#log-java.util.logging.Level-java.lang.String-java.lang.Object...-"><code>log(Level, String, Object...)</code></a> excepts runs the - arguments through <a href="../../../../org/apache/juneau/json/JsonSerializer.html#DEFAULT_LAX_READABLE"><code>JsonSerializer.DEFAULT_LAX_READABLE</code></a>.</div> -</td> -</tr> -<tr id="i80" class="altColor"> -<td class="colFirst"><code>protected void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#onError-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-org.apache.juneau.rest.RestException-">onError</a></span>(<a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true"; title="class or interface in javax.servlet.http">HttpServletRequest</a> req, - <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true"; title="class or interface in javax.servlet.http">HttpServletResponse</a> res, - <a href="../../../../org/apache/juneau/rest/RestException.html" title="class in org.apache.juneau.rest">RestException</a> e)</code> -<div class="block">Callback method for logging errors during HTTP requests.</div> +<div class="block">Convenience method for calling <code>getContext().getLogger().log(level, cause, msg, args);</code></div> </td> </tr> -<tr id="i81" class="rowColor"> +<tr id="i11" class="rowColor"> <td class="colFirst"><code>protected void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#onPostCall-org.apache.juneau.rest.RestRequest-org.apache.juneau.rest.RestResponse-">onPostCall</a></span>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req, <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> res)</code> @@ -699,13 +244,13 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ the serializer is invoked.</div> </td> </tr> -<tr id="i82" class="altColor"> +<tr id="i12" class="altColor"> <td class="colFirst"><code>protected void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#onPreCall-org.apache.juneau.rest.RestRequest-">onPreCall</a></span>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)</code> <div class="block">Callback method that gets invoked right before the REST Java method is invoked.</div> </td> </tr> -<tr id="i83" class="rowColor"> +<tr id="i13" class="rowColor"> <td class="colFirst"><code>protected void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#onSuccess-org.apache.juneau.rest.RestRequest-org.apache.juneau.rest.RestResponse-long-">onSuccess</a></span>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req, <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> res, @@ -713,70 +258,13 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <div class="block">Callback method for listening for successful completion of requests.</div> </td> </tr> -<tr id="i84" class="altColor"> -<td class="colFirst"><code>protected void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#renderError-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-org.apache.juneau.rest.RestException-">renderError</a></span>(<a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true"; title="class or interface in javax.servlet.http">HttpServletRequest</a> req, - <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true"; title="class or interface in javax.servlet.http">HttpServletResponse</a> res, - <a href="../../../../org/apache/juneau/rest/RestException.html" title="class in org.apache.juneau.rest">RestException</a> e)</code> -<div class="block">Method for rendering response errors.</div> -</td> -</tr> -<tr id="i85" class="rowColor"> -<td class="colFirst"><code>protected void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#replaceChild-org.apache.juneau.rest.RestServlet-">replaceChild</a></span>(<a href="../../../../org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest">RestServlet</a> servlet)</code> -<div class="block">This method can be use to replace a child resource with another instance while - the parent resource is still running.</div> -</td> -</tr> -<tr id="i86" class="altColor"> -<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest">RestServlet</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#resolveChild-java.lang.Class-">resolveChild</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> interfaceClass)</code> -<div class="block">Subclasses can override this method to provide a way to resolve interfaces - in <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#children--"><code>@RestResource.children()</code></a> annotations.</div> -</td> -</tr> -<tr id="i87" class="rowColor"> -<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/rest/StreamResource.html" title="class in org.apache.juneau.rest">StreamResource</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#resolveStaticFile-java.lang.String-">resolveStaticFile</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> pathInfo)</code> -<div class="block">Resolve a static resource file.</div> -</td> -</tr> -<tr id="i88" class="altColor"> +<tr id="i14" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#service-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">service</a></span>(<a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true"; title="class or interface in javax.servlet.http">HttpServletRequest</a> r1, <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true"; title="class or interface in javax.servlet.http">HttpServletResponse</a> r2)</code> <div class="block">The main service method.</div> </td> </tr> -<tr id="i89" class="rowColor"> -<td class="colFirst"><code>protected void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#setParent-org.apache.juneau.rest.RestServlet-">setParent</a></span>(<a href="../../../../org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest">RestServlet</a> parent)</code> -<div class="block">Sets the parent of this resource.</div> -</td> -</tr> -<tr id="i90" class="altColor"> -<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest">RestServlet</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#setProperty-java.lang.String-java.lang.Object-">setProperty</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> key, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</code> -<div class="block">Specify a class-level property.</div> -</td> -</tr> -<tr id="i91" class="rowColor"> -<td class="colFirst"><code>protected boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#shouldLog-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-org.apache.juneau.rest.RestException-">shouldLog</a></span>(<a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true"; title="class or interface in javax.servlet.http">HttpServletRequest</a> req, - <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true"; title="class or interface in javax.servlet.http">HttpServletResponse</a> res, - <a href="../../../../org/apache/juneau/rest/RestException.html" title="class in org.apache.juneau.rest">RestException</a> e)</code> -<div class="block">Returns <jk>true</jk> if the specified exception should be logged.</div> -</td> -</tr> -<tr id="i92" class="altColor"> -<td class="colFirst"><code>protected boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestServlet.html#shouldLogStackTrace-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-org.apache.juneau.rest.RestException-">shouldLogStackTrace</a></span>(<a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true"; title="class or interface in javax.servlet.http">HttpServletRequest</a> req, - <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true"; title="class or interface in javax.servlet.http">HttpServletResponse</a> res, - <a href="../../../../org/apache/juneau/rest/RestException.html" title="class in org.apache.juneau.rest">RestException</a> e)</code> -<div class="block">Returns <jk>true</jk> if a stack trace should be logged for this exception.</div> -</td> -</tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.javax.servlet.http.HttpServlet"> @@ -819,7 +307,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockListLast"> <li class="blockList"> <h4>RestServlet</h4> -<pre>public <a href="../../../../src-html/org/apache/juneau/rest/RestServlet.html#line.65">RestServlet</a>()</pre> +<pre>public <a href="../../../../src-html/org/apache/juneau/rest/RestServlet.html#line.34">RestServlet</a>()</pre> </li> </ul> </li> @@ -836,8 +324,8 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>init</h4> -<pre>public void <a href="../../../../src-html/org/apache/juneau/rest/RestServlet.html#line.152">init</a>(<a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletConfig.html?is-external=true"; title="class or interface in javax.servlet">ServletConfig</a> servletConfig) - throws <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletException.html?is-external=true"; title="class or interface in javax.servlet">ServletException</a></pre> +<pre>public final void <a href="../../../../src-html/org/apache/juneau/rest/RestServlet.html#line.45">init</a>(<a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletConfig.html?is-external=true"; title="class or interface in javax.servlet">ServletConfig</a> servletConfig) + throws <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletException.html?is-external=true"; title="class or interface in javax.servlet">ServletException</a></pre> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="http://docs.oracle.com/javaee/5/api/javax/servlet/Servlet.html?is-external=true#init-javax.servlet.ServletConfig-"; title="class or interface in javax.servlet">init</a></code> in interface <code><a href="http://docs.oracle.com/javaee/5/api/javax/servlet/Servlet.html?is-external=true"; title="class or interface in javax.servlet">Servlet</a></code></dd> @@ -848,2129 +336,289 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ </dl> </li> </ul> -<a name="createChildrenMap--"> +<a name="init-org.apache.juneau.rest.RestConfig-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>createChildrenMap</h4> -<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest">RestServlet</a>> <a href="../../../../src-html/org/apache/juneau/rest/RestServlet.html#line.309">createChildrenMap</a>() - throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> -<div class="block">Creates the child resources of this resource. +<h4>init</h4> +<pre>public void <a href="../../../../src-html/org/apache/juneau/rest/RestServlet.html#line.93">init</a>(<a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> config) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block">Resource initialization method. <p> - Default implementation calls <a href="../../../../org/apache/juneau/rest/RestServlet.html#createChildren--"><code>createChildren()</code></a> and uses the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#path--"><code>@RestResource.path()</code></a> annotation - on each child to identify the subpath for the resource which become the keys in this map. - It then calls the <a href="../../../../org/apache/juneau/rest/RestServlet.html#setParent-org.apache.juneau.rest.RestServlet-"><code>setParent(RestServlet)</code></a> method on the child resource. + Identical to <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/Servlet.html?is-external=true#init-javax.servlet.ServletConfig-"; title="class or interface in javax.servlet"><code>Servlet.init(ServletConfig)</code></a> except the config object provides + access to the external config file, configuration properties, and variable resolver + defined for this resource. <p> - Subclasses can override this method to programatically create child resources - without using the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#children--"><code>@RestResource.children()</code></a> annotation. - When overridding this method, you are responsible for calling <a href="../../../../org/apache/juneau/rest/RestServlet.html#setParent-org.apache.juneau.rest.RestServlet-"><code>setParent(RestServlet)</code></a> on the - child resources.</div> + Classes can also use <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/GenericServlet.html?is-external=true#init--"; title="class or interface in javax.servlet"><code>GenericServlet.init()</code></a> and <a href="../../../../org/apache/juneau/rest/RestServlet.html#getServletConfig--"><code>getServletConfig()</code></a> + as well to perform initialization. + <p> + Note that if you override this method, you must first call <code><jk>super</jk>.init(servletConfig)</code>! + <p> + Resource classes that don't extend from <a href="../../../../org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest"><code>RestServlet</code></a> can add this method to their class + to get access to the config object.</div> <dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>The new mutable list of child resource instances.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>config</code> - The servlet configuration.</dd> <dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code> - If an error occurred during servlet instantiation.</dd> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code> - Any exception can be thrown to signal an initialization failure.</dd> </dl> </li> </ul> -<a name="createChildren--"> +<a name="init-org.apache.juneau.rest.RestContext-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>createChildren</h4> -<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest">RestServlet</a>> <a href="../../../../src-html/org/apache/juneau/rest/RestServlet.html#line.333">createChildren</a>() - throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> -<div class="block">Creates instances of child resources for this servlet. +<h4>init</h4> +<pre>public void <a href="../../../../src-html/org/apache/juneau/rest/RestServlet.html#line.112">init</a>(<a href="../../../../org/apache/juneau/rest/RestContext.html" title="class in org.apache.juneau.rest">RestContext</a> context) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block">Convenience method if you want to perform initialization on your resource after all configuration settings + have been made. <p> - Default implementation uses the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#children--"><code>@RestResource.children()</code></a> annotation to identify and - instantiate children. + This allows you to get access to the <a href="../../../../org/apache/juneau/rest/RestContext.html" title="class in org.apache.juneau.rest"><code>RestContext</code></a> object during initialization. <p> - Subclasses can override this method to programatically create child resources - without using the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#children--"><code>@RestResource.children()</code></a> annotation.</div> + The default implementation does nothing.</div> <dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>The new mutable list of child resource instances.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>context</code> - The servlet context containing all the set-in-stone configurations for this resource.</dd> <dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code> - If an error occurred during servlet instantiation.</dd> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code> - Any exception can be thrown to signal an initialization failure.</dd> </dl> </li> </ul> -<a name="getChildClasses--"> +<a name="service-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getChildClasses</h4> -<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] <a href="../../../../src-html/org/apache/juneau/rest/RestServlet.html#line.355">getChildClasses</a>() - throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> -<div class="block">Programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#children--"><code>@RestResource.children()</code></a> annotation. - <p> - Subclasses can override this method to provide customized list of child resources. - (e.g. different children based on values specified in the config file). +<h4>service</h4> +<pre>public void <a href="../../../../src-html/org/apache/juneau/rest/RestServlet.html#line.134">service</a>(<a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true"; title="class or interface in javax.servlet.http">HttpServletRequest</a> r1, + <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true"; title="class or interface in javax.servlet.http">HttpServletResponse</a> r2) + throws <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletException.html?is-external=true"; title="class or interface in javax.servlet">ServletException</a>, + <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">The main service method. <p> - Default implementation simply returns the value from the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#children--"><code>@RestResource.children()</code></a> annotation.</div> + Subclasses can optionally override this method if they want to tailor the behavior of requests.</div> <dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>The new mutable list of child resource instances.</dd> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServlet.html?is-external=true#service-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-"; title="class or interface in javax.servlet.http">service</a></code> in class <code><a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServlet.html?is-external=true"; title="class or interface in javax.servlet.http">HttpServlet</a></code></dd> <dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code> - If an error occurred during servlet instantiation.</dd> +<dd><code><a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletException.html?is-external=true"; title="class or interface in javax.servlet">ServletException</a></code></dd> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd> </dl> </li> </ul> -<a name="createProperties--"> +<a name="getContext--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>createProperties</h4> -<pre>protected <a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> <a href="../../../../src-html/org/apache/juneau/rest/RestServlet.html#line.381">createProperties</a>()</pre> -<div class="block">Creates the class-level properties associated with this servlet. +<h4>getContext</h4> +<pre>protected <a href="../../../../org/apache/juneau/rest/RestContext.html" title="class in org.apache.juneau.rest">RestContext</a> <a href="../../../../src-html/org/apache/juneau/rest/RestServlet.html#line.170">getContext</a>()</pre> +<div class="block">Returns the read-only context object that contains all the configuration information about this resource. <p> - Subclasses can override this method to provide their own class-level properties for this servlet, typically - by calling <code><jk>super</jk>.createProperties()</code> and appending to the map. - However, in most cases, the existing set of properties can be added to by overridding <a href="../../../../org/apache/juneau/rest/RestServlet.html#getProperties--"><code>getProperties()</code></a> - and appending to the map returned by <code><jk>super</jk>.getProperties()</code> + This object is <jk>null</jk> during the call to <a href="../../../../org/apache/juneau/rest/RestServlet.html#init-org.apache.juneau.rest.RestConfig-"><code>init(RestConfig)</code></a> but is populated + by the time <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/GenericServlet.html?is-external=true#init--"; title="class or interface in javax.servlet"><code>GenericServlet.init()</code></a> is called. <p> - By default, the map returned by this method contains the following: - </p> - <ul class='spaced-list'> - <li>Servlet-init parameters. - <li><a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#properties--"><code>RestResource.properties()</code></a> annotations in parent-to-child order. - <li><a href="../../../../org/apache/juneau/serializer/SerializerContext.html#SERIALIZER_relativeUriBase"><code>SerializerContext.SERIALIZER_relativeUriBase</code></a> from <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletConfig.html?is-external=true#getServletContext--"; title="class or interface in javax.servlet"><code>ServletConfig.getServletContext()</code></a>. - </ul></div> + Resource classes that don't extend from <a href="../../../../org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest"><code>RestServlet</code></a> can add the following method to their + class to get access to this context object: + <p class='bcode'> + <jk>public void</jk> init(RestServletContext context) <jk>throws</jk> Exception; + </p></div> <dl> <dt><span class="returnLabel">Returns:</span></dt> -<dd>The resource properties as an <a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau"><code>ObjectMap</code></a>.</dd> +<dd>The context information on this servlet.</dd> </dl> </li> </ul> -<a name="createBeanFilters--"> +<a name="onSuccess-org.apache.juneau.rest.RestRequest-org.apache.juneau.rest.RestResponse-long-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>createBeanFilters</h4> -<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] <a href="../../../../src-html/org/apache/juneau/rest/RestServlet.html#line.418">createBeanFilters</a>()</pre> -<div class
<TRUNCATED>
