You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2017/08/14 14:58:08 UTC
[3/6] incubator-juneau-website git commit: Update Javadocs on
@RestHook support.
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/07548003/content/site/apidocs/src-html/org/apache/juneau/rest/RestConfig.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/RestConfig.html b/content/site/apidocs/src-html/org/apache/juneau/rest/RestConfig.html
index 1a4ddc5..2efc020 100644
--- a/content/site/apidocs/src-html/org/apache/juneau/rest/RestConfig.html
+++ b/content/site/apidocs/src-html/org/apache/juneau/rest/RestConfig.html
@@ -289,1351 +289,1352 @@
<span class="sourceLineNo">281</span> Map<String,Method> map = new LinkedHashMap<String,Method>();<a name="line.281"></a>
<span class="sourceLineNo">282</span> for (Method m : ClassUtils.getAllMethods(this.resourceClass, true)) {<a name="line.282"></a>
<span class="sourceLineNo">283</span> if (m.isAnnotationPresent(RestHook.class) && m.getAnnotation(RestHook.class).value() == HookEvent.INIT) {<a name="line.283"></a>
-<span class="sourceLineNo">284</span> String sig = ClassUtils.getMethodSignature(m);<a name="line.284"></a>
-<span class="sourceLineNo">285</span> if (! map.containsKey(sig))<a name="line.285"></a>
-<span class="sourceLineNo">286</span> map.put(sig, m);<a name="line.286"></a>
-<span class="sourceLineNo">287</span> }<a name="line.287"></a>
-<span class="sourceLineNo">288</span> }<a name="line.288"></a>
-<span class="sourceLineNo">289</span> for (Method m : map.values()) {<a name="line.289"></a>
-<span class="sourceLineNo">290</span> ClassUtils.assertArgsOfType(m, RestConfig.class, ServletConfig.class);<a name="line.290"></a>
-<span class="sourceLineNo">291</span> Class<?>[] argTypes = m.getParameterTypes();<a name="line.291"></a>
-<span class="sourceLineNo">292</span> Object[] args = new Object[argTypes.length];<a name="line.292"></a>
-<span class="sourceLineNo">293</span> for (int i = 0; i < args.length; i++) {<a name="line.293"></a>
-<span class="sourceLineNo">294</span> if (argTypes[i] == RestConfig.class)<a name="line.294"></a>
-<span class="sourceLineNo">295</span> args[i] = this;<a name="line.295"></a>
-<span class="sourceLineNo">296</span> else<a name="line.296"></a>
-<span class="sourceLineNo">297</span> args[i] = this.inner;<a name="line.297"></a>
-<span class="sourceLineNo">298</span> }<a name="line.298"></a>
-<span class="sourceLineNo">299</span> try {<a name="line.299"></a>
-<span class="sourceLineNo">300</span> m.invoke(resource, args);<a name="line.300"></a>
-<span class="sourceLineNo">301</span> } catch (Exception e) {<a name="line.301"></a>
-<span class="sourceLineNo">302</span> throw new RestServletException("Exception thrown from @RestHook(INIT) method {0}.", m).initCause(e);<a name="line.302"></a>
-<span class="sourceLineNo">303</span> }<a name="line.303"></a>
-<span class="sourceLineNo">304</span> }<a name="line.304"></a>
-<span class="sourceLineNo">305</span> }<a name="line.305"></a>
-<span class="sourceLineNo">306</span><a name="line.306"></a>
-<span class="sourceLineNo">307</span> /**<a name="line.307"></a>
-<span class="sourceLineNo">308</span> * Adds the specified {@link Var} classes to this config.<a name="line.308"></a>
-<span class="sourceLineNo">309</span> *<a name="line.309"></a>
-<span class="sourceLineNo">310</span> * <p><a name="line.310"></a>
-<span class="sourceLineNo">311</span> * These variables affect the variable resolver returned by {@link RestRequest#getVarResolverSession()} which is<a name="line.311"></a>
-<span class="sourceLineNo">312</span> * used to resolve string variables of the form <js>"$X{...}"</js>.<a name="line.312"></a>
-<span class="sourceLineNo">313</span> *<a name="line.313"></a>
-<span class="sourceLineNo">314</span> * <p><a name="line.314"></a>
-<span class="sourceLineNo">315</span> * By default, this config includes the following variables:<a name="line.315"></a>
-<span class="sourceLineNo">316</span> * <ul><a name="line.316"></a>
-<span class="sourceLineNo">317</span> * <li>{@link SystemPropertiesVar}<a name="line.317"></a>
-<span class="sourceLineNo">318</span> * <li>{@link EnvVariablesVar}<a name="line.318"></a>
-<span class="sourceLineNo">319</span> * <li>{@link ConfigFileVar}<a name="line.319"></a>
-<span class="sourceLineNo">320</span> * <li>{@link IfVar}<a name="line.320"></a>
-<span class="sourceLineNo">321</span> * <li>{@link SwitchVar}<a name="line.321"></a>
-<span class="sourceLineNo">322</span> * </ul><a name="line.322"></a>
-<span class="sourceLineNo">323</span> *<a name="line.323"></a>
-<span class="sourceLineNo">324</span> * <p><a name="line.324"></a>
-<span class="sourceLineNo">325</span> * Later during the construction of {@link RestContext}, we add the following variables:<a name="line.325"></a>
-<span class="sourceLineNo">326</span> * <ul><a name="line.326"></a>
-<span class="sourceLineNo">327</span> * <li>{@link LocalizationVar}<a name="line.327"></a>
-<span class="sourceLineNo">328</span> * <li>{@link RequestVar}<a name="line.328"></a>
-<span class="sourceLineNo">329</span> * <li>{@link SerializedRequestAttrVar}<a name="line.329"></a>
-<span class="sourceLineNo">330</span> * <li>{@link ServletInitParamVar}<a name="line.330"></a>
-<span class="sourceLineNo">331</span> * <li>{@link UrlVar}<a name="line.331"></a>
-<span class="sourceLineNo">332</span> * <li>{@link UrlEncodeVar}<a name="line.332"></a>
-<span class="sourceLineNo">333</span> * <li>{@link WidgetVar}<a name="line.333"></a>
-<span class="sourceLineNo">334</span> * </ul><a name="line.334"></a>
-<span class="sourceLineNo">335</span> *<a name="line.335"></a>
-<span class="sourceLineNo">336</span> * @param vars The {@link Var} classes to add to this config.<a name="line.336"></a>
-<span class="sourceLineNo">337</span> * @return This object (for method chaining).<a name="line.337"></a>
-<span class="sourceLineNo">338</span> */<a name="line.338"></a>
-<span class="sourceLineNo">339</span> public RestConfig addVars(Class<?>...vars) {<a name="line.339"></a>
-<span class="sourceLineNo">340</span> this.varResolverBuilder.vars(vars);<a name="line.340"></a>
-<span class="sourceLineNo">341</span> return this;<a name="line.341"></a>
-<span class="sourceLineNo">342</span> }<a name="line.342"></a>
-<span class="sourceLineNo">343</span><a name="line.343"></a>
-<span class="sourceLineNo">344</span> /**<a name="line.344"></a>
-<span class="sourceLineNo">345</span> * Adds a var context object to this config.<a name="line.345"></a>
-<span class="sourceLineNo">346</span> *<a name="line.346"></a>
-<span class="sourceLineNo">347</span> * <p><a name="line.347"></a>
-<span class="sourceLineNo">348</span> * Var context objects are read-only objects associated with the variable resolver for vars that require external<a name="line.348"></a>
-<span class="sourceLineNo">349</span> * information.<a name="line.349"></a>
-<span class="sourceLineNo">350</span> *<a name="line.350"></a>
-<span class="sourceLineNo">351</span> * <p><a name="line.351"></a>
-<span class="sourceLineNo">352</span> * For example, the {@link ConfigFileVar} needs access to this resource's {@link ConfigFile} through the<a name="line.352"></a>
-<span class="sourceLineNo">353</span> * {@link ConfigFileVar#SESSION_config} object that can be specified as either a session object (temporary) or<a name="line.353"></a>
-<span class="sourceLineNo">354</span> * context object (permanent).<a name="line.354"></a>
-<span class="sourceLineNo">355</span> * In this case, we call the following code to add it to the context map:<a name="line.355"></a>
-<span class="sourceLineNo">356</span> * <p class='bcode'><a name="line.356"></a>
-<span class="sourceLineNo">357</span> * config.addVarContextObject(<jsf>SESSION_config</jsf>, configFile);<a name="line.357"></a>
-<span class="sourceLineNo">358</span> * </p><a name="line.358"></a>
-<span class="sourceLineNo">359</span> *<a name="line.359"></a>
-<span class="sourceLineNo">360</span> * @param name The context object key (i.e. the name that the Var class looks for).<a name="line.360"></a>
-<span class="sourceLineNo">361</span> * @param object The context object.<a name="line.361"></a>
-<span class="sourceLineNo">362</span> * @return This object (for method chaining).<a name="line.362"></a>
-<span class="sourceLineNo">363</span> */<a name="line.363"></a>
-<span class="sourceLineNo">364</span> public RestConfig addVarContextObject(String name, Object object) {<a name="line.364"></a>
-<span class="sourceLineNo">365</span> this.varResolverBuilder.contextObject(name, object);<a name="line.365"></a>
-<span class="sourceLineNo">366</span> return this;<a name="line.366"></a>
-<span class="sourceLineNo">367</span> }<a name="line.367"></a>
-<span class="sourceLineNo">368</span><a name="line.368"></a>
-<span class="sourceLineNo">369</span> /**<a name="line.369"></a>
-<span class="sourceLineNo">370</span> * Overwrites the default config file with a custom config file.<a name="line.370"></a>
-<span class="sourceLineNo">371</span> *<a name="line.371"></a>
-<span class="sourceLineNo">372</span> * <p><a name="line.372"></a>
-<span class="sourceLineNo">373</span> * By default, the config file is determined using the {@link RestResource#config() @RestResource.config()}<a name="line.373"></a>
-<span class="sourceLineNo">374</span> * annotation.<a name="line.374"></a>
-<span class="sourceLineNo">375</span> * This method allows you to programmatically override it with your own custom config file.<a name="line.375"></a>
-<span class="sourceLineNo">376</span> *<a name="line.376"></a>
-<span class="sourceLineNo">377</span> * @param configFile The new config file.<a name="line.377"></a>
-<span class="sourceLineNo">378</span> * @return This object (for method chaining).<a name="line.378"></a>
-<span class="sourceLineNo">379</span> */<a name="line.379"></a>
-<span class="sourceLineNo">380</span> public RestConfig setConfigFile(ConfigFile configFile) {<a name="line.380"></a>
-<span class="sourceLineNo">381</span> this.configFile = configFile;<a name="line.381"></a>
-<span class="sourceLineNo">382</span> return this;<a name="line.382"></a>
-<span class="sourceLineNo">383</span> }<a name="line.383"></a>
-<span class="sourceLineNo">384</span><a name="line.384"></a>
-<span class="sourceLineNo">385</span> /**<a name="line.385"></a>
-<span class="sourceLineNo">386</span> * Sets a property on this resource.<a name="line.386"></a>
-<span class="sourceLineNo">387</span> *<a name="line.387"></a>
-<span class="sourceLineNo">388</span> * <p><a name="line.388"></a>
-<span class="sourceLineNo">389</span> * This is the programmatic equivalent to the {@link RestResource#properties()} annotation.<a name="line.389"></a>
-<span class="sourceLineNo">390</span> *<a name="line.390"></a>
-<span class="sourceLineNo">391</span> * @param key The property name.<a name="line.391"></a>
-<span class="sourceLineNo">392</span> * @param value The property value.<a name="line.392"></a>
-<span class="sourceLineNo">393</span> * @return This object (for method chaining).<a name="line.393"></a>
-<span class="sourceLineNo">394</span> */<a name="line.394"></a>
-<span class="sourceLineNo">395</span> public RestConfig setProperty(String key, Object value) {<a name="line.395"></a>
-<span class="sourceLineNo">396</span> this.properties.put(key, value);<a name="line.396"></a>
-<span class="sourceLineNo">397</span> return this;<a name="line.397"></a>
-<span class="sourceLineNo">398</span> }<a name="line.398"></a>
-<span class="sourceLineNo">399</span><a name="line.399"></a>
-<span class="sourceLineNo">400</span> /**<a name="line.400"></a>
-<span class="sourceLineNo">401</span> * Sets multiple properties on this resource.<a name="line.401"></a>
-<span class="sourceLineNo">402</span> *<a name="line.402"></a>
-<span class="sourceLineNo">403</span> * <p><a name="line.403"></a>
-<span class="sourceLineNo">404</span> * This is the programmatic equivalent to the {@link RestResource#properties() @RestResource.properties()} annotation.<a name="line.404"></a>
-<span class="sourceLineNo">405</span> *<a name="line.405"></a>
-<span class="sourceLineNo">406</span> * <p><a name="line.406"></a>
-<span class="sourceLineNo">407</span> * Values in the map are added to the existing properties and are overwritten if duplicates are found.<a name="line.407"></a>
-<span class="sourceLineNo">408</span> *<a name="line.408"></a>
-<span class="sourceLineNo">409</span> * @param properties The new properties to add to this config.<a name="line.409"></a>
-<span class="sourceLineNo">410</span> * @return This object (for method chaining).<a name="line.410"></a>
-<span class="sourceLineNo">411</span> */<a name="line.411"></a>
-<span class="sourceLineNo">412</span> public RestConfig setProperties(Map<String,Object> properties) {<a name="line.412"></a>
-<span class="sourceLineNo">413</span> this.properties.putAll(properties);<a name="line.413"></a>
-<span class="sourceLineNo">414</span> return this;<a name="line.414"></a>
-<span class="sourceLineNo">415</span> }<a name="line.415"></a>
-<span class="sourceLineNo">416</span><a name="line.416"></a>
-<span class="sourceLineNo">417</span> /**<a name="line.417"></a>
-<span class="sourceLineNo">418</span> * Adds class-level bean filters to this resource.<a name="line.418"></a>
-<span class="sourceLineNo">419</span> *<a name="line.419"></a>
-<span class="sourceLineNo">420</span> * <p><a name="line.420"></a>
-<span class="sourceLineNo">421</span> * This is the programmatic equivalent to the {@link RestResource#beanFilters() @RestResource.beanFilters()}<a name="line.421"></a>
-<span class="sourceLineNo">422</span> * annotation.<a name="line.422"></a>
-<span class="sourceLineNo">423</span> *<a name="line.423"></a>
-<span class="sourceLineNo">424</span> * <p><a name="line.424"></a>
-<span class="sourceLineNo">425</span> * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the<a name="line.425"></a>
-<span class="sourceLineNo">426</span> * annotation.<a name="line.426"></a>
-<span class="sourceLineNo">427</span> *<a name="line.427"></a>
-<span class="sourceLineNo">428</span> * @param beanFilters The bean filters to add to this config.<a name="line.428"></a>
-<span class="sourceLineNo">429</span> * @return This object (for method chaining).<a name="line.429"></a>
-<span class="sourceLineNo">430</span> */<a name="line.430"></a>
-<span class="sourceLineNo">431</span> public RestConfig addBeanFilters(Class<?>...beanFilters) {<a name="line.431"></a>
-<span class="sourceLineNo">432</span> this.beanFilters.addAll(Arrays.asList(beanFilters));<a name="line.432"></a>
-<span class="sourceLineNo">433</span> return this;<a name="line.433"></a>
-<span class="sourceLineNo">434</span> }<a name="line.434"></a>
-<span class="sourceLineNo">435</span><a name="line.435"></a>
-<span class="sourceLineNo">436</span> /**<a name="line.436"></a>
-<span class="sourceLineNo">437</span> * Adds class-level pojo swaps to this resource.<a name="line.437"></a>
-<span class="sourceLineNo">438</span> *<a name="line.438"></a>
-<span class="sourceLineNo">439</span> * <p><a name="line.439"></a>
-<span class="sourceLineNo">440</span> * This is the programmatic equivalent to the {@link RestResource#pojoSwaps() @RestResource.pojoSwaps()} annotation.<a name="line.440"></a>
-<span class="sourceLineNo">441</span> *<a name="line.441"></a>
-<span class="sourceLineNo">442</span> * <p><a name="line.442"></a>
-<span class="sourceLineNo">443</span> * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the<a name="line.443"></a>
-<span class="sourceLineNo">444</span> * annotation.<a name="line.444"></a>
-<span class="sourceLineNo">445</span> *<a name="line.445"></a>
-<span class="sourceLineNo">446</span> * @param pojoSwaps The pojo swaps to add to this config.<a name="line.446"></a>
-<span class="sourceLineNo">447</span> * @return This object (for method chaining).<a name="line.447"></a>
-<span class="sourceLineNo">448</span> */<a name="line.448"></a>
-<span class="sourceLineNo">449</span> public RestConfig addPojoSwaps(Class<?>...pojoSwaps) {<a name="line.449"></a>
-<span class="sourceLineNo">450</span> this.pojoSwaps.addAll(Arrays.asList(pojoSwaps));<a name="line.450"></a>
-<span class="sourceLineNo">451</span> return this;<a name="line.451"></a>
-<span class="sourceLineNo">452</span> }<a name="line.452"></a>
-<span class="sourceLineNo">453</span><a name="line.453"></a>
-<span class="sourceLineNo">454</span> /**<a name="line.454"></a>
-<span class="sourceLineNo">455</span> * Specifies the serializer listener class to use for listening to non-fatal serialization errors.<a name="line.455"></a>
-<span class="sourceLineNo">456</span> *<a name="line.456"></a>
-<span class="sourceLineNo">457</span> * <p><a name="line.457"></a>
-<span class="sourceLineNo">458</span> * This is the programmatic equivalent to the<a name="line.458"></a>
-<span class="sourceLineNo">459</span> * {@link RestResource#serializerListener() @RestResource.serializerListener()} annotation.<a name="line.459"></a>
-<span class="sourceLineNo">460</span> *<a name="line.460"></a>
-<span class="sourceLineNo">461</span> * @param listener The listener to add to this config.<a name="line.461"></a>
-<span class="sourceLineNo">462</span> * @return This object (for method chaining).<a name="line.462"></a>
-<span class="sourceLineNo">463</span> */<a name="line.463"></a>
-<span class="sourceLineNo">464</span> public RestConfig serializerListener(Class<? extends SerializerListener> listener) {<a name="line.464"></a>
-<span class="sourceLineNo">465</span> if (listener != SerializerListener.class)<a name="line.465"></a>
-<span class="sourceLineNo">466</span> this.serializerListener = listener;<a name="line.466"></a>
-<span class="sourceLineNo">467</span> return this;<a name="line.467"></a>
-<span class="sourceLineNo">468</span> }<a name="line.468"></a>
-<span class="sourceLineNo">469</span><a name="line.469"></a>
-<span class="sourceLineNo">470</span> /**<a name="line.470"></a>
-<span class="sourceLineNo">471</span> * Specifies the parser listener class to use for listening to non-fatal parse errors.<a name="line.471"></a>
-<span class="sourceLineNo">472</span> *<a name="line.472"></a>
-<span class="sourceLineNo">473</span> * <p><a name="line.473"></a>
-<span class="sourceLineNo">474</span> * This is the programmatic equivalent to the<a name="line.474"></a>
-<span class="sourceLineNo">475</span> * {@link RestResource#parserListener() @RestResource.parserListener()} annotation.<a name="line.475"></a>
-<span class="sourceLineNo">476</span> *<a name="line.476"></a>
-<span class="sourceLineNo">477</span> * @param listener The listener to add to this config.<a name="line.477"></a>
-<span class="sourceLineNo">478</span> * @return This object (for method chaining).<a name="line.478"></a>
-<span class="sourceLineNo">479</span> */<a name="line.479"></a>
-<span class="sourceLineNo">480</span> public RestConfig parserListener(Class<? extends ParserListener> listener) {<a name="line.480"></a>
-<span class="sourceLineNo">481</span> if (listener != ParserListener.class)<a name="line.481"></a>
-<span class="sourceLineNo">482</span> this.parserListener = listener;<a name="line.482"></a>
-<span class="sourceLineNo">483</span> return this;<a name="line.483"></a>
-<span class="sourceLineNo">484</span> }<a name="line.484"></a>
-<span class="sourceLineNo">485</span><a name="line.485"></a>
-<span class="sourceLineNo">486</span> /**<a name="line.486"></a>
-<span class="sourceLineNo">487</span> * Adds class-level parameter resolvers to this resource.<a name="line.487"></a>
-<span class="sourceLineNo">488</span> *<a name="line.488"></a>
-<span class="sourceLineNo">489</span> * <p><a name="line.489"></a>
-<span class="sourceLineNo">490</span> * This is the programmatic equivalent to the<a name="line.490"></a>
-<span class="sourceLineNo">491</span> * {@link RestResource#paramResolvers() @RestResource.paramResolvers()} annotation.<a name="line.491"></a>
-<span class="sourceLineNo">492</span> *<a name="line.492"></a>
-<span class="sourceLineNo">493</span> * @param paramResolvers The parameter resolvers to add to this config.<a name="line.493"></a>
-<span class="sourceLineNo">494</span> * @return This object (for method chaining).<a name="line.494"></a>
-<span class="sourceLineNo">495</span> */<a name="line.495"></a>
-<span class="sourceLineNo">496</span> public RestConfig addParamResolvers(Class<? extends RestParam>...paramResolvers) {<a name="line.496"></a>
-<span class="sourceLineNo">497</span> this.paramResolvers.addAll(Arrays.asList(paramResolvers));<a name="line.497"></a>
-<span class="sourceLineNo">498</span> return this;<a name="line.498"></a>
-<span class="sourceLineNo">499</span> }<a name="line.499"></a>
-<span class="sourceLineNo">500</span><a name="line.500"></a>
-<span class="sourceLineNo">501</span> /**<a name="line.501"></a>
-<span class="sourceLineNo">502</span> * Adds class-level serializers to this resource.<a name="line.502"></a>
-<span class="sourceLineNo">503</span> *<a name="line.503"></a>
-<span class="sourceLineNo">504</span> * <p><a name="line.504"></a>
-<span class="sourceLineNo">505</span> * This is the programmatic equivalent to the {@link RestResource#serializers() @RestResource.serializers()}<a name="line.505"></a>
-<span class="sourceLineNo">506</span> * annotation.<a name="line.506"></a>
-<span class="sourceLineNo">507</span> *<a name="line.507"></a>
-<span class="sourceLineNo">508</span> * <p><a name="line.508"></a>
-<span class="sourceLineNo">509</span> * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the<a name="line.509"></a>
-<span class="sourceLineNo">510</span> * annotation.<a name="line.510"></a>
-<span class="sourceLineNo">511</span> *<a name="line.511"></a>
-<span class="sourceLineNo">512</span> * @param serializers The serializer classes to add to this config.<a name="line.512"></a>
-<span class="sourceLineNo">513</span> * @return This object (for method chaining).<a name="line.513"></a>
-<span class="sourceLineNo">514</span> */<a name="line.514"></a>
-<span class="sourceLineNo">515</span> public RestConfig addSerializers(Class<?>...serializers) {<a name="line.515"></a>
-<span class="sourceLineNo">516</span> this.serializers.append(serializers);<a name="line.516"></a>
-<span class="sourceLineNo">517</span> return this;<a name="line.517"></a>
-<span class="sourceLineNo">518</span> }<a name="line.518"></a>
-<span class="sourceLineNo">519</span><a name="line.519"></a>
-<span class="sourceLineNo">520</span> /**<a name="line.520"></a>
-<span class="sourceLineNo">521</span> * Adds class-level serializers to this resource.<a name="line.521"></a>
-<span class="sourceLineNo">522</span> *<a name="line.522"></a>
-<span class="sourceLineNo">523</span> * <p><a name="line.523"></a>
-<span class="sourceLineNo">524</span> * Same as {@link #addSerializers(Class...)} except allows you to pass in serializer instances.<a name="line.524"></a>
-<span class="sourceLineNo">525</span> * The actual serializer ends up being the result of this operation using the bean filters, pojo swaps, and<a name="line.525"></a>
-<span class="sourceLineNo">526</span> * properties on this config:<a name="line.526"></a>
-<span class="sourceLineNo">527</span> * <p class='bcode'><a name="line.527"></a>
-<span class="sourceLineNo">528</span> * serializer = serializer.builder().beanFilters(beanFilters).pojoSwaps(pojoSwaps).properties(properties).build();<a name="line.528"></a>
-<span class="sourceLineNo">529</span> * </p><a name="line.529"></a>
-<span class="sourceLineNo">530</span> *<a name="line.530"></a>
-<span class="sourceLineNo">531</span> * <p><a name="line.531"></a>
-<span class="sourceLineNo">532</span> * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the<a name="line.532"></a>
-<span class="sourceLineNo">533</span> * annotation.<a name="line.533"></a>
-<span class="sourceLineNo">534</span> *<a name="line.534"></a>
-<span class="sourceLineNo">535</span> * @param serializers The serializers to add to this config.<a name="line.535"></a>
-<span class="sourceLineNo">536</span> * @return This object (for method chaining).<a name="line.536"></a>
-<span class="sourceLineNo">537</span> */<a name="line.537"></a>
-<span class="sourceLineNo">538</span> public RestConfig addSerializers(Serializer...serializers) {<a name="line.538"></a>
-<span class="sourceLineNo">539</span> this.serializers.append(serializers);<a name="line.539"></a>
-<span class="sourceLineNo">540</span> return this;<a name="line.540"></a>
-<span class="sourceLineNo">541</span> }<a name="line.541"></a>
-<span class="sourceLineNo">542</span><a name="line.542"></a>
-<span class="sourceLineNo">543</span> /**<a name="line.543"></a>
-<span class="sourceLineNo">544</span> * Adds class-level parsers to this resource.<a name="line.544"></a>
-<span class="sourceLineNo">545</span> *<a name="line.545"></a>
-<span class="sourceLineNo">546</span> * <p><a name="line.546"></a>
-<span class="sourceLineNo">547</span> * This is the programmatic equivalent to the {@link RestResource#parsers() @RestResource.parsers()} annotation.<a name="line.547"></a>
-<span class="sourceLineNo">548</span> *<a name="line.548"></a>
-<span class="sourceLineNo">549</span> * <p><a name="line.549"></a>
-<span class="sourceLineNo">550</span> * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the<a name="line.550"></a>
-<span class="sourceLineNo">551</span> * annotation.<a name="line.551"></a>
-<span class="sourceLineNo">552</span> *<a name="line.552"></a>
-<span class="sourceLineNo">553</span> * @param parsers The parser classes to add to this config.<a name="line.553"></a>
-<span class="sourceLineNo">554</span> * @return This object (for method chaining).<a name="line.554"></a>
-<span class="sourceLineNo">555</span> */<a name="line.555"></a>
-<span class="sourceLineNo">556</span> public RestConfig addParsers(Class<?>...parsers) {<a name="line.556"></a>
-<span class="sourceLineNo">557</span> this.parsers.append(parsers);<a name="line.557"></a>
-<span class="sourceLineNo">558</span> return this;<a name="line.558"></a>
-<span class="sourceLineNo">559</span> }<a name="line.559"></a>
-<span class="sourceLineNo">560</span><a name="line.560"></a>
-<span class="sourceLineNo">561</span> /**<a name="line.561"></a>
-<span class="sourceLineNo">562</span> * Adds class-level parsers to this resource.<a name="line.562"></a>
-<span class="sourceLineNo">563</span> *<a name="line.563"></a>
-<span class="sourceLineNo">564</span> * <p><a name="line.564"></a>
-<span class="sourceLineNo">565</span> * Same as {@link #addParsers(Class...)} except allows you to pass in parser instances.<a name="line.565"></a>
-<span class="sourceLineNo">566</span> * The actual parser ends up being the result of this operation using the bean filters, pojo swaps, and properties<a name="line.566"></a>
-<span class="sourceLineNo">567</span> * on this config:<a name="line.567"></a>
-<span class="sourceLineNo">568</span> * <p class='bcode'><a name="line.568"></a>
-<span class="sourceLineNo">569</span> * parser = parser.builder().beanFilters(beanFilters).pojoSwaps(pojoSwaps).properties(properties).build();<a name="line.569"></a>
-<span class="sourceLineNo">570</span> * </p><a name="line.570"></a>
-<span class="sourceLineNo">571</span> *<a name="line.571"></a>
-<span class="sourceLineNo">572</span> * <p><a name="line.572"></a>
-<span class="sourceLineNo">573</span> * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the<a name="line.573"></a>
-<span class="sourceLineNo">574</span> * annotation.<a name="line.574"></a>
-<span class="sourceLineNo">575</span> *<a name="line.575"></a>
-<span class="sourceLineNo">576</span> * @param parsers The parsers to add to this config.<a name="line.576"></a>
-<span class="sourceLineNo">577</span> * @return This object (for method chaining).<a name="line.577"></a>
-<span class="sourceLineNo">578</span> */<a name="line.578"></a>
-<span class="sourceLineNo">579</span> public RestConfig addParsers(Parser...parsers) {<a name="line.579"></a>
-<span class="sourceLineNo">580</span> this.parsers.append(parsers);<a name="line.580"></a>
-<span class="sourceLineNo">581</span> return this;<a name="line.581"></a>
-<span class="sourceLineNo">582</span> }<a name="line.582"></a>
-<span class="sourceLineNo">583</span><a name="line.583"></a>
-<span class="sourceLineNo">584</span> /**<a name="line.584"></a>
-<span class="sourceLineNo">585</span> * Adds class-level encoders to this resource.<a name="line.585"></a>
-<span class="sourceLineNo">586</span> *<a name="line.586"></a>
-<span class="sourceLineNo">587</span> * <p><a name="line.587"></a>
-<span class="sourceLineNo">588</span> * This is the programmatic equivalent to the {@link RestResource#encoders() @RestResource.encoders()} annotation.<a name="line.588"></a>
-<span class="sourceLineNo">589</span> *<a name="line.589"></a>
-<span class="sourceLineNo">590</span> * <p><a name="line.590"></a>
-<span class="sourceLineNo">591</span> * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the<a name="line.591"></a>
-<span class="sourceLineNo">592</span> * annotation.<a name="line.592"></a>
-<span class="sourceLineNo">593</span> *<a name="line.593"></a>
-<span class="sourceLineNo">594</span> * <p><a name="line.594"></a>
-<span class="sourceLineNo">595</span> * By default, only the {@link IdentityEncoder} is included in this list.<a name="line.595"></a>
-<span class="sourceLineNo">596</span> *<a name="line.596"></a>
-<span class="sourceLineNo">597</span> * @param encoders The parser classes to add to this config.<a name="line.597"></a>
-<span class="sourceLineNo">598</span> * @return This object (for method chaining).<a name="line.598"></a>
-<span class="sourceLineNo">599</span> */<a name="line.599"></a>
-<span class="sourceLineNo">600</span> public RestConfig addEncoders(Class<?>...encoders) {<a name="line.600"></a>
-<span class="sourceLineNo">601</span> this.encoders.append(encoders);<a name="line.601"></a>
-<span class="sourceLineNo">602</span> return this;<a name="line.602"></a>
-<span class="sourceLineNo">603</span> }<a name="line.603"></a>
-<span class="sourceLineNo">604</span><a name="line.604"></a>
-<span class="sourceLineNo">605</span> /**<a name="line.605"></a>
-<span class="sourceLineNo">606</span> * Adds class-level encoders to this resource.<a name="line.606"></a>
-<span class="sourceLineNo">607</span> *<a name="line.607"></a>
-<span class="sourceLineNo">608</span> * <p><a name="line.608"></a>
-<span class="sourceLineNo">609</span> * Same as {@link #addEncoders(Class...)} except allows you to pass in encoder instances.<a name="line.609"></a>
-<span class="sourceLineNo">610</span> *<a name="line.610"></a>
-<span class="sourceLineNo">611</span> * @param encoders The encoders to add to this config.<a name="line.611"></a>
-<span class="sourceLineNo">612</span> * @return This object (for method chaining).<a name="line.612"></a>
-<span class="sourceLineNo">613</span> */<a name="line.613"></a>
-<span class="sourceLineNo">614</span> public RestConfig addEncoders(Encoder...encoders) {<a name="line.614"></a>
-<span class="sourceLineNo">615</span> this.encoders.append(encoders);<a name="line.615"></a>
-<span class="sourceLineNo">616</span> return this;<a name="line.616"></a>
-<span class="sourceLineNo">617</span> }<a name="line.617"></a>
-<span class="sourceLineNo">618</span><a name="line.618"></a>
-<span class="sourceLineNo">619</span> /**<a name="line.619"></a>
-<span class="sourceLineNo">620</span> * Adds class-level converters to this resource.<a name="line.620"></a>
-<span class="sourceLineNo">621</span> *<a name="line.621"></a>
-<span class="sourceLineNo">622</span> * <p><a name="line.622"></a>
-<span class="sourceLineNo">623</span> * This is the programmatic equivalent to the {@link RestResource#converters() @RestResource.converters()}<a name="line.623"></a>
-<span class="sourceLineNo">624</span> * annotation.<a name="line.624"></a>
-<span class="sourceLineNo">625</span> *<a name="line.625"></a>
-<span class="sourceLineNo">626</span> * <p><a name="line.626"></a>
-<span class="sourceLineNo">627</span> * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the<a name="line.627"></a>
-<span class="sourceLineNo">628</span> * annotation.<a name="line.628"></a>
-<span class="sourceLineNo">629</span> *<a name="line.629"></a>
-<span class="sourceLineNo">630</span> * <p><a name="line.630"></a>
-<span class="sourceLineNo">631</span> * By default, this config includes the following converters:<a name="line.631"></a>
-<span class="sourceLineNo">632</span> * <ul><a name="line.632"></a>
-<span class="sourceLineNo">633</span> * <li>{@link StreamableHandler}<a name="line.633"></a>
-<span class="sourceLineNo">634</span> * <li>{@link WritableHandler}<a name="line.634"></a>
-<span class="sourceLineNo">635</span> * <li>{@link ReaderHandler}<a name="line.635"></a>
-<span class="sourceLineNo">636</span> * <li>{@link InputStreamHandler}<a name="line.636"></a>
-<span class="sourceLineNo">637</span> * <li>{@link RedirectHandler}<a name="line.637"></a>
-<span class="sourceLineNo">638</span> * <li>{@link DefaultHandler}<a name="line.638"></a>
-<span class="sourceLineNo">639</span> * </ul><a name="line.639"></a>
-<span class="sourceLineNo">640</span> *<a name="line.640"></a>
-<span class="sourceLineNo">641</span> * @param converters The converter classes to add to this config.<a name="line.641"></a>
-<span class="sourceLineNo">642</span> * @return This object (for method chaining).<a name="line.642"></a>
-<span class="sourceLineNo">643</span> */<a name="line.643"></a>
-<span class="sourceLineNo">644</span> public RestConfig addConverters(Class<?>...converters) {<a name="line.644"></a>
-<span class="sourceLineNo">645</span> this.converters.addAll(Arrays.asList(converters));<a name="line.645"></a>
-<span class="sourceLineNo">646</span> return this;<a name="line.646"></a>
-<span class="sourceLineNo">647</span> }<a name="line.647"></a>
-<span class="sourceLineNo">648</span><a name="line.648"></a>
-<span class="sourceLineNo">649</span> /**<a name="line.649"></a>
-<span class="sourceLineNo">650</span> * Adds class-level encoders to this resource.<a name="line.650"></a>
-<span class="sourceLineNo">651</span> *<a name="line.651"></a>
-<span class="sourceLineNo">652</span> * <p><a name="line.652"></a>
-<span class="sourceLineNo">653</span> * Same as {@link #addConverters(Class...)} except allows you to pass in converter instances.<a name="line.653"></a>
-<span class="sourceLineNo">654</span> *<a name="line.654"></a>
-<span class="sourceLineNo">655</span> * @param converters The converters to add to this config.<a name="line.655"></a>
-<span class="sourceLineNo">656</span> * @return This object (for method chaining).<a name="line.656"></a>
-<span class="sourceLineNo">657</span> */<a name="line.657"></a>
-<span class="sourceLineNo">658</span> public RestConfig addConverters(RestConverter...converters) {<a name="line.658"></a>
-<span class="sourceLineNo">659</span> this.converters.addAll(Arrays.asList(converters));<a name="line.659"></a>
-<span class="sourceLineNo">660</span> return this;<a name="line.660"></a>
-<span class="sourceLineNo">661</span> }<a name="line.661"></a>
-<span class="sourceLineNo">662</span><a name="line.662"></a>
-<span class="sourceLineNo">663</span> /**<a name="line.663"></a>
-<span class="sourceLineNo">664</span> * Adds class-level guards to this resource.<a name="line.664"></a>
-<span class="sourceLineNo">665</span> *<a name="line.665"></a>
-<span class="sourceLineNo">666</span> * <p><a name="line.666"></a>
-<span class="sourceLineNo">667</span> * This is the programmatic equivalent to the {@link RestResource#guards() @RestResource.guards()} annotation.<a name="line.667"></a>
-<span class="sourceLineNo">668</span> *<a name="line.668"></a>
-<span class="sourceLineNo">669</span> * <p><a name="line.669"></a>
-<span class="sourceLineNo">670</span> * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the<a name="line.670"></a>
-<span class="sourceLineNo">671</span> * annotation.<a name="line.671"></a>
-<span class="sourceLineNo">672</span> *<a name="line.672"></a>
-<span class="sourceLineNo">673</span> * @param guards The guard classes to add to this config.<a name="line.673"></a>
-<span class="sourceLineNo">674</span> * @return This object (for method chaining).<a name="line.674"></a>
-<span class="sourceLineNo">675</span> */<a name="line.675"></a>
-<span class="sourceLineNo">676</span> public RestConfig addGuards(Class<?>...guards) {<a name="line.676"></a>
-<span class="sourceLineNo">677</span> this.guards.addAll(Arrays.asList(guards));<a name="line.677"></a>
-<span class="sourceLineNo">678</span> return this;<a name="line.678"></a>
-<span class="sourceLineNo">679</span> }<a name="line.679"></a>
-<span class="sourceLineNo">680</span><a name="line.680"></a>
-<span class="sourceLineNo">681</span> /**<a name="line.681"></a>
-<span class="sourceLineNo">682</span> * Adds class-level guards to this resource.<a name="line.682"></a>
-<span class="sourceLineNo">683</span> *<a name="line.683"></a>
-<span class="sourceLineNo">684</span> * <p><a name="line.684"></a>
-<span class="sourceLineNo">685</span> * Same as {@link #addGuards(Class...)} except allows you to pass in guard instances.<a name="line.685"></a>
-<span class="sourceLineNo">686</span> *<a name="line.686"></a>
-<span class="sourceLineNo">687</span> * @param guards The guards to add to this config.<a name="line.687"></a>
-<span class="sourceLineNo">688</span> * @return This object (for method chaining).<a name="line.688"></a>
-<span class="sourceLineNo">689</span> */<a name="line.689"></a>
-<span class="sourceLineNo">690</span> public RestConfig addGuards(RestGuard...guards) {<a name="line.690"></a>
-<span class="sourceLineNo">691</span> this.guards.addAll(Arrays.asList(guards));<a name="line.691"></a>
-<span class="sourceLineNo">692</span> return this;<a name="line.692"></a>
-<span class="sourceLineNo">693</span> }<a name="line.693"></a>
-<span class="sourceLineNo">694</span><a name="line.694"></a>
-<span class="sourceLineNo">695</span> /**<a name="line.695"></a>
-<span class="sourceLineNo">696</span> * Adds MIME-type definitions.<a name="line.696"></a>
-<span class="sourceLineNo">697</span> *<a name="line.697"></a>
-<span class="sourceLineNo">698</span> * <p><a name="line.698"></a>
-<span class="sourceLineNo">699</span> * These definitions are used in the following locations for setting the media type on responses:<a name="line.699"></a>
-<span class="sourceLineNo">700</span> * <ul><a name="line.700"></a>
-<span class="sourceLineNo">701</span> * <li>{@link RestRequest#getReaderResource(String)}<a name="line.701"></a>
-<span class="sourceLineNo">702</span> * <li>Static files resolved through {@link RestResource#staticFiles()}<a name="line.702"></a>
-<span class="sourceLineNo">703</span> * </ul><a name="line.703"></a>
-<span class="sourceLineNo">704</span> *<a name="line.704"></a>
-<span class="sourceLineNo">705</span> * <p><a name="line.705"></a>
-<span class="sourceLineNo">706</span> * Refer to {@link MimetypesFileTypeMap#addMimeTypes(String)} for an explanation of the format.<a name="line.706"></a>
-<span class="sourceLineNo">707</span> *<a name="line.707"></a>
-<span class="sourceLineNo">708</span> * @param mimeTypes The MIME-types to add to this config.<a name="line.708"></a>
-<span class="sourceLineNo">709</span> * @return This object (for method chaining).<a name="line.709"></a>
-<span class="sourceLineNo">710</span> */<a name="line.710"></a>
-<span class="sourceLineNo">711</span> public RestConfig addMimeTypes(String...mimeTypes) {<a name="line.711"></a>
-<span class="sourceLineNo">712</span> if (this.mimeTypes == ExtendedMimetypesFileTypeMap.DEFAULT)<a name="line.712"></a>
-<span class="sourceLineNo">713</span> this.mimeTypes = new ExtendedMimetypesFileTypeMap();<a name="line.713"></a>
-<span class="sourceLineNo">714</span> for (String mimeType : mimeTypes)<a name="line.714"></a>
-<span class="sourceLineNo">715</span> this.mimeTypes.addMimeTypes(mimeType);<a name="line.715"></a>
-<span class="sourceLineNo">716</span> return this;<a name="line.716"></a>
-<span class="sourceLineNo">717</span> }<a name="line.717"></a>
-<span class="sourceLineNo">718</span><a name="line.718"></a>
-<span class="sourceLineNo">719</span> /**<a name="line.719"></a>
-<span class="sourceLineNo">720</span> * Adds class-level default HTTP request headers to this resource.<a name="line.720"></a>
-<span class="sourceLineNo">721</span> *<a name="line.721"></a>
-<span class="sourceLineNo">722</span> * <p><a name="line.722"></a>
-<span class="sourceLineNo">723</span> * Default request headers are default values for when HTTP requests do not specify a header value.<a name="line.723"></a>
-<span class="sourceLineNo">724</span> * For example, you can specify a default value for <code>Accept</code> if a request does not specify that header<a name="line.724"></a>
-<span class="sourceLineNo">725</span> * value.<a name="line.725"></a>
-<span class="sourceLineNo">726</span> *<a name="line.726"></a>
-<span class="sourceLineNo">727</span> * <p><a name="line.727"></a>
-<span class="sourceLineNo">728</span> * This is the programmatic equivalent to the<a name="line.728"></a>
-<span class="sourceLineNo">729</span> * {@link RestResource#defaultRequestHeaders() @RestResource.defaultRequestHeaders()} annotation.<a name="line.729"></a>
-<span class="sourceLineNo">730</span> *<a name="line.730"></a>
-<span class="sourceLineNo">731</span> * @param name The HTTP header name.<a name="line.731"></a>
-<span class="sourceLineNo">732</span> * @param value The HTTP header value.<a name="line.732"></a>
-<span class="sourceLineNo">733</span> * @return This object (for method chaining).<a name="line.733"></a>
-<span class="sourceLineNo">734</span> */<a name="line.734"></a>
-<span class="sourceLineNo">735</span> public RestConfig addDefaultRequestHeader(String name, Object value) {<a name="line.735"></a>
-<span class="sourceLineNo">736</span> this.defaultRequestHeaders.put(name, StringUtils.toString(value));<a name="line.736"></a>
-<span class="sourceLineNo">737</span> return this;<a name="line.737"></a>
-<span class="sourceLineNo">738</span> }<a name="line.738"></a>
-<span class="sourceLineNo">739</span><a name="line.739"></a>
-<span class="sourceLineNo">740</span> /**<a name="line.740"></a>
-<span class="sourceLineNo">741</span> * Adds class-level default HTTP request headers to this resource.<a name="line.741"></a>
-<span class="sourceLineNo">742</span> *<a name="line.742"></a>
-<span class="sourceLineNo">743</span> * <p><a name="line.743"></a>
-<span class="sourceLineNo">744</span> * Default request headers are default values for when HTTP requests do not specify a header value.<a name="line.744"></a>
-<span class="sourceLineNo">745</span> * For example, you can specify a default value for <code>Accept</code> if a request does not specify that header<a name="line.745"></a>
-<span class="sourceLineNo">746</span> * value.<a name="line.746"></a>
-<span class="sourceLineNo">747</span> *<a name="line.747"></a>
-<span class="sourceLineNo">748</span> * <p><a name="line.748"></a>
-<span class="sourceLineNo">749</span> * This is the programmatic equivalent to the<a name="line.749"></a>
-<span class="sourceLineNo">750</span> * {@link RestResource#defaultRequestHeaders() @RestResource.defaultRequestHeaders()} annotation.<a name="line.750"></a>
-<span class="sourceLineNo">751</span> *<a name="line.751"></a>
-<span class="sourceLineNo">752</span> * @param headers HTTP headers of the form <js>"Name: Value"</js>.<a name="line.752"></a>
-<span class="sourceLineNo">753</span> * @return This object (for method chaining).<a name="line.753"></a>
-<span class="sourceLineNo">754</span> * @throws RestServletException If header string is not correctly formatted.<a name="line.754"></a>
-<span class="sourceLineNo">755</span> */<a name="line.755"></a>
-<span class="sourceLineNo">756</span> public RestConfig addDefaultRequestHeaders(String...headers) throws RestServletException {<a name="line.756"></a>
-<span class="sourceLineNo">757</span> for (String header : headers) {<a name="line.757"></a>
-<span class="sourceLineNo">758</span> String[] h = RestUtils.parseHeader(header);<a name="line.758"></a>
-<span class="sourceLineNo">759</span> if (h == null)<a name="line.759"></a>
-<span class="sourceLineNo">760</span> throw new RestServletException("Invalid default request header specified: ''{0}''. Must be in the format: ''Header-Name: header-value''", header);<a name="line.760"></a>
-<span class="sourceLineNo">761</span> addDefaultRequestHeader(h[0], h[1]);<a name="line.761"></a>
-<span class="sourceLineNo">762</span> }<a name="line.762"></a>
-<span class="sourceLineNo">763</span> return this;<a name="line.763"></a>
-<span class="sourceLineNo">764</span> }<a name="line.764"></a>
-<span class="sourceLineNo">765</span><a name="line.765"></a>
-<span class="sourceLineNo">766</span> /**<a name="line.766"></a>
-<span class="sourceLineNo">767</span> * Adds class-level default HTTP response headers to this resource.<a name="line.767"></a>
-<span class="sourceLineNo">768</span> *<a name="line.768"></a>
-<span class="sourceLineNo">769</span> * <p><a name="line.769"></a>
-<span class="sourceLineNo">770</span> * Default response headers are headers that will be appended to all responses if those headers have not already been<a name="line.770"></a>
-<span class="sourceLineNo">771</span> * set on the response object.<a name="line.771"></a>
-<span class="sourceLineNo">772</span> *<a name="line.772"></a>
-<span class="sourceLineNo">773</span> * <p><a name="line.773"></a>
-<span class="sourceLineNo">774</span> * This is the programmatic equivalent to the<a name="line.774"></a>
-<span class="sourceLineNo">775</span> * {@link RestResource#defaultResponseHeaders() @RestResource.defaultResponseHeaders()} annotation.<a name="line.775"></a>
-<span class="sourceLineNo">776</span> *<a name="line.776"></a>
-<span class="sourceLineNo">777</span> * <p><a name="line.777"></a>
-<span class="sourceLineNo">778</span> * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the<a name="line.778"></a>
-<span class="sourceLineNo">779</span> * annotation.<a name="line.779"></a>
-<span class="sourceLineNo">780</span> *<a name="line.780"></a>
-<span class="sourceLineNo">781</span> * @param name The HTTP header name.<a name="line.781"></a>
-<span class="sourceLineNo">782</span> * @param value The HTTP header value.<a name="line.782"></a>
-<span class="sourceLineNo">783</span> * @return This object (for method chaining).<a name="line.783"></a>
-<span class="sourceLineNo">784</span> */<a name="line.784"></a>
-<span class="sourceLineNo">785</span> public RestConfig addDefaultResponseHeader(String name, Object value) {<a name="line.785"></a>
-<span class="sourceLineNo">786</span> this.defaultResponseHeaders.put(name, value);<a name="line.786"></a>
-<span class="sourceLineNo">787</span> return this;<a name="line.787"></a>
-<span class="sourceLineNo">788</span> }<a name="line.788"></a>
-<span class="sourceLineNo">789</span><a name="line.789"></a>
-<span class="sourceLineNo">790</span> /**<a name="line.790"></a>
-<span class="sourceLineNo">791</span> * Adds class-level default HTTP response headers to this resource.<a name="line.791"></a>
-<span class="sourceLineNo">792</span> *<a name="line.792"></a>
-<span class="sourceLineNo">793</span> * <p><a name="line.793"></a>
-<span class="sourceLineNo">794</span> * Default response headers are headers that will be appended to all responses if those headers have not already been<a name="line.794"></a>
-<span class="sourceLineNo">795</span> * set on the response object.<a name="line.795"></a>
-<span class="sourceLineNo">796</span> *<a name="line.796"></a>
-<span class="sourceLineNo">797</span> * <p><a name="line.797"></a>
-<span class="sourceLineNo">798</span> * This is the programmatic equivalent to the<a name="line.798"></a>
-<span class="sourceLineNo">799</span> * {@link RestResource#defaultResponseHeaders() @RestResource.defaultResponseHeaders()} annotation.<a name="line.799"></a>
-<span class="sourceLineNo">800</span> *<a name="line.800"></a>
-<span class="sourceLineNo">801</span> * @param headers HTTP headers of the form <js>"Name: Value"</js>.<a name="line.801"></a>
-<span class="sourceLineNo">802</span> * @return This object (for method chaining).<a name="line.802"></a>
-<span class="sourceLineNo">803</span> * @throws RestServletException If header string is not correctly formatted.<a name="line.803"></a>
-<span class="sourceLineNo">804</span> */<a name="line.804"></a>
-<span class="sourceLineNo">805</span> public RestConfig addDefaultResponseHeaders(String...headers) throws RestServletException {<a name="line.805"></a>
-<span class="sourceLineNo">806</span> for (String header : headers) {<a name="line.806"></a>
-<span class="sourceLineNo">807</span> String[] h = RestUtils.parseHeader(header);<a name="line.807"></a>
-<span class="sourceLineNo">808</span> if (h == null)<a name="line.808"></a>
-<span class="sourceLineNo">809</span> throw new RestServletException("Invalid default response header specified: ''{0}''. Must be in the format: ''Header-Name: header-value''", header);<a name="line.809"></a>
-<span class="sourceLineNo">810</span> addDefaultResponseHeader(h[0], h[1]);<a name="line.810"></a>
-<span class="sourceLineNo">811</span> }<a name="line.811"></a>
-<span class="sourceLineNo">812</span> return this;<a name="line.812"></a>
-<span class="sourceLineNo">813</span> }<a name="line.813"></a>
-<span class="sourceLineNo">814</span><a name="line.814"></a>
-<span class="sourceLineNo">815</span> /**<a name="line.815"></a>
-<span class="sourceLineNo">816</span> * Adds class-level response handler classes to this resource.<a name="line.816"></a>
-<span class="sourceLineNo">817</span> *<a name="line.817"></a>
-<span class="sourceLineNo">818</span> * <p><a name="line.818"></a>
-<span class="sourceLineNo">819</span> * Response handlers are responsible for converting various POJOs returned by REST methods into actual HTTP responses.<a name="line.819"></a>
-<span class="sourceLineNo">820</span> *<a name="line.820"></a>
-<span class="sourceLineNo">821</span> * <p><a name="line.821"></a>
-<span class="sourceLineNo">822</span> * By default, this config includes the following response handlers:<a name="line.822"></a>
-<span class="sourceLineNo">823</span> * <ul><a name="line.823"></a>
-<span class="sourceLineNo">824</span> * <li>{@link StreamableHandler}<a name="line.824"></a>
-<span class="sourceLineNo">825</span> * <li>{@link WritableHandler}<a name="line.825"></a>
-<span class="sourceLineNo">826</span> * <li>{@link ReaderHandler}<a name="line.826"></a>
-<span class="sourceLineNo">827</span> * <li>{@link InputStreamHandler}<a name="line.827"></a>
-<span class="sourceLineNo">828</span> * <li>{@link RedirectHandler}<a name="line.828"></a>
-<span class="sourceLineNo">829</span> * <li>{@link DefaultHandler}<a name="line.829"></a>
-<span class="sourceLineNo">830</span> * </ul><a name="line.830"></a>
-<span class="sourceLineNo">831</span> *<a name="line.831"></a>
-<span class="sourceLineNo">832</span> * <p><a name="line.832"></a>
-<span class="sourceLineNo">833</span> * This is the programmatic equivalent to the<a name="line.833"></a>
-<span class="sourceLineNo">834</span> * {@link RestResource#responseHandlers() @RestResource.responseHandlers()} annotation.<a name="line.834"></a>
-<span class="sourceLineNo">835</span> *<a name="line.835"></a>
-<span class="sourceLineNo">836</span> * @param responseHandlers The response handlers to add to this config.<a name="line.836"></a>
-<span class="sourceLineNo">837</span> * @return This object (for method chaining).<a name="line.837"></a>
-<span class="sourceLineNo">838</span> */<a name="line.838"></a>
-<span class="sourceLineNo">839</span> public RestConfig addResponseHandlers(Class<?>...responseHandlers) {<a name="line.839"></a>
-<span class="sourceLineNo">840</span> this.responseHandlers.addAll(Arrays.asList(responseHandlers));<a name="line.840"></a>
-<span class="sourceLineNo">841</span> return this;<a name="line.841"></a>
-<span class="sourceLineNo">842</span> }<a name="line.842"></a>
-<span class="sourceLineNo">843</span><a name="line.843"></a>
-<span class="sourceLineNo">844</span> /**<a name="line.844"></a>
-<span class="sourceLineNo">845</span> * Adds class-level response handlers to this resource.<a name="line.845"></a>
-<span class="sourceLineNo">846</span> *<a name="line.846"></a>
-<span class="sourceLineNo">847</span> * <p><a name="line.847"></a>
-<span class="sourceLineNo">848</span> * Same as {@link #addResponseHandlers(Class...)} except allows you to pass in response handler instances.<a name="line.848"></a>
-<span class="sourceLineNo">849</span> *<a name="line.849"></a>
-<span class="sourceLineNo">850</span> * @param responseHandlers The response handlers to add to this config.<a name="line.850"></a>
-<span class="sourceLineNo">851</span> * @return This object (for method chaining).<a name="line.851"></a>
-<span class="sourceLineNo">852</span> */<a name="line.852"></a>
-<span class="sourceLineNo">853</span> public RestConfig addResponseHandlers(ResponseHandler...responseHandlers) {<a name="line.853"></a>
-<span class="sourceLineNo">854</span> this.responseHandlers.addAll(Arrays.asList(responseHandlers));<a name="line.854"></a>
-<span class="sourceLineNo">855</span> return this;<a name="line.855"></a>
-<span class="sourceLineNo">856</span> }<a name="line.856"></a>
-<span class="sourceLineNo">857</span><a name="line.857"></a>
-<span class="sourceLineNo">858</span> /**<a name="line.858"></a>
-<span class="sourceLineNo">859</span> * Adds a child resource to this resource.<a name="line.859"></a>
-<span class="sourceLineNo">860</span> *<a name="line.860"></a>
-<span class="sourceLineNo">861</span> * <p><a name="line.861"></a>
-<span class="sourceLineNo">862</span> * Child resources are resources that are accessed under the path of the parent resource.<a name="line.862"></a>
-<span class="sourceLineNo">863</span> *<a name="line.863"></a>
-<span class="sourceLineNo">864</span> * <p><a name="line.864"></a>
-<span class="sourceLineNo">865</span> * This is the programmatic equivalent to the {@link RestResource#children() @RestResource.children()} annotation.<a name="line.865"></a>
-<span class="sourceLineNo">866</span> *<a name="line.866"></a>
-<span class="sourceLineNo">867</span> * @param path The child path of the resource. Must conform to {@link RestResource#path()} format.<a name="line.867"></a>
-<span class="sourceLineNo">868</span> * @param child The child resource.<a name="line.868"></a>
-<span class="sourceLineNo">869</span> * @return This object (for method chaining).<a name="line.869"></a>
-<span class="sourceLineNo">870</span> */<a name="line.870"></a>
-<span class="sourceLineNo">871</span> public RestConfig addChildResource(String path, Object child) {<a name="line.871"></a>
-<span class="sourceLineNo">872</span> this.childResources.add(new Pair<String,Object>(path, child));<a name="line.872"></a>
-<span class="sourceLineNo">873</span> return this;<a name="line.873"></a>
-<span class="sourceLineNo">874</span> }<a name="line.874"></a>
-<span class="sourceLineNo">875</span><a name="line.875"></a>
-<span class="sourceLineNo">876</span> /**<a name="line.876"></a>
-<span class="sourceLineNo">877</span> * Add child resources to this resource.<a name="line.877"></a>
-<span class="sourceLineNo">878</span> *<a name="line.878"></a>
-<span class="sourceLineNo">879</span> * <p><a name="line.879"></a>
-<span class="sourceLineNo">880</span> * Child resources are resources that are accessed under the path of the parent resource.<a name="line.880"></a>
-<span class="sourceLineNo">881</span> *<a name="line.881"></a>
-<span class="sourceLineNo">882</span> * <p><a name="line.882"></a>
-<span class="sourceLineNo">883</span> * This is the programmatic equivalent to the {@link RestResource#children() @RestResource.children()} annotation.<a name="line.883"></a>
-<span class="sourceLineNo">884</span> *<a name="line.884"></a>
-<span class="sourceLineNo">885</span> * @param children The child resources to add to this resource.<a name="line.885"></a>
-<span class="sourceLineNo">886</span> * Children must be annotated with {@link RestResource#path()} to identify the child path.<a name="line.886"></a>
-<span class="sourceLineNo">887</span> * @return This object (for method chaining).<a name="line.887"></a>
-<span class="sourceLineNo">888</span> */<a name="line.888"></a>
-<span class="sourceLineNo">889</span> public RestConfig addChildResources(Object...children) {<a name="line.889"></a>
-<span class="sourceLineNo">890</span> this.childResources.addAll(Arrays.asList(children));<a name="line.890"></a>
-<span class="sourceLineNo">891</span> return this;<a name="line.891"></a>
-<span class="sourceLineNo">892</span> }<a name="line.892"></a>
-<span class="sourceLineNo">893</span><a name="line.893"></a>
-<span class="sourceLineNo">894</span> /**<a name="line.894"></a>
-<span class="sourceLineNo">895</span> * Add child resources to this resource.<a name="line.895"></a>
-<span class="sourceLineNo">896</span> *<a name="line.896"></a>
-<span class="sourceLineNo">897</span> * <p><a name="line.897"></a>
-<span class="sourceLineNo">898</span> * Child resources are resources that are accessed under the path of the parent resource.<a name="line.898"></a>
-<span class="sourceLineNo">899</span> *<a name="line.899"></a>
-<span class="sourceLineNo">900</span> * <p><a name="line.900"></a>
-<span class="sourceLineNo">901</span> * This is the programmatic equivalent to the {@link RestResource#children() @RestResource.children()} annotation.<a name="line.901"></a>
-<span class="sourceLineNo">902</span> *<a name="line.902"></a>
-<span class="sourceLineNo">903</span> * @param children The child resources to add to this resource.<a name="line.903"></a>
-<span class="sourceLineNo">904</span> * Children must be annotated with {@link RestResource#path()} to identify the child path.<a name="line.904"></a>
-<span class="sourceLineNo">905</span> * @return This object (for method chaining).<a name="line.905"></a>
-<span class="sourceLineNo">906</span> */<a name="line.906"></a>
-<span class="sourceLineNo">907</span> public RestConfig addChildResources(Class<?>...children) {<a name="line.907"></a>
-<span class="sourceLineNo">908</span> this.childResources.addAll(Arrays.asList(children));<a name="line.908"></a>
-<span class="sourceLineNo">909</span> return this;<a name="line.909"></a>
-<span class="sourceLineNo">910</span> }<a name="line.910"></a>
-<span class="sourceLineNo">911</span><a name="line.911"></a>
-<span class="sourceLineNo">912</span> /**<a name="line.912"></a>
-<span class="sourceLineNo">913</span> * Specifies the list of supported <code>Accept</code> media types for this resource.<a name="line.913"></a>
-<span class="sourceLineNo">914</span> *<a name="line.914"></a>
-<span class="sourceLineNo">915</span> * <p><a name="line.915"></a>
-<span class="sourceLineNo">916</span> * This overrides the media types inferred from the parsers on this resource.<a name="line.916"></a>
-<span class="sourceLineNo">917</span> *<a name="line.917"></a>
-<span class="sourceLineNo">918</span> * <p><a name="line.918"></a>
-<span class="sourceLineNo">919</span> * There is no annotation equivalent to this method call.<a name="line.919"></a>
-<span class="sourceLineNo">920</span> *<a name="line.920"></a>
-<span class="sourceLineNo">921</span> * @param mediaTypes The new list of media types supported by this resource.<a name="line.921"></a>
-<span class="sourceLineNo">922</span> * @return This object (for method chaining).<a name="line.922"></a>
-<span class="sourceLineNo">923</span> */<a name="line.923"></a>
-<span class="sourceLineNo">924</span> public RestConfig setSupportedAcceptTypes(String...mediaTypes) {<a name="line.924"></a>
-<span class="sourceLineNo">925</span> supportedAcceptTypes = new ArrayList<MediaType>();<a name="line.925"></a>
-<span class="sourceLineNo">926</span> for (String mediaType : mediaTypes)<a name="line.926"></a>
-<span class="sourceLineNo">927</span> supportedAcceptTypes.add(MediaType.forString(mediaType));<a name="line.927"></a>
-<span class="sourceLineNo">928</span> return this;<a name="line.928"></a>
-<span class="sourceLineNo">929</span> }<a name="line.929"></a>
-<span class="sourceLineNo">930</span><a name="line.930"></a>
-<span class="sourceLineNo">931</span> /**<a name="line.931"></a>
-<span class="sourceLineNo">932</span> * Specifies the list of supported <code>Accept</code> media types for this resource.<a name="line.932"></a>
-<span class="sourceLineNo">933</span> *<a name="line.933"></a>
-<span class="sourceLineNo">934</span> * <p><a name="line.934"></a>
-<span class="sourceLineNo">935</span> * This overrides the media types inferred from the parsers on this resource.<a name="line.935"></a>
-<span class="sourceLineNo">936</span> *<a name="line.936"></a>
-<span class="sourceLineNo">937</span> * <p><a name="line.937"></a>
-<span class="sourceLineNo">938</span> * There is no annotation equivalent to this method call.<a name="line.938"></a>
-<span class="sourceLineNo">939</span> *<a name="line.939"></a>
-<span class="sourceLineNo">940</span> * @param mediaTypes The new list of media types supported by this resource.<a name="line.940"></a>
-<span class="sourceLineNo">941</span> * @return This object (for method chaining).<a name="line.941"></a>
-<span class="sourceLineNo">942</span> */<a name="line.942"></a>
-<span class="sourceLineNo">943</span> public RestConfig setSupportedAcceptTypes(MediaType...mediaTypes) {<a name="line.943"></a>
-<span class="sourceLineNo">944</span> supportedAcceptTypes = Arrays.asList(mediaTypes);<a name="line.944"></a>
-<span class="sourceLineNo">945</span> return this;<a name="line.945"></a>
-<span class="sourceLineNo">946</span> }<a name="line.946"></a>
-<span class="sourceLineNo">947</span><a name="line.947"></a>
-<span class="sourceLineNo">948</span> /**<a name="line.948"></a>
-<span class="sourceLineNo">949</span> * Specifies the list of supported <code>Content-Type</code> media types for this resource.<a name="line.949"></a>
-<span class="sourceLineNo">950</span> *<a name="line.950"></a>
-<span class="sourceLineNo">951</span> * <p><a name="line.951"></a>
-<span class="sourceLineNo">952</span> * This overrides the media types inferred from the serializers on this resource.<a name="line.952"></a>
-<span class="sourceLineNo">953</span> *<a name="line.953"></a>
-<span class="sourceLineNo">954</span> * <p><a name="line.954"></a>
-<span class="sourceLineNo">955</span> * There is no annotation equivalent to this method call.<a name="line.955"></a>
-<span class="sourceLineNo">956</span> *<a name="line.956"></a>
-<span class="sourceLineNo">957</span> * @param mediaTypes The new list of media types supported by this resource.<a name="line.957"></a>
-<span class="sourceLineNo">958</span> * @return This object (for method chaining).<a name="line.958"></a>
-<span class="sourceLineNo">959</span> */<a name="line.959"></a>
-<span class="sourceLineNo">960</span> public RestConfig setSupportedContentTypes(String...mediaTypes) {<a name="line.960"></a>
-<span class="sourceLineNo">961</span> supportedContentTypes = new ArrayList<MediaType>();<a name="line.961"></a>
-<span class="sourceLineNo">962</span> for (String mediaType : mediaTypes)<a name="line.962"></a>
-<span class="sourceLineNo">963</span> supportedContentTypes.add(MediaType.forString(mediaType));<a name="line.963"></a>
-<span class="sourceLineNo">964</span> return this;<a name="line.964"></a>
-<span class="sourceLineNo">965</span> }<a name="line.965"></a>
-<span class="sourceLineNo">966</span><a name="line.966"></a>
-<span class="sourceLineNo">967</span> /**<a name="line.967"></a>
-<span class="sourceLineNo">968</span> * Specifies the list of supported <code>Content-Type</code> media types for this resource.<a name="line.968"></a>
-<span class="sourceLineNo">969</span> *<a name="line.969"></a>
-<span class="sourceLineNo">970</span> * <p><a name="line.970"></a>
-<span class="sourceLineNo">971</span> * This overrides the media types inferred from the serializers on this resource.<a name="line.971"></a>
-<span class="sourceLineNo">972</span> *<a name="line.972"></a>
-<span class="sourceLineNo">973</span> * <p><a name="line.973"></a>
-<span class="sourceLineNo">974</span> * There is no annotation equivalent to this method call.<a name="line.974"></a>
-<span class="sourceLineNo">975</span> *<a name="line.975"></a>
-<span class="sourceLineNo">976</span> * @param mediaTypes The new list of media types supported by this resource.<a name="line.976"></a>
-<span class="sourceLineNo">977</span> * @return This object (for method chaining).<a name="line.977"></a>
-<span class="sourceLineNo">978</span> */<a name="line.978"></a>
-<span class="sourceLineNo">979</span> public RestConfig setSupportedContentTypes(MediaType...mediaTypes) {<a name="line.979"></a>
-<span class="sourceLineNo">980</span> supportedContentTypes = Arrays.asList(mediaTypes);<a name="line.980"></a>
-<span class="sourceLineNo">981</span> return this;<a name="line.981"></a>
-<span class="sourceLineNo">982</span> }<a name="line.982"></a>
-<span class="sourceLineNo">983</span><a name="line.983"></a>
-<span class="sourceLineNo">984</span> /**<a name="line.984"></a>
-<span class="sourceLineNo">985</span> * Specifies the icon contents that make up the contents of the page <js>"/resource-path/favicon.ico"</js>.<a name="line.985"></a>
-<span class="sourceLineNo">986</span> *<a name="line.986"></a>
-<span class="sourceLineNo">987</span> * <p><a name="line.987"></a>
-<span class="sourceLineNo">988</span> * This is the programmatic equivalent to the {@link RestResource#favicon() @RestResource.favicon()} annotation.<a name="line.988"></a>
-<span class="sourceLineNo">989</span> *<a name="line.989"></a>
-<span class="sourceLineNo">990</span> * <p><a name="line.990"></a>
-<span class="sourceLineNo">991</span> * The object type can be any of the following:<a name="line.991"></a>
-<span class="sourceLineNo">992</span> * <ul><a name="line.992"></a>
-<span class="sourceLineNo">993</span> * <li>{@link InputStream}<a name="line.993"></a>
-<span class="sourceLineNo">994</span> * <li>{@link File}<a name="line.994"></a>
-<span class="sourceLineNo">995</span> * <li><code><jk>byte</jk>[]</code><a name="line.995"></a>
-<span class="sourceLineNo">996</span> * </ul><a name="line.996"></a>
-<span class="sourceLineNo">997</span> *<a name="line.997"></a>
-<span class="sourceLineNo">998</span> * @param favIcon The contents that make up the <code>favicon.ico</code> page.<a name="line.998"></a>
-<span class="sourceLineNo">999</span> * @return This object (for method chaining).<a name="line.999"></a>
-<span class="sourceLineNo">1000</span> */<a name="line.1000"></a>
-<span class="sourceLineNo">1001</span> public RestConfig setFavIcon(Object favIcon) {<a name="line.1001"></a>
-<span class="sourceLineNo">1002</span> this.favIcon = favIcon;<a name="line.1002"></a>
-<span class="sourceLineNo">1003</span> return this;<a name="line.1003"></a>
-<span class="sourceLineNo">1004</span> }<a name="line.1004"></a>
-<span class="sourceLineNo">1005</span><a name="line.1005"></a>
-<span class="sourceLineNo">1006</span> /**<a name="line.1006"></a>
-<span class="sourceLineNo">1007</span> * Specifies the icon contents that make up the contents of the page <js>"/resource-path/favicon.ico"</js>.<a name="line.1007"></a>
-<span class="sourceLineNo">1008</span> *<a name="line.1008"></a>
-<span class="sourceLineNo">1009</span> * <p><a name="line.1009"></a>
-<span class="sourceLineNo">1010</span> * This is the programmatic equivalent to the {@link RestResource#favicon() @RestResource.favicon()} annotation.<a name="line.1010"></a>
-<span class="sourceLineNo">1011</span> *<a name="line.1011"></a>
-<span class="sourceLineNo">1012</span> * <p><a name="line.1012"></a>
-<span class="sourceLineNo">1013</span> * Use this method to specify a resource located in the classpath.<a name="line.1013"></a>
-<span class="sourceLineNo">1014</span> * This call uses the {@link Class#getResourceAsStream(String)} method to retrieve the stylesheet contents.<a name="line.1014"></a>
-<span class="sourceLineNo">1015</span> *<a name="line.1015"></a>
-<span class="sourceLineNo">1016</span> * @param resourceClass The resource class used to resolve the resource stream.<a name="line.1016"></a>
-<span class="sourceLineNo">1017</span> * @param resourcePath<a name="line.1017"></a>
-<span class="sourceLineNo">1018</span> * The path passed to the {@link Class#getResourceAsStream(String)} method.<a name="line.1018"></a>
-<span class="sourceLineNo">1019</span> * Can also be a path starting with <js>"file://"</js> denoting a location to pull from the file system.<a name="line.1019"></a>
-<span class="sourceLineNo">1020</span> * @return This object (for method chaining).<a name="line.1020"></a>
-<span class="sourceLineNo">1021</span> */<a name="line.1021"></a>
-<span class="sourceLineNo">1022</span> public RestConfig setFavIcon(Class<?> resourceClass, String resourcePath) {<a name="line.1022"></a>
-<span class="sourceLineNo">1023</span> this.favIcon = new Pair<Class<?>,String>(resourceClass, resourcePath);<a name="line.1023"></a>
-<span class="sourceLineNo">1024</span> return this;<a name="line.1024"></a>
-<span class="sourceLineNo">1025</span> }<a name="line.1025"></a>
-<span class="sourceLineNo">1026</span><a name="line.1026"></a>
-<span class="sourceLineNo">1027</span> /**<a name="line.1027"></a>
-<span class="sourceLineNo">1028</span> * Appends to the static files resource map.<a name="line.1028"></a>
-<span class="sourceLineNo">1029</span> *<a name="line.1029"></a>
-<span class="sourceLineNo">1030</span> * <p><a name="line.1030"></a>
-<span class="sourceLineNo">1031</span> * Use this method to specify resources located in the classpath to be served up as static files.<a name="line.1031"></a>
-<span class="sourceLineNo">1032</span> *<a name="line.1032"></a>
-<span class="sourceLineNo">1033</span> * <p><a name="line.1033"></a>
-<span class="sourceLineNo">1034</span> * This is the programmatic equivalent to the {@link RestResource#staticFiles() @RestResource.staticFiles()}<a name="line.1034"></a>
-<span class="sourceLineNo">1035</span> * annotation.<a name="line.1035"></a>
-<span class="sourceLineNo">1036</span> *<a name="line.1036"></a>
-<span class="sourceLineNo">1037</span> * @param resourceClass The resource class used to resolve the resource streams.<a name="line.1037"></a>
-<span class="sourceLineNo">1038</span> * @param staticFilesString<a name="line.1038"></a>
-<span class="sourceLineNo">1039</span> * A JSON string denoting a map of child URLs to classpath subdirectories.<a name="line.1039"></a>
-<span class="sourceLineNo">1040</span> * For example, if this string is <js>"{htdocs:'docs'}"</js> with class <code>com.foo.MyResource</code>,<a name="line.1040"></a>
-<span class="sourceLineNo">1041</span> * then URLs of the form <js>"/resource-path/htdocs/..."</js> will resolve to files located in the<a name="line.1041"></a>
-<span class="sourceLineNo">1042</span> * <code>com.foo.docs</code> package.<a name="line.1042"></a>
-<span class="sourceLineNo">1043</span> * @return This object (for method chaining).<a name="line.1043"></a>
-<span class="sourceLineNo">1044</span> */<a name="line.1044"></a>
-<span class="sourceLineNo">1045</span> public RestConfig addStaticFiles(Class<?> resourceClass, String staticFilesString) {<a name="line.1045"></a>
-<span class="sourceLineNo">1046</span> if (staticFiles == null)<a name="line.1046"></a>
-<span class="sourceLineNo">1047</span> staticFiles = new ArrayList<Object>();<a name="line.1047"></a>
-<span class="sourceLineNo">1048</span> staticFiles.add(new Pair<Class<?>,Object>(resourceClass, staticFilesString));<a name="line.1048"></a>
-<span class="sourceLineNo">1049</span> return this;<a name="line.1049"></a>
-<span class="sourceLineNo">1050</span> }<a name="line.1050"></a>
-<span class="sourceLineNo">1051</span><a name="line.1051"></a>
-<span class="sourceLineNo">1052</span> /**<a name="line.1052"></a>
-<span class="sourceLineNo">1053</span> * Overrides the default REST resource resolver.<a name="line.1053"></a>
-<span class="sourceLineNo">1054</span> *<a name="line.1054"></a>
-<span class="sourceLineNo">1055</span> * <p><a name="line.1055"></a>
-<span class="sourceLineNo">1056</span> * The resource resolver is used to resolve instances from {@link Class} objects defined in the<a name="line.1056"></a>
-<span class="sourceLineNo">1057</span> * {@link RestResource#children()} annotation.<a name="line.1057"></a>
-<span class="sourceLineNo">1058</span> * The default value is {@link RestResourceResolverSimple}.<a name="line.1058"></a>
-<span class="sourceLineNo">1059</span> *<a name="line.1059"></a>
-<span class="sourceLineNo">1060</span> * <p><a name="line.1060"></a>
-<span class="sourceLineNo">1061</span> * This is the programmatic equivalent to the<a name="line.1061"></a>
-<span class="sourceLineNo">1062</span> * {@link RestResource#resourceResolver() @RestResource.resourceResolver()} annotation.<a name="line.1062"></a>
-<span class="sourceLineNo">1063</span> *<a name="line.1063"></a>
-<span class="sourceLineNo">1064</span> * @param resourceResolver The new resource resolver.<a name="line.1064"></a>
-<span class="sourceLineNo">1065</span> * @return This object (for method chaining).<a name="line.1065"></a>
-<span class="sourceLineNo">1066</span> */<a name="line.1066"></a>
-<span class="sourceLineNo">1067</span> public RestConfig setResourceResolver(Class<? extends RestResourceResolver> resourceResolver) {<a name="line.1067"></a>
-<span class="sourceLineNo">1068</span> this.resourceResolver = resourceResolver;<a name="line.1068"></a>
-<span class="sourceLineNo">1069</span> return this;<a name="line.1069"></a>
-<span class="sourceLineNo">1070</span> }<a name="line.1070"></a>
-<span class="sourceLineNo">1071</span><a name="line.1071"></a>
-<span class="sourceLineNo">1072</span> /**<a name="line.1072"></a>
-<span class="sourceLineNo">1073</span> * Overrides the default REST resource resolver.<a name="line.1073"></a>
-<span class="sourceLineNo">1074</span> *<a name="line.1074"></a>
-<span class="sourceLineNo">1075</span> * <p><a name="line.1075"></a>
-<span class="sourceLineNo">1076</span> * Same as {@link #setResourceResolver(Class)} except allows you to specify an instance instead of a class.<a name="line.1076"></a>
-<span class="sourceLineNo">1077</span> *<a name="line.1077"></a>
-<span class="sourceLineNo">1078</span> * @param resourceResolver The new resource resolver.<a name="line.1078"></a>
-<span class="sourceLineNo">1079</span> * @return This object (for method chaining).<a name="line.1079"></a>
-<span class="sourceLineNo">1080</span> */<a name="line.1080"></a>
-<span class="sourceLineNo">1081</span> public RestConfig setResourceResolver(RestResourceResolver resourceResolver) {<a name="line.1081"></a>
-<span class="sourceLineNo">1082</span> this.resourceResolver = resourceResolver;<a name="line.1082"></a>
-<span class="sourceLineNo">1083</span> return this;<a name="line.1083"></a>
-<span class="sourceLineNo">1084</span> }<a name="line.1084"></a>
-<span class="sourceLineNo">1085</span><a name="line.1085"></a>
-<span class="sourceLineNo">1086</span> /**<a name="line.1086"></a>
-<span class="sourceLineNo">1087</span> * Sets the URL path of the resource <js>"/foobar"</js>.<a name="line.1087"></a>
-<span class="sourceLineNo">1088</span> *<a name="line.1088"></a>
-<span class="sourceLineNo">1089</span> * <p><a name="line.1089"></a>
-<span class="sourceLineNo">1090</span> * This is the programmatic equivalent to the {@link RestResource#path() @RestResource.path()} annotation.<a name="line.1090"></a>
-<span class="sourceLineNo">1091</span> *<a name="line.1091"></a>
-<span class="sourceLineNo">1092</span> * @param path The URL path of this resource.<a name="line.1092"></a>
-<span class="sourceLineNo">1093</span> * @return This object (for method chaining).<a name="line.1093"></a>
-<span class="sourceLineNo">1094</span> */<a name="line.1094"></a>
-<span class="sourceLineNo">1095</span> public RestConfig setPath(String path) {<a name="line.1095"></a>
-<span class="sourceLineNo">1096</span> if (startsWith(path, '/'))<a name="line.1096"></a>
-<span class="sourceLineNo">1097</span> path = path.substring(1);<a name="line.1097"></a>
-<span class="sourceLineNo">1098</span> this.path = path;<a name="line.1098"></a>
-<span class="sourceLineNo">1099</span> return this;<a name="line.1099"></a>
-<span class="sourceLineNo">1100</span> }<a name="line.1100"></a>
-<span class="sourceLineNo">1101</span><a name="line.1101"></a>
-<span class="sourceLineNo">1102</span> /**<a name="line.1102"></a>
-<span class="sourceLineNo">1103</span> * Sets name of the header used to denote the client version on HTTP requests.<a name="line.1103"></a>
-<span class="sourceLineNo">1104</span> *<a name="line.1104"></a>
-<span class="sourceLineNo">1105</span> * <p><a name="line.1105"></a>
-<span class="sourceLineNo">1106</span> * This is the programmatic equivalent to the<a name="line.1106"></a>
-<span class="sourceLineNo">1107</span> * {@link RestResource#clientVersionHeader() @RestResource.clientVersionHeader()} annotation.<a name="line.1107"></a>
-<span class="sourceLineNo">1108</span> *<a name="line.1108"></a>
-<span class="sourceLineNo">1109</span> * @param clientVersionHeader The name of the HTTP header that denotes the client version.<a name="line.1109"></a>
-<span class="sourceLineNo">1110</span> * @return This object (for method chaining).<a name="line.1110"></a>
-<span class="sourceLineNo">1111</span> */<a name="line.1111"></a>
-<span class="sourceLineNo">1112</span> public RestConfig setClientVersionHeader(String clientVersionHeader) {<a name="line.1112"></a>
-<span class="sourceLineNo">1113</span> this.clientVersionHeader = clientVersionHeader;<a name="line.1113"></a>
-<span class="sourceLineNo">1114</span> return this;<a name="line.1114"></a>
-<span class="sourceLineNo">1115</span> }<a name="line.1115"></a>
-<span class="sourceLineNo">1116</span><a name="line.1116"></a>
-<span class="sourceLineNo">1117</span> /**<a name="line.1117"></a>
-<span class="sourceLineNo">1118</span> * Sets the HTML header section contents.<a name="line.1118"></a>
-<span class="sourceLineNo">1119</span> *<a name="line.1119"></a>
-<span class="sourceLineNo">1120</span> * <p><a name="line.1120"></a>
-<span class="sourceLineNo">1121</span> * The format of this value is HTML.<a name="line.1121"></a>
-<span class="sourceLineNo">1122</span> *<a name="line.1122"></a>
-<span class="sourceLineNo">1123</span> * <p><a name="line.1123"></a>
-<span class="sourceLineNo">1124</span> * The page header normally contains the title and description, but this value can be used to override the contents<a name="line.1124"></a>
-<span class="sourceLineNo">1125</span> * to be whatever you want.<a name="line.1125"></a>
-<span class="sourceLineNo">1126</span> *<a name="line.1126"></a>
-<span class="sourceLineNo">1127</span> * <p><a name="line.1127"></a>
-<span class="sourceLineNo">1128</span> * A value of <js>"NONE"</js> can be used to force no header.<a name="line.1128"></a>
-<span class="sourceLineNo">1129</span> *<a name="line.1129"></a>
-<span class="sourceLineNo">1130</span> * <p><a name="line.1130"></a>
-<span class="sourceLineNo">1131</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.1131"></a>
-<span class="sourceLineNo">1132</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.1132"></a>
-<span class="sourceLineNo">1133</span> *<a name="line.1133"></a>
-<span class="sourceLineNo">1134</span> * <p><a name="line.1134"></a>
-<span class="sourceLineNo">1135</span> * This is the programmatic equivalent to the {@link HtmlDoc#header() @HtmlDoc.header()} annotation.<a name="line.1135"></a>
-<span class="sourceLineNo">1136</span> *<a name="line.1136"></a>
-<span class="sourceLineNo">1137</span> * @param value The HTML header section contents.<a name="line.1137"></a>
-<span class="sourceLineNo">1138</span> * @return This object (for method chaining).<a name="line.1138"></a>
-<span class="sourceLineNo">1139</span> */<a name="line.1139"></a>
-<span class="sourceLineNo">1140</span> public RestConfig setHtmlHeader(String value) {<a name="line.1140"></a>
-<span class="sourceLineNo">1141</span> this.htmlHeader = value;<a name="line.1141"></a>
-<span class="sourceLineNo">1142</span> return this;<a name="line.1142"></a>
-<span class="sourceLineNo">1143</span> }<a name="line.1143"></a>
-<span class="sourceLineNo">1144</span><a name="line.1144"></a>
-<span class="sourceLineNo">1145</span> /**<a name="line.1145"></a>
-<span class="sourceLineNo">1146</span> * Sets the links in the HTML nav section.<a name="line.1146"></a>
-<span class="sourceLineNo">1147</span> *<a name="line.1147"></a>
-<span class="sourceLineNo">1148</span> * <p><a name="line.1148"></a>
-<span class="sourceLineNo">1149</span> * The format of this value is a lax-JSON map of key/value pairs where the keys are the link text and the values are<a name="line.1149"></a>
-<span class="sourceLineNo">1150</span> * relative (to the servlet) or absolute URLs.<a name="line.1150"></a>
-<span class="sourceLineNo">1151</span> *<a name="line.1151"></a>
-<span class="sourceLineNo">1152</span> * <p><a name="line.1152"></a>
-<span class="sourceLineNo">1153</span> * The page links are positioned immediately under the title and text.<a name="line.1153"></a>
-<span class="sourceLineNo">1154</span> *<a name="line.1154"></a>
-<span class="sourceLineNo">1155</span> * <p><a name="line.1155"></a>
-<span class="sourceLineNo">1156</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.1156"></a>
-<span class="sourceLineNo">1157</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.1157"></a>
-<span class="sourceLineNo">1158</span> *<a name="line.1158"></a>
-<span class="sourceLineNo">1159</span> * <p><a name="line.1159"></a>
-<span class="sourceLineNo">1160</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.1160"></a>
-<span class="sourceLineNo">1161</span> *<a name="line.1161"></a>
-<span class="sourceLineNo">1162</span> * <p><a name="line.1162"></a>
-<span class="sourceLineNo">1163</span> * This field can also use URIs of any support type in {@link UriResolver}.<a name="line.1163"></a>
-<span class="sourceLineNo">1164</span> *<a name="line.1164"></a>
-<span class="sourceLineNo">1165</span> * <p><a name="line.1165"></a>
-<span class="sourceLineNo">1166</span> * This is the programmatic equivalent to the {@link HtmlDoc#links() @HtmlDoc.links()} annotation.<a name="line.1166"></a>
-<span class="sourceLineNo">1167</span> *<a name="line.1167"></a>
-<span class="sourceLineNo">1168</span> * @param value The HTML nav section links links.<a name="line.1168"></a>
-<span class="sourceLineNo">1169</span> * @return This object (for method chaining).<a name="line.1169"></a>
-<span class="sourceLineNo">1170</span> */<a name="line.1170"></a>
-<span class="sourceLineNo">1171</span> public RestConfig setHtmlLinks(String[] value) {<a name="line.1171"></a>
-<span class="sourceLineNo">1172</span> this.htmlLinks = value;<a name="line.1172"></a>
-<span class="sourceLineNo">1173</span> return this;<a name="line.1173"></a>
-<span class="sourceLineNo">1174</span> }<a name="line.1174"></a>
-<span class="sourceLineNo">1175</span><a name="line.1175"></a>
-<span class="sourceLineNo">1176</span> /**<a name="line.1176"></a>
-<span class="sourceLineNo">1177</span> * Sets the HTML nav section contents.<a name="line.1177"></a>
-<span class="sourceLineNo">1178</span> *<a name="line.1178"></a>
-<span class="sourceLineNo">1179</span> * <p><a name="line.1179"></a>
-<span class="sourceLineNo">1180</span> * The format of this value is HTML.<a name="line.1180"></a>
-<span class="sourceLineNo">1181</span> *<a name="line.1181"></a>
-<span class="sourceLineNo">1182</span> * <p><a name="line.1182"></a>
-<span class="sourceLineNo">1183</span> * The nav section of the page contains the links.<a name="line.1183"></a>
-<span class="sourceLineNo">1184</span> *<a name="line.1184"></a>
-<span class="sourceLineNo">1185</span> * <p><a name="line.1185"></a>
-<span class="sourceLineNo">1186</span> * The format of this value is HTML.<a name="li
<TRUNCATED>