http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/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 05bc053..3cf79a8 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 @@ -487,318 +487,253 @@ <span class="sourceLineNo">479</span> String config() default "";<a name="line.479"></a> <span class="sourceLineNo">480</span><a name="line.480"></a> <span class="sourceLineNo">481</span> /**<a name="line.481"></a> -<span class="sourceLineNo">482</span> * The stylesheet to use for HTML views.<a name="line.482"></a> +<span class="sourceLineNo">482</span> * The favicon to use for HTML views.<a name="line.482"></a> <span class="sourceLineNo">483</span> *<a name="line.483"></a> <span class="sourceLineNo">484</span> * <p><a name="line.484"></a> -<span class="sourceLineNo">485</span> * The name is a path to a stylesheet located in either the classpath or working directory.<a name="line.485"></a> -<span class="sourceLineNo">486</span> * The resulting stylesheet becomes available through the servlet via the URL <js>"[servlet-path]/style.css"</js>.<a name="line.486"></a> +<span class="sourceLineNo">485</span> * The name is a path to an icon file located in either the classpath or working directory.<a name="line.485"></a> +<span class="sourceLineNo">486</span> * The resulting favicon becomes available in the servlet via the URL <js>"[servlet-path]/favicon.ico"</js>.<a name="line.486"></a> <span class="sourceLineNo">487</span> *<a name="line.487"></a> <span class="sourceLineNo">488</span> * <p><a name="line.488"></a> -<span class="sourceLineNo">489</span> * The default set of styles located in the <code>org.apache.juneau.rest.styles</code> package are:<a name="line.489"></a> -<span class="sourceLineNo">490</span> * <ul class='spaced-list'><a name="line.490"></a> -<span class="sourceLineNo">491</span> * <li><a name="line.491"></a> -<span class="sourceLineNo">492</span> * <js>"styles/juneau.css"</js> - Theme based on Jazz look-and-feel.<a name="line.492"></a> -<span class="sourceLineNo">493</span> * <li><a name="line.493"></a> -<span class="sourceLineNo">494</span> * <js>"styles/devops.css"</js> - Theme based on IBM DevOps look-and-feel.<a name="line.494"></a> -<span class="sourceLineNo">495</span> * </ul><a name="line.495"></a> -<span class="sourceLineNo">496</span> *<a name="line.496"></a> -<span class="sourceLineNo">497</span> * <p><a name="line.497"></a> -<span class="sourceLineNo">498</span> * The classpath search starts with the child servlet class and proceeds up the class hierarchy chain.<a name="line.498"></a> -<span class="sourceLineNo">499</span> * Since the {@link RestServlet} class is in the <code>org.apache.juneau.rest</code> package and the predefined<a name="line.499"></a> -<span class="sourceLineNo">500</span> * styles are in the <code>org.apache.juneau.rest.styles</code> package, the paths to the predefined styles are<a name="line.500"></a> -<span class="sourceLineNo">501</span> * prefixed with <js>"styles/"</js>.<a name="line.501"></a> +<span class="sourceLineNo">489</span> * If the file cannot be located, the request to <js>"[servlet-path]/favicon.ico"</js> will return<a name="line.489"></a> +<span class="sourceLineNo">490</span> * {@link HttpServletResponse#SC_NOT_FOUND}.<a name="line.490"></a> +<span class="sourceLineNo">491</span> *<a name="line.491"></a> +<span class="sourceLineNo">492</span> * <h5 class='section'>Example:</h5><a name="line.492"></a> +<span class="sourceLineNo">493</span> * <p class='bcode'><a name="line.493"></a> +<span class="sourceLineNo">494</span> * <jk>package</jk> com.foo.mypackage;<a name="line.494"></a> +<span class="sourceLineNo">495</span> *<a name="line.495"></a> +<span class="sourceLineNo">496</span> * <ja>@RestResource</ja>(<a name="line.496"></a> +<span class="sourceLineNo">497</span> * favicon=<js>"mydocs/myicon.ico"</js><a name="line.497"></a> +<span class="sourceLineNo">498</span> * )<a name="line.498"></a> +<span class="sourceLineNo">499</span> * <jk>public class</jk> MyResource <jk>extends</jk> RestServletDefault {<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> *<a name="line.502"></a> <span class="sourceLineNo">503</span> * <p><a name="line.503"></a> -<span class="sourceLineNo">504</span> * If the stylesheet cannot be found on the classpath, an attempt to look in the working directory for it will be<a name="line.504"></a> -<span class="sourceLineNo">505</span> * made.<a name="line.505"></a> -<span class="sourceLineNo">506</span> * This allows for stylesheets to be placed on the file system in the working directory.<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> * If the file cannot be located, the request to <js>"[servlet-path]/style.css"</js> will return<a name="line.509"></a> -<span class="sourceLineNo">510</span> * {@link HttpServletResponse#SC_NOT_FOUND}.<a name="line.510"></a> -<span class="sourceLineNo">511</span> *<a name="line.511"></a> -<span class="sourceLineNo">512</span> * <h5 class='section'>Example:</h5><a name="line.512"></a> -<span class="sourceLineNo">513</span> * <p class='bcode'><a name="line.513"></a> -<span class="sourceLineNo">514</span> * <jk>package</jk> com.foo.mypackage;<a name="line.514"></a> -<span class="sourceLineNo">515</span> *<a name="line.515"></a> -<span class="sourceLineNo">516</span> * <ja>@RestResource</ja>(<a name="line.516"></a> -<span class="sourceLineNo">517</span> * stylesheet=<js>"mystyles/mycss.css"</js><a name="line.517"></a> -<span class="sourceLineNo">518</span> * )<a name="line.518"></a> -<span class="sourceLineNo">519</span> * <jk>public class</jk> MyResource <jk>extends</jk> RestServletDefault {<a name="line.519"></a> -<span class="sourceLineNo">520</span> * }<a name="line.520"></a> -<span class="sourceLineNo">521</span> * </p><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> * In this example, the servlet will attempt to find the <code>mycss.css</code> file in the following ordered<a name="line.524"></a> -<span class="sourceLineNo">525</span> * locations:<a name="line.525"></a> -<span class="sourceLineNo">526</span> * </p><a name="line.526"></a> -<span class="sourceLineNo">527</span> * <ol><a name="line.527"></a> -<span class="sourceLineNo">528</span> * <li><code>com.foo.mypackage.mystyles</code> package.<a name="line.528"></a> -<span class="sourceLineNo">529</span> * <li><code>org.apache.juneau.rest.mystyles</code> package (since <code>RestServletDefault</code> is in<a name="line.529"></a> -<span class="sourceLineNo">530</span> * <code>org.apache.juneau.rest</code>).<a name="line.530"></a> -<span class="sourceLineNo">531</span> * <li><code>[working-dir]/mystyles</code> directory.<a name="line.531"></a> -<span class="sourceLineNo">532</span> * </ol><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> * Multiple stylesheets can be specified as a comma-delimited list.<a name="line.535"></a> -<span class="sourceLineNo">536</span> * When multiple stylesheets are specified, their contents will be concatenated and return in the order specified<a name="line.536"></a> -<span class="sourceLineNo">537</span> * in the list.<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> * The programmatic equivalent to this annotation are the {@link RestConfig#addStyleSheet(Object...)}/<a name="line.540"></a> -<span class="sourceLineNo">541</span> * {@link RestConfig#addStyleSheet(Class, String)} methods.<a name="line.541"></a> -<span class="sourceLineNo">542</span> */<a name="line.542"></a> -<span class="sourceLineNo">543</span> String stylesheet() default "";<a name="line.543"></a> -<span class="sourceLineNo">544</span><a name="line.544"></a> -<span class="sourceLineNo">545</span> /**<a name="line.545"></a> -<span class="sourceLineNo">546</span> * The favicon to use for HTML views.<a name="line.546"></a> -<span class="sourceLineNo">547</span> *<a name="line.547"></a> -<span class="sourceLineNo">548</span> * <p><a name="line.548"></a> -<span class="sourceLineNo">549</span> * The name is a path to an icon file located in either the classpath or working directory in a similar way to how<a name="line.549"></a> -<span class="sourceLineNo">550</span> * the {@link #stylesheet()} stylesheet is resolved.<a name="line.550"></a> -<span class="sourceLineNo">551</span> * The resulting favicon becomes available in the servlet via the URL <js>"[servlet-path]/favicon.ico"</js>.<a name="line.551"></a> +<span class="sourceLineNo">504</span> * In this example, the servlet will attempt to find the <code>myicon.ico</code> file in the following ordered<a name="line.504"></a> +<span class="sourceLineNo">505</span> * locations:<a name="line.505"></a> +<span class="sourceLineNo">506</span> * <ol><a name="line.506"></a> +<span class="sourceLineNo">507</span> * <li><code>com.foo.mypackage.mydocs</code> package.<a name="line.507"></a> +<span class="sourceLineNo">508</span> * <li><code>org.apache.juneau.rest.mydocs</code> package (since <code>RestServletDefault</code> is in<a name="line.508"></a> +<span class="sourceLineNo">509</span> * <code>org.apache.juneau.rest</code>).<a name="line.509"></a> +<span class="sourceLineNo">510</span> * <li><code>[working-dir]/mydocs</code> directory.<a name="line.510"></a> +<span class="sourceLineNo">511</span> * </ol><a name="line.511"></a> +<span class="sourceLineNo">512</span> *<a name="line.512"></a> +<span class="sourceLineNo">513</span> * <p><a name="line.513"></a> +<span class="sourceLineNo">514</span> * The programmatic equivalent to this annotation are the {@link RestConfig#setFavIcon(Object)}/<a name="line.514"></a> +<span class="sourceLineNo">515</span> * {@link RestConfig#setFavIcon(Class, String)} methods.<a name="line.515"></a> +<span class="sourceLineNo">516</span> */<a name="line.516"></a> +<span class="sourceLineNo">517</span> String favicon() default "";<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> * Defines paths and locations of statically served files.<a name="line.520"></a> +<span class="sourceLineNo">521</span> *<a name="line.521"></a> +<span class="sourceLineNo">522</span> * <p><a name="line.522"></a> +<span class="sourceLineNo">523</span> * This is a JSON map of paths to packages/directories located on either the classpath or working directory.<a name="line.523"></a> +<span class="sourceLineNo">524</span> *<a name="line.524"></a> +<span class="sourceLineNo">525</span> * <p><a name="line.525"></a> +<span class="sourceLineNo">526</span> * Mappings are cumulative from parent to child. Child resources can override mappings made on parent resources.<a name="line.526"></a> +<span class="sourceLineNo">527</span> *<a name="line.527"></a> +<span class="sourceLineNo">528</span> * <p><a name="line.528"></a> +<span class="sourceLineNo">529</span> * If the file cannot be located, the request will return {@link HttpServletResponse#SC_NOT_FOUND}.<a name="line.529"></a> +<span class="sourceLineNo">530</span> *<a name="line.530"></a> +<span class="sourceLineNo">531</span> * <h5 class='section'>Example:</h5><a name="line.531"></a> +<span class="sourceLineNo">532</span> * <p class='bcode'><a name="line.532"></a> +<span class="sourceLineNo">533</span> * <jk>package</jk> com.foo.mypackage;<a name="line.533"></a> +<span class="sourceLineNo">534</span> *<a name="line.534"></a> +<span class="sourceLineNo">535</span> * <ja>@RestResource</ja>(<a name="line.535"></a> +<span class="sourceLineNo">536</span> * path=<js>"/myresource"</js>,<a name="line.536"></a> +<span class="sourceLineNo">537</span> * staticFiles=<js>"{htdocs:'docs'}"</js><a name="line.537"></a> +<span class="sourceLineNo">538</span> * )<a name="line.538"></a> +<span class="sourceLineNo">539</span> * <jk>public class</jk> MyResource <jk>extends</jk> RestServletDefault {<a name="line.539"></a> +<span class="sourceLineNo">540</span> * }<a name="line.540"></a> +<span class="sourceLineNo">541</span> * </p><a name="line.541"></a> +<span class="sourceLineNo">542</span> *<a name="line.542"></a> +<span class="sourceLineNo">543</span> * <p><a name="line.543"></a> +<span class="sourceLineNo">544</span> * In this example, given a GET request to <code>/myresource/htdocs/foobar.html</code>, the servlet will attempt to<a name="line.544"></a> +<span class="sourceLineNo">545</span> * find the <code>foobar.html</code> file in the following ordered locations:<a name="line.545"></a> +<span class="sourceLineNo">546</span> * <ol><a name="line.546"></a> +<span class="sourceLineNo">547</span> * <li><code>com.foo.mypackage.docs</code> package.<a name="line.547"></a> +<span class="sourceLineNo">548</span> * <li><code>org.apache.juneau.rest.docs</code> package (since <code>RestServletDefault</code> is in<a name="line.548"></a> +<span class="sourceLineNo">549</span> * <code>org.apache.juneau.rest</code>).<a name="line.549"></a> +<span class="sourceLineNo">550</span> * <li><code>[working-dir]/docs</code> directory.<a name="line.550"></a> +<span class="sourceLineNo">551</span> * </ol><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> * If the file cannot be located, the request to <js>"[servlet-path]/favicon.ico"</js> will return<a name="line.554"></a> -<span class="sourceLineNo">555</span> * {@link HttpServletResponse#SC_NOT_FOUND}.<a name="line.555"></a> -<span class="sourceLineNo">556</span> *<a name="line.556"></a> -<span class="sourceLineNo">557</span> * <h5 class='section'>Example:</h5><a name="line.557"></a> -<span class="sourceLineNo">558</span> * <p class='bcode'><a name="line.558"></a> -<span class="sourceLineNo">559</span> * <jk>package</jk> com.foo.mypackage;<a name="line.559"></a> +<span class="sourceLineNo">554</span> * The programmatic equivalent to this annotation is the {@link RestConfig#addStaticFiles(Class, String)} method.<a name="line.554"></a> +<span class="sourceLineNo">555</span> */<a name="line.555"></a> +<span class="sourceLineNo">556</span> String staticFiles() default "";<a name="line.556"></a> +<span class="sourceLineNo">557</span><a name="line.557"></a> +<span class="sourceLineNo">558</span> /**<a name="line.558"></a> +<span class="sourceLineNo">559</span> * Specifies the HTTP header name used to identify the client version.<a name="line.559"></a> <span class="sourceLineNo">560</span> *<a name="line.560"></a> -<span class="sourceLineNo">561</span> * <ja>@RestResource</ja>(<a name="line.561"></a> -<span class="sourceLineNo">562</span> * favicon=<js>"mydocs/myicon.ico"</js><a name="line.562"></a> -<span class="sourceLineNo">563</span> * )<a name="line.563"></a> -<span class="sourceLineNo">564</span> * <jk>public class</jk> MyResource <jk>extends</jk> RestServletDefault {<a name="line.564"></a> -<span class="sourceLineNo">565</span> * }<a name="line.565"></a> -<span class="sourceLineNo">566</span> * </p><a name="line.566"></a> +<span class="sourceLineNo">561</span> * <p><a name="line.561"></a> +<span class="sourceLineNo">562</span> * The client version is used to support backwards compatibility for breaking REST interface changes.<a name="line.562"></a> +<span class="sourceLineNo">563</span> * Used in conjunction with {@link RestMethod#clientVersion()} annotation.<a name="line.563"></a> +<span class="sourceLineNo">564</span> *<a name="line.564"></a> +<span class="sourceLineNo">565</span> * <p><a name="line.565"></a> +<span class="sourceLineNo">566</span> * If not specified, uses <js>"X-Client-Version"</js>.<a name="line.566"></a> <span class="sourceLineNo">567</span> *<a name="line.567"></a> <span class="sourceLineNo">568</span> * <p><a name="line.568"></a> -<span class="sourceLineNo">569</span> * In this example, the servlet will attempt to find the <code>myicon.ico</code> file in the following ordered<a name="line.569"></a> -<span class="sourceLineNo">570</span> * locations:<a name="line.570"></a> -<span class="sourceLineNo">571</span> * <ol><a name="line.571"></a> -<span class="sourceLineNo">572</span> * <li><code>com.foo.mypackage.mydocs</code> package.<a name="line.572"></a> -<span class="sourceLineNo">573</span> * <li><code>org.apache.juneau.rest.mydocs</code> package (since <code>RestServletDefault</code> is in<a name="line.573"></a> -<span class="sourceLineNo">574</span> * <code>org.apache.juneau.rest</code>).<a name="line.574"></a> -<span class="sourceLineNo">575</span> * <li><code>[working-dir]/mydocs</code> directory.<a name="line.575"></a> -<span class="sourceLineNo">576</span> * </ol><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 programmatic equivalent to this annotation are the {@link RestConfig#setFavIcon(Object)}/<a name="line.579"></a> -<span class="sourceLineNo">580</span> * {@link RestConfig#setFavIcon(Class, String)} methods.<a name="line.580"></a> -<span class="sourceLineNo">581</span> */<a name="line.581"></a> -<span class="sourceLineNo">582</span> String favicon() default "";<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> * Defines paths and locations of statically served files.<a name="line.585"></a> +<span class="sourceLineNo">569</span> * The programmatic equivalent to this annotation is the {@link RestConfig#setClientVersionHeader(String)} method.<a name="line.569"></a> +<span class="sourceLineNo">570</span> */<a name="line.570"></a> +<span class="sourceLineNo">571</span> String clientVersionHeader() default "";<a name="line.571"></a> +<span class="sourceLineNo">572</span><a name="line.572"></a> +<span class="sourceLineNo">573</span> /**<a name="line.573"></a> +<span class="sourceLineNo">574</span> * Specifies the resolver class to use for resolving child resources by class name.<a name="line.574"></a> +<span class="sourceLineNo">575</span> *<a name="line.575"></a> +<span class="sourceLineNo">576</span> * <p><a name="line.576"></a> +<span class="sourceLineNo">577</span> * The default implementation simply instantiates the class using one of the following constructors:<a name="line.577"></a> +<span class="sourceLineNo">578</span> * <ul><a name="line.578"></a> +<span class="sourceLineNo">579</span> * <li><code><jk>public</jk> T(RestConfig)</code><a name="line.579"></a> +<span class="sourceLineNo">580</span> * <li><code><jk>public</jk> T()</code><a name="line.580"></a> +<span class="sourceLineNo">581</span> * </ul><a name="line.581"></a> +<span class="sourceLineNo">582</span> *<a name="line.582"></a> +<span class="sourceLineNo">583</span> * <p><a name="line.583"></a> +<span class="sourceLineNo">584</span> * The former constructor can be used to get access to the {@link RestConfig} object to get access to the config<a name="line.584"></a> +<span class="sourceLineNo">585</span> * file and initialization information or make programmatic modifications to the resource before full initialization.<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 a JSON map of paths to packages/directories located on either the classpath or working directory.<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> * Mappings are cumulative from parent to child. Child resources can override mappings made on parent resources.<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> * If the file cannot be located, the request will return {@link HttpServletResponse#SC_NOT_FOUND}.<a name="line.594"></a> -<span class="sourceLineNo">595</span> *<a name="line.595"></a> -<span class="sourceLineNo">596</span> * <h5 class='section'>Example:</h5><a name="line.596"></a> -<span class="sourceLineNo">597</span> * <p class='bcode'><a name="line.597"></a> -<span class="sourceLineNo">598</span> * <jk>package</jk> com.foo.mypackage;<a name="line.598"></a> -<span class="sourceLineNo">599</span> *<a name="line.599"></a> -<span class="sourceLineNo">600</span> * <ja>@RestResource</ja>(<a name="line.600"></a> -<span class="sourceLineNo">601</span> * path=<js>"/myresource"</js>,<a name="line.601"></a> -<span class="sourceLineNo">602</span> * staticFiles=<js>"{htdocs:'docs'}"</js><a name="line.602"></a> -<span class="sourceLineNo">603</span> * )<a name="line.603"></a> -<span class="sourceLineNo">604</span> * <jk>public class</jk> MyResource <jk>extends</jk> RestServletDefault {<a name="line.604"></a> -<span class="sourceLineNo">605</span> * }<a name="line.605"></a> -<span class="sourceLineNo">606</span> * </p><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> * In this example, given a GET request to <code>/myresource/htdocs/foobar.html</code>, the servlet will attempt to<a name="line.609"></a> -<span class="sourceLineNo">610</span> * find the <code>foobar.html</code> file in the following ordered locations:<a name="line.610"></a> -<span class="sourceLineNo">611</span> * <ol><a name="line.611"></a> -<span class="sourceLineNo">612</span> * <li><code>com.foo.mypackage.docs</code> package.<a name="line.612"></a> -<span class="sourceLineNo">613</span> * <li><code>org.apache.juneau.rest.docs</code> package (since <code>RestServletDefault</code> is in<a name="line.613"></a> -<span class="sourceLineNo">614</span> * <code>org.apache.juneau.rest</code>).<a name="line.614"></a> -<span class="sourceLineNo">615</span> * <li><code>[working-dir]/docs</code> directory.<a name="line.615"></a> -<span class="sourceLineNo">616</span> * </ol><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> * The programmatic equivalent to this annotation is the {@link RestConfig#addStaticFiles(Class, String)} method.<a name="line.619"></a> -<span class="sourceLineNo">620</span> */<a name="line.620"></a> -<span class="sourceLineNo">621</span> String staticFiles() default "";<a name="line.621"></a> -<span class="sourceLineNo">622</span><a name="line.622"></a> -<span class="sourceLineNo">623</span> /**<a name="line.623"></a> -<span class="sourceLineNo">624</span> * Specifies the HTTP header name used to identify the client version.<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> * The client version is used to support backwards compatibility for breaking REST interface changes.<a name="line.627"></a> -<span class="sourceLineNo">628</span> * Used in conjunction with {@link RestMethod#clientVersion()} 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> * If not specified, uses <js>"X-Client-Version"</js>.<a name="line.631"></a> +<span class="sourceLineNo">588</span> * Non-<code>RestServlet</code> classes can also add the following two methods to get access to the<a name="line.588"></a> +<span class="sourceLineNo">589</span> * {@link RestConfig} and {@link RestContext} objects:<a name="line.589"></a> +<span class="sourceLineNo">590</span> * <ul><a name="line.590"></a> +<span class="sourceLineNo">591</span> * <li><code><jk>public void</jk> init(RestConfig);</code><a name="line.591"></a> +<span class="sourceLineNo">592</span> * <li><code><jk>public void</jk> init(RestContext);</code><a name="line.592"></a> +<span class="sourceLineNo">593</span> * </ul><a name="line.593"></a> +<span class="sourceLineNo">594</span> *<a name="line.594"></a> +<span class="sourceLineNo">595</span> * <p><a name="line.595"></a> +<span class="sourceLineNo">596</span> * Subclasses can be used to provide customized resolution of REST resource class instances.<a name="line.596"></a> +<span class="sourceLineNo">597</span> *<a name="line.597"></a> +<span class="sourceLineNo">598</span> * <p><a name="line.598"></a> +<span class="sourceLineNo">599</span> * The programmatic equivalent to this annotation are the {@link RestConfig#setResourceResolver(Class)}/<a name="line.599"></a> +<span class="sourceLineNo">600</span> * {@link RestConfig#setResourceResolver(RestResourceResolver)} methods.<a name="line.600"></a> +<span class="sourceLineNo">601</span> */<a name="line.601"></a> +<span class="sourceLineNo">602</span> Class<? extends RestResourceResolver> resourceResolver() default RestResourceResolver.class;<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 logger class to use for logging.<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 logger performs basic error logging to the Java logger.<a name="line.608"></a> +<span class="sourceLineNo">609</span> * Subclasses can be used to customize logging behavior on the resource.<a name="line.609"></a> +<span class="sourceLineNo">610</span> *<a name="line.610"></a> +<span class="sourceLineNo">611</span> * <p><a name="line.611"></a> +<span class="sourceLineNo">612</span> * The programmatic equivalent to this annotation are the<a name="line.612"></a> +<span class="sourceLineNo">613</span> * {@link RestConfig#setLogger(Class)}/{@link RestConfig#setLogger(RestLogger)} methods.<a name="line.613"></a> +<span class="sourceLineNo">614</span> */<a name="line.614"></a> +<span class="sourceLineNo">615</span> Class<? extends RestLogger> logger() default RestLogger.Normal.class;<a name="line.615"></a> +<span class="sourceLineNo">616</span><a name="line.616"></a> +<span class="sourceLineNo">617</span> /**<a name="line.617"></a> +<span class="sourceLineNo">618</span> * Specifies the REST call handler class.<a name="line.618"></a> +<span class="sourceLineNo">619</span> *<a name="line.619"></a> +<span class="sourceLineNo">620</span> * <p><a name="line.620"></a> +<span class="sourceLineNo">621</span> * This class handles the basic lifecycle of an HTTP REST call.<a name="line.621"></a> +<span class="sourceLineNo">622</span> * Subclasses can be used to customize how these HTTP calls are handled.<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 programmatic equivalent to this annotation are the<a name="line.625"></a> +<span class="sourceLineNo">626</span> * {@link RestConfig#setCallHandler(Class)}/{@link RestConfig#setCallHandler(RestCallHandler)} methods.<a name="line.626"></a> +<span class="sourceLineNo">627</span> */<a name="line.627"></a> +<span class="sourceLineNo">628</span> Class<? extends RestCallHandler> callHandler() default RestCallHandler.class;<a name="line.628"></a> +<span class="sourceLineNo">629</span><a name="line.629"></a> +<span class="sourceLineNo">630</span> /**<a name="line.630"></a> +<span class="sourceLineNo">631</span> * Specifies the class used to retrieve title/description/swagger information about a resource.<a name="line.631"></a> <span class="sourceLineNo">632</span> *<a name="line.632"></a> <span class="sourceLineNo">633</span> * <p><a name="line.633"></a> -<span class="sourceLineNo">634</span> * The programmatic equivalent to this annotation is the {@link RestConfig#setClientVersionHeader(String)} method.<a name="line.634"></a> -<span class="sourceLineNo">635</span> */<a name="line.635"></a> -<span class="sourceLineNo">636</span> String clientVersionHeader() default "";<a name="line.636"></a> -<span class="sourceLineNo">637</span><a name="line.637"></a> -<span class="sourceLineNo">638</span> /**<a name="line.638"></a> -<span class="sourceLineNo">639</span> * Specifies the resolver class to use for resolving child resources by class name.<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 default implementation simply instantiates the class using one of the following constructors:<a name="line.642"></a> -<span class="sourceLineNo">643</span> * <ul><a name="line.643"></a> -<span class="sourceLineNo">644</span> * <li><code><jk>public</jk> T(RestConfig)</code><a name="line.644"></a> -<span class="sourceLineNo">645</span> * <li><code><jk>public</jk> T()</code><a name="line.645"></a> -<span class="sourceLineNo">646</span> * </ul><a name="line.646"></a> -<span class="sourceLineNo">647</span> *<a name="line.647"></a> -<span class="sourceLineNo">648</span> * <p><a name="line.648"></a> -<span class="sourceLineNo">649</span> * The former constructor can be used to get access to the {@link RestConfig} object to get access to the config<a name="line.649"></a> -<span class="sourceLineNo">650</span> * file and initialization information or make programmatic modifications to the resource before full initialization.<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> * Non-<code>RestServlet</code> classes can also add the following two methods to get access to the<a name="line.653"></a> -<span class="sourceLineNo">654</span> * {@link RestConfig} and {@link RestContext} objects:<a name="line.654"></a> -<span class="sourceLineNo">655</span> * <ul><a name="line.655"></a> -<span class="sourceLineNo">656</span> * <li><code><jk>public void</jk> init(RestConfig);</code><a name="line.656"></a> -<span class="sourceLineNo">657</span> * <li><code><jk>public void</jk> init(RestContext);</code><a name="line.657"></a> -<span class="sourceLineNo">658</span> * </ul><a name="line.658"></a> -<span class="sourceLineNo">659</span> *<a name="line.659"></a> -<span class="sourceLineNo">660</span> * <p><a name="line.660"></a> -<span class="sourceLineNo">661</span> * Subclasses can be used to provide customized resolution of REST resource class instances.<a name="line.661"></a> -<span class="sourceLineNo">662</span> *<a name="line.662"></a> -<span class="sourceLineNo">663</span> * <p><a name="line.663"></a> -<span class="sourceLineNo">664</span> * The programmatic equivalent to this annotation are the {@link RestConfig#setResourceResolver(Class)}/<a name="line.664"></a> -<span class="sourceLineNo">665</span> * {@link RestConfig#setResourceResolver(RestResourceResolver)} methods.<a name="line.665"></a> -<span class="sourceLineNo">666</span> */<a name="line.666"></a> -<span class="sourceLineNo">667</span> Class<? extends RestResourceResolver> resourceResolver() default RestResourceResolver.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> * Specifies the logger class to use for logging.<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> * The default logger performs basic error logging to the Java logger.<a name="line.673"></a> -<span class="sourceLineNo">674</span> * Subclasses can be used to customize logging behavior on the resource.<a name="line.674"></a> -<span class="sourceLineNo">675</span> *<a name="line.675"></a> -<span class="sourceLineNo">676</span> * <p><a name="line.676"></a> -<span class="sourceLineNo">677</span> * The programmatic equivalent to this annotation are the<a name="line.677"></a> -<span class="sourceLineNo">678</span> * {@link RestConfig#setLogger(Class)}/{@link RestConfig#setLogger(RestLogger)} methods.<a name="line.678"></a> -<span class="sourceLineNo">679</span> */<a name="line.679"></a> -<span class="sourceLineNo">680</span> Class<? extends RestLogger> logger() default RestLogger.Normal.class;<a name="line.680"></a> -<span class="sourceLineNo">681</span><a name="line.681"></a> -<span class="sourceLineNo">682</span> /**<a name="line.682"></a> -<span class="sourceLineNo">683</span> * Specifies the REST call handler class.<a name="line.683"></a> -<span class="sourceLineNo">684</span> *<a name="line.684"></a> -<span class="sourceLineNo">685</span> * <p><a name="line.685"></a> -<span class="sourceLineNo">686</span> * This class handles the basic lifecycle of an HTTP REST call.<a name="line.686"></a> -<span class="sourceLineNo">687</span> * Subclasses can be used to customize how these HTTP calls are handled.<a name="line.687"></a> -<span class="sourceLineNo">688</span> *<a name="line.688"></a> -<span class="sourceLineNo">689</span> * <p><a name="line.689"></a> -<span class="sourceLineNo">690</span> * The programmatic equivalent to this annotation are the<a name="line.690"></a> -<span class="sourceLineNo">691</span> * {@link RestConfig#setCallHandler(Class)}/{@link RestConfig#setCallHandler(RestCallHandler)} methods.<a name="line.691"></a> -<span class="sourceLineNo">692</span> */<a name="line.692"></a> -<span class="sourceLineNo">693</span> Class<? extends RestCallHandler> callHandler() default RestCallHandler.class;<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> * Specifies the class used to retrieve title/description/swagger information about a resource.<a name="line.696"></a> +<span class="sourceLineNo">634</span> * Subclasses can be used to customize the documentation on a resource.<a name="line.634"></a> +<span class="sourceLineNo">635</span> *<a name="line.635"></a> +<span class="sourceLineNo">636</span> * <p><a name="line.636"></a> +<span class="sourceLineNo">637</span> * The programmatic equivalent to this annotation are the<a name="line.637"></a> +<span class="sourceLineNo">638</span> * {@link RestConfig#setInfoProvider(Class)}/{@link RestConfig#setInfoProvider(RestInfoProvider)} methods.<a name="line.638"></a> +<span class="sourceLineNo">639</span> */<a name="line.639"></a> +<span class="sourceLineNo">640</span> Class<? extends RestInfoProvider> infoProvider() default RestInfoProvider.class;<a name="line.640"></a> +<span class="sourceLineNo">641</span><a name="line.641"></a> +<span class="sourceLineNo">642</span> /**<a name="line.642"></a> +<span class="sourceLineNo">643</span> * Specifies the serializer listener class to use for listening for non-fatal errors.<a name="line.643"></a> +<span class="sourceLineNo">644</span> */<a name="line.644"></a> +<span class="sourceLineNo">645</span> Class<? extends SerializerListener> serializerListener() default SerializerListener.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 parser listener class to use for listening for non-fatal errors.<a name="line.648"></a> +<span class="sourceLineNo">649</span> */<a name="line.649"></a> +<span class="sourceLineNo">650</span> Class<? extends ParserListener> parserListener() default ParserListener.class;<a name="line.650"></a> +<span class="sourceLineNo">651</span><a name="line.651"></a> +<span class="sourceLineNo">652</span> /**<a name="line.652"></a> +<span class="sourceLineNo">653</span> * Defines widgets that can be used in conjunction with string variables of the form <js>"$W{name}"</js>to quickly<a name="line.653"></a> +<span class="sourceLineNo">654</span> * generate arbitrary replacement text.<a name="line.654"></a> +<span class="sourceLineNo">655</span> *<a name="line.655"></a> +<span class="sourceLineNo">656</span> * <p><a name="line.656"></a> +<span class="sourceLineNo">657</span> * Widgets are inherited from parent to child, but can be overridden by reusing the widget name.<a name="line.657"></a> +<span class="sourceLineNo">658</span> *<a name="line.658"></a> +<span class="sourceLineNo">659</span> * <p><a name="line.659"></a> +<span class="sourceLineNo">660</span> * See {@link #htmldoc()} for an example of usage.<a name="line.660"></a> +<span class="sourceLineNo">661</span> */<a name="line.661"></a> +<span class="sourceLineNo">662</span> Class<? extends Widget>[] widgets() default {};<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> * Provides swagger-specific metadata on this 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> * Used to populate the auto-generated OPTIONS swagger documentation.<a name="line.668"></a> +<span class="sourceLineNo">669</span> *<a name="line.669"></a> +<span class="sourceLineNo">670</span> * <h5 class='section'>Example:</h5><a name="line.670"></a> +<span class="sourceLineNo">671</span> * <p class='bcode'><a name="line.671"></a> +<span class="sourceLineNo">672</span> * <ja>@RestResource</ja>(<a name="line.672"></a> +<span class="sourceLineNo">673</span> * path=<js>"/addressBook"</js>,<a name="line.673"></a> +<span class="sourceLineNo">674</span> *<a name="line.674"></a> +<span class="sourceLineNo">675</span> * <jc>// Swagger info.</jc><a name="line.675"></a> +<span class="sourceLineNo">676</span> * swagger=<ja>@ResourceSwagger</ja>(<a name="line.676"></a> +<span class="sourceLineNo">677</span> * contact=<js>"{name:'John Smith',email:'[email protected]'}"</js>,<a name="line.677"></a> +<span class="sourceLineNo">678</span> * license=<js>"{name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js>,<a name="line.678"></a> +<span class="sourceLineNo">679</span> * version=<js>"2.0"</js>,<a name="line.679"></a> +<span class="sourceLineNo">680</span> * termsOfService=<js>"You're on your own."</js>,<a name="line.680"></a> +<span class="sourceLineNo">681</span> * tags=<js>"[{name:'Java',description:'Java utility',externalDocs:{description:'Home page',url:'http://juneau.apache.org'}}]"</js>,<a name="line.681"></a> +<span class="sourceLineNo">682</span> * externalDocs=<js>"{description:'Home page',url:'http://juneau.apache.org'}"</js><a name="line.682"></a> +<span class="sourceLineNo">683</span> * )<a name="line.683"></a> +<span class="sourceLineNo">684</span> * )<a name="line.684"></a> +<span class="sourceLineNo">685</span> * </p><a name="line.685"></a> +<span class="sourceLineNo">686</span> */<a name="line.686"></a> +<span class="sourceLineNo">687</span> ResourceSwagger swagger() default @ResourceSwagger;<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> * Provides HTML-doc-specific metadata on this method.<a name="line.690"></a> +<span class="sourceLineNo">691</span> *<a name="line.691"></a> +<span class="sourceLineNo">692</span> * <p><a name="line.692"></a> +<span class="sourceLineNo">693</span> * Used to customize the output from the HTML Doc serializer.<a name="line.693"></a> +<span class="sourceLineNo">694</span> * <p class='bcode'><a name="line.694"></a> +<span class="sourceLineNo">695</span> * <ja>@RestResource</ja>(<a name="line.695"></a> +<span class="sourceLineNo">696</span> * path=<js>"/addressBook"</js>,<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> * Subclasses can be used to customize the documentation on a resource.<a name="line.699"></a> -<span class="sourceLineNo">700</span> *<a name="line.700"></a> -<span class="sourceLineNo">701</span> * <p><a name="line.701"></a> -<span class="sourceLineNo">702</span> * The programmatic equivalent to this annotation are the<a name="line.702"></a> -<span class="sourceLineNo">703</span> * {@link RestConfig#setInfoProvider(Class)}/{@link RestConfig#setInfoProvider(RestInfoProvider)} methods.<a name="line.703"></a> -<span class="sourceLineNo">704</span> */<a name="line.704"></a> -<span class="sourceLineNo">705</span> Class<? extends RestInfoProvider> infoProvider() default RestInfoProvider.class;<a name="line.705"></a> -<span class="sourceLineNo">706</span><a name="line.706"></a> -<span class="sourceLineNo">707</span> /**<a name="line.707"></a> -<span class="sourceLineNo">708</span> * Specifies the serializer listener class to use for listening for non-fatal errors.<a name="line.708"></a> -<span class="sourceLineNo">709</span> */<a name="line.709"></a> -<span class="sourceLineNo">710</span> Class<? extends SerializerListener> serializerListener() default SerializerListener.class;<a name="line.710"></a> -<span class="sourceLineNo">711</span><a name="line.711"></a> -<span class="sourceLineNo">712</span> /**<a name="line.712"></a> -<span class="sourceLineNo">713</span> * Specifies the parser listener class to use for listening for non-fatal errors.<a name="line.713"></a> -<span class="sourceLineNo">714</span> */<a name="line.714"></a> -<span class="sourceLineNo">715</span> Class<? extends ParserListener> parserListener() default ParserListener.class;<a name="line.715"></a> -<span class="sourceLineNo">716</span><a name="line.716"></a> -<span class="sourceLineNo">717</span> /**<a name="line.717"></a> -<span class="sourceLineNo">718</span> * Defines widgets that can be used in conjunction with string variables of the form <js>"$W{name}"</js>to quickly<a name="line.718"></a> -<span class="sourceLineNo">719</span> * generate arbitrary replacement text.<a name="line.719"></a> -<span class="sourceLineNo">720</span> *<a name="line.720"></a> -<span class="sourceLineNo">721</span> * <p><a name="line.721"></a> -<span class="sourceLineNo">722</span> * Widgets are inherited from parent to child, but can be overridden by reusing the widget name.<a name="line.722"></a> -<span class="sourceLineNo">723</span> *<a name="line.723"></a> -<span class="sourceLineNo">724</span> * <p><a name="line.724"></a> -<span class="sourceLineNo">725</span> * See {@link #htmldoc()} for an example of usage.<a name="line.725"></a> +<span class="sourceLineNo">698</span> * <jc>// Links on the HTML rendition page.<a name="line.698"></a> +<span class="sourceLineNo">699</span> * // "request:/..." URIs are relative to the request URI.<a name="line.699"></a> +<span class="sourceLineNo">700</span> * // "servlet:/..." URIs are relative to the servlet URI.<a name="line.700"></a> +<span class="sourceLineNo">701</span> * // "$C{...}" variables are pulled from the config file.</jc><a name="line.701"></a> +<span class="sourceLineNo">702</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.702"></a> +<span class="sourceLineNo">703</span> * links=<js>"{up:'request:/..',options:'servlet:/?method=OPTIONS',source:'$C{Source/gitHub}/org/apache/juneau/examples/rest/addressbook/AddressBookResource.java'}"</js>,<a name="line.703"></a> +<span class="sourceLineNo">704</span> * aside=<js>""</js><a name="line.704"></a> +<span class="sourceLineNo">705</span> * + <js>"&lt;div style='max-width:400px;min-width:200px'&gt;"</js><a name="line.705"></a> +<span class="sourceLineNo">706</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.706"></a> +<span class="sourceLineNo">707</span> * + <js>" &lt;p&gt;Provides examples of: &lt;/p&gt;"</js><a name="line.707"></a> +<span class="sourceLineNo">708</span> * + <js>" &lt;ul&gt;"</js><a name="line.708"></a> +<span class="sourceLineNo">709</span> * + <js>" &lt;li&gt;XML and RDF namespaces"</js><a name="line.709"></a> +<span class="sourceLineNo">710</span> * + <js>" &lt;li&gt;Swagger documentation"</js><a name="line.710"></a> +<span class="sourceLineNo">711</span> * + <js>" &lt;li&gt;Widgets"</js><a name="line.711"></a> +<span class="sourceLineNo">712</span> * + <js>" &lt;/ul&gt;"</js><a name="line.712"></a> +<span class="sourceLineNo">713</span> * + <js>" &lt;p style='text-weight:bold;text-decoration:underline;'&gt;Available Content Types&lt;/p&gt;"</js><a name="line.713"></a> +<span class="sourceLineNo">714</span> * + <js>" $W{contentTypeLinks}"</js><a name="line.714"></a> +<span class="sourceLineNo">715</span> * + <js>"&lt;/div&gt;"</js>,<a name="line.715"></a> +<span class="sourceLineNo">716</span> * footer=<js>"$W{poweredByJuneau}"</js><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> * <jc>// Widgets for $W variables above.</jc><a name="line.719"></a> +<span class="sourceLineNo">720</span> * widgets={<a name="line.720"></a> +<span class="sourceLineNo">721</span> * PoweredByJuneauWidget.<jk>class</jk>,<a name="line.721"></a> +<span class="sourceLineNo">722</span> * ContentTypeLinksWidget.<jk>class</jk><a name="line.722"></a> +<span class="sourceLineNo">723</span> * }<a name="line.723"></a> +<span class="sourceLineNo">724</span> * )<a name="line.724"></a> +<span class="sourceLineNo">725</span> * </p><a name="line.725"></a> <span class="sourceLineNo">726</span> */<a name="line.726"></a> -<span class="sourceLineNo">727</span> Class<? extends Widget>[] widgets() default {};<a name="line.727"></a> -<span class="sourceLineNo">728</span><a name="line.728"></a> -<span class="sourceLineNo">729</span> /**<a name="line.729"></a> -<span class="sourceLineNo">730</span> * Provides swagger-specific metadata on this resource.<a name="line.730"></a> -<span class="sourceLineNo">731</span> *<a name="line.731"></a> -<span class="sourceLineNo">732</span> * <p><a name="line.732"></a> -<span class="sourceLineNo">733</span> * Used to populate the auto-generated OPTIONS swagger documentation.<a name="line.733"></a> -<span class="sourceLineNo">734</span> *<a name="line.734"></a> -<span class="sourceLineNo">735</span> * <h5 class='section'>Example:</h5><a name="line.735"></a> -<span class="sourceLineNo">736</span> * <p class='bcode'><a name="line.736"></a> -<span class="sourceLineNo">737</span> * <ja>@RestResource</ja>(<a name="line.737"></a> -<span class="sourceLineNo">738</span> * path=<js>"/addressBook"</js>,<a name="line.738"></a> -<span class="sourceLineNo">739</span> *<a name="line.739"></a> -<span class="sourceLineNo">740</span> * <jc>// Swagger info.</jc><a name="line.740"></a> -<span class="sourceLineNo">741</span> * swagger=<ja>@ResourceSwagger</ja>(<a name="line.741"></a> -<span class="sourceLineNo">742</span> * contact=<js>"{name:'John Smith',email:'[email protected]'}"</js>,<a name="line.742"></a> -<span class="sourceLineNo">743</span> * license=<js>"{name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js>,<a name="line.743"></a> -<span class="sourceLineNo">744</span> * version=<js>"2.0"</js>,<a name="line.744"></a> -<span class="sourceLineNo">745</span> * termsOfService=<js>"You're on your own."</js>,<a name="line.745"></a> -<span class="sourceLineNo">746</span> * tags=<js>"[{name:'Java',description:'Java utility',externalDocs:{description:'Home page',url:'http://juneau.apache.org'}}]"</js>,<a name="line.746"></a> -<span class="sourceLineNo">747</span> * externalDocs=<js>"{description:'Home page',url:'http://juneau.apache.org'}"</js><a name="line.747"></a> -<span class="sourceLineNo">748</span> * )<a name="line.748"></a> -<span class="sourceLineNo">749</span> * )<a name="line.749"></a> -<span class="sourceLineNo">750</span> * </p><a name="line.750"></a> -<span class="sourceLineNo">751</span> */<a name="line.751"></a> -<span class="sourceLineNo">752</span> ResourceSwagger swagger() default @ResourceSwagger;<a name="line.752"></a> -<span class="sourceLineNo">753</span><a name="line.753"></a> -<span class="sourceLineNo">754</span> /**<a name="line.754"></a> -<span class="sourceLineNo">755</span> * Provides HTML-doc-specific metadata on this method.<a name="line.755"></a> -<span class="sourceLineNo">756</span> *<a name="line.756"></a> -<span class="sourceLineNo">757</span> * <p><a name="line.757"></a> -<span class="sourceLineNo">758</span> * Used to customize the output from the HTML Doc serializer.<a name="line.758"></a> -<span class="sourceLineNo">759</span> * <p class='bcode'><a name="line.759"></a> -<span class="sourceLineNo">760</span> * <ja>@RestResource</ja>(<a name="line.760"></a> -<span class="sourceLineNo">761</span> * path=<js>"/addressBook"</js>,<a name="line.761"></a> -<span class="sourceLineNo">762</span> *<a name="line.762"></a> -<span class="sourceLineNo">763</span> * <jc>// Links on the HTML rendition page.<a name="line.763"></a> -<span class="sourceLineNo">764</span> * // "request:/..." URIs are relative to the request URI.<a name="line.764"></a> -<span class="sourceLineNo">765</span> * // "servlet:/..." URIs are relative to the servlet URI.<a name="line.765"></a> -<span class="sourceLineNo">766</span> * // "$C{...}" variables are pulled from the config file.</jc><a name="line.766"></a> -<span class="sourceLineNo">767</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.767"></a> -<span class="sourceLineNo">768</span> * links=<js>"{up:'request:/..',options:'servlet:/?method=OPTIONS',source:'$C{Source/gitHub}/org/apache/juneau/examples/rest/addressbook/AddressBookResource.java'}"</js>,<a name="line.768"></a> -<span class="sourceLineNo">769</span> * aside=<js>""</js><a name="line.769"></a> -<span class="sourceLineNo">770</span> * + <js>"&lt;div style='max-width:400px;min-width:200px'&gt;"</js><a name="line.770"></a> -<span class="sourceLineNo">771</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.771"></a> -<span class="sourceLineNo">772</span> * + <js>" &lt;p&gt;Provides examples of: &lt;/p&gt;"</js><a name="line.772"></a> -<span class="sourceLineNo">773</span> * + <js>" &lt;ul&gt;"</js><a name="line.773"></a> -<span class="sourceLineNo">774</span> * + <js>" &lt;li&gt;XML and RDF namespaces"</js><a name="line.774"></a> -<span class="sourceLineNo">775</span> * + <js>" &lt;li&gt;Swagger documentation"</js><a name="line.775"></a> -<span class="sourceLineNo">776</span> * + <js>" &lt;li&gt;Widgets"</js><a name="line.776"></a> -<span class="sourceLineNo">777</span> * + <js>" &lt;/ul&gt;"</js><a name="line.777"></a> -<span class="sourceLineNo">778</span> * + <js>" &lt;p style='text-weight:bold;text-decoration:underline;'&gt;Available Content Types&lt;/p&gt;"</js><a name="line.778"></a> -<span class="sourceLineNo">779</span> * + <js>" $W{contentTypeLinks}"</js><a name="line.779"></a> -<span class="sourceLineNo">780</span> * + <js>"&lt;/div&gt;"</js>,<a name="line.780"></a> -<span class="sourceLineNo">781</span> * footer=<js>"$W{poweredByJuneau}"</js><a name="line.781"></a> -<span class="sourceLineNo">782</span> * ),<a name="line.782"></a> -<span class="sourceLineNo">783</span> *<a name="line.783"></a> -<span class="sourceLineNo">784</span> * <jc>// Widgets for $W variables above.</jc><a name="line.784"></a> -<span class="sourceLineNo">785</span> * widgets={<a name="line.785"></a> -<span class="sourceLineNo">786</span> * PoweredByJuneauWidget.<jk>class</jk>,<a name="line.786"></a> -<span class="sourceLineNo">787</span> * ContentTypeLinksWidget.<jk>class</jk><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> * </p><a name="line.790"></a> -<span class="sourceLineNo">791</span> */<a name="line.791"></a> -<span class="sourceLineNo">792</span> HtmlDoc htmldoc() default @HtmlDoc;<a name="line.792"></a> -<span class="sourceLineNo">793</span>}<a name="line.793"></a> +<span class="sourceLineNo">727</span> HtmlDoc htmldoc() default @HtmlDoc;<a name="line.727"></a> +<span class="sourceLineNo">728</span>}<a name="line.728"></a>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/content/site/apidocs/src-html/org/apache/juneau/rest/jena/RestServletJenaDefault.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/jena/RestServletJenaDefault.html b/content/site/apidocs/src-html/org/apache/juneau/rest/jena/RestServletJenaDefault.html index 926edb8..d2f48e7 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/jena/RestServletJenaDefault.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/jena/RestServletJenaDefault.html @@ -252,30 +252,33 @@ <span class="sourceLineNo">244</span> // Allow &method parameter on safe HTTP methods.<a name="line.244"></a> <span class="sourceLineNo">245</span> @Property(name=REST_allowMethodParam, value="OPTIONS")<a name="line.245"></a> <span class="sourceLineNo">246</span> },<a name="line.246"></a> -<span class="sourceLineNo">247</span> stylesheet="styles/juneau.css",<a name="line.247"></a> -<span class="sourceLineNo">248</span> favicon="juneau.ico",<a name="line.248"></a> -<span class="sourceLineNo">249</span> staticFiles="{htdocs:'htdocs'}"<a name="line.249"></a> -<span class="sourceLineNo">250</span>)<a name="line.250"></a> -<span class="sourceLineNo">251</span>public abstract class RestServletJenaDefault extends RestServlet {<a name="line.251"></a> -<span class="sourceLineNo">252</span> private static final long serialVersionUID = 1L;<a name="line.252"></a> -<span class="sourceLineNo">253</span><a name="line.253"></a> -<span class="sourceLineNo">254</span> /**<a name="line.254"></a> -<span class="sourceLineNo">255</span> * [OPTIONS /*] - Show resource options.<a name="line.255"></a> -<span class="sourceLineNo">256</span> *<a name="line.256"></a> -<span class="sourceLineNo">257</span> * @param req The HTTP request.<a name="line.257"></a> -<span class="sourceLineNo">258</span> * @return The bean containing the contents of the OPTIONS page.<a name="line.258"></a> -<span class="sourceLineNo">259</span> */<a name="line.259"></a> -<span class="sourceLineNo">260</span> @RestMethod(name="OPTIONS", path="/*",<a name="line.260"></a> -<span class="sourceLineNo">261</span> summary="Resource options",<a name="line.261"></a> -<span class="sourceLineNo">262</span> description="Resource options",<a name="line.262"></a> -<span class="sourceLineNo">263</span> htmldoc=@HtmlDoc(<a name="line.263"></a> -<span class="sourceLineNo">264</span> links="{back:'$R{servletURI}'}"<a name="line.264"></a> -<span class="sourceLineNo">265</span> )<a name="line.265"></a> -<span class="sourceLineNo">266</span> )<a name="line.266"></a> -<span class="sourceLineNo">267</span> public Swagger getOptions(RestRequest req) {<a name="line.267"></a> -<span class="sourceLineNo">268</span> return req.getSwagger();<a name="line.268"></a> -<span class="sourceLineNo">269</span> }<a name="line.269"></a> -<span class="sourceLineNo">270</span>}<a name="line.270"></a> +<span class="sourceLineNo">247</span> htmldoc=@HtmlDoc(<a name="line.247"></a> +<span class="sourceLineNo">248</span> branding="<a href='http://juneau.apache.org'><img src='$U{servlet:/htdocs/juneau.png}' style='position:absolute;top:5;right:5;background-color:transparent;height:30px'></a>",<a name="line.248"></a> +<span class="sourceLineNo">249</span> styleImport="servlet:/styles/devops.css"<a name="line.249"></a> +<span class="sourceLineNo">250</span> ),<a name="line.250"></a> +<span class="sourceLineNo">251</span> favicon="htdocs/juneau.png",<a name="line.251"></a> +<span class="sourceLineNo">252</span> staticFiles="{htdocs:'htdocs',styles:'styles'}"<a name="line.252"></a> +<span class="sourceLineNo">253</span>)<a name="line.253"></a> +<span class="sourceLineNo">254</span>public abstract class RestServletJenaDefault extends RestServlet {<a name="line.254"></a> +<span class="sourceLineNo">255</span> private static final long serialVersionUID = 1L;<a name="line.255"></a> +<span class="sourceLineNo">256</span><a name="line.256"></a> +<span class="sourceLineNo">257</span> /**<a name="line.257"></a> +<span class="sourceLineNo">258</span> * [OPTIONS /*] - Show resource options.<a name="line.258"></a> +<span class="sourceLineNo">259</span> *<a name="line.259"></a> +<span class="sourceLineNo">260</span> * @param req The HTTP request.<a name="line.260"></a> +<span class="sourceLineNo">261</span> * @return The bean containing the contents of the OPTIONS page.<a name="line.261"></a> +<span class="sourceLineNo">262</span> */<a name="line.262"></a> +<span class="sourceLineNo">263</span> @RestMethod(name="OPTIONS", path="/*",<a name="line.263"></a> +<span class="sourceLineNo">264</span> summary="Resource options",<a name="line.264"></a> +<span class="sourceLineNo">265</span> description="Resource options",<a name="line.265"></a> +<span class="sourceLineNo">266</span> htmldoc=@HtmlDoc(<a name="line.266"></a> +<span class="sourceLineNo">267</span> links="{back:'$R{servletURI}'}"<a name="line.267"></a> +<span class="sourceLineNo">268</span> )<a name="line.268"></a> +<span class="sourceLineNo">269</span> )<a name="line.269"></a> +<span class="sourceLineNo">270</span> public Swagger getOptions(RestRequest req) {<a name="line.270"></a> +<span class="sourceLineNo">271</span> return req.getSwagger();<a name="line.271"></a> +<span class="sourceLineNo">272</span> }<a name="line.272"></a> +<span class="sourceLineNo">273</span>}<a name="line.273"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/content/site/apidocs/src-html/org/apache/juneau/rest/vars/WidgetVar.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/vars/WidgetVar.html b/content/site/apidocs/src-html/org/apache/juneau/rest/vars/WidgetVar.html index ec3591d..35a195e 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/vars/WidgetVar.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/vars/WidgetVar.html @@ -67,7 +67,7 @@ <span class="sourceLineNo">059</span> if (w == null)<a name="line.59"></a> <span class="sourceLineNo">060</span> return "unknown-widget-"+key;<a name="line.60"></a> <span class="sourceLineNo">061</span> try {<a name="line.61"></a> -<span class="sourceLineNo">062</span> return w.resolve(req);<a name="line.62"></a> +<span class="sourceLineNo">062</span> return w.getHtml(req);<a name="line.62"></a> <span class="sourceLineNo">063</span> } catch (Exception e) {<a name="line.63"></a> <span class="sourceLineNo">064</span> return "widget-error-"+e.getLocalizedMessage();<a name="line.64"></a> <span class="sourceLineNo">065</span> }<a name="line.65"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/content/site/apidocs/src-html/org/apache/juneau/rest/widget/ContentTypeLinksColumnWidget.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/widget/ContentTypeLinksColumnWidget.html b/content/site/apidocs/src-html/org/apache/juneau/rest/widget/ContentTypeLinksColumnWidget.html deleted file mode 100644 index 261a7c5..0000000 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/widget/ContentTypeLinksColumnWidget.html +++ /dev/null @@ -1,121 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<html lang="en"> -<head> -<title>Source code</title> -<link rel="stylesheet" type="text/css" href="../../../../../../javadoc.css" title="Style"> -</head> -<body> -<div class="sourceContainer"> -<pre><span class="sourceLineNo">001</span>// ***************************************************************************************************************************<a name="line.1"></a> -<span class="sourceLineNo">002</span>// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *<a name="line.2"></a> -<span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a> -<span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a> -<span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a> -<span class="sourceLineNo">006</span>// * *<a name="line.6"></a> -<span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a> -<span class="sourceLineNo">008</span>// * *<a name="line.8"></a> -<span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a> -<span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a> -<span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a> -<span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> -<span class="sourceLineNo">013</span>package org.apache.juneau.rest.widget;<a name="line.13"></a> -<span class="sourceLineNo">014</span><a name="line.14"></a> -<span class="sourceLineNo">015</span>import static org.apache.juneau.dto.html5.HtmlBuilder.*;<a name="line.15"></a> -<span class="sourceLineNo">016</span><a name="line.16"></a> -<span class="sourceLineNo">017</span>import java.util.*;<a name="line.17"></a> -<span class="sourceLineNo">018</span><a name="line.18"></a> -<span class="sourceLineNo">019</span>import org.apache.juneau.*;<a name="line.19"></a> -<span class="sourceLineNo">020</span>import org.apache.juneau.dto.html5.*;<a name="line.20"></a> -<span class="sourceLineNo">021</span>import org.apache.juneau.html.*;<a name="line.21"></a> -<span class="sourceLineNo">022</span>import org.apache.juneau.http.*;<a name="line.22"></a> -<span class="sourceLineNo">023</span>import org.apache.juneau.rest.*;<a name="line.23"></a> -<span class="sourceLineNo">024</span><a name="line.24"></a> -<span class="sourceLineNo">025</span>/**<a name="line.25"></a> -<span class="sourceLineNo">026</span> * Widget that returns back a list of hyperlinks for rendering the contents of a page in a variety of content types.<a name="line.26"></a> -<span class="sourceLineNo">027</span> *<a name="line.27"></a> -<span class="sourceLineNo">028</span> * <p><a name="line.28"></a> -<span class="sourceLineNo">029</span> * The variable it resolves is <js>"$W{contentTypeLinksColumn}"</js>.<a name="line.29"></a> -<span class="sourceLineNo">030</span> */<a name="line.30"></a> -<span class="sourceLineNo">031</span>public class ContentTypeLinksColumnWidget extends Widget {<a name="line.31"></a> -<span class="sourceLineNo">032</span><a name="line.32"></a> -<span class="sourceLineNo">033</span> @Override /* Widget */<a name="line.33"></a> -<span class="sourceLineNo">034</span> public String getName() {<a name="line.34"></a> -<span class="sourceLineNo">035</span> return "contentTypeLinksColumn";<a name="line.35"></a> -<span class="sourceLineNo">036</span> }<a name="line.36"></a> -<span class="sourceLineNo">037</span><a name="line.37"></a> -<span class="sourceLineNo">038</span> @Override /* Widget */<a name="line.38"></a> -<span class="sourceLineNo">039</span> public String resolve(RestRequest req) throws Exception {<a name="line.39"></a> -<span class="sourceLineNo">040</span> UriResolver uriResolver = req.getUriResolver();<a name="line.40"></a> -<span class="sourceLineNo">041</span> P p = p();<a name="line.41"></a> -<span class="sourceLineNo">042</span> List<MediaType> l = new ArrayList<MediaType>(req.getSerializerGroup().getSupportedMediaTypes());<a name="line.42"></a> -<span class="sourceLineNo">043</span> Collections.sort(l);<a name="line.43"></a> -<span class="sourceLineNo">044</span> for (MediaType mt : l)<a name="line.44"></a> -<span class="sourceLineNo">045</span> p.child(a()._class("link").href(uriResolver.resolve("request:/?plainText=true&Accept="+mt)).child(mt)).child(br());<a name="line.45"></a> -<span class="sourceLineNo">046</span> return HtmlSerializer.DEFAULT_SQ.serialize(p);<a name="line.46"></a> -<span class="sourceLineNo">047</span> }<a name="line.47"></a> -<span class="sourceLineNo">048</span><a name="line.48"></a> -<span class="sourceLineNo">049</span>}<a name="line.49"></a> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -</pre> -</div> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/content/site/apidocs/src-html/org/apache/juneau/rest/widget/ContentTypeLinksRowWidget.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/widget/ContentTypeLinksRowWidget.html b/content/site/apidocs/src-html/org/apache/juneau/rest/widget/ContentTypeLinksRowWidget.html deleted file mode 100644 index 7691ab6..0000000 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/widget/ContentTypeLinksRowWidget.html +++ /dev/null @@ -1,121 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<html lang="en"> -<head> -<title>Source code</title> -<link rel="stylesheet" type="text/css" href="../../../../../../javadoc.css" title="Style"> -</head> -<body> -<div class="sourceContainer"> -<pre><span class="sourceLineNo">001</span>// ***************************************************************************************************************************<a name="line.1"></a> -<span class="sourceLineNo">002</span>// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *<a name="line.2"></a> -<span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a> -<span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a> -<span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a> -<span class="sourceLineNo">006</span>// * *<a name="line.6"></a> -<span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a> -<span class="sourceLineNo">008</span>// * *<a name="line.8"></a> -<span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a> -<span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a> -<span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a> -<span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> -<span class="sourceLineNo">013</span>package org.apache.juneau.rest.widget;<a name="line.13"></a> -<span class="sourceLineNo">014</span><a name="line.14"></a> -<span class="sourceLineNo">015</span>import static org.apache.juneau.dto.html5.HtmlBuilder.*;<a name="line.15"></a> -<span class="sourceLineNo">016</span><a name="line.16"></a> -<span class="sourceLineNo">017</span>import java.util.*;<a name="line.17"></a> -<span class="sourceLineNo">018</span><a name="line.18"></a> -<span class="sourceLineNo">019</span>import org.apache.juneau.*;<a name="line.19"></a> -<span class="sourceLineNo">020</span>import org.apache.juneau.dto.html5.*;<a name="line.20"></a> -<span class="sourceLineNo">021</span>import org.apache.juneau.html.*;<a name="line.21"></a> -<span class="sourceLineNo">022</span>import org.apache.juneau.http.*;<a name="line.22"></a> -<span class="sourceLineNo">023</span>import org.apache.juneau.rest.*;<a name="line.23"></a> -<span class="sourceLineNo">024</span><a name="line.24"></a> -<span class="sourceLineNo">025</span>/**<a name="line.25"></a> -<span class="sourceLineNo">026</span> * Widget that returns back a list of hyperlinks for rendering the contents of a page in a variety of content types.<a name="line.26"></a> -<span class="sourceLineNo">027</span> *<a name="line.27"></a> -<span class="sourceLineNo">028</span> * <p><a name="line.28"></a> -<span class="sourceLineNo">029</span> * The variable it resolves is <js>"$W{contentTypeLinksRow}"</js>.<a name="line.29"></a> -<span class="sourceLineNo">030</span> */<a name="line.30"></a> -<span class="sourceLineNo">031</span>public class ContentTypeLinksRowWidget extends Widget {<a name="line.31"></a> -<span class="sourceLineNo">032</span><a name="line.32"></a> -<span class="sourceLineNo">033</span> @Override /* Widget */<a name="line.33"></a> -<span class="sourceLineNo">034</span> public String getName() {<a name="line.34"></a> -<span class="sourceLineNo">035</span> return "contentTypeLinksRow";<a name="line.35"></a> -<span class="sourceLineNo">036</span> }<a name="line.36"></a> -<span class="sourceLineNo">037</span><a name="line.37"></a> -<span class="sourceLineNo">038</span> @Override /* Widget */<a name="line.38"></a> -<span class="sourceLineNo">039</span> public String resolve(RestRequest req) throws Exception {<a name="line.39"></a> -<span class="sourceLineNo">040</span> UriResolver uriResolver = req.getUriResolver();<a name="line.40"></a> -<span class="sourceLineNo">041</span> P p = p();<a name="line.41"></a> -<span class="sourceLineNo">042</span> List<MediaType> l = new ArrayList<MediaType>(req.getSerializerGroup().getSupportedMediaTypes());<a name="line.42"></a> -<span class="sourceLineNo">043</span> Collections.sort(l);<a name="line.43"></a> -<span class="sourceLineNo">044</span> for (MediaType mt : l)<a name="line.44"></a> -<span class="sourceLineNo">045</span> p.style("max-width:1200px").child(a()._class("link").href(uriResolver.resolve("request:/?plainText=true&Accept="+mt)).children(mt)).child("\u00AD");<a name="line.45"></a> -<span class="sourceLineNo">046</span> return HtmlSerializer.DEFAULT_SQ.serialize(p);<a name="line.46"></a> -<span class="sourceLineNo">047</span> }<a name="line.47"></a> -<span class="sourceLineNo">048</span><a name="line.48"></a> -<span class="sourceLineNo">049</span>}<a name="line.49"></a> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -</pre> -</div> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/content/site/apidocs/src-html/org/apache/juneau/rest/widget/ContentTypeMenuItem.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/widget/ContentTypeMenuItem.html b/content/site/apidocs/src-html/org/apache/juneau/rest/widget/ContentTypeMenuItem.html new file mode 100644 index 0000000..d7735da --- /dev/null +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/widget/ContentTypeMenuItem.html @@ -0,0 +1,154 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<html lang="en"> +<head> +<title>Source code</title> +<link rel="stylesheet" type="text/css" href="../../../../../../javadoc.css" title="Style"> +</head> +<body> +<div class="sourceContainer"> +<pre><span class="sourceLineNo">001</span>// ***************************************************************************************************************************<a name="line.1"></a> +<span class="sourceLineNo">002</span>// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *<a name="line.2"></a> +<span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a> +<span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a> +<span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a> +<span class="sourceLineNo">006</span>// * *<a name="line.6"></a> +<span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a> +<span class="sourceLineNo">008</span>// * *<a name="line.8"></a> +<span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a> +<span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a> +<span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a> +<span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> +<span class="sourceLineNo">013</span>package org.apache.juneau.rest.widget;<a name="line.13"></a> +<span class="sourceLineNo">014</span><a name="line.14"></a> +<span class="sourceLineNo">015</span>import java.util.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span><a name="line.16"></a> +<span class="sourceLineNo">017</span>import org.apache.juneau.*;<a name="line.17"></a> +<span class="sourceLineNo">018</span>import org.apache.juneau.http.*;<a name="line.18"></a> +<span class="sourceLineNo">019</span>import org.apache.juneau.rest.*;<a name="line.19"></a> +<span class="sourceLineNo">020</span><a name="line.20"></a> +<span class="sourceLineNo">021</span>/**<a name="line.21"></a> +<span class="sourceLineNo">022</span> * Widget that returns back a list of hyperlinks for rendering the contents of a page in a variety of content types.<a name="line.22"></a> +<span class="sourceLineNo">023</span> *<a name="line.23"></a> +<span class="sourceLineNo">024</span> * <p><a name="line.24"></a> +<span class="sourceLineNo">025</span> * The variable it resolves is <js>"$W{contentTypeMenuItem}"</js>.<a name="line.25"></a> +<span class="sourceLineNo">026</span> *<a name="line.26"></a> +<span class="sourceLineNo">027</span> * <p><a name="line.27"></a> +<span class="sourceLineNo">028</span> * An example of this widget can be found in the <code>PetStoreResource</code> in the examples that provides<a name="line.28"></a> +<span class="sourceLineNo">029</span> * a drop-down menu item for rendering all other supported content types in plain text:<a name="line.29"></a> +<span class="sourceLineNo">030</span> * <p class='bcode'><a name="line.30"></a> +<span class="sourceLineNo">031</span> * <ja>@RestMethod</ja>(<a name="line.31"></a> +<span class="sourceLineNo">032</span> * name=<js>"GET"</js>,<a name="line.32"></a> +<span class="sourceLineNo">033</span> * path=<js>"/"</js>,<a name="line.33"></a> +<span class="sourceLineNo">034</span> * widgets={<a name="line.34"></a> +<span class="sourceLineNo">035</span> * ContentTypeMenuItem.<jk>class</jk>,<a name="line.35"></a> +<span class="sourceLineNo">036</span> * },<a name="line.36"></a> +<span class="sourceLineNo">037</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.37"></a> +<span class="sourceLineNo">038</span> * links=<js>"{up:'...',options:'...',query:'...',contentTypes:'$W{contentTypeMenuItem}',source:'...'}"</js><a name="line.38"></a> +<span class="sourceLineNo">039</span> * )<a name="line.39"></a> +<span class="sourceLineNo">040</span> * )<a name="line.40"></a> +<span class="sourceLineNo">041</span> * <jk>public</jk> Collection&lt;Pet&gt; getPets() {<a name="line.41"></a> +<span class="sourceLineNo">042</span> * </p><a name="line.42"></a> +<span class="sourceLineNo">043</span> *<a name="line.43"></a> +<span class="sourceLineNo">044</span> * <p><a name="line.44"></a> +<span class="sourceLineNo">045</span> * It renders the following popup-box:<a name="line.45"></a> +<span class="sourceLineNo">046</span> * <br><img class='bordered' src='doc-files/ContentTypeMenuItem.png'><a name="line.46"></a> +<span class="sourceLineNo">047</span> */<a name="line.47"></a> +<span class="sourceLineNo">048</span>public class ContentTypeMenuItem extends MenuItemWidget {<a name="line.48"></a> +<span class="sourceLineNo">049</span><a name="line.49"></a> +<span class="sourceLineNo">050</span> /**<a name="line.50"></a> +<span class="sourceLineNo">051</span> * Returns <js>"contentTypeMenuItem"</js>.<a name="line.51"></a> +<span class="sourceLineNo">052</span> */<a name="line.52"></a> +<span class="sourceLineNo">053</span> @Override /* Widget */<a name="line.53"></a> +<span class="sourceLineNo">054</span> public String getName() {<a name="line.54"></a> +<span class="sourceLineNo">055</span> return "contentTypeMenuItem";<a name="line.55"></a> +<span class="sourceLineNo">056</span> }<a name="line.56"></a> +<span class="sourceLineNo">057</span><a name="line.57"></a> +<span class="sourceLineNo">058</span> /**<a name="line.58"></a> +<span class="sourceLineNo">059</span> * Looks at the supported media types from the request and constructs a list of hyperlinks to render the data<a name="line.59"></a> +<span class="sourceLineNo">060</span> * as plain-text.<a name="line.60"></a> +<span class="sourceLineNo">061</span> */<a name="line.61"></a> +<span class="sourceLineNo">062</span> @Override /* Widget */<a name="line.62"></a> +<span class="sourceLineNo">063</span> public String getHtml(RestRequest req) throws Exception {<a name="line.63"></a> +<span class="sourceLineNo">064</span> UriResolver r = req.getUriResolver();<a name="line.64"></a> +<span class="sourceLineNo">065</span> StringBuilder sb = new StringBuilder();<a name="line.65"></a> +<span class="sourceLineNo">066</span> sb.append(""<a name="line.66"></a> +<span class="sourceLineNo">067</span> + "<div class='menu-item'>"<a name="line.67"></a> +<span class="sourceLineNo">068</span> + "\n\t<a class='link' onclick='menuClick(this)'>content-types</a>"<a name="line.68"></a> +<span class="sourceLineNo">069</span> + "\n\t<div class='popup-content'>"<a name="line.69"></a> +<span class="sourceLineNo">070</span> );<a name="line.70"></a> +<span class="sourceLineNo">071</span> List<MediaType> l = new ArrayList<MediaType>(req.getSerializerGroup().getSupportedMediaTypes());<a name="line.71"></a> +<span class="sourceLineNo">072</span> Collections.sort(l);<a name="line.72"></a> +<span class="sourceLineNo">073</span> for (MediaType mt : l)<a name="line.73"></a> +<span class="sourceLineNo">074</span> sb.append("\n\t\t<a class='link' href='").append(r.resolve("request:/?plainText=true&Accept="+mt))<a name="line.74"></a> +<span class="sourceLineNo">075</span> .append("'>").append(mt).append("</a><br>");<a name="line.75"></a> +<span class="sourceLineNo">076</span> sb.append(""<a name="line.76"></a> +<span class="sourceLineNo">077</span> + "\n\t</div>"<a name="line.77"></a> +<span class="sourceLineNo">078</span> + "\n</div>"<a name="line.78"></a> +<span class="sourceLineNo">079</span> );<a name="line.79"></a> +<span class="sourceLineNo">080</span> return sb.toString();<a name="line.80"></a> +<span class="sourceLineNo">081</span> }<a name="line.81"></a> +<span class="sourceLineNo">082</span>}<a name="line.82"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html>
