Repository: incubator-juneau-website Updated Branches: refs/heads/asf-site 85dc92a63 -> c4956832d
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/c4956832/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestResource.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestResource.html b/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestResource.html index c55c56b..74b0801 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestResource.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestResource.html @@ -430,319 +430,333 @@ <span class="sourceLineNo">422</span> * Optional site name.<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> * Used as a label for the overall site.<a name="line.425"></a> -<span class="sourceLineNo">426</span> * This value can be retrieved programmatically through the {@link RestRequest#getSiteName()} method.<a name="line.426"></a> -<span class="sourceLineNo">427</span> *<a name="line.427"></a> -<span class="sourceLineNo">428</span> * <p><a name="line.428"></a> -<span class="sourceLineNo">429</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.429"></a> -<span class="sourceLineNo">430</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.430"></a> -<span class="sourceLineNo">431</span> *<a name="line.431"></a> -<span class="sourceLineNo">432</span> * <p><a name="line.432"></a> -<span class="sourceLineNo">433</span> * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getSiteName(RestRequest)} method.<a name="line.433"></a> -<span class="sourceLineNo">434</span> */<a name="line.434"></a> -<span class="sourceLineNo">435</span> String siteName() default "";<a name="line.435"></a> -<span class="sourceLineNo">436</span><a name="line.436"></a> -<span class="sourceLineNo">437</span> /**<a name="line.437"></a> -<span class="sourceLineNo">438</span> * Optional servlet title.<a name="line.438"></a> -<span class="sourceLineNo">439</span> *<a name="line.439"></a> -<span class="sourceLineNo">440</span> * <p><a name="line.440"></a> -<span class="sourceLineNo">441</span> * It is used to populate the Swagger title field.<a name="line.441"></a> -<span class="sourceLineNo">442</span> * This value can be retrieved programmatically through the {@link RestRequest#getServletTitle()} method.<a name="line.442"></a> -<span class="sourceLineNo">443</span> *<a name="line.443"></a> -<span class="sourceLineNo">444</span> * <p><a name="line.444"></a> -<span class="sourceLineNo">445</span> * The default value pulls the label from the <code>label</code> entry in the servlet resource bundle.<a name="line.445"></a> -<span class="sourceLineNo">446</span> * (e.g. <js>"title = foo"</js> or <js>"MyServlet.title = foo"</js>).<a name="line.446"></a> -<span class="sourceLineNo">447</span> *<a name="line.447"></a> -<span class="sourceLineNo">448</span> * <p><a name="line.448"></a> -<span class="sourceLineNo">449</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.449"></a> -<span class="sourceLineNo">450</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.450"></a> -<span class="sourceLineNo">451</span> *<a name="line.451"></a> -<span class="sourceLineNo">452</span> * <p><a name="line.452"></a> -<span class="sourceLineNo">453</span> * Corresponds to the swagger field <code>/info/title</code>.<a name="line.453"></a> -<span class="sourceLineNo">454</span> *<a name="line.454"></a> -<span class="sourceLineNo">455</span> * <p><a name="line.455"></a> -<span class="sourceLineNo">456</span> * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getTitle(RestRequest)} method.<a name="line.456"></a> -<span class="sourceLineNo">457</span> */<a name="line.457"></a> -<span class="sourceLineNo">458</span> String title() default "";<a name="line.458"></a> -<span class="sourceLineNo">459</span><a name="line.459"></a> -<span class="sourceLineNo">460</span> /**<a name="line.460"></a> -<span class="sourceLineNo">461</span> * Optional servlet description.<a name="line.461"></a> -<span class="sourceLineNo">462</span> *<a name="line.462"></a> -<span class="sourceLineNo">463</span> * <p><a name="line.463"></a> -<span class="sourceLineNo">464</span> * It is used to populate the Swagger description field.<a name="line.464"></a> -<span class="sourceLineNo">465</span> * This value can be retrieved programmatically through the {@link RestRequest#getServletDescription()} method.<a name="line.465"></a> -<span class="sourceLineNo">466</span> *<a name="line.466"></a> -<span class="sourceLineNo">467</span> * <p><a name="line.467"></a> -<span class="sourceLineNo">468</span> * The default value pulls the description from the <code>description</code> entry in the servlet resource bundle.<a name="line.468"></a> -<span class="sourceLineNo">469</span> * (e.g. <js>"description = foo"</js> or <js>"MyServlet.description = foo"</js>).<a name="line.469"></a> -<span class="sourceLineNo">470</span> *<a name="line.470"></a> -<span class="sourceLineNo">471</span> * <p><a name="line.471"></a> -<span class="sourceLineNo">472</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.472"></a> -<span class="sourceLineNo">473</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.473"></a> -<span class="sourceLineNo">474</span> *<a name="line.474"></a> -<span class="sourceLineNo">475</span> * <p><a name="line.475"></a> -<span class="sourceLineNo">476</span> * Corresponds to the swagger field <code>/info/description</code>.<a name="line.476"></a> -<span class="sourceLineNo">477</span> *<a name="line.477"></a> -<span class="sourceLineNo">478</span> * <p><a name="line.478"></a> -<span class="sourceLineNo">479</span> * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getDescription(RestRequest)} method.<a name="line.479"></a> -<span class="sourceLineNo">480</span> */<a name="line.480"></a> -<span class="sourceLineNo">481</span> String description() default "";<a name="line.481"></a> -<span class="sourceLineNo">482</span><a name="line.482"></a> -<span class="sourceLineNo">483</span> /**<a name="line.483"></a> -<span class="sourceLineNo">484</span> * Optional location of configuration file for this servlet.<a name="line.484"></a> -<span class="sourceLineNo">485</span> *<a name="line.485"></a> -<span class="sourceLineNo">486</span> * <p><a name="line.486"></a> -<span class="sourceLineNo">487</span> * The configuration file .<a name="line.487"></a> +<span class="sourceLineNo">425</span> * The site name is intended to be a title that can be applied to the entire site.<a name="line.425"></a> +<span class="sourceLineNo">426</span> *<a name="line.426"></a> +<span class="sourceLineNo">427</span> * <p><a name="line.427"></a> +<span class="sourceLineNo">428</span> * This value can be retrieved programmatically through the {@link RestRequest#getSiteName()} method.<a name="line.428"></a> +<span class="sourceLineNo">429</span> *<a name="line.429"></a> +<span class="sourceLineNo">430</span> * <p><a name="line.430"></a> +<span class="sourceLineNo">431</span> * One possible use is if you want to add the same title to the top of all pages by defining a header on a<a name="line.431"></a> +<span class="sourceLineNo">432</span> * common parent class like so:<a name="line.432"></a> +<span class="sourceLineNo">433</span> * <p class='bcode'><a name="line.433"></a> +<span class="sourceLineNo">434</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.434"></a> +<span class="sourceLineNo">435</span> * header={<a name="line.435"></a> +<span class="sourceLineNo">436</span> * <js>"&lt;h1&gt;$R{siteName}&lt;/h1&gt;"</js>,<a name="line.436"></a> +<span class="sourceLineNo">437</span> * <js>"&lt;h2&gt;$R{servletTitle}&lt;/h2&gt;"</js><a name="line.437"></a> +<span class="sourceLineNo">438</span> * }<a name="line.438"></a> +<span class="sourceLineNo">439</span> * )<a name="line.439"></a> +<span class="sourceLineNo">440</span> * </p><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> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.443"></a> +<span class="sourceLineNo">444</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.444"></a> +<span class="sourceLineNo">445</span> *<a name="line.445"></a> +<span class="sourceLineNo">446</span> * <p><a name="line.446"></a> +<span class="sourceLineNo">447</span> * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getSiteName(RestRequest)} method.<a name="line.447"></a> +<span class="sourceLineNo">448</span> */<a name="line.448"></a> +<span class="sourceLineNo">449</span> String siteName() default "";<a name="line.449"></a> +<span class="sourceLineNo">450</span><a name="line.450"></a> +<span class="sourceLineNo">451</span> /**<a name="line.451"></a> +<span class="sourceLineNo">452</span> * Optional servlet title.<a name="line.452"></a> +<span class="sourceLineNo">453</span> *<a name="line.453"></a> +<span class="sourceLineNo">454</span> * <p><a name="line.454"></a> +<span class="sourceLineNo">455</span> * It is used to populate the Swagger title field.<a name="line.455"></a> +<span class="sourceLineNo">456</span> * This value can be retrieved programmatically through the {@link RestRequest#getServletTitle()} method.<a name="line.456"></a> +<span class="sourceLineNo">457</span> *<a name="line.457"></a> +<span class="sourceLineNo">458</span> * <p><a name="line.458"></a> +<span class="sourceLineNo">459</span> * The default value pulls the label from the <code>label</code> entry in the servlet resource bundle.<a name="line.459"></a> +<span class="sourceLineNo">460</span> * (e.g. <js>"title = foo"</js> or <js>"MyServlet.title = foo"</js>).<a name="line.460"></a> +<span class="sourceLineNo">461</span> *<a name="line.461"></a> +<span class="sourceLineNo">462</span> * <p><a name="line.462"></a> +<span class="sourceLineNo">463</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.463"></a> +<span class="sourceLineNo">464</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.464"></a> +<span class="sourceLineNo">465</span> *<a name="line.465"></a> +<span class="sourceLineNo">466</span> * <p><a name="line.466"></a> +<span class="sourceLineNo">467</span> * Corresponds to the swagger field <code>/info/title</code>.<a name="line.467"></a> +<span class="sourceLineNo">468</span> *<a name="line.468"></a> +<span class="sourceLineNo">469</span> * <p><a name="line.469"></a> +<span class="sourceLineNo">470</span> * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getTitle(RestRequest)} method.<a name="line.470"></a> +<span class="sourceLineNo">471</span> */<a name="line.471"></a> +<span class="sourceLineNo">472</span> String title() default "";<a name="line.472"></a> +<span class="sourceLineNo">473</span><a name="line.473"></a> +<span class="sourceLineNo">474</span> /**<a name="line.474"></a> +<span class="sourceLineNo">475</span> * Optional servlet description.<a name="line.475"></a> +<span class="sourceLineNo">476</span> *<a name="line.476"></a> +<span class="sourceLineNo">477</span> * <p><a name="line.477"></a> +<span class="sourceLineNo">478</span> * It is used to populate the Swagger description field.<a name="line.478"></a> +<span class="sourceLineNo">479</span> * This value can be retrieved programmatically through the {@link RestRequest#getServletDescription()} method.<a name="line.479"></a> +<span class="sourceLineNo">480</span> *<a name="line.480"></a> +<span class="sourceLineNo">481</span> * <p><a name="line.481"></a> +<span class="sourceLineNo">482</span> * The default value pulls the description from the <code>description</code> entry in the servlet resource bundle.<a name="line.482"></a> +<span class="sourceLineNo">483</span> * (e.g. <js>"description = foo"</js> or <js>"MyServlet.description = foo"</js>).<a name="line.483"></a> +<span class="sourceLineNo">484</span> *<a name="line.484"></a> +<span class="sourceLineNo">485</span> * <p><a name="line.485"></a> +<span class="sourceLineNo">486</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.486"></a> +<span class="sourceLineNo">487</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<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 field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.490"></a> -<span class="sourceLineNo">491</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.491"></a> -<span class="sourceLineNo">492</span> *<a name="line.492"></a> -<span class="sourceLineNo">493</span> * <p><a name="line.493"></a> -<span class="sourceLineNo">494</span> * The programmatic equivalent to this annotation is the {@link RestConfig#setConfigFile(ConfigFile)} method.<a name="line.494"></a> -<span class="sourceLineNo">495</span> */<a name="line.495"></a> -<span class="sourceLineNo">496</span> String config() default "";<a name="line.496"></a> -<span class="sourceLineNo">497</span><a name="line.497"></a> -<span class="sourceLineNo">498</span> /**<a name="line.498"></a> -<span class="sourceLineNo">499</span> * The favicon to use for HTML views.<a name="line.499"></a> -<span class="sourceLineNo">500</span> *<a name="line.500"></a> -<span class="sourceLineNo">501</span> * <p><a name="line.501"></a> -<span class="sourceLineNo">502</span> * The name is a path to an icon file located in either the classpath or working directory.<a name="line.502"></a> -<span class="sourceLineNo">503</span> * The resulting favicon becomes available in the servlet via the URL <js>"[servlet-path]/favicon.ico"</js>.<a name="line.503"></a> -<span class="sourceLineNo">504</span> *<a name="line.504"></a> -<span class="sourceLineNo">505</span> * <p><a name="line.505"></a> -<span class="sourceLineNo">506</span> * If the file cannot be located, the request to <js>"[servlet-path]/favicon.ico"</js> will return<a name="line.506"></a> -<span class="sourceLineNo">507</span> * {@link HttpServletResponse#SC_NOT_FOUND}.<a name="line.507"></a> -<span class="sourceLineNo">508</span> *<a name="line.508"></a> -<span class="sourceLineNo">509</span> * <h5 class='section'>Example:</h5><a name="line.509"></a> -<span class="sourceLineNo">510</span> * <p class='bcode'><a name="line.510"></a> -<span class="sourceLineNo">511</span> * <jk>package</jk> com.foo.mypackage;<a name="line.511"></a> -<span class="sourceLineNo">512</span> *<a name="line.512"></a> -<span class="sourceLineNo">513</span> * <ja>@RestResource</ja>(<a name="line.513"></a> -<span class="sourceLineNo">514</span> * favicon=<js>"mydocs/myicon.ico"</js><a name="line.514"></a> -<span class="sourceLineNo">515</span> * )<a name="line.515"></a> -<span class="sourceLineNo">516</span> * <jk>public class</jk> MyResource <jk>extends</jk> RestServletDefault {<a name="line.516"></a> -<span class="sourceLineNo">517</span> * }<a name="line.517"></a> -<span class="sourceLineNo">518</span> * </p><a name="line.518"></a> -<span class="sourceLineNo">519</span> *<a name="line.519"></a> -<span class="sourceLineNo">520</span> * <p><a name="line.520"></a> -<span class="sourceLineNo">521</span> * In this example, the servlet will attempt to find the <code>myicon.ico</code> file in the following ordered<a name="line.521"></a> -<span class="sourceLineNo">522</span> * locations:<a name="line.522"></a> -<span class="sourceLineNo">523</span> * <ol><a name="line.523"></a> -<span class="sourceLineNo">524</span> * <li><code>com.foo.mypackage.mydocs</code> package.<a name="line.524"></a> -<span class="sourceLineNo">525</span> * <li><code>org.apache.juneau.rest.mydocs</code> package (since <code>RestServletDefault</code> is in<a name="line.525"></a> -<span class="sourceLineNo">526</span> * <code>org.apache.juneau.rest</code>).<a name="line.526"></a> -<span class="sourceLineNo">527</span> * <li><code>[working-dir]/mydocs</code> directory.<a name="line.527"></a> -<span class="sourceLineNo">528</span> * </ol><a name="line.528"></a> -<span class="sourceLineNo">529</span> *<a name="line.529"></a> -<span class="sourceLineNo">530</span> * <p><a name="line.530"></a> -<span class="sourceLineNo">531</span> * The programmatic equivalent to this annotation are the {@link RestConfig#setFavIcon(Object)}/<a name="line.531"></a> -<span class="sourceLineNo">532</span> * {@link RestConfig#setFavIcon(Class, String)} methods.<a name="line.532"></a> -<span class="sourceLineNo">533</span> */<a name="line.533"></a> -<span class="sourceLineNo">534</span> String favicon() default "";<a name="line.534"></a> -<span class="sourceLineNo">535</span><a name="line.535"></a> -<span class="sourceLineNo">536</span> /**<a name="line.536"></a> -<span class="sourceLineNo">537</span> * Defines paths and locations of statically served files.<a name="line.537"></a> -<span class="sourceLineNo">538</span> *<a name="line.538"></a> -<span class="sourceLineNo">539</span> * <p><a name="line.539"></a> -<span class="sourceLineNo">540</span> * This is a JSON map of paths to packages/directories located on either the classpath or working directory.<a name="line.540"></a> -<span class="sourceLineNo">541</span> *<a name="line.541"></a> -<span class="sourceLineNo">542</span> * <p><a name="line.542"></a> -<span class="sourceLineNo">543</span> * Mappings are cumulative from parent to child. Child resources can override mappings made on parent resources.<a name="line.543"></a> -<span class="sourceLineNo">544</span> *<a name="line.544"></a> -<span class="sourceLineNo">545</span> * <p><a name="line.545"></a> -<span class="sourceLineNo">546</span> * If the file cannot be located, the request will return {@link HttpServletResponse#SC_NOT_FOUND}.<a name="line.546"></a> -<span class="sourceLineNo">547</span> *<a name="line.547"></a> -<span class="sourceLineNo">548</span> * <h5 class='section'>Example:</h5><a name="line.548"></a> -<span class="sourceLineNo">549</span> * <p class='bcode'><a name="line.549"></a> -<span class="sourceLineNo">550</span> * <jk>package</jk> com.foo.mypackage;<a name="line.550"></a> -<span class="sourceLineNo">551</span> *<a name="line.551"></a> -<span class="sourceLineNo">552</span> * <ja>@RestResource</ja>(<a name="line.552"></a> -<span class="sourceLineNo">553</span> * path=<js>"/myresource"</js>,<a name="line.553"></a> -<span class="sourceLineNo">554</span> * staticFiles=<js>"{htdocs:'docs'}"</js><a name="line.554"></a> -<span class="sourceLineNo">555</span> * )<a name="line.555"></a> -<span class="sourceLineNo">556</span> * <jk>public class</jk> MyResource <jk>extends</jk> RestServletDefault {<a name="line.556"></a> -<span class="sourceLineNo">557</span> * }<a name="line.557"></a> -<span class="sourceLineNo">558</span> * </p><a name="line.558"></a> -<span class="sourceLineNo">559</span> *<a name="line.559"></a> -<span class="sourceLineNo">560</span> * <p><a name="line.560"></a> -<span class="sourceLineNo">561</span> * In this example, given a GET request to <code>/myresource/htdocs/foobar.html</code>, the servlet will attempt to<a name="line.561"></a> -<span class="sourceLineNo">562</span> * find the <code>foobar.html</code> file in the following ordered locations:<a name="line.562"></a> -<span class="sourceLineNo">563</span> * <ol><a name="line.563"></a> -<span class="sourceLineNo">564</span> * <li><code>com.foo.mypackage.docs</code> package.<a name="line.564"></a> -<span class="sourceLineNo">565</span> * <li><code>org.apache.juneau.rest.docs</code> package (since <code>RestServletDefault</code> is in<a name="line.565"></a> -<span class="sourceLineNo">566</span> * <code>org.apache.juneau.rest</code>).<a name="line.566"></a> -<span class="sourceLineNo">567</span> * <li><code>[working-dir]/docs</code> directory.<a name="line.567"></a> -<span class="sourceLineNo">568</span> * </ol><a name="line.568"></a> -<span class="sourceLineNo">569</span> *<a name="line.569"></a> -<span class="sourceLineNo">570</span> * <p><a name="line.570"></a> -<span class="sourceLineNo">571</span> * The programmatic equivalent to this annotation is the {@link RestConfig#addStaticFiles(Class, String)} method.<a name="line.571"></a> -<span class="sourceLineNo">572</span> */<a name="line.572"></a> -<span class="sourceLineNo">573</span> String staticFiles() default "";<a name="line.573"></a> -<span class="sourceLineNo">574</span><a name="line.574"></a> -<span class="sourceLineNo">575</span> /**<a name="line.575"></a> -<span class="sourceLineNo">576</span> * Specifies the HTTP header name used to identify the client version.<a name="line.576"></a> -<span class="sourceLineNo">577</span> *<a name="line.577"></a> -<span class="sourceLineNo">578</span> * <p><a name="line.578"></a> -<span class="sourceLineNo">579</span> * The client version is used to support backwards compatibility for breaking REST interface changes.<a name="line.579"></a> -<span class="sourceLineNo">580</span> * Used in conjunction with {@link RestMethod#clientVersion()} annotation.<a name="line.580"></a> -<span class="sourceLineNo">581</span> *<a name="line.581"></a> -<span class="sourceLineNo">582</span> * <p><a name="line.582"></a> -<span class="sourceLineNo">583</span> * If not specified, uses <js>"X-Client-Version"</js>.<a name="line.583"></a> -<span class="sourceLineNo">584</span> *<a name="line.584"></a> -<span class="sourceLineNo">585</span> * <p><a name="line.585"></a> -<span class="sourceLineNo">586</span> * The programmatic equivalent to this annotation is the {@link RestConfig#setClientVersionHeader(String)} method.<a name="line.586"></a> -<span class="sourceLineNo">587</span> */<a name="line.587"></a> -<span class="sourceLineNo">588</span> String clientVersionHeader() default "";<a name="line.588"></a> -<span class="sourceLineNo">589</span><a name="line.589"></a> -<span class="sourceLineNo">590</span> /**<a name="line.590"></a> -<span class="sourceLineNo">591</span> * Specifies the resolver class to use for resolving child resources by class name.<a name="line.591"></a> -<span class="sourceLineNo">592</span> *<a name="line.592"></a> -<span class="sourceLineNo">593</span> * <p><a name="line.593"></a> -<span class="sourceLineNo">594</span> * The default implementation simply instantiates the class using one of the following constructors:<a name="line.594"></a> -<span class="sourceLineNo">595</span> * <ul><a name="line.595"></a> -<span class="sourceLineNo">596</span> * <li><code><jk>public</jk> T(RestConfig)</code><a name="line.596"></a> -<span class="sourceLineNo">597</span> * <li><code><jk>public</jk> T()</code><a name="line.597"></a> -<span class="sourceLineNo">598</span> * </ul><a name="line.598"></a> -<span class="sourceLineNo">599</span> *<a name="line.599"></a> -<span class="sourceLineNo">600</span> * <p><a name="line.600"></a> -<span class="sourceLineNo">601</span> * The former constructor can be used to get access to the {@link RestConfig} object to get access to the config<a name="line.601"></a> -<span class="sourceLineNo">602</span> * file and initialization information or make programmatic modifications to the resource before full initialization.<a name="line.602"></a> -<span class="sourceLineNo">603</span> *<a name="line.603"></a> -<span class="sourceLineNo">604</span> * <p><a name="line.604"></a> -<span class="sourceLineNo">605</span> * Non-<code>RestServlet</code> classes can also add the following two methods to get access to the<a name="line.605"></a> -<span class="sourceLineNo">606</span> * {@link RestConfig} and {@link RestContext} objects:<a name="line.606"></a> -<span class="sourceLineNo">607</span> * <ul><a name="line.607"></a> -<span class="sourceLineNo">608</span> * <li><code><jk>public void</jk> init(RestConfig);</code><a name="line.608"></a> -<span class="sourceLineNo">609</span> * <li><code><jk>public void</jk> init(RestContext);</code><a name="line.609"></a> -<span class="sourceLineNo">610</span> * </ul><a name="line.610"></a> -<span class="sourceLineNo">611</span> *<a name="line.611"></a> -<span class="sourceLineNo">612</span> * <p><a name="line.612"></a> -<span class="sourceLineNo">613</span> * Subclasses can be used to provide customized resolution of REST resource class instances.<a name="line.613"></a> -<span class="sourceLineNo">614</span> *<a name="line.614"></a> -<span class="sourceLineNo">615</span> * <p><a name="line.615"></a> -<span class="sourceLineNo">616</span> * The programmatic equivalent to this annotation are the {@link RestConfig#setResourceResolver(Class)}/<a name="line.616"></a> -<span class="sourceLineNo">617</span> * {@link RestConfig#setResourceResolver(RestResourceResolver)} methods.<a name="line.617"></a> -<span class="sourceLineNo">618</span> */<a name="line.618"></a> -<span class="sourceLineNo">619</span> Class<? extends RestResourceResolver> resourceResolver() default RestResourceResolver.class;<a name="line.619"></a> -<span class="sourceLineNo">620</span><a name="line.620"></a> -<span class="sourceLineNo">621</span> /**<a name="line.621"></a> -<span class="sourceLineNo">622</span> * Specifies the logger class to use for logging.<a name="line.622"></a> -<span class="sourceLineNo">623</span> *<a name="line.623"></a> -<span class="sourceLineNo">624</span> * <p><a name="line.624"></a> -<span class="sourceLineNo">625</span> * The default logger performs basic error logging to the Java logger.<a name="line.625"></a> -<span class="sourceLineNo">626</span> * Subclasses can be used to customize logging behavior on the resource.<a name="line.626"></a> -<span class="sourceLineNo">627</span> *<a name="line.627"></a> -<span class="sourceLineNo">628</span> * <p><a name="line.628"></a> -<span class="sourceLineNo">629</span> * The programmatic equivalent to this annotation are the<a name="line.629"></a> -<span class="sourceLineNo">630</span> * {@link RestConfig#setLogger(Class)}/{@link RestConfig#setLogger(RestLogger)} methods.<a name="line.630"></a> -<span class="sourceLineNo">631</span> */<a name="line.631"></a> -<span class="sourceLineNo">632</span> Class<? extends RestLogger> logger() default RestLogger.Normal.class;<a name="line.632"></a> -<span class="sourceLineNo">633</span><a name="line.633"></a> -<span class="sourceLineNo">634</span> /**<a name="line.634"></a> -<span class="sourceLineNo">635</span> * Specifies the REST call handler class.<a name="line.635"></a> -<span class="sourceLineNo">636</span> *<a name="line.636"></a> -<span class="sourceLineNo">637</span> * <p><a name="line.637"></a> -<span class="sourceLineNo">638</span> * This class handles the basic lifecycle of an HTTP REST call.<a name="line.638"></a> -<span class="sourceLineNo">639</span> * Subclasses can be used to customize how these HTTP calls are handled.<a name="line.639"></a> -<span class="sourceLineNo">640</span> *<a name="line.640"></a> -<span class="sourceLineNo">641</span> * <p><a name="line.641"></a> -<span class="sourceLineNo">642</span> * The programmatic equivalent to this annotation are the<a name="line.642"></a> -<span class="sourceLineNo">643</span> * {@link RestConfig#setCallHandler(Class)}/{@link RestConfig#setCallHandler(RestCallHandler)} methods.<a name="line.643"></a> -<span class="sourceLineNo">644</span> */<a name="line.644"></a> -<span class="sourceLineNo">645</span> Class<? extends RestCallHandler> callHandler() default RestCallHandler.class;<a name="line.645"></a> -<span class="sourceLineNo">646</span><a name="line.646"></a> -<span class="sourceLineNo">647</span> /**<a name="line.647"></a> -<span class="sourceLineNo">648</span> * Specifies the class used to retrieve title/description/swagger information about a resource.<a name="line.648"></a> -<span class="sourceLineNo">649</span> *<a name="line.649"></a> -<span class="sourceLineNo">650</span> * <p><a name="line.650"></a> -<span class="sourceLineNo">651</span> * Subclasses can be used to customize the documentation on a resource.<a name="line.651"></a> -<span class="sourceLineNo">652</span> *<a name="line.652"></a> -<span class="sourceLineNo">653</span> * <p><a name="line.653"></a> -<span class="sourceLineNo">654</span> * The programmatic equivalent to this annotation are the<a name="line.654"></a> -<span class="sourceLineNo">655</span> * {@link RestConfig#setInfoProvider(Class)}/{@link RestConfig#setInfoProvider(RestInfoProvider)} methods.<a name="line.655"></a> -<span class="sourceLineNo">656</span> */<a name="line.656"></a> -<span class="sourceLineNo">657</span> Class<? extends RestInfoProvider> infoProvider() default RestInfoProvider.class;<a name="line.657"></a> -<span class="sourceLineNo">658</span><a name="line.658"></a> -<span class="sourceLineNo">659</span> /**<a name="line.659"></a> -<span class="sourceLineNo">660</span> * Specifies the serializer listener class to use for listening for non-fatal errors.<a name="line.660"></a> -<span class="sourceLineNo">661</span> */<a name="line.661"></a> -<span class="sourceLineNo">662</span> Class<? extends SerializerListener> serializerListener() default SerializerListener.class;<a name="line.662"></a> -<span class="sourceLineNo">663</span><a name="line.663"></a> -<span class="sourceLineNo">664</span> /**<a name="line.664"></a> -<span class="sourceLineNo">665</span> * Specifies the parser listener class to use for listening for non-fatal errors.<a name="line.665"></a> -<span class="sourceLineNo">666</span> */<a name="line.666"></a> -<span class="sourceLineNo">667</span> Class<? extends ParserListener> parserListener() default ParserListener.class;<a name="line.667"></a> -<span class="sourceLineNo">668</span><a name="line.668"></a> -<span class="sourceLineNo">669</span> /**<a name="line.669"></a> -<span class="sourceLineNo">670</span> * Provides swagger-specific metadata on this resource.<a name="line.670"></a> -<span class="sourceLineNo">671</span> *<a name="line.671"></a> -<span class="sourceLineNo">672</span> * <p><a name="line.672"></a> -<span class="sourceLineNo">673</span> * Used to populate the auto-generated OPTIONS swagger documentation.<a name="line.673"></a> -<span class="sourceLineNo">674</span> *<a name="line.674"></a> -<span class="sourceLineNo">675</span> * <h5 class='section'>Example:</h5><a name="line.675"></a> -<span class="sourceLineNo">676</span> * <p class='bcode'><a name="line.676"></a> -<span class="sourceLineNo">677</span> * <ja>@RestResource</ja>(<a name="line.677"></a> -<span class="sourceLineNo">678</span> * path=<js>"/addressBook"</js>,<a name="line.678"></a> -<span class="sourceLineNo">679</span> *<a name="line.679"></a> -<span class="sourceLineNo">680</span> * <jc>// Swagger info.</jc><a name="line.680"></a> -<span class="sourceLineNo">681</span> * swagger=<ja>@ResourceSwagger</ja>(<a name="line.681"></a> -<span class="sourceLineNo">682</span> * contact=<js>"{name:'John Smith',email:'[email protected]'}"</js>,<a name="line.682"></a> -<span class="sourceLineNo">683</span> * license=<js>"{name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js>,<a name="line.683"></a> -<span class="sourceLineNo">684</span> * version=<js>"2.0"</js>,<a name="line.684"></a> -<span class="sourceLineNo">685</span> * termsOfService=<js>"You're on your own."</js>,<a name="line.685"></a> -<span class="sourceLineNo">686</span> * tags=<js>"[{name:'Java',description:'Java utility',externalDocs:{description:'Home page',url:'http://juneau.apache.org'}}]"</js>,<a name="line.686"></a> -<span class="sourceLineNo">687</span> * externalDocs=<js>"{description:'Home page',url:'http://juneau.apache.org'}"</js><a name="line.687"></a> -<span class="sourceLineNo">688</span> * )<a name="line.688"></a> -<span class="sourceLineNo">689</span> * )<a name="line.689"></a> -<span class="sourceLineNo">690</span> * </p><a name="line.690"></a> -<span class="sourceLineNo">691</span> */<a name="line.691"></a> -<span class="sourceLineNo">692</span> ResourceSwagger swagger() default @ResourceSwagger;<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> * Provides HTML-doc-specific metadata on this method.<a name="line.695"></a> -<span class="sourceLineNo">696</span> *<a name="line.696"></a> -<span class="sourceLineNo">697</span> * <p><a name="line.697"></a> -<span class="sourceLineNo">698</span> * Used to customize the output from the HTML Doc serializer.<a name="line.698"></a> -<span class="sourceLineNo">699</span> * <p class='bcode'><a name="line.699"></a> -<span class="sourceLineNo">700</span> * <ja>@RestResource</ja>(<a name="line.700"></a> -<span class="sourceLineNo">701</span> * path=<js>"/addressBook"</js>,<a name="line.701"></a> -<span class="sourceLineNo">702</span> *<a name="line.702"></a> -<span class="sourceLineNo">703</span> * <jc>// Links on the HTML rendition page.<a name="line.703"></a> -<span class="sourceLineNo">704</span> * // "request:/..." URIs are relative to the request URI.<a name="line.704"></a> -<span class="sourceLineNo">705</span> * // "servlet:/..." URIs are relative to the servlet URI.<a name="line.705"></a> -<span class="sourceLineNo">706</span> * // "$C{...}" variables are pulled from the config file.</jc><a name="line.706"></a> -<span class="sourceLineNo">707</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.707"></a> -<span class="sourceLineNo">708</span> * <jc>// Widgets for $W variables.</jc><a name="line.708"></a> -<span class="sourceLineNo">709</span> * widgets={<a name="line.709"></a> -<span class="sourceLineNo">710</span> * PoweredByJuneau.<jk>class</jk>,<a name="line.710"></a> -<span class="sourceLineNo">711</span> * ContentTypeLinks.<jk>class</jk><a name="line.711"></a> -<span class="sourceLineNo">712</span> * }<a name="line.712"></a> -<span class="sourceLineNo">713</span> * links={<a name="line.713"></a> -<span class="sourceLineNo">714</span> * <js>"up: request:/.."</js>,<a name="line.714"></a> -<span class="sourceLineNo">715</span> * <js>"options: servlet:/?method=OPTIONS"</js>,<a name="line.715"></a> -<span class="sourceLineNo">716</span> * <js>"source: $C{Source/gitHub}/org/apache/juneau/examples/rest/addressbook/AddressBookResource.java"</js>,<a name="line.716"></a> -<span class="sourceLineNo">717</span> * },<a name="line.717"></a> -<span class="sourceLineNo">718</span> * aside={<a name="line.718"></a> -<span class="sourceLineNo">719</span> * <js>"&lt;div style='max-width:400px;min-width:200px'&gt;"</js>,<a name="line.719"></a> -<span class="sourceLineNo">720</span> * <js>" &lt;p&gt;Proof-of-concept resource that shows off the capabilities of working with POJO resources.&lt;/p&gt;"</js>,<a name="line.720"></a> -<span class="sourceLineNo">721</span> * <js>" &lt;p&gt;Provides examples of: &lt;/p&gt;"</js>,<a name="line.721"></a> -<span class="sourceLineNo">722</span> * <js>" &lt;ul&gt;"</js>,<a name="line.722"></a> -<span class="sourceLineNo">723</span> * <js>" &lt;li&gt;XML and RDF namespaces"</js>,<a name="line.723"></a> -<span class="sourceLineNo">724</span> * <js>" &lt;li&gt;Swagger documentation"</js>,<a name="line.724"></a> -<span class="sourceLineNo">725</span> * <js>" &lt;li&gt;Widgets"</js>,<a name="line.725"></a> -<span class="sourceLineNo">726</span> * <js>" &lt;/ul&gt;"</js>,<a name="line.726"></a> -<span class="sourceLineNo">727</span> * <js>" &lt;p style='text-weight:bold;text-decoration:underline;'&gt;Available Content Types&lt;/p&gt;"</js>,<a name="line.727"></a> -<span class="sourceLineNo">728</span> * <js>" $W{ContentTypeLinks}"</js>,<a name="line.728"></a> -<span class="sourceLineNo">729</span> * <js>"&lt;/div&gt;"</js><a name="line.729"></a> -<span class="sourceLineNo">730</span> * },<a name="line.730"></a> -<span class="sourceLineNo">731</span> * footer=<js>"$W{PoweredByJuneau}"</js><a name="line.731"></a> -<span class="sourceLineNo">732</span> * )<a name="line.732"></a> -<span class="sourceLineNo">733</span> * )<a name="line.733"></a> -<span class="sourceLineNo">734</span> * </p><a name="line.734"></a> -<span class="sourceLineNo">735</span> */<a name="line.735"></a> -<span class="sourceLineNo">736</span> HtmlDoc htmldoc() default @HtmlDoc;<a name="line.736"></a> -<span class="sourceLineNo">737</span>}<a name="line.737"></a> +<span class="sourceLineNo">490</span> * Corresponds to the swagger field <code>/info/description</code>.<a name="line.490"></a> +<span class="sourceLineNo">491</span> *<a name="line.491"></a> +<span class="sourceLineNo">492</span> * <p><a name="line.492"></a> +<span class="sourceLineNo">493</span> * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getDescription(RestRequest)} method.<a name="line.493"></a> +<span class="sourceLineNo">494</span> */<a name="line.494"></a> +<span class="sourceLineNo">495</span> String description() default "";<a name="line.495"></a> +<span class="sourceLineNo">496</span><a name="line.496"></a> +<span class="sourceLineNo">497</span> /**<a name="line.497"></a> +<span class="sourceLineNo">498</span> * Optional location of configuration file for this servlet.<a name="line.498"></a> +<span class="sourceLineNo">499</span> *<a name="line.499"></a> +<span class="sourceLineNo">500</span> * <p><a name="line.500"></a> +<span class="sourceLineNo">501</span> * The configuration file .<a name="line.501"></a> +<span class="sourceLineNo">502</span> *<a name="line.502"></a> +<span class="sourceLineNo">503</span> * <p><a name="line.503"></a> +<span class="sourceLineNo">504</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.504"></a> +<span class="sourceLineNo">505</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.505"></a> +<span class="sourceLineNo">506</span> *<a name="line.506"></a> +<span class="sourceLineNo">507</span> * <p><a name="line.507"></a> +<span class="sourceLineNo">508</span> * The programmatic equivalent to this annotation is the {@link RestConfig#setConfigFile(ConfigFile)} method.<a name="line.508"></a> +<span class="sourceLineNo">509</span> */<a name="line.509"></a> +<span class="sourceLineNo">510</span> String config() default "";<a name="line.510"></a> +<span class="sourceLineNo">511</span><a name="line.511"></a> +<span class="sourceLineNo">512</span> /**<a name="line.512"></a> +<span class="sourceLineNo">513</span> * The favicon to use for HTML views.<a name="line.513"></a> +<span class="sourceLineNo">514</span> *<a name="line.514"></a> +<span class="sourceLineNo">515</span> * <p><a name="line.515"></a> +<span class="sourceLineNo">516</span> * The name is a path to an icon file located in either the classpath or working directory.<a name="line.516"></a> +<span class="sourceLineNo">517</span> * The resulting favicon becomes available in the servlet via the URL <js>"[servlet-path]/favicon.ico"</js>.<a name="line.517"></a> +<span class="sourceLineNo">518</span> *<a name="line.518"></a> +<span class="sourceLineNo">519</span> * <p><a name="line.519"></a> +<span class="sourceLineNo">520</span> * If the file cannot be located, the request to <js>"[servlet-path]/favicon.ico"</js> will return<a name="line.520"></a> +<span class="sourceLineNo">521</span> * {@link HttpServletResponse#SC_NOT_FOUND}.<a name="line.521"></a> +<span class="sourceLineNo">522</span> *<a name="line.522"></a> +<span class="sourceLineNo">523</span> * <h5 class='section'>Example:</h5><a name="line.523"></a> +<span class="sourceLineNo">524</span> * <p class='bcode'><a name="line.524"></a> +<span class="sourceLineNo">525</span> * <jk>package</jk> com.foo.mypackage;<a name="line.525"></a> +<span class="sourceLineNo">526</span> *<a name="line.526"></a> +<span class="sourceLineNo">527</span> * <ja>@RestResource</ja>(<a name="line.527"></a> +<span class="sourceLineNo">528</span> * favicon=<js>"mydocs/myicon.ico"</js><a name="line.528"></a> +<span class="sourceLineNo">529</span> * )<a name="line.529"></a> +<span class="sourceLineNo">530</span> * <jk>public class</jk> MyResource <jk>extends</jk> RestServletDefault {<a name="line.530"></a> +<span class="sourceLineNo">531</span> * }<a name="line.531"></a> +<span class="sourceLineNo">532</span> * </p><a name="line.532"></a> +<span class="sourceLineNo">533</span> *<a name="line.533"></a> +<span class="sourceLineNo">534</span> * <p><a name="line.534"></a> +<span class="sourceLineNo">535</span> * In this example, the servlet will attempt to find the <code>myicon.ico</code> file in the following ordered<a name="line.535"></a> +<span class="sourceLineNo">536</span> * locations:<a name="line.536"></a> +<span class="sourceLineNo">537</span> * <ol><a name="line.537"></a> +<span class="sourceLineNo">538</span> * <li><code>com.foo.mypackage.mydocs</code> package.<a name="line.538"></a> +<span class="sourceLineNo">539</span> * <li><code>org.apache.juneau.rest.mydocs</code> package (since <code>RestServletDefault</code> is in<a name="line.539"></a> +<span class="sourceLineNo">540</span> * <code>org.apache.juneau.rest</code>).<a name="line.540"></a> +<span class="sourceLineNo">541</span> * <li><code>[working-dir]/mydocs</code> directory.<a name="line.541"></a> +<span class="sourceLineNo">542</span> * </ol><a name="line.542"></a> +<span class="sourceLineNo">543</span> *<a name="line.543"></a> +<span class="sourceLineNo">544</span> * <p><a name="line.544"></a> +<span class="sourceLineNo">545</span> * The programmatic equivalent to this annotation are the {@link RestConfig#setFavIcon(Object)}/<a name="line.545"></a> +<span class="sourceLineNo">546</span> * {@link RestConfig#setFavIcon(Class, String)} methods.<a name="line.546"></a> +<span class="sourceLineNo">547</span> */<a name="line.547"></a> +<span class="sourceLineNo">548</span> String favicon() default "";<a name="line.548"></a> +<span class="sourceLineNo">549</span><a name="line.549"></a> +<span class="sourceLineNo">550</span> /**<a name="line.550"></a> +<span class="sourceLineNo">551</span> * Defines paths and locations of statically served files.<a name="line.551"></a> +<span class="sourceLineNo">552</span> *<a name="line.552"></a> +<span class="sourceLineNo">553</span> * <p><a name="line.553"></a> +<span class="sourceLineNo">554</span> * This is a JSON map of paths to packages/directories located on either the classpath or working directory.<a name="line.554"></a> +<span class="sourceLineNo">555</span> *<a name="line.555"></a> +<span class="sourceLineNo">556</span> * <p><a name="line.556"></a> +<span class="sourceLineNo">557</span> * Mappings are cumulative from parent to child. Child resources can override mappings made on parent resources.<a name="line.557"></a> +<span class="sourceLineNo">558</span> *<a name="line.558"></a> +<span class="sourceLineNo">559</span> * <p><a name="line.559"></a> +<span class="sourceLineNo">560</span> * If the file cannot be located, the request will return {@link HttpServletResponse#SC_NOT_FOUND}.<a name="line.560"></a> +<span class="sourceLineNo">561</span> *<a name="line.561"></a> +<span class="sourceLineNo">562</span> * <h5 class='section'>Example:</h5><a name="line.562"></a> +<span class="sourceLineNo">563</span> * <p class='bcode'><a name="line.563"></a> +<span class="sourceLineNo">564</span> * <jk>package</jk> com.foo.mypackage;<a name="line.564"></a> +<span class="sourceLineNo">565</span> *<a name="line.565"></a> +<span class="sourceLineNo">566</span> * <ja>@RestResource</ja>(<a name="line.566"></a> +<span class="sourceLineNo">567</span> * path=<js>"/myresource"</js>,<a name="line.567"></a> +<span class="sourceLineNo">568</span> * staticFiles=<js>"{htdocs:'docs'}"</js><a name="line.568"></a> +<span class="sourceLineNo">569</span> * )<a name="line.569"></a> +<span class="sourceLineNo">570</span> * <jk>public class</jk> MyResource <jk>extends</jk> RestServletDefault {<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> *<a name="line.573"></a> +<span class="sourceLineNo">574</span> * <p><a name="line.574"></a> +<span class="sourceLineNo">575</span> * In this example, given a GET request to <code>/myresource/htdocs/foobar.html</code>, the servlet will attempt to<a name="line.575"></a> +<span class="sourceLineNo">576</span> * find the <code>foobar.html</code> file in the following ordered locations:<a name="line.576"></a> +<span class="sourceLineNo">577</span> * <ol><a name="line.577"></a> +<span class="sourceLineNo">578</span> * <li><code>com.foo.mypackage.docs</code> package.<a name="line.578"></a> +<span class="sourceLineNo">579</span> * <li><code>org.apache.juneau.rest.docs</code> package (since <code>RestServletDefault</code> is in<a name="line.579"></a> +<span class="sourceLineNo">580</span> * <code>org.apache.juneau.rest</code>).<a name="line.580"></a> +<span class="sourceLineNo">581</span> * <li><code>[working-dir]/docs</code> directory.<a name="line.581"></a> +<span class="sourceLineNo">582</span> * </ol><a name="line.582"></a> +<span class="sourceLineNo">583</span> *<a name="line.583"></a> +<span class="sourceLineNo">584</span> * <p><a name="line.584"></a> +<span class="sourceLineNo">585</span> * The programmatic equivalent to this annotation is the {@link RestConfig#addStaticFiles(Class, String)} method.<a name="line.585"></a> +<span class="sourceLineNo">586</span> */<a name="line.586"></a> +<span class="sourceLineNo">587</span> String staticFiles() default "";<a name="line.587"></a> +<span class="sourceLineNo">588</span><a name="line.588"></a> +<span class="sourceLineNo">589</span> /**<a name="line.589"></a> +<span class="sourceLineNo">590</span> * Specifies the HTTP header name used to identify the client version.<a name="line.590"></a> +<span class="sourceLineNo">591</span> *<a name="line.591"></a> +<span class="sourceLineNo">592</span> * <p><a name="line.592"></a> +<span class="sourceLineNo">593</span> * The client version is used to support backwards compatibility for breaking REST interface changes.<a name="line.593"></a> +<span class="sourceLineNo">594</span> * Used in conjunction with {@link RestMethod#clientVersion()} annotation.<a name="line.594"></a> +<span class="sourceLineNo">595</span> *<a name="line.595"></a> +<span class="sourceLineNo">596</span> * <p><a name="line.596"></a> +<span class="sourceLineNo">597</span> * If not specified, uses <js>"X-Client-Version"</js>.<a name="line.597"></a> +<span class="sourceLineNo">598</span> *<a name="line.598"></a> +<span class="sourceLineNo">599</span> * <p><a name="line.599"></a> +<span class="sourceLineNo">600</span> * The programmatic equivalent to this annotation is the {@link RestConfig#setClientVersionHeader(String)} method.<a name="line.600"></a> +<span class="sourceLineNo">601</span> */<a name="line.601"></a> +<span class="sourceLineNo">602</span> String clientVersionHeader() default "";<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> * Specifies the resolver class to use for resolving child resources by class name.<a name="line.605"></a> +<span class="sourceLineNo">606</span> *<a name="line.606"></a> +<span class="sourceLineNo">607</span> * <p><a name="line.607"></a> +<span class="sourceLineNo">608</span> * The default implementation simply instantiates the class using one of the following constructors:<a name="line.608"></a> +<span class="sourceLineNo">609</span> * <ul><a name="line.609"></a> +<span class="sourceLineNo">610</span> * <li><code><jk>public</jk> T(RestConfig)</code><a name="line.610"></a> +<span class="sourceLineNo">611</span> * <li><code><jk>public</jk> T()</code><a name="line.611"></a> +<span class="sourceLineNo">612</span> * </ul><a name="line.612"></a> +<span class="sourceLineNo">613</span> *<a name="line.613"></a> +<span class="sourceLineNo">614</span> * <p><a name="line.614"></a> +<span class="sourceLineNo">615</span> * The former constructor can be used to get access to the {@link RestConfig} object to get access to the config<a name="line.615"></a> +<span class="sourceLineNo">616</span> * file and initialization information or make programmatic modifications to the resource before full initialization.<a name="line.616"></a> +<span class="sourceLineNo">617</span> *<a name="line.617"></a> +<span class="sourceLineNo">618</span> * <p><a name="line.618"></a> +<span class="sourceLineNo">619</span> * Non-<code>RestServlet</code> classes can also add the following two methods to get access to the<a name="line.619"></a> +<span class="sourceLineNo">620</span> * {@link RestConfig} and {@link RestContext} objects:<a name="line.620"></a> +<span class="sourceLineNo">621</span> * <ul><a name="line.621"></a> +<span class="sourceLineNo">622</span> * <li><code><jk>public void</jk> init(RestConfig);</code><a name="line.622"></a> +<span class="sourceLineNo">623</span> * <li><code><jk>public void</jk> init(RestContext);</code><a name="line.623"></a> +<span class="sourceLineNo">624</span> * </ul><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> * Subclasses can be used to provide customized resolution of REST resource class instances.<a name="line.627"></a> +<span class="sourceLineNo">628</span> *<a name="line.628"></a> +<span class="sourceLineNo">629</span> * <p><a name="line.629"></a> +<span class="sourceLineNo">630</span> * The programmatic equivalent to this annotation are the {@link RestConfig#setResourceResolver(Class)}/<a name="line.630"></a> +<span class="sourceLineNo">631</span> * {@link RestConfig#setResourceResolver(RestResourceResolver)} methods.<a name="line.631"></a> +<span class="sourceLineNo">632</span> */<a name="line.632"></a> +<span class="sourceLineNo">633</span> Class<? extends RestResourceResolver> resourceResolver() default RestResourceResolver.class;<a name="line.633"></a> +<span class="sourceLineNo">634</span><a name="line.634"></a> +<span class="sourceLineNo">635</span> /**<a name="line.635"></a> +<span class="sourceLineNo">636</span> * Specifies the logger class to use for logging.<a name="line.636"></a> +<span class="sourceLineNo">637</span> *<a name="line.637"></a> +<span class="sourceLineNo">638</span> * <p><a name="line.638"></a> +<span class="sourceLineNo">639</span> * The default logger performs basic error logging to the Java logger.<a name="line.639"></a> +<span class="sourceLineNo">640</span> * Subclasses can be used to customize logging behavior on the resource.<a name="line.640"></a> +<span class="sourceLineNo">641</span> *<a name="line.641"></a> +<span class="sourceLineNo">642</span> * <p><a name="line.642"></a> +<span class="sourceLineNo">643</span> * The programmatic equivalent to this annotation are the<a name="line.643"></a> +<span class="sourceLineNo">644</span> * {@link RestConfig#setLogger(Class)}/{@link RestConfig#setLogger(RestLogger)} methods.<a name="line.644"></a> +<span class="sourceLineNo">645</span> */<a name="line.645"></a> +<span class="sourceLineNo">646</span> Class<? extends RestLogger> logger() default RestLogger.Normal.class;<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> * Specifies the REST call handler class.<a name="line.649"></a> +<span class="sourceLineNo">650</span> *<a name="line.650"></a> +<span class="sourceLineNo">651</span> * <p><a name="line.651"></a> +<span class="sourceLineNo">652</span> * This class handles the basic lifecycle of an HTTP REST call.<a name="line.652"></a> +<span class="sourceLineNo">653</span> * Subclasses can be used to customize how these HTTP calls are handled.<a name="line.653"></a> +<span class="sourceLineNo">654</span> *<a name="line.654"></a> +<span class="sourceLineNo">655</span> * <p><a name="line.655"></a> +<span class="sourceLineNo">656</span> * The programmatic equivalent to this annotation are the<a name="line.656"></a> +<span class="sourceLineNo">657</span> * {@link RestConfig#setCallHandler(Class)}/{@link RestConfig#setCallHandler(RestCallHandler)} methods.<a name="line.657"></a> +<span class="sourceLineNo">658</span> */<a name="line.658"></a> +<span class="sourceLineNo">659</span> Class<? extends RestCallHandler> callHandler() default RestCallHandler.class;<a name="line.659"></a> +<span class="sourceLineNo">660</span><a name="line.660"></a> +<span class="sourceLineNo">661</span> /**<a name="line.661"></a> +<span class="sourceLineNo">662</span> * Specifies the class used to retrieve title/description/swagger information about a resource.<a name="line.662"></a> +<span class="sourceLineNo">663</span> *<a name="line.663"></a> +<span class="sourceLineNo">664</span> * <p><a name="line.664"></a> +<span class="sourceLineNo">665</span> * Subclasses can be used to customize the documentation on a resource.<a name="line.665"></a> +<span class="sourceLineNo">666</span> *<a name="line.666"></a> +<span class="sourceLineNo">667</span> * <p><a name="line.667"></a> +<span class="sourceLineNo">668</span> * The programmatic equivalent to this annotation are the<a name="line.668"></a> +<span class="sourceLineNo">669</span> * {@link RestConfig#setInfoProvider(Class)}/{@link RestConfig#setInfoProvider(RestInfoProvider)} methods.<a name="line.669"></a> +<span class="sourceLineNo">670</span> */<a name="line.670"></a> +<span class="sourceLineNo">671</span> Class<? extends RestInfoProvider> infoProvider() default RestInfoProvider.class;<a name="line.671"></a> +<span class="sourceLineNo">672</span><a name="line.672"></a> +<span class="sourceLineNo">673</span> /**<a name="line.673"></a> +<span class="sourceLineNo">674</span> * Specifies the serializer listener class to use for listening for non-fatal errors.<a name="line.674"></a> +<span class="sourceLineNo">675</span> */<a name="line.675"></a> +<span class="sourceLineNo">676</span> Class<? extends SerializerListener> serializerListener() default SerializerListener.class;<a name="line.676"></a> +<span class="sourceLineNo">677</span><a name="line.677"></a> +<span class="sourceLineNo">678</span> /**<a name="line.678"></a> +<span class="sourceLineNo">679</span> * Specifies the parser listener class to use for listening for non-fatal errors.<a name="line.679"></a> +<span class="sourceLineNo">680</span> */<a name="line.680"></a> +<span class="sourceLineNo">681</span> Class<? extends ParserListener> parserListener() default ParserListener.class;<a name="line.681"></a> +<span class="sourceLineNo">682</span><a name="line.682"></a> +<span class="sourceLineNo">683</span> /**<a name="line.683"></a> +<span class="sourceLineNo">684</span> * Provides swagger-specific metadata on this resource.<a name="line.684"></a> +<span class="sourceLineNo">685</span> *<a name="line.685"></a> +<span class="sourceLineNo">686</span> * <p><a name="line.686"></a> +<span class="sourceLineNo">687</span> * Used to populate the auto-generated OPTIONS swagger documentation.<a name="line.687"></a> +<span class="sourceLineNo">688</span> *<a name="line.688"></a> +<span class="sourceLineNo">689</span> * <h5 class='section'>Example:</h5><a name="line.689"></a> +<span class="sourceLineNo">690</span> * <p class='bcode'><a name="line.690"></a> +<span class="sourceLineNo">691</span> * <ja>@RestResource</ja>(<a name="line.691"></a> +<span class="sourceLineNo">692</span> * path=<js>"/addressBook"</js>,<a name="line.692"></a> +<span class="sourceLineNo">693</span> *<a name="line.693"></a> +<span class="sourceLineNo">694</span> * <jc>// Swagger info.</jc><a name="line.694"></a> +<span class="sourceLineNo">695</span> * swagger=<ja>@ResourceSwagger</ja>(<a name="line.695"></a> +<span class="sourceLineNo">696</span> * contact=<js>"{name:'John Smith',email:'[email protected]'}"</js>,<a name="line.696"></a> +<span class="sourceLineNo">697</span> * license=<js>"{name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js>,<a name="line.697"></a> +<span class="sourceLineNo">698</span> * version=<js>"2.0"</js>,<a name="line.698"></a> +<span class="sourceLineNo">699</span> * termsOfService=<js>"You're on your own."</js>,<a name="line.699"></a> +<span class="sourceLineNo">700</span> * tags=<js>"[{name:'Java',description:'Java utility',externalDocs:{description:'Home page',url:'http://juneau.apache.org'}}]"</js>,<a name="line.700"></a> +<span class="sourceLineNo">701</span> * externalDocs=<js>"{description:'Home page',url:'http://juneau.apache.org'}"</js><a name="line.701"></a> +<span class="sourceLineNo">702</span> * )<a name="line.702"></a> +<span class="sourceLineNo">703</span> * )<a name="line.703"></a> +<span class="sourceLineNo">704</span> * </p><a name="line.704"></a> +<span class="sourceLineNo">705</span> */<a name="line.705"></a> +<span class="sourceLineNo">706</span> ResourceSwagger swagger() default @ResourceSwagger;<a name="line.706"></a> +<span class="sourceLineNo">707</span><a name="line.707"></a> +<span class="sourceLineNo">708</span> /**<a name="line.708"></a> +<span class="sourceLineNo">709</span> * Provides HTML-doc-specific metadata on this method.<a name="line.709"></a> +<span class="sourceLineNo">710</span> *<a name="line.710"></a> +<span class="sourceLineNo">711</span> * <p><a name="line.711"></a> +<span class="sourceLineNo">712</span> * Used to customize the output from the HTML Doc serializer.<a name="line.712"></a> +<span class="sourceLineNo">713</span> * <p class='bcode'><a name="line.713"></a> +<span class="sourceLineNo">714</span> * <ja>@RestResource</ja>(<a name="line.714"></a> +<span class="sourceLineNo">715</span> * path=<js>"/addressBook"</js>,<a name="line.715"></a> +<span class="sourceLineNo">716</span> *<a name="line.716"></a> +<span class="sourceLineNo">717</span> * <jc>// Links on the HTML rendition page.<a name="line.717"></a> +<span class="sourceLineNo">718</span> * // "request:/..." URIs are relative to the request URI.<a name="line.718"></a> +<span class="sourceLineNo">719</span> * // "servlet:/..." URIs are relative to the servlet URI.<a name="line.719"></a> +<span class="sourceLineNo">720</span> * // "$C{...}" variables are pulled from the config file.</jc><a name="line.720"></a> +<span class="sourceLineNo">721</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.721"></a> +<span class="sourceLineNo">722</span> * <jc>// Widgets for $W variables.</jc><a name="line.722"></a> +<span class="sourceLineNo">723</span> * widgets={<a name="line.723"></a> +<span class="sourceLineNo">724</span> * PoweredByJuneau.<jk>class</jk>,<a name="line.724"></a> +<span class="sourceLineNo">725</span> * ContentTypeLinks.<jk>class</jk><a name="line.725"></a> +<span class="sourceLineNo">726</span> * }<a name="line.726"></a> +<span class="sourceLineNo">727</span> * links={<a name="line.727"></a> +<span class="sourceLineNo">728</span> * <js>"up: request:/.."</js>,<a name="line.728"></a> +<span class="sourceLineNo">729</span> * <js>"options: servlet:/?method=OPTIONS"</js>,<a name="line.729"></a> +<span class="sourceLineNo">730</span> * <js>"source: $C{Source/gitHub}/org/apache/juneau/examples/rest/addressbook/AddressBookResource.java"</js>,<a name="line.730"></a> +<span class="sourceLineNo">731</span> * },<a name="line.731"></a> +<span class="sourceLineNo">732</span> * aside={<a name="line.732"></a> +<span class="sourceLineNo">733</span> * <js>"&lt;div style='max-width:400px;min-width:200px'&gt;"</js>,<a name="line.733"></a> +<span class="sourceLineNo">734</span> * <js>" &lt;p&gt;Proof-of-concept resource that shows off the capabilities of working with POJO resources.&lt;/p&gt;"</js>,<a name="line.734"></a> +<span class="sourceLineNo">735</span> * <js>" &lt;p&gt;Provides examples of: &lt;/p&gt;"</js>,<a name="line.735"></a> +<span class="sourceLineNo">736</span> * <js>" &lt;ul&gt;"</js>,<a name="line.736"></a> +<span class="sourceLineNo">737</span> * <js>" &lt;li&gt;XML and RDF namespaces"</js>,<a name="line.737"></a> +<span class="sourceLineNo">738</span> * <js>" &lt;li&gt;Swagger documentation"</js>,<a name="line.738"></a> +<span class="sourceLineNo">739</span> * <js>" &lt;li&gt;Widgets"</js>,<a name="line.739"></a> +<span class="sourceLineNo">740</span> * <js>" &lt;/ul&gt;"</js>,<a name="line.740"></a> +<span class="sourceLineNo">741</span> * <js>" &lt;p style='text-weight:bold;text-decoration:underline;'&gt;Available Content Types&lt;/p&gt;"</js>,<a name="line.741"></a> +<span class="sourceLineNo">742</span> * <js>" $W{ContentTypeLinks}"</js>,<a name="line.742"></a> +<span class="sourceLineNo">743</span> * <js>"&lt;/div&gt;"</js><a name="line.743"></a> +<span class="sourceLineNo">744</span> * },<a name="line.744"></a> +<span class="sourceLineNo">745</span> * footer=<js>"$W{PoweredByJuneau}"</js><a name="line.745"></a> +<span class="sourceLineNo">746</span> * )<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> */<a name="line.749"></a> +<span class="sourceLineNo">750</span> HtmlDoc htmldoc() default @HtmlDoc;<a name="line.750"></a> +<span class="sourceLineNo">751</span>}<a name="line.751"></a>
