http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/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 051bfc2..0da3e55 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 @@ -253,37 +253,40 @@ <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> 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> stylesheet="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> htmldoc=@HtmlDoc(<a name="line.264"></a> -<span class="sourceLineNo">265</span> links={<a name="line.265"></a> -<span class="sourceLineNo">266</span> "back: servlet:/",<a name="line.266"></a> -<span class="sourceLineNo">267</span> "json: servlet:/?method=OPTIONS&Accept=text/json&plainText=true"<a name="line.267"></a> -<span class="sourceLineNo">268</span> },<a name="line.268"></a> -<span class="sourceLineNo">269</span> description="Swagger documentation",<a name="line.269"></a> -<span class="sourceLineNo">270</span> aside="NONE"<a name="line.270"></a> -<span class="sourceLineNo">271</span> ),<a name="line.271"></a> -<span class="sourceLineNo">272</span> summary="Resource options",<a name="line.272"></a> -<span class="sourceLineNo">273</span> description="Swagger documentation"<a name="line.273"></a> -<span class="sourceLineNo">274</span> )<a name="line.274"></a> -<span class="sourceLineNo">275</span> public Swagger getOptions(RestRequest req) {<a name="line.275"></a> -<span class="sourceLineNo">276</span> return req.getSwagger();<a name="line.276"></a> -<span class="sourceLineNo">277</span> }<a name="line.277"></a> -<span class="sourceLineNo">278</span>}<a name="line.278"></a> +<span class="sourceLineNo">248</span> header={<a name="line.248"></a> +<span class="sourceLineNo">249</span> "<h1>$R{servletTitle}</h1>",<a name="line.249"></a> +<span class="sourceLineNo">250</span> "<h2>$R{methodSummary,$R{servletDescription}}</h2>",<a name="line.250"></a> +<span class="sourceLineNo">251</span> "<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.251"></a> +<span class="sourceLineNo">252</span> },<a name="line.252"></a> +<span class="sourceLineNo">253</span> stylesheet="servlet:/styles/devops.css"<a name="line.253"></a> +<span class="sourceLineNo">254</span> ),<a name="line.254"></a> +<span class="sourceLineNo">255</span> favicon="htdocs/juneau.png",<a name="line.255"></a> +<span class="sourceLineNo">256</span> staticFiles="{htdocs:'htdocs',styles:'styles'}"<a name="line.256"></a> +<span class="sourceLineNo">257</span>)<a name="line.257"></a> +<span class="sourceLineNo">258</span>public abstract class RestServletJenaDefault extends RestServlet {<a name="line.258"></a> +<span class="sourceLineNo">259</span> private static final long serialVersionUID = 1L;<a name="line.259"></a> +<span class="sourceLineNo">260</span><a name="line.260"></a> +<span class="sourceLineNo">261</span> /**<a name="line.261"></a> +<span class="sourceLineNo">262</span> * [OPTIONS /*] - Show resource options.<a name="line.262"></a> +<span class="sourceLineNo">263</span> *<a name="line.263"></a> +<span class="sourceLineNo">264</span> * @param req The HTTP request.<a name="line.264"></a> +<span class="sourceLineNo">265</span> * @return The bean containing the contents of the OPTIONS page.<a name="line.265"></a> +<span class="sourceLineNo">266</span> */<a name="line.266"></a> +<span class="sourceLineNo">267</span> @RestMethod(name="OPTIONS", path="/*",<a name="line.267"></a> +<span class="sourceLineNo">268</span> htmldoc=@HtmlDoc(<a name="line.268"></a> +<span class="sourceLineNo">269</span> links={<a name="line.269"></a> +<span class="sourceLineNo">270</span> "back: servlet:/",<a name="line.270"></a> +<span class="sourceLineNo">271</span> "json: servlet:/?method=OPTIONS&Accept=text/json&plainText=true"<a name="line.271"></a> +<span class="sourceLineNo">272</span> },<a name="line.272"></a> +<span class="sourceLineNo">273</span> aside="NONE"<a name="line.273"></a> +<span class="sourceLineNo">274</span> ),<a name="line.274"></a> +<span class="sourceLineNo">275</span> summary="Swagger documentation",<a name="line.275"></a> +<span class="sourceLineNo">276</span> description="Auto-generated swagger documentation for this resource"<a name="line.276"></a> +<span class="sourceLineNo">277</span> )<a name="line.277"></a> +<span class="sourceLineNo">278</span> public Swagger getOptions(RestRequest req) {<a name="line.278"></a> +<span class="sourceLineNo">279</span> return req.getSwagger();<a name="line.279"></a> +<span class="sourceLineNo">280</span> }<a name="line.280"></a> +<span class="sourceLineNo">281</span>}<a name="line.281"></a>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/src-html/org/apache/juneau/rest/vars/FileVar.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/vars/FileVar.html b/content/site/apidocs/src-html/org/apache/juneau/rest/vars/FileVar.html new file mode 100644 index 0000000..16166c3 --- /dev/null +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/vars/FileVar.html @@ -0,0 +1,161 @@ +<!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.vars;<a name="line.13"></a> +<span class="sourceLineNo">014</span><a name="line.14"></a> +<span class="sourceLineNo">015</span>import org.apache.juneau.rest.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span>import org.apache.juneau.svl.*;<a name="line.16"></a> +<span class="sourceLineNo">017</span>import org.apache.juneau.utils.*;<a name="line.17"></a> +<span class="sourceLineNo">018</span><a name="line.18"></a> +<span class="sourceLineNo">019</span>/**<a name="line.19"></a> +<span class="sourceLineNo">020</span> * File resource variable resolver<a name="line.20"></a> +<span class="sourceLineNo">021</span> *<a name="line.21"></a> +<span class="sourceLineNo">022</span> * <p><a name="line.22"></a> +<span class="sourceLineNo">023</span> * The format for this var is <js>"$F{path[,defaultValue]}"</js>.<a name="line.23"></a> +<span class="sourceLineNo">024</span> *<a name="line.24"></a> +<span class="sourceLineNo">025</span> * <p><a name="line.25"></a> +<span class="sourceLineNo">026</span> * File variables resolve to the contents of resource files located on the classpath or local JVM directory.<a name="line.26"></a> +<span class="sourceLineNo">027</span> * They use the {@link RestRequest#getReaderResource(String)} method to retrieve the contents of the file.<a name="line.27"></a> +<span class="sourceLineNo">028</span> * That in turn uses the {@link ResourceFinder} associated with the servlet class to find the file.<a name="line.28"></a> +<span class="sourceLineNo">029</span> *<a name="line.29"></a> +<span class="sourceLineNo">030</span> * <p><a name="line.30"></a> +<span class="sourceLineNo">031</span> * The {@link ResourceFinder} is similar to {@link Class#getResourceAsStream(String)} except if it doesn't find the<a name="line.31"></a> +<span class="sourceLineNo">032</span> * resource on this class, it searches up the parent hierarchy chain.<a name="line.32"></a> +<span class="sourceLineNo">033</span> *<a name="line.33"></a> +<span class="sourceLineNo">034</span> * <p><a name="line.34"></a> +<span class="sourceLineNo">035</span> * If the resource cannot be found in the classpath, then an attempt is made to look in the JVM working directory.<a name="line.35"></a> +<span class="sourceLineNo">036</span> * <br>Path traversals outside the working directory are not allowed for security reasons.<a name="line.36"></a> +<span class="sourceLineNo">037</span><a name="line.37"></a> +<span class="sourceLineNo">038</span> * <p><a name="line.38"></a> +<span class="sourceLineNo">039</span> * Localized resources (based on the locale of the HTTP request) are supported.<a name="line.39"></a> +<span class="sourceLineNo">040</span> * For example, if looking for the resource <js>"MyResource.txt"</js> for the Japanese locale, we will look for<a name="line.40"></a> +<span class="sourceLineNo">041</span> * files in the following order:<a name="line.41"></a> +<span class="sourceLineNo">042</span> * <ol><a name="line.42"></a> +<span class="sourceLineNo">043</span> * <li><js>"MyResource_ja_JP.txt"</js><a name="line.43"></a> +<span class="sourceLineNo">044</span> * <li><js>"MyResource_ja.txt"</js><a name="line.44"></a> +<span class="sourceLineNo">045</span> * <li><js>"MyResource.txt"</js><a name="line.45"></a> +<span class="sourceLineNo">046</span> * </ol><a name="line.46"></a> +<span class="sourceLineNo">047</span> *<a name="line.47"></a> +<span class="sourceLineNo">048</span> * <p><a name="line.48"></a> +<span class="sourceLineNo">049</span> * Example:<a name="line.49"></a> +<span class="sourceLineNo">050</span> * <p class='bcode'><a name="line.50"></a> +<span class="sourceLineNo">051</span> * <ja>@RestResource</ja>(<a name="line.51"></a> +<span class="sourceLineNo">052</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.52"></a> +<span class="sourceLineNo">053</span> * aside=<js>"$F{resources/MyAsideMessage.html, Oops not found!}"</js><a name="line.53"></a> +<span class="sourceLineNo">054</span> * )<a name="line.54"></a> +<span class="sourceLineNo">055</span> * )<a name="line.55"></a> +<span class="sourceLineNo">056</span> * </p><a name="line.56"></a> +<span class="sourceLineNo">057</span> *<a name="line.57"></a> +<span class="sourceLineNo">058</span> * <p><a name="line.58"></a> +<span class="sourceLineNo">059</span> * Files of type HTML, XHTML, XML, JSON, Javascript, and CSS will be stripped of comments.<a name="line.59"></a> +<span class="sourceLineNo">060</span> * This allows you to place license headers in files without them being serialized to the output.<a name="line.60"></a> +<span class="sourceLineNo">061</span> *<a name="line.61"></a> +<span class="sourceLineNo">062</span> * @see org.apache.juneau.svl<a name="line.62"></a> +<span class="sourceLineNo">063</span> */<a name="line.63"></a> +<span class="sourceLineNo">064</span>public class FileVar extends DefaultingVar {<a name="line.64"></a> +<span class="sourceLineNo">065</span><a name="line.65"></a> +<span class="sourceLineNo">066</span> /**<a name="line.66"></a> +<span class="sourceLineNo">067</span> * The name of the session or context object that identifies the {@link RestRequest} object.<a name="line.67"></a> +<span class="sourceLineNo">068</span> */<a name="line.68"></a> +<span class="sourceLineNo">069</span> public static final String SESSION_req = "req";<a name="line.69"></a> +<span class="sourceLineNo">070</span><a name="line.70"></a> +<span class="sourceLineNo">071</span> /**<a name="line.71"></a> +<span class="sourceLineNo">072</span> * The name of this variable.<a name="line.72"></a> +<span class="sourceLineNo">073</span> */<a name="line.73"></a> +<span class="sourceLineNo">074</span> public static final String NAME = "F";<a name="line.74"></a> +<span class="sourceLineNo">075</span><a name="line.75"></a> +<span class="sourceLineNo">076</span> /**<a name="line.76"></a> +<span class="sourceLineNo">077</span> * Constructor.<a name="line.77"></a> +<span class="sourceLineNo">078</span> */<a name="line.78"></a> +<span class="sourceLineNo">079</span> public FileVar() {<a name="line.79"></a> +<span class="sourceLineNo">080</span> super(NAME);<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> +<span class="sourceLineNo">083</span> @Override /* Parameter */<a name="line.83"></a> +<span class="sourceLineNo">084</span> public String resolve(VarResolverSession session, String key) throws Exception {<a name="line.84"></a> +<span class="sourceLineNo">085</span> RestRequest req = session.getSessionObject(RestRequest.class, SESSION_req);<a name="line.85"></a> +<span class="sourceLineNo">086</span> ReaderResource rr = req.getReaderResource(key);<a name="line.86"></a> +<span class="sourceLineNo">087</span> return (rr == null ? null : rr.toCommentStrippedString());<a name="line.87"></a> +<span class="sourceLineNo">088</span> }<a name="line.88"></a> +<span class="sourceLineNo">089</span>}<a name="line.89"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/src-html/org/apache/juneau/rest/vars/LocalizationVar.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/vars/LocalizationVar.html b/content/site/apidocs/src-html/org/apache/juneau/rest/vars/LocalizationVar.html index 9793f9a..7198904 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/vars/LocalizationVar.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/vars/LocalizationVar.html @@ -29,7 +29,7 @@ <span class="sourceLineNo">021</span> * Localized string variable resolver.<a name="line.21"></a> <span class="sourceLineNo">022</span> *<a name="line.22"></a> <span class="sourceLineNo">023</span> * <p><a name="line.23"></a> -<span class="sourceLineNo">024</span> * The format for this var is <js>"$L{key}"</js> or <js>"$L{key,args...}"</js>.<a name="line.24"></a> +<span class="sourceLineNo">024</span> * The format for this var is <js>"$L{key[,args...]}"</js>.<a name="line.24"></a> <span class="sourceLineNo">025</span> *<a name="line.25"></a> <span class="sourceLineNo">026</span> * <p><a name="line.26"></a> <span class="sourceLineNo">027</span> * This variable resolver requires that a {@link RestRequest} object be set as a context object on the resolver or a<a name="line.27"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/src-html/org/apache/juneau/rest/vars/RequestVar.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/vars/RequestVar.html b/content/site/apidocs/src-html/org/apache/juneau/rest/vars/RequestVar.html index e0e66b9..03037c5 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/vars/RequestVar.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/vars/RequestVar.html @@ -20,116 +20,92 @@ <span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> <span class="sourceLineNo">013</span>package org.apache.juneau.rest.vars;<a name="line.13"></a> <span class="sourceLineNo">014</span><a name="line.14"></a> -<span class="sourceLineNo">015</span>import org.apache.juneau.*;<a name="line.15"></a> -<span class="sourceLineNo">016</span>import org.apache.juneau.internal.*;<a name="line.16"></a> -<span class="sourceLineNo">017</span>import org.apache.juneau.rest.*;<a name="line.17"></a> -<span class="sourceLineNo">018</span>import org.apache.juneau.svl.*;<a name="line.18"></a> -<span class="sourceLineNo">019</span><a name="line.19"></a> -<span class="sourceLineNo">020</span>/**<a name="line.20"></a> -<span class="sourceLineNo">021</span> * Request attribute variable resolver.<a name="line.21"></a> -<span class="sourceLineNo">022</span> *<a name="line.22"></a> -<span class="sourceLineNo">023</span> * <p><a name="line.23"></a> -<span class="sourceLineNo">024</span> * The format for this var is <js>"$R{key}"</js>.<a name="line.24"></a> -<span class="sourceLineNo">025</span> * The possible values are:<a name="line.25"></a> -<span class="sourceLineNo">026</span> * <ul><a name="line.26"></a> -<span class="sourceLineNo">027</span> * <li><code>$R{contextPath}</code> - Value returned by {@link RestRequest#getContextPath()}.<a name="line.27"></a> -<span class="sourceLineNo">028</span> * <li><code>$R{method}</code> - Value returned by {@link RestRequest#getMethod()}.<a name="line.28"></a> -<span class="sourceLineNo">029</span> * <li><code>$R{methodDescription}</code> - Value returned by {@link RestRequest#getMethodDescription()}.<a name="line.29"></a> -<span class="sourceLineNo">030</span> * <li><code>$R{pathInfo}</code> - Value returned by {@link RestRequest#getPathInfo()}.<a name="line.30"></a> -<span class="sourceLineNo">031</span> * <li><code>$R{requestParentURI}</code> - Value returned by {@link UriContext#getRootRelativePathInfoParent()}.<a name="line.31"></a> -<span class="sourceLineNo">032</span> * <li><code>$R{requestURI}</code> - Value returned by {@link RestRequest#getRequestURI()}.<a name="line.32"></a> -<span class="sourceLineNo">033</span> * <li><code>$R{servletDescription}</code> - Value returned by {@link RestRequest#getServletDescription()}.<a name="line.33"></a> -<span class="sourceLineNo">034</span> * <li><code>$R{servletTitle}</code> - Value returned by {@link RestRequest#getServletTitle()}.<a name="line.34"></a> -<span class="sourceLineNo">035</span> * <li><code>$R{servletParentURI}</code> - Value returned by {@link UriContext#getRootRelativeServletPathParent()}.<a name="line.35"></a> -<span class="sourceLineNo">036</span> * <li><code>$R{servletPath}</code> - Value returned by {@link RestRequest#getServletPath()}.<a name="line.36"></a> -<span class="sourceLineNo">037</span> * <li><code>$R{servletURI}</code> - Value returned by {@link UriContext#getRootRelativeServletPath()}.<a name="line.37"></a> -<span class="sourceLineNo">038</span> * </ul><a name="line.38"></a> -<span class="sourceLineNo">039</span> *<a name="line.39"></a> -<span class="sourceLineNo">040</span> * <p><a name="line.40"></a> -<span class="sourceLineNo">041</span> * This variable resolver requires that a {@link RestRequest} object be set as a context object on the resolver or a<a name="line.41"></a> -<span class="sourceLineNo">042</span> * session object on the resolver session.<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> * Since this is a {@link SimpleVar}, any variables contained in the result will be recursively resolved.<a name="line.45"></a> -<span class="sourceLineNo">046</span> * Likewise, if the arguments contain any variables, those will be resolved before they are passed to this var.<a name="line.46"></a> -<span class="sourceLineNo">047</span> *<a name="line.47"></a> -<span class="sourceLineNo">048</span> * @see org.apache.juneau.svl<a name="line.48"></a> -<span class="sourceLineNo">049</span> */<a name="line.49"></a> -<span class="sourceLineNo">050</span>public class RequestVar extends SimpleVar {<a name="line.50"></a> -<span class="sourceLineNo">051</span><a name="line.51"></a> -<span class="sourceLineNo">052</span> /**<a name="line.52"></a> -<span class="sourceLineNo">053</span> * The name of the session or context object that identifies the {@link RestRequest} object.<a name="line.53"></a> -<span class="sourceLineNo">054</span> */<a name="line.54"></a> -<span class="sourceLineNo">055</span> public static final String SESSION_req = "req";<a name="line.55"></a> -<span class="sourceLineNo">056</span><a name="line.56"></a> -<span class="sourceLineNo">057</span> /** The name of this variable. */<a name="line.57"></a> -<span class="sourceLineNo">058</span> public static final String NAME = "R";<a name="line.58"></a> -<span class="sourceLineNo">059</span><a name="line.59"></a> -<span class="sourceLineNo">060</span> /**<a name="line.60"></a> -<span class="sourceLineNo">061</span> * Constructor.<a name="line.61"></a> -<span class="sourceLineNo">062</span> */<a name="line.62"></a> -<span class="sourceLineNo">063</span> public RequestVar() {<a name="line.63"></a> -<span class="sourceLineNo">064</span> super(NAME);<a name="line.64"></a> -<span class="sourceLineNo">065</span> }<a name="line.65"></a> -<span class="sourceLineNo">066</span><a name="line.66"></a> -<span class="sourceLineNo">067</span> @Override /* Parameter */<a name="line.67"></a> -<span class="sourceLineNo">068</span> public String resolve(VarResolverSession session, String key) {<a name="line.68"></a> -<span class="sourceLineNo">069</span> RestRequest req = session.getSessionObject(RestRequest.class, SESSION_req);<a name="line.69"></a> -<span class="sourceLineNo">070</span> if (key.length() > 0) {<a name="line.70"></a> -<span class="sourceLineNo">071</span> String k = key.toString();<a name="line.71"></a> -<span class="sourceLineNo">072</span> if (k.indexOf('.') != -1) {<a name="line.72"></a> -<span class="sourceLineNo">073</span> String prefix = k.substring(0, k.indexOf('.'));<a name="line.73"></a> -<span class="sourceLineNo">074</span> String remainder = k.substring(k.indexOf('.')+1);<a name="line.74"></a> -<span class="sourceLineNo">075</span> if ("path".equals(prefix))<a name="line.75"></a> -<span class="sourceLineNo">076</span> return req.getPathMatch().get(remainder);<a name="line.76"></a> -<span class="sourceLineNo">077</span> if ("query".equals(prefix))<a name="line.77"></a> -<span class="sourceLineNo">078</span> return req.getQuery().getString(remainder);<a name="line.78"></a> -<span class="sourceLineNo">079</span> if ("formData".equals(prefix))<a name="line.79"></a> -<span class="sourceLineNo">080</span> return req.getFormData().getString(remainder);<a name="line.80"></a> -<span class="sourceLineNo">081</span> if ("header".equals(prefix))<a name="line.81"></a> -<span class="sourceLineNo">082</span> return req.getHeader(remainder);<a name="line.82"></a> -<span class="sourceLineNo">083</span> if ("attribute".equals(prefix))<a name="line.83"></a> -<span class="sourceLineNo">084</span> return StringUtils.toString(req.getAttribute(remainder));<a name="line.84"></a> -<span class="sourceLineNo">085</span> }<a name="line.85"></a> -<span class="sourceLineNo">086</span> char c = key.charAt(0);<a name="line.86"></a> -<span class="sourceLineNo">087</span> if (c == 'c') {<a name="line.87"></a> -<span class="sourceLineNo">088</span> if (key.equals("contextPath"))<a name="line.88"></a> -<span class="sourceLineNo">089</span> return req.getContextPath();<a name="line.89"></a> -<span class="sourceLineNo">090</span> } else if (c == 'm') {<a name="line.90"></a> -<span class="sourceLineNo">091</span> if (key.equals("method"))<a name="line.91"></a> -<span class="sourceLineNo">092</span> return req.getMethod();<a name="line.92"></a> -<span class="sourceLineNo">093</span> if (key.equals("methodSummary"))<a name="line.93"></a> -<span class="sourceLineNo">094</span> return req.getMethodSummary();<a name="line.94"></a> -<span class="sourceLineNo">095</span> if (key.equals("methodDescription"))<a name="line.95"></a> -<span class="sourceLineNo">096</span> return req.getMethodDescription();<a name="line.96"></a> -<span class="sourceLineNo">097</span> } else if (c == 'p') {<a name="line.97"></a> -<span class="sourceLineNo">098</span> if (key.equals("pathInfo"))<a name="line.98"></a> -<span class="sourceLineNo">099</span> return req.getPathInfo();<a name="line.99"></a> -<span class="sourceLineNo">100</span> } else if (c == 'r') {<a name="line.100"></a> -<span class="sourceLineNo">101</span> if (key.equals("requestURI"))<a name="line.101"></a> -<span class="sourceLineNo">102</span> return req.getRequestURI();<a name="line.102"></a> -<span class="sourceLineNo">103</span> if (key.equals("requestParentURI"))<a name="line.103"></a> -<span class="sourceLineNo">104</span> return req.getUriContext().getRootRelativePathInfoParent();<a name="line.104"></a> -<span class="sourceLineNo">105</span> } else if (c == 's') {<a name="line.105"></a> -<span class="sourceLineNo">106</span> if (key.equals("servletPath"))<a name="line.106"></a> -<span class="sourceLineNo">107</span> return req.getServletPath();<a name="line.107"></a> -<span class="sourceLineNo">108</span> if (key.equals("servletURI"))<a name="line.108"></a> -<span class="sourceLineNo">109</span> return req.getUriContext().getRootRelativeServletPath();<a name="line.109"></a> -<span class="sourceLineNo">110</span> if (key.equals("servletParentURI"))<a name="line.110"></a> -<span class="sourceLineNo">111</span> return req.getUriContext().getRootRelativeServletPathParent();<a name="line.111"></a> -<span class="sourceLineNo">112</span> if (key.equals("servletTitle"))<a name="line.112"></a> -<span class="sourceLineNo">113</span> return req.getServletTitle();<a name="line.113"></a> -<span class="sourceLineNo">114</span> if (key.equals("servletDescription"))<a name="line.114"></a> -<span class="sourceLineNo">115</span> return req.getServletDescription();<a name="line.115"></a> -<span class="sourceLineNo">116</span> }<a name="line.116"></a> -<span class="sourceLineNo">117</span> Object o = req.getProperties().get(key);<a name="line.117"></a> -<span class="sourceLineNo">118</span> if (o != null)<a name="line.118"></a> -<span class="sourceLineNo">119</span> return o.toString();<a name="line.119"></a> -<span class="sourceLineNo">120</span> return req.getPathMatch().get(key);<a name="line.120"></a> -<span class="sourceLineNo">121</span> }<a name="line.121"></a> -<span class="sourceLineNo">122</span> return null;<a name="line.122"></a> -<span class="sourceLineNo">123</span> }<a name="line.123"></a> -<span class="sourceLineNo">124</span>}<a name="line.124"></a> +<span class="sourceLineNo">015</span>import javax.servlet.http.*;<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.rest.*;<a name="line.18"></a> +<span class="sourceLineNo">019</span>import org.apache.juneau.svl.*;<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> * Request attribute variable resolver.<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 format for this var is <js>"$R{key[,defaultValue]}"</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> * The possible values are:<a name="line.28"></a> +<span class="sourceLineNo">029</span> * <ul><a name="line.29"></a> +<span class="sourceLineNo">030</span> * <li><js>"contextPath"</js> - Value returned by {@link RestRequest#getContextPath()}<a name="line.30"></a> +<span class="sourceLineNo">031</span> * <li><js>"method"</js> - Value returned by {@link RestRequest#getMethod()}<a name="line.31"></a> +<span class="sourceLineNo">032</span> * <li><js>"methodDescription"</js> - Value returned by {@link RestRequest#getMethodDescription()}<a name="line.32"></a> +<span class="sourceLineNo">033</span> * <li><js>"methodSummary"</js> - Value returned by {@link RestRequest#getMethodSummary()}<a name="line.33"></a> +<span class="sourceLineNo">034</span> * <li><js>"pathInfo"</js> - Value returned by {@link RestRequest#getPathInfo()}<a name="line.34"></a> +<span class="sourceLineNo">035</span> * <li><js>"requestParentURI"</js> - Value returned by {@link UriContext#getRootRelativePathInfoParent()}<a name="line.35"></a> +<span class="sourceLineNo">036</span> * <li><js>"requestURI"</js> - Value returned by {@link RestRequest#getRequestURI()}<a name="line.36"></a> +<span class="sourceLineNo">037</span> * <li><js>"servletDescription"</js> - Value returned by {@link RestRequest#getServletDescription()}<a name="line.37"></a> +<span class="sourceLineNo">038</span> * <li><js>"servletParentURI"</js> - Value returned by {@link UriContext#getRootRelativeServletPathParent()}<a name="line.38"></a> +<span class="sourceLineNo">039</span> * <li><js>"servletPath"</js> - See {@link RestRequest#getServletPath()}<a name="line.39"></a> +<span class="sourceLineNo">040</span> * <li><js>"servletTitle"</js> - See {@link RestRequest#getServletTitle()}<a name="line.40"></a> +<span class="sourceLineNo">041</span> * <li><js>"servletURI"</js> - See {@link UriContext#getRootRelativeServletPath()}<a name="line.41"></a> +<span class="sourceLineNo">042</span> * <li><js>"siteName"</js> - See {@link RestRequest#getSiteName()}<a name="line.42"></a> +<span class="sourceLineNo">043</span> * <li><js>"Attribute.x"</js> - Value returned by {@link HttpServletRequest#getAttribute(String)}.<a name="line.43"></a> +<span class="sourceLineNo">044</span> * <li><js>"FormData.x"</js> - Value returned by {@link RestRequest#getFormData(String)}.<a name="line.44"></a> +<span class="sourceLineNo">045</span> * <li><js>"Header.x"</js> - Value returned by {@link RestRequest#getHeader(String)}.<a name="line.45"></a> +<span class="sourceLineNo">046</span> * <li><js>"Path.x"</js> - Value returned by {@link RestRequest#getPath(String)}.<a name="line.46"></a> +<span class="sourceLineNo">047</span> * <li><js>"Query.x"</js> = Value returned by {@link RestRequest#getQuery(String)}.<a name="line.47"></a> +<span class="sourceLineNo">048</span> * </ul><a name="line.48"></a> +<span class="sourceLineNo">049</span> * <p><a name="line.49"></a> +<span class="sourceLineNo">050</span> * This variable resolver requires that a {@link RestRequest} object be set as a context object on the resolver or a<a name="line.50"></a> +<span class="sourceLineNo">051</span> * session object on the resolver session.<a name="line.51"></a> +<span class="sourceLineNo">052</span> *<a name="line.52"></a> +<span class="sourceLineNo">053</span> * <p><a name="line.53"></a> +<span class="sourceLineNo">054</span> * Since this is a {@link SimpleVar}, any variables contained in the result will be recursively resolved.<a name="line.54"></a> +<span class="sourceLineNo">055</span> * Likewise, if the arguments contain any variables, those will be resolved before they are passed to this var.<a name="line.55"></a> +<span class="sourceLineNo">056</span> *<a name="line.56"></a> +<span class="sourceLineNo">057</span> * @see org.apache.juneau.svl<a name="line.57"></a> +<span class="sourceLineNo">058</span> */<a name="line.58"></a> +<span class="sourceLineNo">059</span>public class RequestVar extends DefaultingVar {<a name="line.59"></a> +<span class="sourceLineNo">060</span><a name="line.60"></a> +<span class="sourceLineNo">061</span> /**<a name="line.61"></a> +<span class="sourceLineNo">062</span> * The name of the session or context object that identifies the {@link RestRequest} object.<a name="line.62"></a> +<span class="sourceLineNo">063</span> */<a name="line.63"></a> +<span class="sourceLineNo">064</span> public static final String SESSION_req = "req";<a name="line.64"></a> +<span class="sourceLineNo">065</span><a name="line.65"></a> +<span class="sourceLineNo">066</span> /** The name of this variable. */<a name="line.66"></a> +<span class="sourceLineNo">067</span> public static final String NAME = "R";<a name="line.67"></a> +<span class="sourceLineNo">068</span><a name="line.68"></a> +<span class="sourceLineNo">069</span> /**<a name="line.69"></a> +<span class="sourceLineNo">070</span> * Constructor.<a name="line.70"></a> +<span class="sourceLineNo">071</span> */<a name="line.71"></a> +<span class="sourceLineNo">072</span> public RequestVar() {<a name="line.72"></a> +<span class="sourceLineNo">073</span> super(NAME);<a name="line.73"></a> +<span class="sourceLineNo">074</span> }<a name="line.74"></a> +<span class="sourceLineNo">075</span><a name="line.75"></a> +<span class="sourceLineNo">076</span> @Override /* Parameter */<a name="line.76"></a> +<span class="sourceLineNo">077</span> public String resolve(VarResolverSession session, String key) {<a name="line.77"></a> +<span class="sourceLineNo">078</span> RestRequest req = session.getSessionObject(RestRequest.class, SESSION_req);<a name="line.78"></a> +<span class="sourceLineNo">079</span> if (key.length() > 0) {<a name="line.79"></a> +<span class="sourceLineNo">080</span> String k = key.toString();<a name="line.80"></a> +<span class="sourceLineNo">081</span> int i = k.indexOf('.');<a name="line.81"></a> +<span class="sourceLineNo">082</span> if (i != -1) {<a name="line.82"></a> +<span class="sourceLineNo">083</span> String prefix = k.substring(0, i);<a name="line.83"></a> +<span class="sourceLineNo">084</span> String remainder = k.substring(i+1);<a name="line.84"></a> +<span class="sourceLineNo">085</span> Object o = req.resolveProperty(null, prefix, remainder);<a name="line.85"></a> +<span class="sourceLineNo">086</span> if (o != null)<a name="line.86"></a> +<span class="sourceLineNo">087</span> return o.toString();<a name="line.87"></a> +<span class="sourceLineNo">088</span> } else {<a name="line.88"></a> +<span class="sourceLineNo">089</span> Object o = req.resolveProperty(null, "Request", key);<a name="line.89"></a> +<span class="sourceLineNo">090</span> if (o != null)<a name="line.90"></a> +<span class="sourceLineNo">091</span> return o.toString();<a name="line.91"></a> +<span class="sourceLineNo">092</span> }<a name="line.92"></a> +<span class="sourceLineNo">093</span> Object o = req.getProperties().get(key);<a name="line.93"></a> +<span class="sourceLineNo">094</span> if (o != null)<a name="line.94"></a> +<span class="sourceLineNo">095</span> return o.toString();<a name="line.95"></a> +<span class="sourceLineNo">096</span> return req.getPathMatch().get(key);<a name="line.96"></a> +<span class="sourceLineNo">097</span> }<a name="line.97"></a> +<span class="sourceLineNo">098</span> return null;<a name="line.98"></a> +<span class="sourceLineNo">099</span> }<a name="line.99"></a> +<span class="sourceLineNo">100</span>}<a name="line.100"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/src-html/org/apache/juneau/rest/vars/SerializedRequestAttrVar.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/vars/SerializedRequestAttrVar.html b/content/site/apidocs/src-html/org/apache/juneau/rest/vars/SerializedRequestAttrVar.html index 92d5224..6f45984 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/vars/SerializedRequestAttrVar.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/vars/SerializedRequestAttrVar.html @@ -32,7 +32,7 @@ <span class="sourceLineNo">024</span> * Serialized request attribute variable resolver.<a name="line.24"></a> <span class="sourceLineNo">025</span> *<a name="line.25"></a> <span class="sourceLineNo">026</span> * <p><a name="line.26"></a> -<span class="sourceLineNo">027</span> * The format for this var is <js>"$SA{contentType,key}"</js> or <js>"$SA{contentType,key,defaultValue}"</js>.<a name="line.27"></a> +<span class="sourceLineNo">027</span> * The format for this var is <js>"$SA{contentType,key[,defaultValue]}"</js>.<a name="line.27"></a> <span class="sourceLineNo">028</span> *<a name="line.28"></a> <span class="sourceLineNo">029</span> * <p><a name="line.29"></a> <span class="sourceLineNo">030</span> * This variable resolver requires that a {@link RestRequest} object be set as a context object on the resolver or a<a name="line.30"></a> @@ -57,26 +57,22 @@ <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> @Override /* Parameter */<a name="line.51"></a> -<span class="sourceLineNo">052</span> public void resolveTo(VarResolverSession session, Writer w, String key) {<a name="line.52"></a> -<span class="sourceLineNo">053</span> try {<a name="line.53"></a> -<span class="sourceLineNo">054</span> int i = key.indexOf(',');<a name="line.54"></a> -<span class="sourceLineNo">055</span> if (i == -1)<a name="line.55"></a> -<span class="sourceLineNo">056</span> throw new RuntimeException("Invalid format for $SA var. Must be of the format $SA{contentType,key[,defaultValue]}");<a name="line.56"></a> -<span class="sourceLineNo">057</span> String[] s2 = split(key);<a name="line.57"></a> -<span class="sourceLineNo">058</span> RestRequest req = session.getSessionObject(RestRequest.class, RequestVar.SESSION_req);<a name="line.58"></a> -<span class="sourceLineNo">059</span> if (req != null) {<a name="line.59"></a> -<span class="sourceLineNo">060</span> Object o = req.getAttribute(key);<a name="line.60"></a> -<span class="sourceLineNo">061</span> if (o == null)<a name="line.61"></a> -<span class="sourceLineNo">062</span> o = key;<a name="line.62"></a> -<span class="sourceLineNo">063</span> Serializer s = req.getSerializerGroup().getSerializer(s2[0]);<a name="line.63"></a> -<span class="sourceLineNo">064</span> if (s != null)<a name="line.64"></a> -<span class="sourceLineNo">065</span> s.serialize(w, o);<a name="line.65"></a> -<span class="sourceLineNo">066</span> }<a name="line.66"></a> -<span class="sourceLineNo">067</span> } catch (Exception e) {<a name="line.67"></a> -<span class="sourceLineNo">068</span> throw new RuntimeException(e);<a name="line.68"></a> -<span class="sourceLineNo">069</span> }<a name="line.69"></a> -<span class="sourceLineNo">070</span> }<a name="line.70"></a> -<span class="sourceLineNo">071</span>}<a name="line.71"></a> +<span class="sourceLineNo">052</span> public void resolveTo(VarResolverSession session, Writer w, String key) throws Exception {<a name="line.52"></a> +<span class="sourceLineNo">053</span> int i = key.indexOf(',');<a name="line.53"></a> +<span class="sourceLineNo">054</span> if (i == -1)<a name="line.54"></a> +<span class="sourceLineNo">055</span> throw new RuntimeException("Invalid format for $SA var. Must be of the format $SA{contentType,key[,defaultValue]}");<a name="line.55"></a> +<span class="sourceLineNo">056</span> String[] s2 = split(key);<a name="line.56"></a> +<span class="sourceLineNo">057</span> RestRequest req = session.getSessionObject(RestRequest.class, RequestVar.SESSION_req);<a name="line.57"></a> +<span class="sourceLineNo">058</span> if (req != null) {<a name="line.58"></a> +<span class="sourceLineNo">059</span> Object o = req.getAttribute(key);<a name="line.59"></a> +<span class="sourceLineNo">060</span> if (o == null)<a name="line.60"></a> +<span class="sourceLineNo">061</span> o = key;<a name="line.61"></a> +<span class="sourceLineNo">062</span> Serializer s = req.getSerializerGroup().getSerializer(s2[0]);<a name="line.62"></a> +<span class="sourceLineNo">063</span> if (s != null)<a name="line.63"></a> +<span class="sourceLineNo">064</span> s.serialize(w, o);<a name="line.64"></a> +<span class="sourceLineNo">065</span> }<a name="line.65"></a> +<span class="sourceLineNo">066</span> }<a name="line.66"></a> +<span class="sourceLineNo">067</span>}<a name="line.67"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/src-html/org/apache/juneau/rest/vars/ServletInitParamVar.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/vars/ServletInitParamVar.html b/content/site/apidocs/src-html/org/apache/juneau/rest/vars/ServletInitParamVar.html index 3db73c4..8a0fb96 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/vars/ServletInitParamVar.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/vars/ServletInitParamVar.html @@ -27,7 +27,7 @@ <span class="sourceLineNo">019</span> * Servlet init parameter variable resolver.<a name="line.19"></a> <span class="sourceLineNo">020</span> *<a name="line.20"></a> <span class="sourceLineNo">021</span> * <p><a name="line.21"></a> -<span class="sourceLineNo">022</span> * The format for this var is <js>"$I{key}"</js> or <js>"$I{key,defaultValue}"</js>.<a name="line.22"></a> +<span class="sourceLineNo">022</span> * The format for this var is <js>"$I{key[,defaultValue]}"</js>.<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> * This variable resolver requires that a {@link RestRequest} object be set as a context object on the resolver or a<a name="line.25"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/src-html/org/apache/juneau/rest/vars/UrlEncodeVar.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/vars/UrlEncodeVar.html b/content/site/apidocs/src-html/org/apache/juneau/rest/vars/UrlEncodeVar.html index a25e8fe..a13bb0e 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/vars/UrlEncodeVar.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/vars/UrlEncodeVar.html @@ -29,7 +29,7 @@ <span class="sourceLineNo">021</span> * URL-encoding variable resolver.<a name="line.21"></a> <span class="sourceLineNo">022</span> *<a name="line.22"></a> <span class="sourceLineNo">023</span> * <p><a name="line.23"></a> -<span class="sourceLineNo">024</span> * The format for this var is <js>"$UE{innerValue}"</js>.<a name="line.24"></a> +<span class="sourceLineNo">024</span> * The format for this var is <js>"$UE{uriPart}"</js>.<a name="line.24"></a> <span class="sourceLineNo">025</span> *<a name="line.25"></a> <span class="sourceLineNo">026</span> * <p><a name="line.26"></a> <span class="sourceLineNo">027</span> * This variable takes the contents inside the variable and replaces it with a value returned by calling<a name="line.27"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/src-html/org/apache/juneau/rest/vars/UrlVar.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/vars/UrlVar.html b/content/site/apidocs/src-html/org/apache/juneau/rest/vars/UrlVar.html index aa623df..067b53f 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/vars/UrlVar.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/vars/UrlVar.html @@ -26,49 +26,51 @@ <span class="sourceLineNo">018</span>import org.apache.juneau.svl.*;<a name="line.18"></a> <span class="sourceLineNo">019</span><a name="line.19"></a> <span class="sourceLineNo">020</span>/**<a name="line.20"></a> -<span class="sourceLineNo">021</span> * Resolver for resolving URL variables <js>"$U{name}"</js>.<a name="line.21"></a> +<span class="sourceLineNo">021</span> * URL variable resolver.<a name="line.21"></a> <span class="sourceLineNo">022</span> *<a name="line.22"></a> <span class="sourceLineNo">023</span> * <p><a name="line.23"></a> -<span class="sourceLineNo">024</span> * The advantage of using this variable is that you can resolve URLs with special protocols such as<a name="line.24"></a> -<span class="sourceLineNo">025</span> * <js>"servlet:/xxx"</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> * See {@link UriResolver} for the kinds of URIs that can be resolved.<a name="line.28"></a> -<span class="sourceLineNo">029</span> * <ul><a name="line.29"></a> -<span class="sourceLineNo">030</span> * <li>{@link RestResource#widgets() @RestResource.widgets()}<a name="line.30"></a> -<span class="sourceLineNo">031</span> * <li>{@link RestMethod#widgets() @RestMethod.widgets()}<a name="line.31"></a> -<span class="sourceLineNo">032</span> * <li>{@link RestConfig#addWidget(Class)}<a name="line.32"></a> -<span class="sourceLineNo">033</span> * </ul><a name="line.33"></a> -<span class="sourceLineNo">034</span> *<a name="line.34"></a> -<span class="sourceLineNo">035</span> * <p><a name="line.35"></a> -<span class="sourceLineNo">036</span> * Uses the URI resolver returned by {@link RestRequest#getUriResolver(UriResolution, UriRelativity)} with resolution<a name="line.36"></a> -<span class="sourceLineNo">037</span> * {@link UriResolution#ROOT_RELATIVE} and relativity {@link UriRelativity#RESOURCE}.<a name="line.37"></a> -<span class="sourceLineNo">038</span> *<a name="line.38"></a> -<span class="sourceLineNo">039</span> * @see org.apache.juneau.svl<a name="line.39"></a> -<span class="sourceLineNo">040</span> */<a name="line.40"></a> -<span class="sourceLineNo">041</span>public class UrlVar extends SimpleVar {<a name="line.41"></a> -<span class="sourceLineNo">042</span><a name="line.42"></a> -<span class="sourceLineNo">043</span> /**<a name="line.43"></a> -<span class="sourceLineNo">044</span> * The name of the session or context object that identifies the {@link RestRequest} object.<a name="line.44"></a> -<span class="sourceLineNo">045</span> */<a name="line.45"></a> -<span class="sourceLineNo">046</span> public static final String SESSION_req = "req";<a name="line.46"></a> -<span class="sourceLineNo">047</span><a name="line.47"></a> -<span class="sourceLineNo">048</span> /** The name of this variable. */<a name="line.48"></a> -<span class="sourceLineNo">049</span> public static final String NAME = "U";<a name="line.49"></a> -<span class="sourceLineNo">050</span><a name="line.50"></a> -<span class="sourceLineNo">051</span> /**<a name="line.51"></a> -<span class="sourceLineNo">052</span> * Constructor.<a name="line.52"></a> -<span class="sourceLineNo">053</span> */<a name="line.53"></a> -<span class="sourceLineNo">054</span> public UrlVar() {<a name="line.54"></a> -<span class="sourceLineNo">055</span> super(NAME);<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> @Override /* Parameter */<a name="line.58"></a> -<span class="sourceLineNo">059</span> public String resolve(VarResolverSession session, String key) {<a name="line.59"></a> -<span class="sourceLineNo">060</span> RestRequest req = session.getSessionObject(RestRequest.class, SESSION_req);<a name="line.60"></a> -<span class="sourceLineNo">061</span> return req.getUriResolver().resolve(key);<a name="line.61"></a> -<span class="sourceLineNo">062</span> }<a name="line.62"></a> -<span class="sourceLineNo">063</span>}<a name="line.63"></a> +<span class="sourceLineNo">024</span> * The format for this var is <js>"$U{uri}"</js>.<a name="line.24"></a> +<span class="sourceLineNo">025</span> *<a name="line.25"></a> +<span class="sourceLineNo">026</span> * <p><a name="line.26"></a> +<span class="sourceLineNo">027</span> * The advantage of using this variable is that you can resolve URLs with special protocols such as<a name="line.27"></a> +<span class="sourceLineNo">028</span> * <js>"servlet:/xxx"</js>.<a name="line.28"></a> +<span class="sourceLineNo">029</span> *<a name="line.29"></a> +<span class="sourceLineNo">030</span> * <p><a name="line.30"></a> +<span class="sourceLineNo">031</span> * See {@link UriResolver} for the kinds of URIs that can be resolved.<a name="line.31"></a> +<span class="sourceLineNo">032</span> * <ul><a name="line.32"></a> +<span class="sourceLineNo">033</span> * <li>{@link HtmlDoc#widgets() @HtmlDoc.widgets()}<a name="line.33"></a> +<span class="sourceLineNo">034</span> * <li>{@link RestConfig#addHtmlWidget(Class)}<a name="line.34"></a> +<span class="sourceLineNo">035</span> * </ul><a name="line.35"></a> +<span class="sourceLineNo">036</span> *<a name="line.36"></a> +<span class="sourceLineNo">037</span> * <p><a name="line.37"></a> +<span class="sourceLineNo">038</span> * Uses the URI resolver returned by {@link RestRequest#getUriResolver(UriResolution, UriRelativity)} with resolution<a name="line.38"></a> +<span class="sourceLineNo">039</span> * {@link UriResolution#ROOT_RELATIVE} and relativity {@link UriRelativity#RESOURCE}.<a name="line.39"></a> +<span class="sourceLineNo">040</span> *<a name="line.40"></a> +<span class="sourceLineNo">041</span> * @see org.apache.juneau.svl<a name="line.41"></a> +<span class="sourceLineNo">042</span> */<a name="line.42"></a> +<span class="sourceLineNo">043</span>public class UrlVar extends SimpleVar {<a name="line.43"></a> +<span class="sourceLineNo">044</span><a name="line.44"></a> +<span class="sourceLineNo">045</span> /**<a name="line.45"></a> +<span class="sourceLineNo">046</span> * The name of the session or context object that identifies the {@link RestRequest} object.<a name="line.46"></a> +<span class="sourceLineNo">047</span> */<a name="line.47"></a> +<span class="sourceLineNo">048</span> public static final String SESSION_req = "req";<a name="line.48"></a> +<span class="sourceLineNo">049</span><a name="line.49"></a> +<span class="sourceLineNo">050</span> /** The name of this variable. */<a name="line.50"></a> +<span class="sourceLineNo">051</span> public static final String NAME = "U";<a name="line.51"></a> +<span class="sourceLineNo">052</span><a name="line.52"></a> +<span class="sourceLineNo">053</span> /**<a name="line.53"></a> +<span class="sourceLineNo">054</span> * Constructor.<a name="line.54"></a> +<span class="sourceLineNo">055</span> */<a name="line.55"></a> +<span class="sourceLineNo">056</span> public UrlVar() {<a name="line.56"></a> +<span class="sourceLineNo">057</span> super(NAME);<a name="line.57"></a> +<span class="sourceLineNo">058</span> }<a name="line.58"></a> +<span class="sourceLineNo">059</span><a name="line.59"></a> +<span class="sourceLineNo">060</span> @Override /* Parameter */<a name="line.60"></a> +<span class="sourceLineNo">061</span> public String resolve(VarResolverSession session, String key) {<a name="line.61"></a> +<span class="sourceLineNo">062</span> RestRequest req = session.getSessionObject(RestRequest.class, SESSION_req);<a name="line.62"></a> +<span class="sourceLineNo">063</span> return req.getUriResolver().resolve(key);<a name="line.63"></a> +<span class="sourceLineNo">064</span> }<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/9b48e212/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 35a195e..3e12edd 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 @@ -26,53 +26,51 @@ <span class="sourceLineNo">018</span>import org.apache.juneau.svl.*;<a name="line.18"></a> <span class="sourceLineNo">019</span><a name="line.19"></a> <span class="sourceLineNo">020</span>/**<a name="line.20"></a> -<span class="sourceLineNo">021</span> * Resolver for resolving widget variables <js>"$W{name}"</js>.<a name="line.21"></a> +<span class="sourceLineNo">021</span> * HTML widget variable resolver.<a name="line.21"></a> <span class="sourceLineNo">022</span> *<a name="line.22"></a> <span class="sourceLineNo">023</span> * <p><a name="line.23"></a> -<span class="sourceLineNo">024</span> * Widgets are simple class that produce some sort of string based on a passed-in HTTP request.<a name="line.24"></a> +<span class="sourceLineNo">024</span> * The format for this var is <js>"$W{widgetName}"</js>.<a name="line.24"></a> <span class="sourceLineNo">025</span> *<a name="line.25"></a> <span class="sourceLineNo">026</span> * <p><a name="line.26"></a> -<span class="sourceLineNo">027</span> * They're registered via the following mechanisms:<a name="line.27"></a> -<span class="sourceLineNo">028</span> * <ul><a name="line.28"></a> -<span class="sourceLineNo">029</span> * <li>{@link RestResource#widgets() @RestResource.widgets()}<a name="line.29"></a> -<span class="sourceLineNo">030</span> * <li>{@link RestMethod#widgets() @RestMethod.widgets()}<a name="line.30"></a> -<span class="sourceLineNo">031</span> * <li>{@link RestConfig#addWidget(Class)}<a name="line.31"></a> -<span class="sourceLineNo">032</span> * </ul><a name="line.32"></a> -<span class="sourceLineNo">033</span> *<a name="line.33"></a> -<span class="sourceLineNo">034</span> * @see org.apache.juneau.svl<a name="line.34"></a> -<span class="sourceLineNo">035</span> */<a name="line.35"></a> -<span class="sourceLineNo">036</span>public class WidgetVar extends SimpleVar {<a name="line.36"></a> -<span class="sourceLineNo">037</span><a name="line.37"></a> -<span class="sourceLineNo">038</span> /**<a name="line.38"></a> -<span class="sourceLineNo">039</span> * The name of the session or context object that identifies the {@link RestRequest} object.<a name="line.39"></a> -<span class="sourceLineNo">040</span> */<a name="line.40"></a> -<span class="sourceLineNo">041</span> public static final String SESSION_req = "req";<a name="line.41"></a> -<span class="sourceLineNo">042</span><a name="line.42"></a> -<span class="sourceLineNo">043</span> /**<a name="line.43"></a> -<span class="sourceLineNo">044</span> * The name of this variable.<a name="line.44"></a> -<span class="sourceLineNo">045</span> */<a name="line.45"></a> -<span class="sourceLineNo">046</span> public static final String NAME = "W";<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> * Constructor.<a name="line.49"></a> -<span class="sourceLineNo">050</span> */<a name="line.50"></a> -<span class="sourceLineNo">051</span> public WidgetVar() {<a name="line.51"></a> -<span class="sourceLineNo">052</span> super(NAME);<a name="line.52"></a> -<span class="sourceLineNo">053</span> }<a name="line.53"></a> -<span class="sourceLineNo">054</span><a name="line.54"></a> -<span class="sourceLineNo">055</span> @Override /* Parameter */<a name="line.55"></a> -<span class="sourceLineNo">056</span> public String resolve(VarResolverSession session, String key) {<a name="line.56"></a> -<span class="sourceLineNo">057</span> RestRequest req = session.getSessionObject(RestRequest.class, SESSION_req);<a name="line.57"></a> -<span class="sourceLineNo">058</span> Widget w = req.getWidgets().get(key);<a name="line.58"></a> -<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.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> -<span class="sourceLineNo">066</span> }<a name="line.66"></a> -<span class="sourceLineNo">067</span>}<a name="line.67"></a> +<span class="sourceLineNo">027</span> * Widgets are simple class that produce some sort of string based on a passed-in HTTP request.<a name="line.27"></a> +<span class="sourceLineNo">028</span> *<a name="line.28"></a> +<span class="sourceLineNo">029</span> * <p><a name="line.29"></a> +<span class="sourceLineNo">030</span> * They're registered via the following mechanisms:<a name="line.30"></a> +<span class="sourceLineNo">031</span> * <ul><a name="line.31"></a> +<span class="sourceLineNo">032</span> * <li>{@link HtmlDoc#widgets() @HtmlDoc.widgets()}<a name="line.32"></a> +<span class="sourceLineNo">033</span> * <li>{@link RestConfig#addHtmlWidget(Class)}<a name="line.33"></a> +<span class="sourceLineNo">034</span> * </ul><a name="line.34"></a> +<span class="sourceLineNo">035</span> *<a name="line.35"></a> +<span class="sourceLineNo">036</span> * @see org.apache.juneau.svl<a name="line.36"></a> +<span class="sourceLineNo">037</span> */<a name="line.37"></a> +<span class="sourceLineNo">038</span>public class WidgetVar extends SimpleVar {<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> * The name of the session or context object that identifies the {@link RestRequest} object.<a name="line.41"></a> +<span class="sourceLineNo">042</span> */<a name="line.42"></a> +<span class="sourceLineNo">043</span> public static final String SESSION_req = "req";<a name="line.43"></a> +<span class="sourceLineNo">044</span><a name="line.44"></a> +<span class="sourceLineNo">045</span> /**<a name="line.45"></a> +<span class="sourceLineNo">046</span> * The name of this variable.<a name="line.46"></a> +<span class="sourceLineNo">047</span> */<a name="line.47"></a> +<span class="sourceLineNo">048</span> public static final String NAME = "W";<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> * Constructor.<a name="line.51"></a> +<span class="sourceLineNo">052</span> */<a name="line.52"></a> +<span class="sourceLineNo">053</span> public WidgetVar() {<a name="line.53"></a> +<span class="sourceLineNo">054</span> super(NAME);<a name="line.54"></a> +<span class="sourceLineNo">055</span> }<a name="line.55"></a> +<span class="sourceLineNo">056</span><a name="line.56"></a> +<span class="sourceLineNo">057</span> @Override /* Parameter */<a name="line.57"></a> +<span class="sourceLineNo">058</span> public String resolve(VarResolverSession session, String key) throws Exception {<a name="line.58"></a> +<span class="sourceLineNo">059</span> RestRequest req = session.getSessionObject(RestRequest.class, SESSION_req);<a name="line.59"></a> +<span class="sourceLineNo">060</span> Widget w = req.getWidgets().get(key);<a name="line.60"></a> +<span class="sourceLineNo">061</span> if (w == null)<a name="line.61"></a> +<span class="sourceLineNo">062</span> return "unknown-widget-"+key;<a name="line.62"></a> +<span class="sourceLineNo">063</span> return w.getHtml(req);<a name="line.63"></a> +<span class="sourceLineNo">064</span> }<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/9b48e212/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 index fde7cb8..2ee1dfa 100644 --- 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 @@ -31,7 +31,7 @@ <span class="sourceLineNo">023</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.23"></a> <span class="sourceLineNo">024</span> *<a name="line.24"></a> <span class="sourceLineNo">025</span> * <p><a name="line.25"></a> -<span class="sourceLineNo">026</span> * The variable it resolves is <js>"$W{contentTypeMenuItem}"</js>.<a name="line.26"></a> +<span class="sourceLineNo">026</span> * The variable it resolves is <js>"$W{ContentTypeMenuItem}"</js>.<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> * An example of this widget can be found in the <code>PetStoreResource</code> in the examples that provides<a name="line.29"></a> @@ -47,9 +47,9 @@ <span class="sourceLineNo">039</span> * links={<a name="line.39"></a> <span class="sourceLineNo">040</span> * <js>"up: ..."</js>,<a name="line.40"></a> <span class="sourceLineNo">041</span> * <js>"options: ..."</js>,<a name="line.41"></a> -<span class="sourceLineNo">042</span> * <js>"$W{queryMenuItem}"</js>,<a name="line.42"></a> -<span class="sourceLineNo">043</span> * <js>"$W{contentTypeMenuItem}"</js>,<a name="line.43"></a> -<span class="sourceLineNo">044</span> * <js>"$W{styleMenuItem}"</js>,<a name="line.44"></a> +<span class="sourceLineNo">042</span> * <js>"$W{QueryMenuItem}"</js>,<a name="line.42"></a> +<span class="sourceLineNo">043</span> * <js>"$W{ContentTypeMenuItem}"</js>,<a name="line.43"></a> +<span class="sourceLineNo">044</span> * <js>"$W{StyleMenuItem}"</js>,<a name="line.44"></a> <span class="sourceLineNo">045</span> * <js>"source: ..."</js><a name="line.45"></a> <span class="sourceLineNo">046</span> * }<a name="line.46"></a> <span class="sourceLineNo">047</span> * )<a name="line.47"></a> @@ -64,38 +64,30 @@ <span class="sourceLineNo">056</span>public class ContentTypeMenuItem extends MenuItemWidget {<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> * Returns <js>"contentTypeMenuItem"</js>.<a name="line.59"></a> -<span class="sourceLineNo">060</span> */<a name="line.60"></a> -<span class="sourceLineNo">061</span> @Override /* Widget */<a name="line.61"></a> -<span class="sourceLineNo">062</span> public String getName() {<a name="line.62"></a> -<span class="sourceLineNo">063</span> return "contentTypeMenuItem";<a name="line.63"></a> -<span class="sourceLineNo">064</span> }<a name="line.64"></a> -<span class="sourceLineNo">065</span><a name="line.65"></a> -<span class="sourceLineNo">066</span> /**<a name="line.66"></a> -<span class="sourceLineNo">067</span> * Looks at the supported media types from the request and constructs a list of hyperlinks to render the data<a name="line.67"></a> -<span class="sourceLineNo">068</span> * as plain-text.<a name="line.68"></a> -<span class="sourceLineNo">069</span> */<a name="line.69"></a> -<span class="sourceLineNo">070</span> @Override /* Widget */<a name="line.70"></a> -<span class="sourceLineNo">071</span> public String getHtml(RestRequest req) throws Exception {<a name="line.71"></a> -<span class="sourceLineNo">072</span> StringBuilder sb = new StringBuilder();<a name="line.72"></a> -<span class="sourceLineNo">073</span> sb.append(""<a name="line.73"></a> -<span class="sourceLineNo">074</span> + "<div class='menu-item'>"<a name="line.74"></a> -<span class="sourceLineNo">075</span> + "\n\t<a class='link' onclick='menuClick(this)'>content-types</a>"<a name="line.75"></a> -<span class="sourceLineNo">076</span> + "\n\t<div class='popup-content'>"<a name="line.76"></a> -<span class="sourceLineNo">077</span> );<a name="line.77"></a> -<span class="sourceLineNo">078</span> List<MediaType> l = new ArrayList<MediaType>(req.getSerializerGroup().getSupportedMediaTypes());<a name="line.78"></a> -<span class="sourceLineNo">079</span> Collections.sort(l);<a name="line.79"></a> -<span class="sourceLineNo">080</span> for (MediaType mt : l) {<a name="line.80"></a> -<span class="sourceLineNo">081</span> URI uri = req.getUri(true, new AMap<String,String>().append("plainText","true").append("Accept",mt.toString()));<a name="line.81"></a> -<span class="sourceLineNo">082</span> sb.append("\n\t\t<a class='link' href='").append(uri).append("'>").append(mt).append("</a><br>");<a name="line.82"></a> -<span class="sourceLineNo">083</span> }<a name="line.83"></a> -<span class="sourceLineNo">084</span> sb.append(""<a name="line.84"></a> -<span class="sourceLineNo">085</span> + "\n\t</div>"<a name="line.85"></a> -<span class="sourceLineNo">086</span> + "\n</div>"<a name="line.86"></a> -<span class="sourceLineNo">087</span> );<a name="line.87"></a> -<span class="sourceLineNo">088</span> return sb.toString();<a name="line.88"></a> -<span class="sourceLineNo">089</span> }<a name="line.89"></a> -<span class="sourceLineNo">090</span>}<a name="line.90"></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> StringBuilder sb = new StringBuilder();<a name="line.64"></a> +<span class="sourceLineNo">065</span> sb.append(""<a name="line.65"></a> +<span class="sourceLineNo">066</span> + "<div class='menu-item'>"<a name="line.66"></a> +<span class="sourceLineNo">067</span> + "\n\t<a class='link' onclick='menuClick(this)'>content-types</a>"<a name="line.67"></a> +<span class="sourceLineNo">068</span> + "\n\t<div class='popup-content'>"<a name="line.68"></a> +<span class="sourceLineNo">069</span> );<a name="line.69"></a> +<span class="sourceLineNo">070</span> List<MediaType> l = new ArrayList<MediaType>(req.getSerializerGroup().getSupportedMediaTypes());<a name="line.70"></a> +<span class="sourceLineNo">071</span> Collections.sort(l);<a name="line.71"></a> +<span class="sourceLineNo">072</span> for (MediaType mt : l) {<a name="line.72"></a> +<span class="sourceLineNo">073</span> URI uri = req.getUri(true, new AMap<String,String>().append("plainText","true").append("Accept",mt.toString()));<a name="line.73"></a> +<span class="sourceLineNo">074</span> sb.append("\n\t\t<a class='link' href='").append(uri).append("'>").append(mt).append("</a><br>");<a name="line.74"></a> +<span class="sourceLineNo">075</span> }<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> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/src-html/org/apache/juneau/rest/widget/PoweredByApache.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/widget/PoweredByApache.html b/content/site/apidocs/src-html/org/apache/juneau/rest/widget/PoweredByApache.html new file mode 100644 index 0000000..eff06cb --- /dev/null +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/widget/PoweredByApache.html @@ -0,0 +1,129 @@ +<!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 org.apache.juneau.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span>import org.apache.juneau.rest.*;<a name="line.16"></a> +<span class="sourceLineNo">017</span><a name="line.17"></a> +<span class="sourceLineNo">018</span>/**<a name="line.18"></a> +<span class="sourceLineNo">019</span> * Widget that places a powered-by-Apache message on the page.<a name="line.19"></a> +<span class="sourceLineNo">020</span> *<a name="line.20"></a> +<span class="sourceLineNo">021</span> * <p><a name="line.21"></a> +<span class="sourceLineNo">022</span> * The variable it resolves is <js>"$W{PoweredByApache}"</js>.<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> * It produces a simple Apache icon floating on the right.<a name="line.25"></a> +<span class="sourceLineNo">026</span> * Typically it's used in the footer of the page, as shown below in the <code>RootResources</code> from the examples:<a name="line.26"></a> +<span class="sourceLineNo">027</span> *<a name="line.27"></a> +<span class="sourceLineNo">028</span> * <p class='bcode'><a name="line.28"></a> +<span class="sourceLineNo">029</span> * <ja>@RestResource</ja>(<a name="line.29"></a> +<span class="sourceLineNo">030</span> * path=<js>"/"</js>,<a name="line.30"></a> +<span class="sourceLineNo">031</span> * title=<js>"Root resources"</js>,<a name="line.31"></a> +<span class="sourceLineNo">032</span> * description=<js>"Example of a router resource page."</js>,<a name="line.32"></a> +<span class="sourceLineNo">033</span> * widgets={<a name="line.33"></a> +<span class="sourceLineNo">034</span> * PoweredByApache.<jk>class</jk><a name="line.34"></a> +<span class="sourceLineNo">035</span> * },<a name="line.35"></a> +<span class="sourceLineNo">036</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.36"></a> +<span class="sourceLineNo">037</span> * footer=<js>"$W{PoweredByApache}"</js><a name="line.37"></a> +<span class="sourceLineNo">038</span> * )<a name="line.38"></a> +<span class="sourceLineNo">039</span> * </p><a name="line.39"></a> +<span class="sourceLineNo">040</span> *<a name="line.40"></a> +<span class="sourceLineNo">041</span> * <p><a name="line.41"></a> +<span class="sourceLineNo">042</span> * It renders the following image:<a name="line.42"></a> +<span class="sourceLineNo">043</span> * <img class='bordered' src='doc-files/PoweredByApacheWidget.png'><a name="line.43"></a> +<span class="sourceLineNo">044</span> */<a name="line.44"></a> +<span class="sourceLineNo">045</span>public class PoweredByApache extends Widget {<a name="line.45"></a> +<span class="sourceLineNo">046</span><a name="line.46"></a> +<span class="sourceLineNo">047</span> /**<a name="line.47"></a> +<span class="sourceLineNo">048</span> * Returns an Apache image tag hyperlinked to <js>"http://apache.org"</js><a name="line.48"></a> +<span class="sourceLineNo">049</span> */<a name="line.49"></a> +<span class="sourceLineNo">050</span> @Override /* Widget */<a name="line.50"></a> +<span class="sourceLineNo">051</span> public String getHtml(RestRequest req) throws Exception {<a name="line.51"></a> +<span class="sourceLineNo">052</span> UriResolver r = req.getUriResolver();<a name="line.52"></a> +<span class="sourceLineNo">053</span> return "<a href='http://apache.org'><img style='float:right;padding-right:20px;height:32px' src='"+r.resolve("servlet:/htdocs/asf.png")+"'>";<a name="line.53"></a> +<span class="sourceLineNo">054</span> }<a name="line.54"></a> +<span class="sourceLineNo">055</span>}<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> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html>
