Update javadocs Project: http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/commit/c4956832 Tree: http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/tree/c4956832 Diff: http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/diff/c4956832
Branch: refs/heads/asf-site Commit: c4956832d401a2881cd10b1c816b3d513c1e87e5 Parents: 85dc92a Author: JamesBognar <[email protected]> Authored: Tue Jul 11 09:06:32 2017 -0400 Committer: JamesBognar <[email protected]> Committed: Tue Jul 11 09:06:32 2017 -0400 ---------------------------------------------------------------------- .../org/apache/juneau/rest/RestContext.html | 4 +- .../org/apache/juneau/rest/RestRequest.html | 69 +- .../apache/juneau/rest/annotation/HtmlDoc.html | 290 ++++--- .../juneau/rest/annotation/RestMethod.html | 66 +- .../juneau/rest/annotation/RestResource.html | 46 +- content/site/apidocs/overview-summary.html | 11 +- .../org/apache/juneau/rest/RestContext.html | 4 +- .../org/apache/juneau/rest/RestRequest.html | 751 ++++++++++--------- .../apache/juneau/rest/annotation/HtmlDoc.html | 648 ++++++++-------- .../juneau/rest/annotation/RestMethod.html | 502 +++++++------ .../juneau/rest/annotation/RestResource.html | 636 ++++++++-------- 11 files changed, 1604 insertions(+), 1423 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/c4956832/content/site/apidocs/org/apache/juneau/rest/RestContext.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/RestContext.html b/content/site/apidocs/org/apache/juneau/rest/RestContext.html index 4a58714..6e19c0b 100644 --- a/content/site/apidocs/org/apache/juneau/rest/RestContext.html +++ b/content/site/apidocs/org/apache/juneau/rest/RestContext.html @@ -954,8 +954,8 @@ extends <a href="../../../../org/apache/juneau/Context.html" title="class in org <ul> <li><code>$C{key[,defaultValue]}</code> - Config file entry. See <a href="../../../../org/apache/juneau/svl/vars/ConfigFileVar.html" title="class in org.apache.juneau.svl.vars"><code>ConfigFileVar</code></a>. <li><code>$E{envVar[,defaultValue]}</code> - Environment variable. See <a href="../../../../org/apache/juneau/svl/vars/EnvVariablesVar.html" title="class in org.apache.juneau.svl.vars"><code>EnvVariablesVar</code></a>. - <li><code>$F{key[,defaultValue]}</code> - File resource. See <a href="../../../../org/apache/juneau/rest/vars/FileVar.html" title="class in org.apache.juneau.rest.vars"><code>FileVar</code></a>. - <li><code>$I{key[,defaultValue]}</code> - Servlet init parameter. See <a href="../../../../org/apache/juneau/rest/vars/ServletInitParamVar.html" title="class in org.apache.juneau.rest.vars"><code>ServletInitParamVar</code></a>. + <li><code>$F{path[,defaultValue]}</code> - File resource. See <a href="../../../../org/apache/juneau/rest/vars/FileVar.html" title="class in org.apache.juneau.rest.vars"><code>FileVar</code></a>. + <li><code>$I{name[,defaultValue]}</code> - Servlet init parameter. See <a href="../../../../org/apache/juneau/rest/vars/ServletInitParamVar.html" title="class in org.apache.juneau.rest.vars"><code>ServletInitParamVar</code></a>. <li><code>$L{key[,args...]}</code> - Localized message. See <a href="../../../../org/apache/juneau/rest/vars/LocalizationVar.html" title="class in org.apache.juneau.rest.vars"><code>LocalizationVar</code></a>. <li><code>$R{key[,args...]}</code> - Request variable. See <a href="../../../../org/apache/juneau/rest/vars/RequestVar.html" title="class in org.apache.juneau.rest.vars"><code>RequestVar</code></a>. <li><code>$S{systemProperty[,defaultValue]}</code> - System property. See <a href="../../../../org/apache/juneau/svl/vars/SystemPropertiesVar.html" title="class in org.apache.juneau.svl.vars"><code>SystemPropertiesVar</code></a>. http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/c4956832/content/site/apidocs/org/apache/juneau/rest/RestRequest.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/RestRequest.html b/content/site/apidocs/org/apache/juneau/rest/RestRequest.html index dc25b95..72531a9 100644 --- a/content/site/apidocs/org/apache/juneau/rest/RestRequest.html +++ b/content/site/apidocs/org/apache/juneau/rest/RestRequest.html @@ -1063,10 +1063,25 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getSiteName</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.801">getSiteName</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.816">getSiteName</a>()</pre> <div class="block">Returns the localized site name. <p> + The site name is intended to be a title that can be applied to the entire site. + + <p> + One possible use is if you want to add the same title to the top of all pages by defining a header on a + common parent class like so: + <p class='bcode'> + htmldoc=<ja>@HtmlDoc</ja>( + header={ + <js>"<h1>$R{siteName}</h1>"</js>, + <js>"<h2>$R{servletTitle}</h2>"</js> + } + ) + </p> + + <p> Equivalent to calling <a href="../../../../org/apache/juneau/rest/RestInfoProvider.html#getSiteName-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getSiteName(RestRequest)</code></a> with this object.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -1080,7 +1095,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getServletTitle</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.813">getServletTitle</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.828">getServletTitle</a>()</pre> <div class="block">Returns the localized servlet title. <p> @@ -1097,7 +1112,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getServletDescription</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.825">getServletDescription</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.840">getServletDescription</a>()</pre> <div class="block">Returns the localized servlet description. <p> @@ -1114,7 +1129,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getMethodSummary</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.837">getMethodSummary</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.852">getMethodSummary</a>()</pre> <div class="block">Returns the localized method summary. <p> @@ -1131,7 +1146,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getMethodDescription</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.849">getMethodDescription</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.864">getMethodDescription</a>()</pre> <div class="block">Returns the localized method description. <p> @@ -1148,7 +1163,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getStylesheet</h4> -<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.862">getStylesheet</a>()</pre> +<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.877">getStylesheet</a>()</pre> <div class="block">Returns the value of the <jk>"stylesheet"</js> parameter.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -1162,7 +1177,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getSerializerGroup</h4> -<pre>public <a href="../../../../org/apache/juneau/serializer/SerializerGroup.html" title="class in org.apache.juneau.serializer">SerializerGroup</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.871">getSerializerGroup</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/serializer/SerializerGroup.html" title="class in org.apache.juneau.serializer">SerializerGroup</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.886">getSerializerGroup</a>()</pre> <div class="block">Returns the serializers associated with this request.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -1176,7 +1191,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getParserGroup</h4> -<pre>public <a href="../../../../org/apache/juneau/parser/ParserGroup.html" title="class in org.apache.juneau.parser">ParserGroup</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.880">getParserGroup</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/parser/ParserGroup.html" title="class in org.apache.juneau.parser">ParserGroup</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.895">getParserGroup</a>()</pre> <div class="block">Returns the parsers associated with this request.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -1190,7 +1205,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getMethod</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.893">getMethod</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.908">getMethod</a>()</pre> <div class="block">Returns the method of this request. <p> @@ -1210,7 +1225,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getHttpMethod</h4> -<pre>public <a href="../../../../org/apache/juneau/http/HttpMethod.html" title="enum in org.apache.juneau.http">HttpMethod</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.905">getHttpMethod</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/http/HttpMethod.html" title="enum in org.apache.juneau.http">HttpMethod</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.920">getHttpMethod</a>()</pre> <div class="block">Returns the HTTP 1.1 method name of the request as an enum. <p> @@ -1227,7 +1242,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getContentLength</h4> -<pre>public int <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.910">getContentLength</a>()</pre> +<pre>public int <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.925">getContentLength</a>()</pre> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getContentLength--"; title="class or interface in javax.servlet">getContentLength</a></code> in interface <code><a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true"; title="class or interface in javax.servlet">ServletRequest</a></code></dd> @@ -1242,7 +1257,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>isPlainText</h4> -<pre>public boolean <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.930">isPlainText</a>()</pre> +<pre>public boolean <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.945">isPlainText</a>()</pre> <div class="block">Returns <jk>true</jk> if <code>&plainText=true</code> was specified as a URL parameter. <p> @@ -1263,7 +1278,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getMessage</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.941">getMessage</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> key, +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.956">getMessage</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> key, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>... args)</pre> <div class="block">Shortcut method for calling <a href="../../../../org/apache/juneau/utils/MessageBundle.html#getString-java.util.Locale-java.lang.String-java.lang.Object...-"><code>MessageBundle.getString(Locale, String, Object...)</code></a> based on the request locale.</div> <dl> @@ -1281,7 +1296,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getResourceBundle</h4> -<pre>public <a href="../../../../org/apache/juneau/utils/MessageBundle.html" title="class in org.apache.juneau.utils">MessageBundle</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.950">getResourceBundle</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/utils/MessageBundle.html" title="class in org.apache.juneau.utils">MessageBundle</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.965">getResourceBundle</a>()</pre> <div class="block">Returns the resource bundle for the request locale.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -1295,7 +1310,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getContext</h4> -<pre>public <a href="../../../../org/apache/juneau/rest/RestContext.html" title="class in org.apache.juneau.rest">RestContext</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.963">getContext</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/rest/RestContext.html" title="class in org.apache.juneau.rest">RestContext</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.978">getContext</a>()</pre> <div class="block">Returns the servlet handling the request. <p> @@ -1313,7 +1328,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getJavaMethod</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Method.html?is-external=true"; title="class or interface in java.lang.reflect">Method</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.982">getJavaMethod</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Method.html?is-external=true"; title="class or interface in java.lang.reflect">Method</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.997">getJavaMethod</a>()</pre> <div class="block">Returns the java method handling the request. <p> @@ -1337,7 +1352,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getBeanSession</h4> -<pre>public <a href="../../../../org/apache/juneau/BeanSession.html" title="class in org.apache.juneau">BeanSession</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.991">getBeanSession</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/BeanSession.html" title="class in org.apache.juneau">BeanSession</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1006">getBeanSession</a>()</pre> <div class="block">Returns the <a href="../../../../org/apache/juneau/BeanSession.html" title="class in org.apache.juneau"><code>BeanSession</code></a> associated with this request.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -1351,7 +1366,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getVarResolverSession</h4> -<pre>public <a href="../../../../org/apache/juneau/svl/VarResolverSession.html" title="class in org.apache.juneau.svl">VarResolverSession</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1004">getVarResolverSession</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/svl/VarResolverSession.html" title="class in org.apache.juneau.svl">VarResolverSession</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1019">getVarResolverSession</a>()</pre> <div class="block">Returns the variable resolver session for this request using session objects created by <a href="../../../../org/apache/juneau/rest/RestCallHandler.html#getSessionObjects-org.apache.juneau.rest.RestRequest-"><code>RestCallHandler.getSessionObjects(RestRequest)</code></a>. @@ -1369,7 +1384,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>resolveVars</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1016">resolveVars</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> input)</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1031">resolveVars</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> input)</pre> <div class="block">Shortcut for calling <code>getVarResolverSession().resolve(input)</code>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -1385,7 +1400,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getReaderResource</h4> -<pre>public <a href="../../../../org/apache/juneau/rest/ReaderResource.html" title="class in org.apache.juneau.rest">ReaderResource</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1033">getReaderResource</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, +<pre>public <a href="../../../../org/apache/juneau/rest/ReaderResource.html" title="class in org.apache.juneau.rest">ReaderResource</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1048">getReaderResource</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, boolean resolveVars, <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> mediaType) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> @@ -1411,7 +1426,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getReaderResource</h4> -<pre>public <a href="../../../../org/apache/juneau/rest/ReaderResource.html" title="class in org.apache.juneau.rest">ReaderResource</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1055">getReaderResource</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, +<pre>public <a href="../../../../org/apache/juneau/rest/ReaderResource.html" title="class in org.apache.juneau.rest">ReaderResource</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1070">getReaderResource</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, boolean resolveVars) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> <div class="block">Same as <a href="../../../../org/apache/juneau/rest/RestRequest.html#getReaderResource-java.lang.String-boolean-org.apache.juneau.http.MediaType-"><code>getReaderResource(String, boolean, MediaType)</code></a> except uses the resource mime-type map @@ -1435,7 +1450,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getReaderResource</h4> -<pre>public <a href="../../../../org/apache/juneau/rest/ReaderResource.html" title="class in org.apache.juneau.rest">ReaderResource</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1066">getReaderResource</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name) +<pre>public <a href="../../../../org/apache/juneau/rest/ReaderResource.html" title="class in org.apache.juneau.rest">ReaderResource</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1081">getReaderResource</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> <div class="block">Same as <a href="../../../../org/apache/juneau/rest/RestRequest.html#getReaderResource-java.lang.String-boolean-"><code>getReaderResource(String, boolean)</code></a> with <code>resolveVars == <jk>false</jk></code></div> <dl> @@ -1454,7 +1469,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getConfigFile</h4> -<pre>public <a href="../../../../org/apache/juneau/ini/ConfigFile.html" title="class in org.apache.juneau.ini">ConfigFile</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1077">getConfigFile</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/ini/ConfigFile.html" title="class in org.apache.juneau.ini">ConfigFile</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1092">getConfigFile</a>()</pre> <div class="block">Returns the config file associated with the servlet.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -1469,7 +1484,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getSwagger</h4> -<pre>public <a href="../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1090">getSwagger</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1105">getSwagger</a>()</pre> <div class="block">Returns the localized swagger associated with the servlet.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -1484,7 +1499,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getWidgets</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/juneau/rest/widget/Widget.html" title="class in org.apache.juneau.rest.widget">Widget</a>> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1103">getWidgets</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/juneau/rest/widget/Widget.html" title="class in org.apache.juneau.rest.widget">Widget</a>> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1118">getWidgets</a>()</pre> <div class="block">Returns the widgets used for resolving <js>"$W{...}"</js> string variables.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -1499,7 +1514,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getSwaggerFromFile</h4> -<pre>protected <a href="../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1119">getSwaggerFromFile</a>()</pre> +<pre>protected <a href="../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1134">getSwaggerFromFile</a>()</pre> <div class="block">Returns the localized Swagger from the file system. <p> @@ -1520,7 +1535,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockListLast"> <li class="blockList"> <h4>toString</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1128">toString</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/rest/RestRequest.html#line.1143">toString</a>()</pre> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></dd> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/c4956832/content/site/apidocs/org/apache/juneau/rest/annotation/HtmlDoc.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/HtmlDoc.html b/content/site/apidocs/org/apache/juneau/rest/annotation/HtmlDoc.html index 25ea5ea..06c3183 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/HtmlDoc.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/HtmlDoc.html @@ -260,7 +260,7 @@ <ul class="blockList"> <li class="blockList"> <h4>header</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.114">header</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.119">header</a></pre> <div class="block">Sets the HTML header section contents. <p> @@ -281,19 +281,24 @@ ) </p> - <p> - A value of <js>"NONE"</js> can be used to force no header. - - <p> - This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). - <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. - - <p> - Multiple values are combined with newlines into a single string. - - <p> - The programmatic equivalent to this annotation are the - <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlHeader-java.lang.String-"><code>RestConfig.setHtmlHeader(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlHeader-java.lang.Object-"><code>RestResponse.setHtmlHeader(Object)</code></a> methods.</div> + <h6 class='topic'>Other Notes</h6> + <ul class='spaced-list'> + <li> + A value of <js>"NONE"</js> can be used to force no header. + <li> + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. + <li> + Multiple values are combined with newlines into a single string. + <li> + The programmatic equivalent to this annotation are the + <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlHeader-java.lang.String-"><code>RestConfig.setHtmlHeader(String)</code></a> and <a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlHeader-java.lang.Object-"><code>RestResponse.setHtmlHeader(Object)</code></a> methods. + <li> + On methods, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the servlet/resource class. + <li> + On servlet/resource classes, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the + parent class. + </ul></div> <dl> <dt>Default:</dt> <dd>{}</dd> @@ -309,7 +314,7 @@ <ul class="blockList"> <li class="blockList"> <h4>links</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.156">links</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.166">links</a></pre> <div class="block">Sets the links in the HTML nav section. <p> @@ -335,19 +340,24 @@ ) </p> - <p> - This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). - <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. - - <p> - A value of <js>"NONE"</js> can be used to force no value. - - <p> - This field can also use URIs of any support type in <a href="../../../../../org/apache/juneau/UriResolver.html" title="class in org.apache.juneau"><code>UriResolver</code></a>. - - <p> - The programmatic equivalent to this annotation are the - <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlLinks-java.lang.String:A-"><code>RestConfig.setHtmlLinks(String[])</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlLinks-java.lang.String:A-"><code>RestResponse.setHtmlLinks(String[])</code></a> methods.</div> + <h6 class='topic'>Other Notes</h6> + <ul class='spaced-list'> + <li> + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. + <li> + A value of <js>"NONE"</js> can be used to force no value. + <li> + This field can also use URIs of any support type in <a href="../../../../../org/apache/juneau/UriResolver.html" title="class in org.apache.juneau"><code>UriResolver</code></a>. + <li> + The programmatic equivalent to this annotation are the + <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlLinks-java.lang.String:A-"><code>RestConfig.setHtmlLinks(String[])</code></a> and <a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlLinks-java.lang.String:A-"><code>RestResponse.setHtmlLinks(String[])</code></a> methods. + <li> + On methods, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the servlet/resource class. + <li> + On servlet/resource classes, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the + parent class. + </ul></div> <dl> <dt>Default:</dt> <dd>{}</dd> @@ -363,7 +373,7 @@ <ul class="blockList"> <li class="blockList"> <h4>nav</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.198">nav</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.212">nav</a></pre> <div class="block">Sets the HTML nav section contents. <p> @@ -386,22 +396,26 @@ ) </p> - <p> - When a value is specified, the <a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#links--"><code>links()</code></a> value will be ignored. - - <p> - This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). - <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. - - <p> - A value of <js>"NONE"</js> can be used to force no value. - - <p> - Multiple values are combined with newlines into a single string. - - <p> - The programmatic equivalent to this annotation are the - <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlNav-java.lang.String-"><code>RestConfig.setHtmlNav(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlNav-java.lang.Object-"><code>RestResponse.setHtmlNav(Object)</code></a> methods.</div> + <h6 class='topic'>Other Notes</h6> + <ul class='spaced-list'> + <li> + When a value is specified, the <a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#links--"><code>links()</code></a> value will be ignored. + <li> + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. + <li> + A value of <js>"NONE"</js> can be used to force no value. + <li> + Multiple values are combined with newlines into a single string. + <li> + The programmatic equivalent to this annotation are the + <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlNav-java.lang.String-"><code>RestConfig.setHtmlNav(String)</code></a> and <a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlNav-java.lang.Object-"><code>RestResponse.setHtmlNav(Object)</code></a> methods. + <li> + On methods, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the servlet/resource class. + <li> + On servlet/resource classes, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the + parent class. + </ul></div> <dl> <dt>Default:</dt> <dd>{}</dd> @@ -417,7 +431,7 @@ <ul class="blockList"> <li class="blockList"> <h4>aside</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.234">aside</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.253">aside</a></pre> <div class="block">Sets the HTML aside section contents. <p> @@ -437,19 +451,24 @@ ) </p> - <p> - This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). - <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. - - <p> - A value of <js>"NONE"</js> can be used to force no value. - - <p> - Multiple values are combined with newlines into a single string. - - <p> - The programmatic equivalent to this annotation are the - <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlAside-java.lang.String-"><code>RestConfig.setHtmlAside(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlAside-java.lang.Object-"><code>RestResponse.setHtmlAside(Object)</code></a> methods.</div> + <h6 class='topic'>Other Notes</h6> + <ul class='spaced-list'> + <li> + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. + <li> + A value of <js>"NONE"</js> can be used to force no value. + <li> + Multiple values are combined with newlines into a single string. + <li> + The programmatic equivalent to this annotation are the + <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlAside-java.lang.String-"><code>RestConfig.setHtmlAside(String)</code></a> and <a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlAside-java.lang.Object-"><code>RestResponse.setHtmlAside(Object)</code></a> methods. + <li> + On methods, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the servlet/resource class. + <li> + On servlet/resource classes, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the + parent class. + </ul></div> <dl> <dt>Default:</dt> <dd>{}</dd> @@ -465,7 +484,7 @@ <ul class="blockList"> <li class="blockList"> <h4>footer</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.270">footer</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.294">footer</a></pre> <div class="block">Sets the HTML footer section contents. <p> @@ -485,19 +504,24 @@ ) </p> - <p> - This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). - <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. - - <p> - A value of <js>"NONE"</js> can be used to force no value. - - <p> - Multiple values are combined with newlines into a single string. - - <p> - The programmatic equivalent to this annotation are the - <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlFooter-java.lang.String-"><code>RestConfig.setHtmlFooter(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlFooter-java.lang.Object-"><code>RestResponse.setHtmlFooter(Object)</code></a> methods.</div> + <h6 class='topic'>Other Notes</h6> + <ul class='spaced-list'> + <li> + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. + <li> + A value of <js>"NONE"</js> can be used to force no value. + <li> + Multiple values are combined with newlines into a single string. + <li> + The programmatic equivalent to this annotation are the + <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlFooter-java.lang.String-"><code>RestConfig.setHtmlFooter(String)</code></a> and <a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlFooter-java.lang.Object-"><code>RestResponse.setHtmlFooter(Object)</code></a> methods. + <li> + On methods, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the servlet/resource class. + <li> + On servlet/resource classes, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the + parent class. + </ul></div> <dl> <dt>Default:</dt> <dd>{}</dd> @@ -513,7 +537,7 @@ <ul class="blockList"> <li class="blockList"> <h4>style</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.304">style</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.333">style</a></pre> <div class="block">Sets the HTML CSS style section contents. <p> @@ -531,19 +555,24 @@ ) </p> - <p> - This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). - <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. - - <p> - A value of <js>"NONE"</js> can be used to force no value. - - <p> - Multiple values are combined with newlines into a single string. - - <p> - The programmatic equivalent to this annotation are the - <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlStyle-java.lang.String-"><code>RestConfig.setHtmlStyle(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlStyle-java.lang.Object-"><code>RestResponse.setHtmlStyle(Object)</code></a> methods.</div> + <h6 class='topic'>Other Notes</h6> + <ul class='spaced-list'> + <li> + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. + <li> + A value of <js>"NONE"</js> can be used to force no value. + <li> + Multiple values are combined with newlines into a single string. + <li> + The programmatic equivalent to this annotation are the + <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlStyle-java.lang.String-"><code>RestConfig.setHtmlStyle(String)</code></a> and <a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlStyle-java.lang.Object-"><code>RestResponse.setHtmlStyle(Object)</code></a> methods. + <li> + On methods, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the servlet/resource class. + <li> + On servlet/resource classes, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the + parent class. + </ul></div> <dl> <dt>Default:</dt> <dd>{}</dd> @@ -559,7 +588,7 @@ <ul class="blockList"> <li class="blockList"> <h4>stylesheet</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.336">stylesheet</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.372">stylesheet</a></pre> <div class="block">Sets the CSS URL in the HTML CSS style section. <p> @@ -580,14 +609,21 @@ ) </p> - <p> - This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>) and can use URL protocols defined - by <a href="../../../../../org/apache/juneau/UriResolver.html" title="class in org.apache.juneau"><code>UriResolver</code></a>. - <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. - - <p> - The programmatic equivalent to this annotation are the - <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlStylesheet-java.lang.String-"><code>RestConfig.setHtmlStylesheet(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlStylesheet-java.lang.Object-"><code>RestResponse.setHtmlStylesheet(Object)</code></a> methods.</div> + <h6 class='topic'>Other Notes</h6> + <ul class='spaced-list'> + <li> + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>) and can use URL protocols + defined by <a href="../../../../../org/apache/juneau/UriResolver.html" title="class in org.apache.juneau"><code>UriResolver</code></a>. + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. + <li> + The programmatic equivalent to this annotation are the + <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlStylesheet-java.lang.String-"><code>RestConfig.setHtmlStylesheet(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlStylesheet-java.lang.Object-"><code>RestResponse.setHtmlStylesheet(Object)</code></a> methods. + <li> + On methods, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the servlet/resource class. + <li> + On servlet/resource classes, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the + parent class. + </ul></div> <dl> <dt>Default:</dt> <dd>""</dd> @@ -603,7 +639,7 @@ <ul class="blockList"> <li class="blockList"> <h4>script</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.369">script</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.410">script</a></pre> <div class="block">Sets the HTML script section contents. <p> @@ -620,19 +656,24 @@ ) </p> - <p> - This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). - <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. - - <p> - A value of <js>"NONE"</js> can be used to force no value. - - <p> - Multiple values are combined with newlines into a single string. - - <p> - The programmatic equivalent to this annotation are the - <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlScript-java.lang.String-"><code>RestConfig.setHtmlScript(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlScript-java.lang.Object-"><code>RestResponse.setHtmlScript(Object)</code></a> methods.</div> + <h6 class='topic'>Other Notes</h6> + <ul class='spaced-list'> + <li> + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. + <li> + A value of <js>"NONE"</js> can be used to force no value. + <li> + Multiple values are combined with newlines into a single string. + <li> + The programmatic equivalent to this annotation are the + <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlScript-java.lang.String-"><code>RestConfig.setHtmlScript(String)</code></a> and <a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlScript-java.lang.Object-"><code>RestResponse.setHtmlScript(Object)</code></a> methods. + <li> + On methods, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the servlet/resource class. + <li> + On servlet/resource classes, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the + parent class. + </ul></div> <dl> <dt>Default:</dt> <dd>{}</dd> @@ -648,7 +689,7 @@ <ul class="blockList"> <li class="blockList"> <h4>nowrap</h4> -<pre>public abstract boolean <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.377">nowrap</a></pre> +<pre>public abstract boolean <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.418">nowrap</a></pre> <div class="block">Shorthand method for forcing the rendered HTML content to be no-wrap. <p> @@ -668,7 +709,7 @@ <ul class="blockList"> <li class="blockList"> <h4>noResultsMessage</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.382">noResultsMessage</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.423">noResultsMessage</a></pre> <div class="block">Specifies the text to display when serializing an empty array or collection.</div> <dl> <dt>Default:</dt> @@ -685,16 +726,24 @@ <ul class="blockList"> <li class="blockList"> <h4>template</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/html/HtmlDocTemplate.html" title="interface in org.apache.juneau.html">HtmlDocTemplate</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.395">template</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/html/HtmlDocTemplate.html" title="interface in org.apache.juneau.html">HtmlDocTemplate</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.444">template</a></pre> <div class="block">Specifies the template class to use for rendering the HTML page. <p> By default, uses <a href="../../../../../org/apache/juneau/html/HtmlDocTemplateBasic.html" title="class in org.apache.juneau.html"><code>HtmlDocTemplateBasic</code></a> to render the contents, although you can provide your own custom renderer or subclasses from the basic class to have full control over how the page is rendered. - <p> - The programmatic equivalent to this annotation are the - <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlTemplate-java.lang.Class-"><code>RestConfig.setHtmlTemplate(Class)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlTemplate-java.lang.Class-"><code>RestResponse.setHtmlTemplate(Class)</code></a> methods.</div> + <h6 class='topic'>Other Notes</h6> + <ul class='spaced-list'> + <li> + The programmatic equivalent to this annotation are the + <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlTemplate-java.lang.Class-"><code>RestConfig.setHtmlTemplate(Class)</code></a> and <a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlTemplate-java.lang.Class-"><code>RestResponse.setHtmlTemplate(Class)</code></a> methods. + <li> + On methods, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the servlet/resource class. + <li> + On servlet/resource classes, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the + parent class. + </ul></div> <dl> <dt>Default:</dt> <dd>org.apache.juneau.html.HtmlDocTemplate.class</dd> @@ -710,12 +759,15 @@ <ul class="blockListLast"> <li class="blockList"> <h4>widgets</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/widget/Widget.html" title="class in org.apache.juneau.rest.widget">Widget</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.404">widgets</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/widget/Widget.html" title="class in org.apache.juneau.rest.widget">Widget</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.456">widgets</a></pre> <div class="block">Defines widgets that can be used in conjunction with string variables of the form <js>"$W{name}"</js>to quickly generate arbitrary replacement HTML. - <p> - Widgets are inherited from parent to child, but can be overridden by reusing the widget name.</div> + <h6 class='topic'>Other Notes</h6> + <ul class='spaced-list'> + <li> + Widgets are inherited from parent to child, but can be overridden by reusing the widget name. + </ul></div> <dl> <dt>Default:</dt> <dd>{}</dd> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/c4956832/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html b/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html index d697c65..8f38b6f 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html @@ -125,15 +125,15 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota </td> </tr> <tr class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#bpExcludes--">bpExcludes</a></span></code> -<div class="block">Shortcut for specifying the <a href="../../../../../org/apache/juneau/BeanContext.html#BEAN_excludeProperties"><code>BeanContext.BEAN_excludeProperties</code></a> property on all serializers.</div> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#bpi--">bpi</a></span></code> +<div class="block">Shortcut for specifying the <a href="../../../../../org/apache/juneau/BeanContext.html#BEAN_includeProperties"><code>BeanContext.BEAN_includeProperties</code></a> property on all serializers.</div> </td> </tr> <tr class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#bpIncludes--">bpIncludes</a></span></code> -<div class="block">Shortcut for specifying the <a href="../../../../../org/apache/juneau/BeanContext.html#BEAN_includeProperties"><code>BeanContext.BEAN_includeProperties</code></a> property on all serializers.</div> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#bpx--">bpx</a></span></code> +<div class="block">Shortcut for specifying the <a href="../../../../../org/apache/juneau/BeanContext.html#BEAN_excludeProperties"><code>BeanContext.BEAN_excludeProperties</code></a> property on all serializers.</div> </td> </tr> <tr class="rowColor"> @@ -771,13 +771,13 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota </li> </ul> <ul class="blockList"> -<li class="blockList"><a name="bpIncludes--"> +<li class="blockList"><a name="bpi--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>bpIncludes</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.363">bpIncludes</a></pre> +<h4>bpi</h4> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.366">bpi</a></pre> <div class="block">Shortcut for specifying the <a href="../../../../../org/apache/juneau/BeanContext.html#BEAN_includeProperties"><code>BeanContext.BEAN_includeProperties</code></a> property on all serializers. <p> @@ -800,39 +800,42 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota } <jc>// Only render "id" property.</jc> - <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/mybeans"</js>, bpIncludes=<js>"{MyBean:'id'}"</js>) + <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/mybeans"</js>, bpi=<js>"MyBean: id"</js>) <jk>public</jk> List<MyBean> getBeanSummary(); <jc>// Only render "a" and "b" properties.</jc> - <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/mybeans/{id}"</js>, bpIncludes=<js>"{MyBean:'a,b'}"</js>) + <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/mybeans/{id}"</js>, bpi=<js>"MyBean: a,b"</js>) <jk>public</jk> MyBean getBeanDetails(<ja>@Path</ja> String id); </p> <p> - The format of this value is a lax JSON object. + The format of each value is: <js>"Key: comma-delimited-tokens". <br>Keys can be fully-qualified or short class names or <js>"*"</js> to represent all classes. <br>Values are comma-delimited lists of bean property names. - <br>Properties apply to specified class and all subclasses.</div> + <br>Properties apply to specified class and all subclasses. + + <p> + Semicolons can be used as an additional separator for multiple values: <code>bpi="Bean1: foo; Bean2: bar,baz"</code></div> <dl> <dt>Default:</dt> -<dd>""</dd> +<dd>{}</dd> </dl> </li> </ul> </li> </ul> <ul class="blockList"> -<li class="blockList"><a name="bpExcludes--"> +<li class="blockList"><a name="bpx--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>bpExcludes</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.401">bpExcludes</a></pre> +<h4>bpx</h4> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.407">bpx</a></pre> <div class="block">Shortcut for specifying the <a href="../../../../../org/apache/juneau/BeanContext.html#BEAN_excludeProperties"><code>BeanContext.BEAN_excludeProperties</code></a> property on all serializers. <p> - Same as <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#bpIncludes--"><code>bpIncludes()</code></a> except you specify a list of bean property names that you want to exclude from + Same as <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#bpi--"><code>bpi()</code></a> except you specify a list of bean property names that you want to exclude from serialization. <p> @@ -850,7 +853,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota } <jc>// Don't show "a" and "b" properties.</jc> - <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/mybeans"</js>, bpExcludes=<js>"{MyBean:'a,b'}"</js>) + <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/mybeans"</js>, bpx=<js>"MyBean: a,b"</js>) <jk>public</jk> List<MyBean> getBeanSummary(); <jc>// Render all properties.</jc> @@ -859,13 +862,16 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota </p> <p> - The format of this value is a lax JSON object. + The format of each value is: <js>"Key: comma-delimited-tokens". <br>Keys can be fully-qualified or short class names or <js>"*"</js> to represent all classes. <br>Values are comma-delimited lists of bean property names. - <br>Properties apply to specified class and all subclasses.</div> + <br>Properties apply to specified class and all subclasses. + + <p> + Semicolons can be used as an additional separator for multiple values: <code>bpi="Bean1: foo; Bean2: bar,baz"</code></div> <dl> <dt>Default:</dt> -<dd>""</dd> +<dd>{}</dd> </dl> </li> </ul> @@ -878,7 +884,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>defaultRequestHeaders</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.435">defaultRequestHeaders</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.441">defaultRequestHeaders</a></pre> <div class="block">Specifies default values for request headers. <p> @@ -924,7 +930,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>defaultQuery</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.458">defaultQuery</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.464">defaultQuery</a></pre> <div class="block">Specifies default values for query parameters. <p> @@ -959,7 +965,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>defaultFormData</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.482">defaultFormData</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.488">defaultFormData</a></pre> <div class="block">Specifies default values for form-data parameters. <p> @@ -995,7 +1001,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>summary</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.509">summary</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.515">summary</a></pre> <div class="block">Optional summary for the exposed API. <p> @@ -1034,7 +1040,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>description</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.537">description</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.543">description</a></pre> <div class="block">Optional description for the exposed API. <p> @@ -1074,7 +1080,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>clientVersion</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.603">clientVersion</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.609">clientVersion</a></pre> <div class="block">Specifies whether this method can be called based on the client version. <p> @@ -1152,7 +1158,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>swagger</h4> -<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/MethodSwagger.html" title="annotation in org.apache.juneau.rest.annotation">MethodSwagger</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.608">swagger</a></pre> +<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/MethodSwagger.html" title="annotation in org.apache.juneau.rest.annotation">MethodSwagger</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.614">swagger</a></pre> <div class="block">Provides swagger-specific metadata on this method.</div> <dl> <dt>Default:</dt> @@ -1169,7 +1175,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockListLast"> <li class="blockList"> <h4>htmldoc</h4> -<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html" title="annotation in org.apache.juneau.rest.annotation">HtmlDoc</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.616">htmldoc</a></pre> +<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html" title="annotation in org.apache.juneau.rest.annotation">HtmlDoc</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestMethod.html#line.622">htmldoc</a></pre> <div class="block">Provides HTML-doc-specific metadata on this method. <p> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/c4956832/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html b/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html index 0d31fc8..6f88305 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html @@ -894,14 +894,28 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>siteName</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.435">siteName</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.449">siteName</a></pre> <div class="block">Optional site name. <p> - Used as a label for the overall site. + The site name is intended to be a title that can be applied to the entire site. + + <p> This value can be retrieved programmatically through the <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getSiteName--"><code>RestRequest.getSiteName()</code></a> method. <p> + One possible use is if you want to add the same title to the top of all pages by defining a header on a + common parent class like so: + <p class='bcode'> + htmldoc=<ja>@HtmlDoc</ja>( + header={ + <js>"<h1>$R{siteName}</h1>"</js>, + <js>"<h2>$R{servletTitle}</h2>"</js> + } + ) + </p> + + <p> This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. @@ -922,7 +936,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>title</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.458">title</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.472">title</a></pre> <div class="block">Optional servlet title. <p> @@ -957,7 +971,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>description</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.481">description</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.495">description</a></pre> <div class="block">Optional servlet description. <p> @@ -992,7 +1006,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>config</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.496">config</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.510">config</a></pre> <div class="block">Optional location of configuration file for this servlet. <p> @@ -1019,7 +1033,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>favicon</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.534">favicon</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.548">favicon</a></pre> <div class="block">The favicon to use for HTML views. <p> @@ -1069,7 +1083,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>staticFiles</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.573">staticFiles</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.587">staticFiles</a></pre> <div class="block">Defines paths and locations of statically served files. <p> @@ -1120,7 +1134,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>clientVersionHeader</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.588">clientVersionHeader</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.602">clientVersionHeader</a></pre> <div class="block">Specifies the HTTP header name used to identify the client version. <p> @@ -1147,7 +1161,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>resourceResolver</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestResourceResolver.html" title="class in org.apache.juneau.rest">RestResourceResolver</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.619">resourceResolver</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestResourceResolver.html" title="class in org.apache.juneau.rest">RestResourceResolver</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.633">resourceResolver</a></pre> <div class="block">Specifies the resolver class to use for resolving child resources by class name. <p> @@ -1190,7 +1204,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>logger</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestLogger.html" title="class in org.apache.juneau.rest">RestLogger</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.632">logger</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestLogger.html" title="class in org.apache.juneau.rest">RestLogger</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.646">logger</a></pre> <div class="block">Specifies the logger class to use for logging. <p> @@ -1215,7 +1229,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>callHandler</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestCallHandler.html" title="class in org.apache.juneau.rest">RestCallHandler</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.645">callHandler</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestCallHandler.html" title="class in org.apache.juneau.rest">RestCallHandler</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.659">callHandler</a></pre> <div class="block">Specifies the REST call handler class. <p> @@ -1240,7 +1254,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>infoProvider</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestInfoProvider.html" title="class in org.apache.juneau.rest">RestInfoProvider</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.657">infoProvider</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/rest/RestInfoProvider.html" title="class in org.apache.juneau.rest">RestInfoProvider</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.671">infoProvider</a></pre> <div class="block">Specifies the class used to retrieve title/description/swagger information about a resource. <p> @@ -1264,7 +1278,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>serializerListener</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/serializer/SerializerListener.html" title="class in org.apache.juneau.serializer">SerializerListener</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.662">serializerListener</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/serializer/SerializerListener.html" title="class in org.apache.juneau.serializer">SerializerListener</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.676">serializerListener</a></pre> <div class="block">Specifies the serializer listener class to use for listening for non-fatal errors.</div> <dl> <dt>Default:</dt> @@ -1281,7 +1295,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>parserListener</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/parser/ParserListener.html" title="class in org.apache.juneau.parser">ParserListener</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.667">parserListener</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/parser/ParserListener.html" title="class in org.apache.juneau.parser">ParserListener</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.681">parserListener</a></pre> <div class="block">Specifies the parser listener class to use for listening for non-fatal errors.</div> <dl> <dt>Default:</dt> @@ -1298,7 +1312,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>swagger</h4> -<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/ResourceSwagger.html" title="annotation in org.apache.juneau.rest.annotation">ResourceSwagger</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.692">swagger</a></pre> +<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/ResourceSwagger.html" title="annotation in org.apache.juneau.rest.annotation">ResourceSwagger</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.706">swagger</a></pre> <div class="block">Provides swagger-specific metadata on this resource. <p> @@ -1335,7 +1349,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockListLast"> <li class="blockList"> <h4>htmldoc</h4> -<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html" title="annotation in org.apache.juneau.rest.annotation">HtmlDoc</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.736">htmldoc</a></pre> +<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html" title="annotation in org.apache.juneau.rest.annotation">HtmlDoc</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.750">htmldoc</a></pre> <div class="block">Provides HTML-doc-specific metadata on this method. <p>
