http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4752869d/content/site/apidocs/org/apache/juneau/rest/RestConfig.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/RestConfig.html b/content/site/apidocs/org/apache/juneau/rest/RestConfig.html new file mode 100644 index 0000000..6168f49 --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/rest/RestConfig.html @@ -0,0 +1,1793 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>RestConfig (Apache Juneau (incubating) 6.1.1-incubating-SNAPSHOT)</title> +<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="RestConfig (Apache Juneau (incubating) 6.1.1-incubating-SNAPSHOT)"; + } + } + 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}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/juneau/rest/RestCallHandler.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/rest/RestContext.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/RestConfig.html" target="_top">Frames</a></li> +<li><a href="RestConfig.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.juneau.rest</div> +<h2 title="Class RestConfig" class="title">Class RestConfig</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.juneau.rest.RestConfig</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><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></dd> +</dl> +<hr> +<br> +<pre>public class <a href="../../../../src-html/org/apache/juneau/rest/RestConfig.html#line.71">RestConfig</a> +extends <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> +implements <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></pre> +<div class="block">Defines the initial configuration of a <code>RestServlet</code> or <code>@RestResource</code> annotated object. + <p> + An extension of the <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletConfig.html?is-external=true"; title="class or interface in javax.servlet"><code>ServletConfig</code></a> object used during servlet initialization. + <p> + Provides access to the following initialized resources: + <ul> + <li><a href="../../../../org/apache/juneau/rest/RestConfig.html#getConfigFile--"><code>getConfigFile()</code></a> - The external configuration file for this resource. + <li><a href="../../../../org/apache/juneau/rest/RestConfig.html#getProperties--"><code>getProperties()</code></a> - The modifiable configuration properties for this resource. + <li><a href="../../../../org/apache/juneau/rest/RestConfig.html#getVarResolverBuilder--"><code>getVarResolverBuilder()</code></a> - The variable resolver for this resource. + </ul> + <p> + Methods are provided for overriding or augmenting the information provided by the <ja>@RestResource</ja> annotation. + In general, most information provided in the <ja>@RestResource</ja> annotation can be specified programmatically + through calls on this object. + <p> + To interact with this object, simply implement the following init method in your resource class: + <p class='bcode'> + <jk>public synchronized void</jk> init(RestConfig config) <jk>throws</jk> Exception { + config.addPojoSwaps(CalendarSwap.<jsf>RFC2822DTZ</jsf>.<jk>class</jk>); + config.setProperty(<jsf>PARSER_debug</jsf>, <jk>true</jk>); + <jk>super</jk>.init(config); <jc>// Make sure this is the last line! (or just leave it out entirely)</jc> + } + </p> + <p> + Note that this method is identical to <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/GenericServlet.html?is-external=true#init-javax.servlet.ServletConfig-"; title="class or interface in javax.servlet"><code>GenericServlet.init(ServletConfig)</code></a> except you get access to + this object instead. Also, this method can throw any exception, not just a <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletException.html?is-external=true"; title="class or interface in javax.servlet"><code>ServletException</code></a>. + <p> + The parent <code>init(RestServletConfig)</code> method will construct a read-only <a href="../../../../org/apache/juneau/rest/RestContext.html" title="class in org.apache.juneau.rest"><code>RestContext</code></a> object + that contains a snapshot of these settings. If you call <code><jk>super</jk>.init(RestServletConfig)<code> before + you modify this config object, you won't see the changes!</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<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/RestConfig.html#addBeanFilters-java.lang.Class...-">addBeanFilters</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><?>... beanFilters)</code> +<div class="block">Adds class-level bean filters to this resource.</div> +</td> +</tr> +<tr id="i1" 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/RestConfig.html#addChildResource-java.lang.String-java.lang.Object-">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> path, + <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> child)</code> +<div class="block">Adds a child resource to this resource.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<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/RestConfig.html#addChildResources-java.lang.Class...-">addChildResources</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><?>... children)</code> +<div class="block">Add child resources to this resource.</div> +</td> +</tr> +<tr id="i3" 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/RestConfig.html#addChildResources-java.lang.Object...-">addChildResources</a></span>(<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>... children)</code> +<div class="block">Add child resources to this resource.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<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/RestConfig.html#addConverters-java.lang.Class...-">addConverters</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><?>... converters)</code> +<div class="block">Adds class-level converters to this resource.</div> +</td> +</tr> +<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/RestConfig.html#addConverters-org.apache.juneau.rest.RestConverter...-">addConverters</a></span>(<a href="../../../../org/apache/juneau/rest/RestConverter.html" title="interface in org.apache.juneau.rest">RestConverter</a>... converters)</code> +<div class="block">Adds class-level encoders to this resource.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<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/RestConfig.html#addDefaultRequestHeader-java.lang.String-java.lang.Object-">addDefaultRequestHeader</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/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</code> +<div class="block">Adds class-level default HTTP request headers to this resource.</div> +</td> +</tr> +<tr id="i7" 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/RestConfig.html#addDefaultRequestHeaders-java.lang.String...-">addDefaultRequestHeaders</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>... headers)</code> +<div class="block">Adds class-level default HTTP request headers to this resource.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<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/RestConfig.html#addDefaultResponseHeader-java.lang.String-java.lang.Object-">addDefaultResponseHeader</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/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</code> +<div class="block">Adds class-level default HTTP response headers to this resource.</div> +</td> +</tr> +<tr id="i9" 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/RestConfig.html#addDefaultResponseHeaders-java.lang.String...-">addDefaultResponseHeaders</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>... headers)</code> +<div class="block">Adds class-level default HTTP response headers to this resource.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<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/RestConfig.html#addEncoders-java.lang.Class...-">addEncoders</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><?>... encoders)</code> +<div class="block">Adds class-level encoders to this resource.</div> +</td> +</tr> +<tr id="i11" 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/RestConfig.html#addEncoders-org.apache.juneau.encoders.Encoder...-">addEncoders</a></span>(<a href="../../../../org/apache/juneau/encoders/Encoder.html" title="class in org.apache.juneau.encoders">Encoder</a>... encoders)</code> +<div class="block">Adds class-level encoders to this resource.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<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/RestConfig.html#addGuards-java.lang.Class...-">addGuards</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><?>... guards)</code> +<div class="block">Adds class-level guards to this resource.</div> +</td> +</tr> +<tr id="i13" 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/RestConfig.html#addGuards-org.apache.juneau.rest.RestGuard...-">addGuards</a></span>(<a href="../../../../org/apache/juneau/rest/RestGuard.html" title="class in org.apache.juneau.rest">RestGuard</a>... guards)</code> +<div class="block">Adds class-level guards to this resource.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<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/RestConfig.html#addMimeTypes-java.lang.String...-">addMimeTypes</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>... mimeTypes)</code> +<div class="block">Adds MIME-type definitions.</div> +</td> +</tr> +<tr id="i15" 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/RestConfig.html#addParsers-java.lang.Class...-">addParsers</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><?>... parsers)</code> +<div class="block">Adds class-level parsers to this resource.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<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/RestConfig.html#addParsers-org.apache.juneau.parser.Parser...-">addParsers</a></span>(<a href="../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser">Parser</a>... parsers)</code> +<div class="block">Adds class-level parsers to this resource.</div> +</td> +</tr> +<tr id="i17" 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/RestConfig.html#addPojoSwaps-java.lang.Class...-">addPojoSwaps</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><?>... pojoSwaps)</code> +<div class="block">Adds class-level pojo swaps to this resource.</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<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/RestConfig.html#addResponseHandlers-java.lang.Class...-">addResponseHandlers</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><?>... responseHandlers)</code> +<div class="block">Adds class-level response handler classes to this resource.</div> +</td> +</tr> +<tr id="i19" 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/RestConfig.html#addResponseHandlers-org.apache.juneau.rest.ResponseHandler...-">addResponseHandlers</a></span>(<a href="../../../../org/apache/juneau/rest/ResponseHandler.html" title="interface in org.apache.juneau.rest">ResponseHandler</a>... responseHandlers)</code> +<div class="block">Adds class-level response handlers to this resource.</div> +</td> +</tr> +<tr id="i20" class="altColor"> +<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/RestConfig.html#addSerializers-java.lang.Class...-">addSerializers</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><?>... serializers)</code> +<div class="block">Adds class-level serializers to this resource.</div> +</td> +</tr> +<tr id="i21" 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/RestConfig.html#addSerializers-org.apache.juneau.serializer.Serializer...-">addSerializers</a></span>(<a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a>... serializers)</code> +<div class="block">Adds class-level serializers to this resource.</div> +</td> +</tr> +<tr id="i22" class="altColor"> +<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/RestConfig.html#addStaticFiles-java.lang.Class-java.lang.String-">addStaticFiles</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><?> resourceClass, + <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> staticFilesString)</code> +<div class="block">Appends to the static files resource map.</div> +</td> +</tr> +<tr id="i23" 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/RestConfig.html#addStyleSheet-java.lang.Class-java.lang.String-">addStyleSheet</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><?> resourceClass, + <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> resourcePath)</code> +<div class="block">Adds to the stylesheet that make up the contents of the page <js>"/resource-path/styles.css"</js>.</div> +</td> +</tr> +<tr id="i24" class="altColor"> +<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/RestConfig.html#addStyleSheet-java.lang.Object...-">addStyleSheet</a></span>(<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>... styleSheets)</code> +<div class="block">Adds to the stylesheet that make up the contents of the page <js>"/resource-path/styles.css"</js>.</div> +</td> +</tr> +<tr id="i25" 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/RestConfig.html#addVarContextObject-java.lang.String-java.lang.Object-">addVarContextObject</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/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> object)</code> +<div class="block">Adds a var context object to this config.</div> +</td> +</tr> +<tr id="i26" class="altColor"> +<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/RestConfig.html#addVars-java.lang.Class...-">addVars</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><?>... vars)</code> +<div class="block">Adds the specified <a href="../../../../org/apache/juneau/svl/Var.html" title="class in org.apache.juneau.svl"><code>Var</code></a> classes to this config.</div> +</td> +</tr> +<tr id="i27" class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestConfig.html#createPropertyStore--">createPropertyStore</a></span>()</code> +<div class="block">Creates a new <a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau"><code>PropertyStore</code></a> object initialized with the properties defined in this config.</div> +</td> +</tr> +<tr id="i28" class="altColor"> +<td class="colFirst"><code><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/RestConfig.html#getConfigFile--">getConfigFile</a></span>()</code> +<div class="block">Returns the external configuration file for this resource.</div> +</td> +</tr> +<tr id="i29" 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/RestConfig.html#getInitParameter-java.lang.String-">getInitParameter</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)</code> </td> +</tr> +<tr id="i30" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Enumeration.html?is-external=true"; title="class or interface in java.util">Enumeration</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/RestConfig.html#getInitParameterNames--">getInitParameterNames</a></span>()</code> </td> +</tr> +<tr id="i31" class="rowColor"> +<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/RestConfig.html#getProperties--">getProperties</a></span>()</code> +<div class="block">Returns the configuration properties for this resource.</div> +</td> +</tr> +<tr id="i32" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletContext.html?is-external=true"; title="class or interface in javax.servlet">ServletContext</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestConfig.html#getServletContext--">getServletContext</a></span>()</code> </td> +</tr> +<tr id="i33" 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/RestConfig.html#getServletName--">getServletName</a></span>()</code> </td> +</tr> +<tr id="i34" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/svl/VarResolverBuilder.html" title="class in org.apache.juneau.svl">VarResolverBuilder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestConfig.html#getVarResolverBuilder--">getVarResolverBuilder</a></span>()</code> +<div class="block">Creates the variable resolver for this resource.</div> +</td> +</tr> +<tr id="i35" 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/RestConfig.html#setCallHandler-java.lang.Class-">setCallHandler</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><? extends <a href="../../../../org/apache/juneau/rest/RestCallHandler.html" title="class in org.apache.juneau.rest">RestCallHandler</a>> restHandler)</code> +<div class="block">Overrides the call handler for the resource.</div> +</td> +</tr> +<tr id="i36" class="altColor"> +<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/RestConfig.html#setCallHandler-org.apache.juneau.rest.RestCallHandler-">setCallHandler</a></span>(<a href="../../../../org/apache/juneau/rest/RestCallHandler.html" title="class in org.apache.juneau.rest">RestCallHandler</a> restHandler)</code> +<div class="block">Overrides the call handler for the resource.</div> +</td> +</tr> +<tr id="i37" 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/RestConfig.html#setClientVersionHeader-java.lang.String-">setClientVersionHeader</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> clientVersionHeader)</code> +<div class="block">Sets name of the header used to denote the client version on HTTP requests.</div> +</td> +</tr> +<tr id="i38" class="altColor"> +<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/RestConfig.html#setConfigFile-org.apache.juneau.ini.ConfigFile-">setConfigFile</a></span>(<a href="../../../../org/apache/juneau/ini/ConfigFile.html" title="class in org.apache.juneau.ini">ConfigFile</a> configFile)</code> +<div class="block">Overwrites the default config file with a custom config file.</div> +</td> +</tr> +<tr id="i39" 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/RestConfig.html#setFavIcon-java.lang.Class-java.lang.String-">setFavIcon</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><?> resourceClass, + <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> resourcePath)</code> +<div class="block">Specifies the icon contents that make up the contents of the page <js>"/resource-path/favicon.ico"</js>.</div> +</td> +</tr> +<tr id="i40" class="altColor"> +<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/RestConfig.html#setFavIcon-java.lang.Object-">setFavIcon</a></span>(<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> favIcon)</code> +<div class="block">Specifies the icon contents that make up the contents of the page <js>"/resource-path/favicon.ico"</js>.</div> +</td> +</tr> +<tr id="i41" 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/RestConfig.html#setInfoProvider-java.lang.Class-">setInfoProvider</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><? extends <a href="../../../../org/apache/juneau/rest/RestInfoProvider.html" title="class in org.apache.juneau.rest">RestInfoProvider</a>> infoProvider)</code> +<div class="block">Overrides the info provider for the resource.</div> +</td> +</tr> +<tr id="i42" class="altColor"> +<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/RestConfig.html#setInfoProvider-org.apache.juneau.rest.RestInfoProvider-">setInfoProvider</a></span>(<a href="../../../../org/apache/juneau/rest/RestInfoProvider.html" title="class in org.apache.juneau.rest">RestInfoProvider</a> infoProvider)</code> +<div class="block">Overrides the info provider for the resource.</div> +</td> +</tr> +<tr id="i43" 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/RestConfig.html#setLogger-java.lang.Class-">setLogger</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><? extends <a href="../../../../org/apache/juneau/rest/RestLogger.html" title="class in org.apache.juneau.rest">RestLogger</a>> logger)</code> +<div class="block">Overrides the logger for the resource.</div> +</td> +</tr> +<tr id="i44" class="altColor"> +<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/RestConfig.html#setLogger-org.apache.juneau.rest.RestLogger-">setLogger</a></span>(<a href="../../../../org/apache/juneau/rest/RestLogger.html" title="class in org.apache.juneau.rest">RestLogger</a> logger)</code> +<div class="block">Overrides the logger for the resource.</div> +</td> +</tr> +<tr id="i45" 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/RestConfig.html#setPath-java.lang.String-">setPath</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> path)</code> +<div class="block">Sets the URL path of the resource <js>"/foobar"</js>.</div> +</td> +</tr> +<tr id="i46" class="altColor"> +<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/RestConfig.html#setProperties-java.util.Map-">setProperties</a></span>(<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>> properties)</code> +<div class="block">Sets multiple properties on this resource.</div> +</td> +</tr> +<tr id="i47" 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/RestConfig.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">Sets a property on this resource.</div> +</td> +</tr> +<tr id="i48" class="altColor"> +<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/RestConfig.html#setResourceResolver-java.lang.Class-">setResourceResolver</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><? extends <a href="../../../../org/apache/juneau/rest/RestResourceResolver.html" title="class in org.apache.juneau.rest">RestResourceResolver</a>> resourceResolver)</code> +<div class="block">Overrides the default REST resource resolver.</div> +</td> +</tr> +<tr id="i49" 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/RestConfig.html#setResourceResolver-org.apache.juneau.rest.RestResourceResolver-">setResourceResolver</a></span>(<a href="../../../../org/apache/juneau/rest/RestResourceResolver.html" title="class in org.apache.juneau.rest">RestResourceResolver</a> resourceResolver)</code> +<div class="block">Overrides the default REST resource resolver.</div> +</td> +</tr> +<tr id="i50" class="altColor"> +<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/RestConfig.html#setStyleSheet-java.lang.Class-java.lang.String-">setStyleSheet</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><?> resourceClass, + <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> resourcePath)</code> +<div class="block">Specifies the stylesheet that make up the contents of the page <js>"/resource-path/styles.css"</js>.</div> +</td> +</tr> +<tr id="i51" 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/RestConfig.html#setStyleSheet-java.lang.Object...-">setStyleSheet</a></span>(<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>... styleSheets)</code> +<div class="block">Specifies the stylesheets that make up the contents of the page <js>"/resource-path/styles.css"</js>.</div> +</td> +</tr> +<tr id="i52" class="altColor"> +<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/RestConfig.html#setSupportedAcceptTypes-org.apache.juneau.MediaType...-">setSupportedAcceptTypes</a></span>(<a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a>... mediaTypes)</code> +<div class="block">Specifies the list of supported <code>Accept</code> media types for this resource.</div> +</td> +</tr> +<tr id="i53" 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/RestConfig.html#setSupportedAcceptTypes-java.lang.String...-">setSupportedAcceptTypes</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>... mediaTypes)</code> +<div class="block">Specifies the list of supported <code>Accept</code> media types for this resource.</div> +</td> +</tr> +<tr id="i54" class="altColor"> +<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/RestConfig.html#setSupportedContentTypes-org.apache.juneau.MediaType...-">setSupportedContentTypes</a></span>(<a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a>... mediaTypes)</code> +<div class="block">Specifies the list of supported <code>Content-Type</code> media types for this resource.</div> +</td> +</tr> +<tr id="i55" 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/RestConfig.html#setSupportedContentTypes-java.lang.String...-">setSupportedContentTypes</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>... mediaTypes)</code> +<div class="block">Specifies the list of supported <code>Content-Type</code> media types for this resource.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<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></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="addVars-java.lang.Class...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addVars</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> <a href="../../../../src-html/org/apache/juneau/rest/RestConfig.html#line.255">addVars</a>(<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><?>... vars)</pre> +<div class="block">Adds the specified <a href="../../../../org/apache/juneau/svl/Var.html" title="class in org.apache.juneau.svl"><code>Var</code></a> classes to this config. + <p> + These variables affect the variable resolver returned by <a href="../../../../org/apache/juneau/rest/RestRequest.html#getVarResolverSession--"><code>RestRequest.getVarResolverSession()</code></a> which is + used to resolve string variables of the form <js>"$X{...}"</js>. + <p> + By default, this config includes the following variables: + <ul class='spaced-list'> + <li><a href="../../../../org/apache/juneau/svl/vars/SystemPropertiesVar.html" title="class in org.apache.juneau.svl.vars"><code>SystemPropertiesVar</code></a> + <li><a href="../../../../org/apache/juneau/svl/vars/EnvVariablesVar.html" title="class in org.apache.juneau.svl.vars"><code>EnvVariablesVar</code></a> + <li><a href="../../../../org/apache/juneau/svl/vars/ConfigFileVar.html" title="class in org.apache.juneau.svl.vars"><code>ConfigFileVar</code></a> + <li><a href="../../../../org/apache/juneau/svl/vars/IfVar.html" title="class in org.apache.juneau.svl.vars"><code>IfVar</code></a> + <li><a href="../../../../org/apache/juneau/svl/vars/SwitchVar.html" title="class in org.apache.juneau.svl.vars"><code>SwitchVar</code></a> + </ul> + <p> + Later during the construction of <a href="../../../../org/apache/juneau/rest/RestContext.html" title="class in org.apache.juneau.rest"><code>RestContext</code></a>, we add the following variables: + <ul> + <li><a href="../../../../org/apache/juneau/rest/vars/LocalizationVar.html" title="class in org.apache.juneau.rest.vars"><code>LocalizationVar</code></a> + <li><a href="../../../../org/apache/juneau/rest/vars/RequestVar.html" title="class in org.apache.juneau.rest.vars"><code>RequestVar</code></a> + <li><a href="../../../../org/apache/juneau/rest/vars/SerializedRequestAttrVar.html" title="class in org.apache.juneau.rest.vars"><code>SerializedRequestAttrVar</code></a> + <li><a href="../../../../org/apache/juneau/rest/vars/ServletInitParamVar.html" title="class in org.apache.juneau.rest.vars"><code>ServletInitParamVar</code></a> + <li><a href="../../../../org/apache/juneau/rest/vars/UrlEncodeVar.html" title="class in org.apache.juneau.rest.vars"><code>UrlEncodeVar</code></a> + </ul></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>vars</code> - The <a href="../../../../org/apache/juneau/svl/Var.html" title="class in org.apache.juneau.svl"><code>Var</code></a> classes to add to this config.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addVarContextObject-java.lang.String-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addVarContextObject</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> <a href="../../../../src-html/org/apache/juneau/rest/RestConfig.html#line.277">addVarContextObject</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> name, + <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> object)</pre> +<div class="block">Adds a var context object to this config. + <p> + Var context objects are read-only objects associated with the variable resolver for + vars that require external information. + <p> + For example, the <a href="../../../../org/apache/juneau/svl/vars/ConfigFileVar.html" title="class in org.apache.juneau.svl.vars"><code>ConfigFileVar</code></a> needs access to this resource's <a href="../../../../org/apache/juneau/ini/ConfigFile.html" title="class in org.apache.juneau.ini"><code>ConfigFile</code></a> through the <a href="../../../../org/apache/juneau/svl/vars/ConfigFileVar.html#SESSION_config"><code>ConfigFileVar.SESSION_config</code></a> + object that can be specified as either a session object (temporary) or context object (permanent). + In this case, we call the following code to add it to the context map: + <p class='bcode'> + config.addVarContextObject(<jsf>SESSION_config</jsf>, configFile); + </p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - The context object key (i.e. the name that the Var class looks for).</dd> +<dd><code>object</code> - The context object.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="setConfigFile-org.apache.juneau.ini.ConfigFile-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setConfigFile</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> <a href="../../../../src-html/org/apache/juneau/rest/RestConfig.html#line.291">setConfigFile</a>(<a href="../../../../org/apache/juneau/ini/ConfigFile.html" title="class in org.apache.juneau.ini">ConfigFile</a> configFile)</pre> +<div class="block">Overwrites the default config file with a custom config file. + <p> + By default, the config file is determined using the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#config--"><code>@RestResource.config()</code></a> annotation. + This method allows you to programmatically override it with your own custom config file.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>configFile</code> - The new config file.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="setProperty-java.lang.String-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setProperty</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> <a href="../../../../src-html/org/apache/juneau/rest/RestConfig.html#line.305">setProperty</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> 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)</pre> +<div class="block">Sets a property on this resource. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#properties--"><code>RestResource.properties()</code></a> annotation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>key</code> - The property name.</dd> +<dd><code>value</code> - The property value.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="setProperties-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setProperties</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> <a href="../../../../src-html/org/apache/juneau/rest/RestConfig.html#line.320">setProperties</a>(<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>> properties)</pre> +<div class="block">Sets multiple properties on this resource. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#properties--"><code>@RestResource.properties()</code></a> annotation. + <p> + Values in the map are added to the existing properties and are overwritten if duplicates are found.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>properties</code> - The new properties to add to this config.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addBeanFilters-java.lang.Class...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addBeanFilters</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> <a href="../../../../src-html/org/apache/juneau/rest/RestConfig.html#line.335">addBeanFilters</a>(<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)</pre> +<div class="block">Adds class-level bean filters to this resource. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#beanFilters--"><code>@RestResource.beanFilters()</code></a> annotation. + <p> + Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>beanFilters</code> - The bean filters to add to this config.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addPojoSwaps-java.lang.Class...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addPojoSwaps</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> <a href="../../../../src-html/org/apache/juneau/rest/RestConfig.html#line.350">addPojoSwaps</a>(<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)</pre> +<div class="block">Adds class-level pojo swaps to this resource. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#pojoSwaps--"><code>@RestResource.pojoSwaps()</code></a> annotation. + <p> + Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>pojoSwaps</code> - The pojo swaps to add to this config.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addSerializers-java.lang.Class...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addSerializers</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> <a href="../../../../src-html/org/apache/juneau/rest/RestConfig.html#line.365">addSerializers</a>(<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><?>... serializers)</pre> +<div class="block">Adds class-level serializers to this resource. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#serializers--"><code>@RestResource.serializers()</code></a> annotation. + <p> + Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>serializers</code> - The serializer classes to add to this config.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addSerializers-org.apache.juneau.serializer.Serializer...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addSerializers</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> <a href="../../../../src-html/org/apache/juneau/rest/RestConfig.html#line.384">addSerializers</a>(<a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a>... serializers)</pre> +<div class="block">Adds class-level serializers to this resource. + <p> + Same as <a href="../../../../org/apache/juneau/rest/RestConfig.html#addSerializers-java.lang.Class...-"><code>addSerializers(Class...)</code></a> except allows you to pass in serializer instances. + The actual serializer ends up being the result of this operation using the bean filters, pojo swaps, and properties on this config: + <p class='bcode'> + serializer = serializer.builder().beanFilters(beanFilters).pojoSwaps(pojoSwaps).properties(properties).build(); + </p> + <p> + Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>serializers</code> - The serializers to add to this config.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addParsers-java.lang.Class...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addParsers</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> <a href="../../../../src-html/org/apache/juneau/rest/RestConfig.html#line.399">addParsers</a>(<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><?>... parsers)</pre> +<div class="block">Adds class-level parsers to this resource. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#parsers--"><code>@RestResource.parsers()</code></a> annotation. + <p> + Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>parsers</code> - The parser classes to add to this config.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addParsers-org.apache.juneau.parser.Parser...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addParsers</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> <a href="../../../../src-html/org/apache/juneau/rest/RestConfig.html#line.418">addParsers</a>(<a href="../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser">Parser</a>... parsers)</pre> +<div class="block">Adds class-level parsers to this resource. + <p> + Same as <a href="../../../../org/apache/juneau/rest/RestConfig.html#addParsers-java.lang.Class...-"><code>addParsers(Class...)</code></a> except allows you to pass in parser instances. + The actual parser ends up being the result of this operation using the bean filters, pojo swaps, and properties on this config: + <p class='bcode'> + parser = parser.builder().beanFilters(beanFilters).pojoSwaps(pojoSwaps).properties(properties).build(); + </p> + <p> + Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>parsers</code> - The parsers to add to this config.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addEncoders-java.lang.Class...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addEncoders</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> <a href="../../../../src-html/org/apache/juneau/rest/RestConfig.html#line.435">addEncoders</a>(<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><?>... encoders)</pre> +<div class="block">Adds class-level encoders to this resource. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#encoders--"><code>@RestResource.encoders()</code></a> annotation. + <p> + Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation. + <p> + By default, only the <a href="../../../../org/apache/juneau/encoders/IdentityEncoder.html" title="class in org.apache.juneau.encoders"><code>IdentityEncoder</code></a> is included in this list.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>encoders</code> - The parser classes to add to this config.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addEncoders-org.apache.juneau.encoders.Encoder...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addEncoders</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> <a href="../../../../src-html/org/apache/juneau/rest/RestConfig.html#line.448">addEncoders</a>(<a href="../../../../org/apache/juneau/encoders/Encoder.html" title="class in org.apache.juneau.encoders">Encoder</a>... encoders)</pre> +<div class="block">Adds class-level encoders to this resource. + <p> + Same as <a href="../../../../org/apache/juneau/rest/RestConfig.html#addEncoders-java.lang.Class...-"><code>addEncoders(Class...)</code></a> except allows you to pass in encoder instances.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>encoders</code> - The encoders to add to this config.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addConverters-java.lang.Class...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addConverters</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> <a href="../../../../src-html/org/apache/juneau/rest/RestConfig.html#line.473">addConverters</a>(<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><?>... converters)</pre> +<div class="block">Adds class-level converters to this resource. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#converters--"><code>@RestResource.converters()</code></a> annotation. + <p> + Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation. + <p> + By default, this config includes the following converters: + <ul class='spaced-list'> + <li><a href="../../../../org/apache/juneau/rest/response/StreamableHandler.html" title="class in org.apache.juneau.rest.response"><code>StreamableHandler</code></a> + <li><a href="../../../../org/apache/juneau/rest/response/WritableHandler.html" title="class in org.apache.juneau.rest.response"><code>WritableHandler</code></a> + <li><a href="../../../../org/apache/juneau/rest/response/ReaderHandler.html" title="class in org.apache.juneau.rest.response"><code>ReaderHandler</code></a> + <li><a href="../../../../org/apache/juneau/rest/response/InputStreamHandler.html" title="class in org.apache.juneau.rest.response"><code>InputStreamHandler</code></a> + <li><a href="../../../../org/apache/juneau/rest/response/RedirectHandler.html" title="class in org.apache.juneau.rest.response"><code>RedirectHandler</code></a> + <li><a href="../../../../org/apache/juneau/rest/response/DefaultHandler.html" title="class in org.apache.juneau.rest.response"><code>DefaultHandler</code></a> + </ul></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>converters</code> - The converter classes to add to this config.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addConverters-org.apache.juneau.rest.RestConverter...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addConverters</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> <a href="../../../../src-html/org/apache/juneau/rest/RestConfig.html#line.486">addConverters</a>(<a href="../../../../org/apache/juneau/rest/RestConverter.html" title="interface in org.apache.juneau.rest">RestConverter</a>... converters)</pre> +<div class="block">Adds class-level encoders to this resource. + <p> + Same as <a href="../../../../org/apache/juneau/rest/RestConfig.html#addConverters-java.lang.Class...-"><code>addConverters(Class...)</code></a> except allows you to pass in converter instances.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>converters</code> - The converters to add to this config.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addGuards-java.lang.Class...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addGuards</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> <a href="../../../../src-html/org/apache/juneau/rest/RestConfig.html#line.501">addGuards</a>(<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><?>... guards)</pre> +<div class="block">Adds class-level guards to this resource. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#guards--"><code>@RestResource.guards()</code></a> annotation. + <p> + Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>guards</code> - The guard classes to add to this config.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addGuards-org.apache.juneau.rest.RestGuard...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addGuards</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> <a href="../../../../src-html/org/apache/juneau/rest/RestConfig.html#line.514">addGuards</a>(<a href="../../../../org/apache/juneau/rest/RestGuard.html" title="class in org.apache.juneau.rest">RestGuard</a>... guards)</pre> +<div class="block">Adds class-level guards to this resource. + <p> + Same as <a href="../../../../org/apache/juneau/rest/RestConfig.html#addGuards-java.lang.Class...-"><code>addGuards(Class...)</code></a> except allows you to pass in guard instances.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>guards</code> - The guards to add to this config.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addMimeTypes-java.lang.String...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addMimeTypes</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> <a href="../../../../src-html/org/apache/juneau/rest/RestConfig.html#line.545">addMimeTypes</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>... mimeTypes)</pre> +<div class="block">Adds MIME-type definitions. + <p> + These definitions are used in the following locations for setting the media type on responses: + <ul> + <li><a href="../../../../org/apache/juneau/rest/RestRequest.html#getReaderResource-java.lang.String-"><code>RestRequest.getReaderResource(String)</code></a> + <li>Static files resolved through <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#staticFiles--"><code>RestResource.staticFiles()</code></a> + </ul> + <p> + Refer to <a href="http://docs.oracle.com/javase/7/docs/api/javax/activation/MimetypesFileTypeMap.html?is-external=true#addMimeTypes-java.lang.String-"; title="class or interface in javax.activation"><code>MimetypesFileTypeMap.addMimeTypes(String)</code></a> for an explanation of the format. + <p> + By default, this config includes the following mime-type definitions: + <ul class='spaced-list'> + <li><js>"text/css css CSS"</js> + <li><js>"text/html html htm HTML"</js> + <li><js>"text/plain txt text TXT"</js> + <li><js>"application/javascript js"</js> + <li><js>"image/png png"</js> + <li><js>"image/gif gif"</js> + <li><js>"application/xml xml XML"</js> + <li><js>"application/json json JSON"</js> + </ul></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>mimeTypes</code> - The MIME-types to add to this config.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addDefaultRequestHeader-java.lang.String-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addDefaultRequestHeader</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> <a href="../../../../src-html/org/apache/juneau/rest/RestConfig.html#line.563">addDefaultRequestHeader</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> name, + <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)</pre> +<div class="block">Adds class-level default HTTP request headers to this resource. + <p> + Default request headers are default values for when HTTP requests do not specify a header value. + For example, you can specify a default value for <code>Accept</code> if a request does not specify that header value. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#defaultRequestHeaders--"><code>@RestResource.defaultRequestHeaders()</code></a> annotation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - The HTTP header name.</dd> +<dd><code>value</code> - The HTTP header value.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addDefaultRequestHeaders-java.lang.String...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addDefaultRequestHeaders</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> <a href="../../../../src-html/org/apache/juneau/rest/RestConfig.html#line.580">addDefaultRequestHeaders</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>... headers) + throws <a href="../../../../org/apache/juneau/rest/RestServletException.html" title="class in org.apache.juneau.rest">RestServletException</a></pre> +<div class="block">Adds class-level default HTTP request headers to this resource. + <p> + Default request headers are default values for when HTTP requests do not specify a header value. + For example, you can specify a default value for <code>Accept</code> if a request does not specify that header value. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#defaultRequestHeaders--"><code>@RestResource.defaultRequestHeaders()</code></a> annotation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>headers</code> - HTTP headers of the form <js>"Name: Value"</js>.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/rest/RestServletException.html" title="class in org.apache.juneau.rest">RestServletException</a></code> - If header string is not correctly formatted.</dd> +</dl> +</li> +</ul> +<a name="addDefaultResponseHeader-java.lang.String-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addDefaultResponseHeader</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> <a href="../../../../src-html/org/apache/juneau/rest/RestConfig.html#line.604">addDefaultResponseHeader</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> name, + <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)</pre> +<div class="block">Adds class-level default HTTP response headers to this resource. + <p> + Default response headers are headers that will be appended to all responses if those headers have not already been + set on the response object. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#defaultResponseHeaders--"><code>@RestResource.defaultResponseHeaders()</code></a> annotation. + <p> + Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - The HTTP header name.</dd> +<dd><code>value</code> - The HTTP header value.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addDefaultResponseHeaders-java.lang.String...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addDefaultResponseHeaders</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> <a href="../../../../src-html/org/apache/juneau/rest/RestConfig.html#line.621">addDefaultResponseHeaders</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>... headers) + throws <a href="../../../../org/apache/juneau/rest/RestServletException.html" title="class in org.apache.juneau.rest">RestServletException</a></pre> +<div class="block">Adds class-level default HTTP response headers to this resource. + <p> + Default response headers are headers that will be appended to all responses if those headers have not already been + set on the response object. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#defaultResponseHeaders--"><code>@RestResource.defaultResponseHeaders()</code></a> annotation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>headers</code> - HTTP headers of the form <js>"Name: Value"</js>.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/rest/RestServletException.html" title="class in org.apache.juneau.rest">RestServletException</a></code> - If header string is not correctly formatted.</dd> +</dl> +</li> +</ul> +<a name="addResponseHandlers-java.lang.Class...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addResponseHandlers</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> <a href="../../../../src-html/org/apache/juneau/rest/RestConfig.html#line.651">addResponseHandlers</a>(<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><?>... responseHandlers)</pre> +<div class="block">Adds class-level response handler classes to this resource. + <p> + Response handlers are responsible for converting various POJOs returned by REST methods into actual HTTP responses. + <p> + By default, this config includes the following response handlers: + <ul class='spaced-list'> + <li><a href="../../../../org/apache/juneau/rest/response/StreamableHandler.html" title="class in org.apache.juneau.rest.response"><code>StreamableHandler</code></a> + <li><a href="../../../../org/apache/juneau/rest/response/WritableHandler.html" title="class in org.apache.juneau.rest.response"><code>WritableHandler</code></a> + <li><a href="../../../../org/apache/juneau/rest/response/ReaderHandler.html" title="class in org.apache.juneau.rest.response"><code>ReaderHandler</code></a> + <li><a href="../../../../org/apache/juneau/rest/response/InputStreamHandler.html" title="class in org.apache.juneau.rest.response"><code>InputStreamHandler</code></a> + <li><a href="../../../../org/apache/juneau/rest/response/RedirectHandler.html" title="class in org.apache.juneau.rest.response"><code>RedirectHandler</code></a> + <li><a href="../../../../org/apache/juneau/rest/response/DefaultHandler.html" title="class in org.apache.juneau.rest.response"><code>DefaultHandler</code></a> + </ul> + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#responseHandlers--"><code>@RestResource.responseHandlers()</code></a> annotation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>responseHandlers</code> - The response handlers to add to this config.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addResponseHandlers-org.apache.juneau.rest.ResponseHandler...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addResponseHandlers</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> <a href="../../../../src-html/org/apache/juneau/rest/RestConfig.html#line.664">addResponseHandlers</a>(<a href="../../../../org/apache/juneau/rest/ResponseHandler.html" title="interface in org.apache.juneau.rest">ResponseHandler</a>... responseHandlers)</pre> +<div class="block">Adds class-level response handlers to this resource. + <p> + Same as <a href="../../../../org/apache/juneau/rest/RestConfig.html#addResponseHandlers-java.lang.Class...-"><code>addResponseHandlers(Class...)</code></a> except allows you to pass in response handler instances.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>responseHandlers</code> - The response handlers to add to this config.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addChildResource-java.lang.String-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addChildResource</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> <a href="../../../../src-html/org/apache/juneau/rest/RestConfig.html#line.680">addChildResource</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> path, + <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> child)</pre> +<div class="block">Adds a child resource to this resource. + <p> + Child resources are resources that are accessed under the path of the parent resource. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#children--"><code>@RestResource.children()</code></a> annotation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>path</code> - The child path of the resource. Must conform to <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#path--"><code>RestResource.path()</code></a> format.</dd> +<dd><code>child</code> - The child resource.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addChildResources-java.lang.Object...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addChildResources</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> <a href="../../../../src-html/org/apache/juneau/rest/RestConfig.html#line.696">addChildResources</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>... children)</pre> +<div class="block">Add child resources to this resource. + <p> + Child resources are resources that are accessed under the path of the parent resource. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#children--"><code>@RestResource.children()</code></a> annotation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>children</code> - The child resources to add to this resource. + Children must be annotated with <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#path--"><code>RestResource.path()</code></a> to identify the child path.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="addChildResources-java.lang.Class...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addChildResources</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestConfig.html" title="class in org.apache.juneau.rest">RestConfig</a> <a href="../../../../src-html/org/apache/juneau/rest/RestConfig.html#line.712">addChildResources</a>(<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><?>... children)</pre> +<div class="block">Add child resources to this resource. + <p> + Child resources are resources that are accessed under the path of the parent resource. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#children--"><code>@RestResource.children()</code></a> annotation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>children</code> - The child resources to add to this resource. + Children must be annotated with <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#path--"><code>RestResource.path()</code></a> to identify the child pa
<TRUNCATED>
