http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/org/apache/juneau/rest/vars/FileVar.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/vars/FileVar.html b/content/site/apidocs/org/apache/juneau/rest/vars/FileVar.html new file mode 100644 index 0000000..464b233 --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/rest/vars/FileVar.html @@ -0,0 +1,435 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>FileVar (Apache Juneau (incubating) 6.3.1-incubating-SNAPSHOT)</title> +<link rel="stylesheet" type="text/css" href="../../../../../javadoc.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="FileVar (Apache Juneau (incubating) 6.3.1-incubating-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../../org/apache/juneau/rest/vars/LocalizationVar.html" title="class in org.apache.juneau.rest.vars"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/juneau/rest/vars/FileVar.html" target="_top">Frames</a></li> +<li><a href="FileVar.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.juneau.rest.vars</div> +<h2 title="Class FileVar" class="title">Class FileVar</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/juneau/svl/Var.html" title="class in org.apache.juneau.svl">org.apache.juneau.svl.Var</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="class in org.apache.juneau.svl">org.apache.juneau.svl.SimpleVar</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/juneau/svl/DefaultingVar.html" title="class in org.apache.juneau.svl">org.apache.juneau.svl.DefaultingVar</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.juneau.rest.vars.FileVar</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <a href="../../../../../src-html/org/apache/juneau/rest/vars/FileVar.html#line.64">FileVar</a> +extends <a href="../../../../../org/apache/juneau/svl/DefaultingVar.html" title="class in org.apache.juneau.svl">DefaultingVar</a></pre> +<div class="block">File resource variable resolver + + <p> + The format for this var is <js>"$F{path[,defaultValue]}"</js>. + + <p> + File variables resolve to the contents of resource files located on the classpath or local JVM directory. + They use the <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getReaderResource-java.lang.String-"><code>RestRequest.getReaderResource(String)</code></a> method to retrieve the contents of the file. + That in turn uses the <a href="../../../../../org/apache/juneau/utils/ResourceFinder.html" title="class in org.apache.juneau.utils"><code>ResourceFinder</code></a> associated with the servlet class to find the file. + + <p> + The <a href="../../../../../org/apache/juneau/utils/ResourceFinder.html" title="class in org.apache.juneau.utils"><code>ResourceFinder</code></a> is similar to <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true#getResourceAsStream-java.lang.String-"; title="class or interface in java.lang"><code>Class.getResourceAsStream(String)</code></a> except if it doesn't find the + resource on this class, it searches up the parent hierarchy chain. + + <p> + If the resource cannot be found in the classpath, then an attempt is made to look in the JVM working directory. + <br>Path traversals outside the working directory are not allowed for security reasons. + + <p> + Localized resources (based on the locale of the HTTP request) are supported. + For example, if looking for the resource <js>"MyResource.txt"</js> for the Japanese locale, we will look for + files in the following order: + <ol> + <li><js>"MyResource_ja_JP.txt"</js> + <li><js>"MyResource_ja.txt"</js> + <li><js>"MyResource.txt"</js> + </ol> + + <p> + Example: + <p class='bcode'> + <ja>@RestResource</ja>( + htmldoc=<ja>@HtmlDoc</ja>( + aside=<js>"$F{resources/MyAsideMessage.html, Oops not found!}"</js> + ) + ) + </p> + + <p> + Files of type HTML, XHTML, XML, JSON, Javascript, and CSS will be stripped of comments. + This allows you to place license headers in files without them being serialized to the output.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/juneau/svl/package-summary.html"><code>org.apache.juneau.svl</code></a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <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/vars/FileVar.html#NAME">NAME</a></span></code> +<div class="block">The name of this variable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <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/vars/FileVar.html#SESSION_req">SESSION_req</a></span></code> +<div class="block">The name of the session or context object that identifies the <a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest"><code>RestRequest</code></a> object.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/vars/FileVar.html#FileVar--">FileVar</a></span>()</code> +<div class="block">Constructor.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" 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/vars/FileVar.html#resolve-org.apache.juneau.svl.VarResolverSession-java.lang.String-">resolve</a></span>(<a href="../../../../../org/apache/juneau/svl/VarResolverSession.html" title="class in org.apache.juneau.svl">VarResolverSession</a> session, + <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)</code> +<div class="block">The interface that needs to be implemented for subclasses of <a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="class in org.apache.juneau.svl"><code>SimpleVar</code></a>.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.svl.DefaultingVar"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.juneau.svl.<a href="../../../../../org/apache/juneau/svl/DefaultingVar.html" title="class in org.apache.juneau.svl">DefaultingVar</a></h3> +<code><a href="../../../../../org/apache/juneau/svl/DefaultingVar.html#doResolve-org.apache.juneau.svl.VarResolverSession-java.lang.String-">doResolve</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.svl.SimpleVar"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.juneau.svl.<a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="class in org.apache.juneau.svl">SimpleVar</a></h3> +<code><a href="../../../../../org/apache/juneau/svl/SimpleVar.html#resolveTo-org.apache.juneau.svl.VarResolverSession-java.io.Writer-java.lang.String-">resolveTo</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.svl.Var"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.juneau.svl.<a href="../../../../../org/apache/juneau/svl/Var.html" title="class in org.apache.juneau.svl">Var</a></h3> +<code><a href="../../../../../org/apache/juneau/svl/Var.html#getName--">getName</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<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></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <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>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="SESSION_req"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SESSION_req</h4> +<pre>public static final <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/vars/FileVar.html#line.69">SESSION_req</a></pre> +<div class="block">The name of the session or context object that identifies the <a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest"><code>RestRequest</code></a> object.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.juneau.rest.vars.FileVar.SESSION_req">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="NAME"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>NAME</h4> +<pre>public static final <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/vars/FileVar.html#line.74">NAME</a></pre> +<div class="block">The name of this variable.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.juneau.rest.vars.FileVar.NAME">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="FileVar--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FileVar</h4> +<pre>public <a href="../../../../../src-html/org/apache/juneau/rest/vars/FileVar.html#line.79">FileVar</a>()</pre> +<div class="block">Constructor.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="resolve-org.apache.juneau.svl.VarResolverSession-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>resolve</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/vars/FileVar.html#line.84">resolve</a>(<a href="../../../../../org/apache/juneau/svl/VarResolverSession.html" title="class in org.apache.juneau.svl">VarResolverSession</a> session, + <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) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/juneau/svl/Var.html#resolve-org.apache.juneau.svl.VarResolverSession-java.lang.String-">Var</a></code></span></div> +<div class="block">The interface that needs to be implemented for subclasses of <a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="class in org.apache.juneau.svl"><code>SimpleVar</code></a>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/juneau/svl/Var.html#resolve-org.apache.juneau.svl.VarResolverSession-java.lang.String-">resolve</a></code> in class <code><a href="../../../../../org/apache/juneau/svl/Var.html" title="class in org.apache.juneau.svl">Var</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>session</code> - The session object used for a single instance of a var resolution.</dd> +<dd><code>key</code> - The inside argument of the variable.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The resolved value.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code> - Any thrown exception will be serialized as <js>"{exceptionMessage}"</js></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../../org/apache/juneau/rest/vars/LocalizationVar.html" title="class in org.apache.juneau.rest.vars"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/juneau/rest/vars/FileVar.html" target="_top">Frames</a></li> +<li><a href="FileVar.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2017 <a href="http://www.apache.org/";>Apache</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/org/apache/juneau/rest/vars/LocalizationVar.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/vars/LocalizationVar.html b/content/site/apidocs/org/apache/juneau/rest/vars/LocalizationVar.html index fa936ac..1e0ae59 100644 --- a/content/site/apidocs/org/apache/juneau/rest/vars/LocalizationVar.html +++ b/content/site/apidocs/org/apache/juneau/rest/vars/LocalizationVar.html @@ -48,7 +48,7 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li>Prev Class</li> +<li><a href="../../../../../org/apache/juneau/rest/vars/FileVar.html" title="class in org.apache.juneau.rest.vars"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../../org/apache/juneau/rest/vars/RequestVar.html" title="class in org.apache.juneau.rest.vars"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> @@ -128,7 +128,7 @@ extends <a href="../../../../../org/apache/juneau/svl/MultipartVar.html" title=" <div class="block">Localized string variable resolver. <p> - The format for this var is <js>"$L{key}"</js> or <js>"$L{key,args...}"</js>. + The format for this var is <js>"$L{key[,args...]}"</js>. <p> This variable resolver requires that a <a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest"><code>RestRequest</code></a> object be set as a context object on the resolver or a @@ -341,7 +341,7 @@ extends <a href="../../../../../org/apache/juneau/svl/MultipartVar.html" title=" </div> <div class="subNav"> <ul class="navList"> -<li>Prev Class</li> +<li><a href="../../../../../org/apache/juneau/rest/vars/FileVar.html" title="class in org.apache.juneau.rest.vars"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../../org/apache/juneau/rest/vars/RequestVar.html" title="class in org.apache.juneau.rest.vars"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/org/apache/juneau/rest/vars/RequestVar.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/vars/RequestVar.html b/content/site/apidocs/org/apache/juneau/rest/vars/RequestVar.html index fec91e5..f7931c0 100644 --- a/content/site/apidocs/org/apache/juneau/rest/vars/RequestVar.html +++ b/content/site/apidocs/org/apache/juneau/rest/vars/RequestVar.html @@ -105,6 +105,9 @@ var activeTableTab = "activeTableTab"; <li><a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="class in org.apache.juneau.svl">org.apache.juneau.svl.SimpleVar</a></li> <li> <ul class="inheritance"> +<li><a href="../../../../../org/apache/juneau/svl/DefaultingVar.html" title="class in org.apache.juneau.svl">org.apache.juneau.svl.DefaultingVar</a></li> +<li> +<ul class="inheritance"> <li>org.apache.juneau.rest.vars.RequestVar</li> </ul> </li> @@ -113,32 +116,42 @@ var activeTableTab = "activeTableTab"; </ul> </li> </ul> +</li> +</ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> -<pre>public class <a href="../../../../../src-html/org/apache/juneau/rest/vars/RequestVar.html#line.50">RequestVar</a> -extends <a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="class in org.apache.juneau.svl">SimpleVar</a></pre> +<pre>public class <a href="../../../../../src-html/org/apache/juneau/rest/vars/RequestVar.html#line.59">RequestVar</a> +extends <a href="../../../../../org/apache/juneau/svl/DefaultingVar.html" title="class in org.apache.juneau.svl">DefaultingVar</a></pre> <div class="block">Request attribute variable resolver. <p> - The format for this var is <js>"$R{key}"</js>. + The format for this var is <js>"$R{key[,defaultValue]}"</js>. + + <p> The possible values are: <ul> - <li><code>$R{contextPath}</code> - Value returned by <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getContextPath--"; title="class or interface in javax.servlet.http"><code>HttpServletRequestWrapper.getContextPath()</code></a>. - <li><code>$R{method}</code> - Value returned by <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getMethod--"><code>RestRequest.getMethod()</code></a>. - <li><code>$R{methodDescription}</code> - Value returned by <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getMethodDescription--"><code>RestRequest.getMethodDescription()</code></a>. - <li><code>$R{pathInfo}</code> - Value returned by <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getPathInfo--"; title="class or interface in javax.servlet.http"><code>HttpServletRequestWrapper.getPathInfo()</code></a>. - <li><code>$R{requestParentURI}</code> - Value returned by <a href="../../../../../org/apache/juneau/UriContext.html#getRootRelativePathInfoParent--"><code>UriContext.getRootRelativePathInfoParent()</code></a>. - <li><code>$R{requestURI}</code> - Value returned by <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getRequestURI--"; title="class or interface in javax.servlet.http"><code>HttpServletRequestWrapper.getRequestURI()</code></a>. - <li><code>$R{servletDescription}</code> - Value returned by <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getServletDescription--"><code>RestRequest.getServletDescription()</code></a>. - <li><code>$R{servletTitle}</code> - Value returned by <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getServletTitle--"><code>RestRequest.getServletTitle()</code></a>. - <li><code>$R{servletParentURI}</code> - Value returned by <a href="../../../../../org/apache/juneau/UriContext.html#getRootRelativeServletPathParent--"><code>UriContext.getRootRelativeServletPathParent()</code></a>. - <li><code>$R{servletPath}</code> - Value returned by <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getServletPath--"; title="class or interface in javax.servlet.http"><code>HttpServletRequestWrapper.getServletPath()</code></a>. - <li><code>$R{servletURI}</code> - Value returned by <a href="../../../../../org/apache/juneau/UriContext.html#getRootRelativeServletPath--"><code>UriContext.getRootRelativeServletPath()</code></a>. + <li><js>"contextPath"</js> - Value returned by <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getContextPath--"; title="class or interface in javax.servlet.http"><code>HttpServletRequestWrapper.getContextPath()</code></a> + <li><js>"method"</js> - Value returned by <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getMethod--"><code>RestRequest.getMethod()</code></a> + <li><js>"methodDescription"</js> - Value returned by <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getMethodDescription--"><code>RestRequest.getMethodDescription()</code></a> + <li><js>"methodSummary"</js> - Value returned by <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getMethodSummary--"><code>RestRequest.getMethodSummary()</code></a> + <li><js>"pathInfo"</js> - Value returned by <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getPathInfo--"; title="class or interface in javax.servlet.http"><code>HttpServletRequestWrapper.getPathInfo()</code></a> + <li><js>"requestParentURI"</js> - Value returned by <a href="../../../../../org/apache/juneau/UriContext.html#getRootRelativePathInfoParent--"><code>UriContext.getRootRelativePathInfoParent()</code></a> + <li><js>"requestURI"</js> - Value returned by <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getRequestURI--"; title="class or interface in javax.servlet.http"><code>HttpServletRequestWrapper.getRequestURI()</code></a> + <li><js>"servletDescription"</js> - Value returned by <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getServletDescription--"><code>RestRequest.getServletDescription()</code></a> + <li><js>"servletParentURI"</js> - Value returned by <a href="../../../../../org/apache/juneau/UriContext.html#getRootRelativeServletPathParent--"><code>UriContext.getRootRelativeServletPathParent()</code></a> + <li><js>"servletPath"</js> - See <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequestWrapper.html?is-external=true#getServletPath--"; title="class or interface in javax.servlet.http"><code>HttpServletRequestWrapper.getServletPath()</code></a> + <li><js>"servletTitle"</js> - See <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getServletTitle--"><code>RestRequest.getServletTitle()</code></a> + <li><js>"servletURI"</js> - See <a href="../../../../../org/apache/juneau/UriContext.html#getRootRelativeServletPath--"><code>UriContext.getRootRelativeServletPath()</code></a> + <li><js>"siteName"</js> - See <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getSiteName--"><code>RestRequest.getSiteName()</code></a> + <li><js>"Attribute.x"</js> - Value returned by <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getAttribute-java.lang.String-"; title="class or interface in javax.servlet"><code>ServletRequest.getAttribute(String)</code></a>. + <li><js>"FormData.x"</js> - Value returned by <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getFormData-java.lang.String-"><code>RestRequest.getFormData(String)</code></a>. + <li><js>"Header.x"</js> - Value returned by <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getHeader-java.lang.String-"><code>RestRequest.getHeader(String)</code></a>. + <li><js>"Path.x"</js> - Value returned by <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getPath-java.lang.String-"><code>RestRequest.getPath(String)</code></a>. + <li><js>"Query.x"</js> = Value returned by <a href="../../../../../org/apache/juneau/rest/RestRequest.html#getQuery-java.lang.String-"><code>RestRequest.getQuery(String)</code></a>. </ul> - <p> This variable resolver requires that a <a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest"><code>RestRequest</code></a> object be set as a context object on the resolver or a session object on the resolver session. @@ -223,6 +236,13 @@ extends <a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="cla </tr> </table> <ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.svl.DefaultingVar"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.juneau.svl.<a href="../../../../../org/apache/juneau/svl/DefaultingVar.html" title="class in org.apache.juneau.svl">DefaultingVar</a></h3> +<code><a href="../../../../../org/apache/juneau/svl/DefaultingVar.html#doResolve-org.apache.juneau.svl.VarResolverSession-java.lang.String-">doResolve</a></code></li> +</ul> +<ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.svl.SimpleVar"> <!-- --> </a> @@ -234,7 +254,7 @@ extends <a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="cla <!-- --> </a> <h3>Methods inherited from class org.apache.juneau.svl.<a href="../../../../../org/apache/juneau/svl/Var.html" title="class in org.apache.juneau.svl">Var</a></h3> -<code><a href="../../../../../org/apache/juneau/svl/Var.html#doResolve-org.apache.juneau.svl.VarResolverSession-java.lang.String-">doResolve</a>, <a href="../../../../../org/apache/juneau/svl/Var.html#getName--">getName</a></code></li> +<code><a href="../../../../../org/apache/juneau/svl/Var.html#getName--">getName</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> @@ -263,7 +283,7 @@ extends <a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="cla <ul class="blockList"> <li class="blockList"> <h4>SESSION_req</h4> -<pre>public static final <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/vars/RequestVar.html#line.55">SESSION_req</a></pre> +<pre>public static final <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/vars/RequestVar.html#line.64">SESSION_req</a></pre> <div class="block">The name of the session or context object that identifies the <a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest"><code>RestRequest</code></a> object.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> @@ -277,7 +297,7 @@ extends <a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="cla <ul class="blockListLast"> <li class="blockList"> <h4>NAME</h4> -<pre>public static final <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/vars/RequestVar.html#line.58">NAME</a></pre> +<pre>public static final <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/vars/RequestVar.html#line.67">NAME</a></pre> <div class="block">The name of this variable.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> @@ -299,7 +319,7 @@ extends <a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="cla <ul class="blockListLast"> <li class="blockList"> <h4>RequestVar</h4> -<pre>public <a href="../../../../../src-html/org/apache/juneau/rest/vars/RequestVar.html#line.63">RequestVar</a>()</pre> +<pre>public <a href="../../../../../src-html/org/apache/juneau/rest/vars/RequestVar.html#line.72">RequestVar</a>()</pre> <div class="block">Constructor.</div> </li> </ul> @@ -317,7 +337,7 @@ extends <a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="cla <ul class="blockListLast"> <li class="blockList"> <h4>resolve</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/vars/RequestVar.html#line.68">resolve</a>(<a href="../../../../../org/apache/juneau/svl/VarResolverSession.html" title="class in org.apache.juneau.svl">VarResolverSession</a> session, +<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/vars/RequestVar.html#line.77">resolve</a>(<a href="../../../../../org/apache/juneau/svl/VarResolverSession.html" title="class in org.apache.juneau.svl">VarResolverSession</a> session, <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> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/juneau/svl/Var.html#resolve-org.apache.juneau.svl.VarResolverSession-java.lang.String-">Var</a></code></span></div> <div class="block">The interface that needs to be implemented for subclasses of <a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="class in org.apache.juneau.svl"><code>SimpleVar</code></a>.</div> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/org/apache/juneau/rest/vars/SerializedRequestAttrVar.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/vars/SerializedRequestAttrVar.html b/content/site/apidocs/org/apache/juneau/rest/vars/SerializedRequestAttrVar.html index 67ed29c..1ce3a98 100644 --- a/content/site/apidocs/org/apache/juneau/rest/vars/SerializedRequestAttrVar.html +++ b/content/site/apidocs/org/apache/juneau/rest/vars/SerializedRequestAttrVar.html @@ -123,7 +123,7 @@ extends <a href="../../../../../org/apache/juneau/svl/StreamedVar.html" title="c <div class="block">Serialized request attribute variable resolver. <p> - The format for this var is <js>"$SA{contentType,key}"</js> or <js>"$SA{contentType,key,defaultValue}"</js>. + The format for this var is <js>"$SA{contentType,key[,defaultValue]}"</js>. <p> This variable resolver requires that a <a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest"><code>RestRequest</code></a> object be set as a context object on the resolver or a @@ -286,7 +286,8 @@ extends <a href="../../../../../org/apache/juneau/svl/StreamedVar.html" title="c <h4>resolveTo</h4> <pre>public void <a href="../../../../../src-html/org/apache/juneau/rest/vars/SerializedRequestAttrVar.html#line.52">resolveTo</a>(<a href="../../../../../org/apache/juneau/svl/VarResolverSession.html" title="class in org.apache.juneau.svl">VarResolverSession</a> session, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io">Writer</a> w, - <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> + <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) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/juneau/svl/Var.html#resolveTo-org.apache.juneau.svl.VarResolverSession-java.io.Writer-java.lang.String-">Var</a></code></span></div> <div class="block">The interface that needs to be implemented for subclasses of <a href="../../../../../org/apache/juneau/svl/StreamedVar.html" title="class in org.apache.juneau.svl"><code>StreamedVar</code></a>.</div> <dl> @@ -296,6 +297,8 @@ extends <a href="../../../../../org/apache/juneau/svl/StreamedVar.html" title="c <dd><code>session</code> - The session object used for a single instance of a var resolution.</dd> <dd><code>w</code> - The writer to send the resolved value to.</dd> <dd><code>key</code> - The inside argument of the variable.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code> - Any thrown exception will be serialized as <js>"{exceptionMessage}"</js></dd> </dl> </li> </ul> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/org/apache/juneau/rest/vars/ServletInitParamVar.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/vars/ServletInitParamVar.html b/content/site/apidocs/org/apache/juneau/rest/vars/ServletInitParamVar.html index 1590259..e38fe5c 100644 --- a/content/site/apidocs/org/apache/juneau/rest/vars/ServletInitParamVar.html +++ b/content/site/apidocs/org/apache/juneau/rest/vars/ServletInitParamVar.html @@ -128,7 +128,7 @@ extends <a href="../../../../../org/apache/juneau/svl/DefaultingVar.html" title= <div class="block">Servlet init parameter variable resolver. <p> - The format for this var is <js>"$I{key}"</js> or <js>"$I{key,defaultValue}"</js>. + The format for this var is <js>"$I{key[,defaultValue]}"</js>. <p> This variable resolver requires that a <a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest"><code>RestRequest</code></a> object be set as a context object on the resolver or a http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/org/apache/juneau/rest/vars/UrlEncodeVar.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/vars/UrlEncodeVar.html b/content/site/apidocs/org/apache/juneau/rest/vars/UrlEncodeVar.html index 15b2b84..7ebf972 100644 --- a/content/site/apidocs/org/apache/juneau/rest/vars/UrlEncodeVar.html +++ b/content/site/apidocs/org/apache/juneau/rest/vars/UrlEncodeVar.html @@ -123,7 +123,7 @@ extends <a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="cla <div class="block">URL-encoding variable resolver. <p> - The format for this var is <js>"$UE{innerValue}"</js>. + The format for this var is <js>"$UE{uriPart}"</js>. <p> This variable takes the contents inside the variable and replaces it with a value returned by calling http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/org/apache/juneau/rest/vars/UrlVar.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/vars/UrlVar.html b/content/site/apidocs/org/apache/juneau/rest/vars/UrlVar.html index 8485ad0..704b2a0 100644 --- a/content/site/apidocs/org/apache/juneau/rest/vars/UrlVar.html +++ b/content/site/apidocs/org/apache/juneau/rest/vars/UrlVar.html @@ -118,9 +118,12 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <hr> <br> -<pre>public class <a href="../../../../../src-html/org/apache/juneau/rest/vars/UrlVar.html#line.41">UrlVar</a> +<pre>public class <a href="../../../../../src-html/org/apache/juneau/rest/vars/UrlVar.html#line.43">UrlVar</a> extends <a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="class in org.apache.juneau.svl">SimpleVar</a></pre> -<div class="block">Resolver for resolving URL variables <js>"$U{name}"</js>. +<div class="block">URL variable resolver. + + <p> + The format for this var is <js>"$U{uri}"</js>. <p> The advantage of using this variable is that you can resolve URLs with special protocols such as @@ -129,9 +132,8 @@ extends <a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="cla <p> See <a href="../../../../../org/apache/juneau/UriResolver.html" title="class in org.apache.juneau"><code>UriResolver</code></a> for the kinds of URIs that can be resolved. <ul> - <li><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#widgets--"><code>@RestResource.widgets()</code></a> - <li><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#widgets--"><code>@RestMethod.widgets()</code></a> - <li><a href="../../../../../org/apache/juneau/rest/RestConfig.html#addWidget-java.lang.Class-"><code>RestConfig.addWidget(Class)</code></a> + <li><a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#widgets--"><code>@HtmlDoc.widgets()</code></a> + <li><a href="../../../../../org/apache/juneau/rest/RestConfig.html#addHtmlWidget-java.lang.Class-"><code>RestConfig.addHtmlWidget(Class)</code></a> </ul> <p> @@ -254,7 +256,7 @@ extends <a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="cla <ul class="blockList"> <li class="blockList"> <h4>SESSION_req</h4> -<pre>public static final <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/vars/UrlVar.html#line.46">SESSION_req</a></pre> +<pre>public static final <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/vars/UrlVar.html#line.48">SESSION_req</a></pre> <div class="block">The name of the session or context object that identifies the <a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest"><code>RestRequest</code></a> object.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> @@ -268,7 +270,7 @@ extends <a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="cla <ul class="blockListLast"> <li class="blockList"> <h4>NAME</h4> -<pre>public static final <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/vars/UrlVar.html#line.49">NAME</a></pre> +<pre>public static final <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/vars/UrlVar.html#line.51">NAME</a></pre> <div class="block">The name of this variable.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> @@ -290,7 +292,7 @@ extends <a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="cla <ul class="blockListLast"> <li class="blockList"> <h4>UrlVar</h4> -<pre>public <a href="../../../../../src-html/org/apache/juneau/rest/vars/UrlVar.html#line.54">UrlVar</a>()</pre> +<pre>public <a href="../../../../../src-html/org/apache/juneau/rest/vars/UrlVar.html#line.56">UrlVar</a>()</pre> <div class="block">Constructor.</div> </li> </ul> @@ -308,7 +310,7 @@ extends <a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="cla <ul class="blockListLast"> <li class="blockList"> <h4>resolve</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/vars/UrlVar.html#line.59">resolve</a>(<a href="../../../../../org/apache/juneau/svl/VarResolverSession.html" title="class in org.apache.juneau.svl">VarResolverSession</a> session, +<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/vars/UrlVar.html#line.61">resolve</a>(<a href="../../../../../org/apache/juneau/svl/VarResolverSession.html" title="class in org.apache.juneau.svl">VarResolverSession</a> session, <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> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/juneau/svl/Var.html#resolve-org.apache.juneau.svl.VarResolverSession-java.lang.String-">Var</a></code></span></div> <div class="block">The interface that needs to be implemented for subclasses of <a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="class in org.apache.juneau.svl"><code>SimpleVar</code></a>.</div> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/org/apache/juneau/rest/vars/WidgetVar.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/vars/WidgetVar.html b/content/site/apidocs/org/apache/juneau/rest/vars/WidgetVar.html index 0c96f7f..8de4f7d 100644 --- a/content/site/apidocs/org/apache/juneau/rest/vars/WidgetVar.html +++ b/content/site/apidocs/org/apache/juneau/rest/vars/WidgetVar.html @@ -118,9 +118,12 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <hr> <br> -<pre>public class <a href="../../../../../src-html/org/apache/juneau/rest/vars/WidgetVar.html#line.36">WidgetVar</a> +<pre>public class <a href="../../../../../src-html/org/apache/juneau/rest/vars/WidgetVar.html#line.38">WidgetVar</a> extends <a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="class in org.apache.juneau.svl">SimpleVar</a></pre> -<div class="block">Resolver for resolving widget variables <js>"$W{name}"</js>. +<div class="block">HTML widget variable resolver. + + <p> + The format for this var is <js>"$W{widgetName}"</js>. <p> Widgets are simple class that produce some sort of string based on a passed-in HTTP request. @@ -128,9 +131,8 @@ extends <a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="cla <p> They're registered via the following mechanisms: <ul> - <li><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#widgets--"><code>@RestResource.widgets()</code></a> - <li><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#widgets--"><code>@RestMethod.widgets()</code></a> - <li><a href="../../../../../org/apache/juneau/rest/RestConfig.html#addWidget-java.lang.Class-"><code>RestConfig.addWidget(Class)</code></a> + <li><a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#widgets--"><code>@HtmlDoc.widgets()</code></a> + <li><a href="../../../../../org/apache/juneau/rest/RestConfig.html#addHtmlWidget-java.lang.Class-"><code>RestConfig.addHtmlWidget(Class)</code></a> </ul></div> <dl> <dt><span class="seeLabel">See Also:</span></dt> @@ -249,7 +251,7 @@ extends <a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="cla <ul class="blockList"> <li class="blockList"> <h4>SESSION_req</h4> -<pre>public static final <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/vars/WidgetVar.html#line.41">SESSION_req</a></pre> +<pre>public static final <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/vars/WidgetVar.html#line.43">SESSION_req</a></pre> <div class="block">The name of the session or context object that identifies the <a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest"><code>RestRequest</code></a> object.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> @@ -263,7 +265,7 @@ extends <a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="cla <ul class="blockListLast"> <li class="blockList"> <h4>NAME</h4> -<pre>public static final <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/vars/WidgetVar.html#line.46">NAME</a></pre> +<pre>public static final <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/vars/WidgetVar.html#line.48">NAME</a></pre> <div class="block">The name of this variable.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> @@ -285,7 +287,7 @@ extends <a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="cla <ul class="blockListLast"> <li class="blockList"> <h4>WidgetVar</h4> -<pre>public <a href="../../../../../src-html/org/apache/juneau/rest/vars/WidgetVar.html#line.51">WidgetVar</a>()</pre> +<pre>public <a href="../../../../../src-html/org/apache/juneau/rest/vars/WidgetVar.html#line.53">WidgetVar</a>()</pre> <div class="block">Constructor.</div> </li> </ul> @@ -303,8 +305,9 @@ extends <a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="cla <ul class="blockListLast"> <li class="blockList"> <h4>resolve</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/vars/WidgetVar.html#line.56">resolve</a>(<a href="../../../../../org/apache/juneau/svl/VarResolverSession.html" title="class in org.apache.juneau.svl">VarResolverSession</a> session, - <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> +<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/vars/WidgetVar.html#line.58">resolve</a>(<a href="../../../../../org/apache/juneau/svl/VarResolverSession.html" title="class in org.apache.juneau.svl">VarResolverSession</a> session, + <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) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/juneau/svl/Var.html#resolve-org.apache.juneau.svl.VarResolverSession-java.lang.String-">Var</a></code></span></div> <div class="block">The interface that needs to be implemented for subclasses of <a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="class in org.apache.juneau.svl"><code>SimpleVar</code></a>.</div> <dl> @@ -315,6 +318,8 @@ extends <a href="../../../../../org/apache/juneau/svl/SimpleVar.html" title="cla <dd><code>key</code> - The inside argument of the variable.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>The resolved value.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code> - Any thrown exception will be serialized as <js>"{exceptionMessage}"</js></dd> </dl> </li> </ul> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/org/apache/juneau/rest/vars/package-frame.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/vars/package-frame.html b/content/site/apidocs/org/apache/juneau/rest/vars/package-frame.html index 98f69ec..9a13230 100644 --- a/content/site/apidocs/org/apache/juneau/rest/vars/package-frame.html +++ b/content/site/apidocs/org/apache/juneau/rest/vars/package-frame.html @@ -13,6 +13,7 @@ <div class="indexContainer"> <h2 title="Classes">Classes</h2> <ul title="Classes"> +<li><a href="FileVar.html" title="class in org.apache.juneau.rest.vars" target="classFrame">FileVar</a></li> <li><a href="LocalizationVar.html" title="class in org.apache.juneau.rest.vars" target="classFrame">LocalizationVar</a></li> <li><a href="RequestVar.html" title="class in org.apache.juneau.rest.vars" target="classFrame">RequestVar</a></li> <li><a href="SerializedRequestAttrVar.html" title="class in org.apache.juneau.rest.vars" target="classFrame">SerializedRequestAttrVar</a></li> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/org/apache/juneau/rest/vars/package-summary.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/vars/package-summary.html b/content/site/apidocs/org/apache/juneau/rest/vars/package-summary.html index 1e23cf5..6816c23 100644 --- a/content/site/apidocs/org/apache/juneau/rest/vars/package-summary.html +++ b/content/site/apidocs/org/apache/juneau/rest/vars/package-summary.html @@ -86,45 +86,51 @@ </tr> <tbody> <tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/juneau/rest/vars/FileVar.html" title="class in org.apache.juneau.rest.vars">FileVar</a></td> +<td class="colLast"> +<div class="block">File resource variable resolver</div> +</td> +</tr> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../../org/apache/juneau/rest/vars/LocalizationVar.html" title="class in org.apache.juneau.rest.vars">LocalizationVar</a></td> <td class="colLast"> <div class="block">Localized string variable resolver.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/juneau/rest/vars/RequestVar.html" title="class in org.apache.juneau.rest.vars">RequestVar</a></td> <td class="colLast"> <div class="block">Request attribute variable resolver.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../../org/apache/juneau/rest/vars/SerializedRequestAttrVar.html" title="class in org.apache.juneau.rest.vars">SerializedRequestAttrVar</a></td> <td class="colLast"> <div class="block">Serialized request attribute variable resolver.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/juneau/rest/vars/ServletInitParamVar.html" title="class in org.apache.juneau.rest.vars">ServletInitParamVar</a></td> <td class="colLast"> <div class="block">Servlet init parameter variable resolver.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../../org/apache/juneau/rest/vars/UrlEncodeVar.html" title="class in org.apache.juneau.rest.vars">UrlEncodeVar</a></td> <td class="colLast"> <div class="block">URL-encoding variable resolver.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/juneau/rest/vars/UrlVar.html" title="class in org.apache.juneau.rest.vars">UrlVar</a></td> <td class="colLast"> -<div class="block">Resolver for resolving URL variables <js>"$U{name}"</js>.</div> +<div class="block">URL variable resolver.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../../org/apache/juneau/rest/vars/WidgetVar.html" title="class in org.apache.juneau.rest.vars">WidgetVar</a></td> <td class="colLast"> -<div class="block">Resolver for resolving widget variables <js>"$W{name}"</js>.</div> +<div class="block">HTML widget variable resolver.</div> </td> </tr> </tbody> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/org/apache/juneau/rest/vars/package-tree.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/vars/package-tree.html b/content/site/apidocs/org/apache/juneau/rest/vars/package-tree.html index cab12f1..dfba612 100644 --- a/content/site/apidocs/org/apache/juneau/rest/vars/package-tree.html +++ b/content/site/apidocs/org/apache/juneau/rest/vars/package-tree.html @@ -86,6 +86,8 @@ <ul> <li type="circle">org.apache.juneau.svl.<a href="../../../../../org/apache/juneau/svl/DefaultingVar.html" title="class in org.apache.juneau.svl"><span class="typeNameLink">DefaultingVar</span></a> <ul> +<li type="circle">org.apache.juneau.rest.vars.<a href="../../../../../org/apache/juneau/rest/vars/FileVar.html" title="class in org.apache.juneau.rest.vars"><span class="typeNameLink">FileVar</span></a></li> +<li type="circle">org.apache.juneau.rest.vars.<a href="../../../../../org/apache/juneau/rest/vars/RequestVar.html" title="class in org.apache.juneau.rest.vars"><span class="typeNameLink">RequestVar</span></a></li> <li type="circle">org.apache.juneau.rest.vars.<a href="../../../../../org/apache/juneau/rest/vars/ServletInitParamVar.html" title="class in org.apache.juneau.rest.vars"><span class="typeNameLink">ServletInitParamVar</span></a></li> </ul> </li> @@ -94,7 +96,6 @@ <li type="circle">org.apache.juneau.rest.vars.<a href="../../../../../org/apache/juneau/rest/vars/LocalizationVar.html" title="class in org.apache.juneau.rest.vars"><span class="typeNameLink">LocalizationVar</span></a></li> </ul> </li> -<li type="circle">org.apache.juneau.rest.vars.<a href="../../../../../org/apache/juneau/rest/vars/RequestVar.html" title="class in org.apache.juneau.rest.vars"><span class="typeNameLink">RequestVar</span></a></li> <li type="circle">org.apache.juneau.rest.vars.<a href="../../../../../org/apache/juneau/rest/vars/UrlEncodeVar.html" title="class in org.apache.juneau.rest.vars"><span class="typeNameLink">UrlEncodeVar</span></a></li> <li type="circle">org.apache.juneau.rest.vars.<a href="../../../../../org/apache/juneau/rest/vars/UrlVar.html" title="class in org.apache.juneau.rest.vars"><span class="typeNameLink">UrlVar</span></a></li> <li type="circle">org.apache.juneau.rest.vars.<a href="../../../../../org/apache/juneau/rest/vars/WidgetVar.html" title="class in org.apache.juneau.rest.vars"><span class="typeNameLink">WidgetVar</span></a></li> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/org/apache/juneau/rest/widget/ContentTypeMenuItem.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/widget/ContentTypeMenuItem.html b/content/site/apidocs/org/apache/juneau/rest/widget/ContentTypeMenuItem.html index ba2a2cb..1139b84 100644 --- a/content/site/apidocs/org/apache/juneau/rest/widget/ContentTypeMenuItem.html +++ b/content/site/apidocs/org/apache/juneau/rest/widget/ContentTypeMenuItem.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10}; +var methods = {"i0":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -123,7 +123,7 @@ extends <a href="../../../../../org/apache/juneau/rest/widget/MenuItemWidget.htm <div class="block">Widget that returns back a list of hyperlinks for rendering the contents of a page in a variety of content types. <p> - The variable it resolves is <js>"$W{contentTypeMenuItem}"</js>. + The variable it resolves is <js>"$W{ContentTypeMenuItem}"</js>. <p> An example of this widget can be found in the <code>PetStoreResource</code> in the examples that provides @@ -139,9 +139,9 @@ extends <a href="../../../../../org/apache/juneau/rest/widget/MenuItemWidget.htm links={ <js>"up: ..."</js>, <js>"options: ..."</js>, - <js>"$W{queryMenuItem}"</js>, - <js>"$W{contentTypeMenuItem}"</js>, - <js>"$W{styleMenuItem}"</js>, + <js>"$W{QueryMenuItem}"</js>, + <js>"$W{ContentTypeMenuItem}"</js>, + <js>"$W{StyleMenuItem}"</js>, <js>"source: ..."</js> } ) @@ -194,12 +194,6 @@ extends <a href="../../../../../org/apache/juneau/rest/widget/MenuItemWidget.htm as plain-text.</div> </td> </tr> -<tr id="i1" 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/widget/ContentTypeMenuItem.html#getName--">getName</a></span>()</code> -<div class="block">Returns <js>"contentTypeMenuItem"</js>.</div> -</td> -</tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.rest.widget.MenuItemWidget"> @@ -213,7 +207,7 @@ extends <a href="../../../../../org/apache/juneau/rest/widget/MenuItemWidget.htm <!-- --> </a> <h3>Methods inherited from class org.apache.juneau.rest.widget.<a href="../../../../../org/apache/juneau/rest/widget/Widget.html" title="class in org.apache.juneau.rest.widget">Widget</a></h3> -<code><a href="../../../../../org/apache/juneau/rest/widget/Widget.html#getResourceAsString-java.lang.String-">getResourceAsString</a>, <a href="../../../../../org/apache/juneau/rest/widget/Widget.html#getResourceAsString-java.lang.String-java.util.Locale-">getResourceAsString</a>, <a href="../../../../../org/apache/juneau/rest/widget/Widget.html#loadHtml-java.lang.String-">loadHtml</a>, <a href="../../../../../org/apache/juneau/rest/widget/Widget.html#loadScript-java.lang.String-">loadScript</a>, <a href="../../../../../org/apache/juneau/rest/widget/Widget.html#loadStyle-java.lang.String-">loadStyle</a></code></li> +<code><a href="../../../../../org/apache/juneau/rest/widget/Widget.html#getName--">getName</a>, <a href="../../../../../org/apache/juneau/rest/widget/Widget.html#getResourceAsString-java.lang.String-">getResourceAsString</a>, <a href="../../../../../org/apache/juneau/rest/widget/Widget.html#getResourceAsString-java.lang.String-java.util.Locale-">getResourceAsString</a>, <a href="../../../../../org/apache/juneau/rest/widget/Widget.html#loadHtml-java.lang.String-">loadHtml</a>, <a href="../../../../../org/apache/juneau/rest/widget/Widget.html#loadScript-java.lang.String-">loadScript</a>, <a href="../../../../../org/apache/juneau/rest/widget/Widget.html#loadStyle-java.lang.String-">loadStyle</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> @@ -253,29 +247,13 @@ extends <a href="../../../../../org/apache/juneau/rest/widget/MenuItemWidget.htm <!-- --> </a> <h3>Method Detail</h3> -<a name="getName--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getName</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/widget/ContentTypeMenuItem.html#line.62">getName</a>()</pre> -<div class="block">Returns <js>"contentTypeMenuItem"</js>.</div> -<dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../../../../org/apache/juneau/rest/widget/Widget.html#getName--">getName</a></code> in class <code><a href="../../../../../org/apache/juneau/rest/widget/Widget.html" title="class in org.apache.juneau.rest.widget">Widget</a></code></dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>The widget key.</dd> -</dl> -</li> -</ul> <a name="getHtml-org.apache.juneau.rest.RestRequest-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getHtml</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/widget/ContentTypeMenuItem.html#line.71">getHtml</a>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req) +<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/widget/ContentTypeMenuItem.html#line.63">getHtml</a>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> <div class="block">Looks at the supported media types from the request and constructs a list of hyperlinks to render the data as plain-text.</div> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/org/apache/juneau/rest/widget/MenuItemWidget.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/widget/MenuItemWidget.html b/content/site/apidocs/org/apache/juneau/rest/widget/MenuItemWidget.html index f1b68f2..bf049d8 100644 --- a/content/site/apidocs/org/apache/juneau/rest/widget/MenuItemWidget.html +++ b/content/site/apidocs/org/apache/juneau/rest/widget/MenuItemWidget.html @@ -49,7 +49,7 @@ var activeTableTab = "activeTableTab"; <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/juneau/rest/widget/ContentTypeMenuItem.html" title="class in org.apache.juneau.rest.widget"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/juneau/rest/widget/PoweredByApacheWidget.html" title="class in org.apache.juneau.rest.widget"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../../org/apache/juneau/rest/widget/PoweredByApache.html" title="class in org.apache.juneau.rest.widget"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/juneau/rest/widget/MenuItemWidget.html" target="_top">Frames</a></li> @@ -319,7 +319,7 @@ extends <a href="../../../../../org/apache/juneau/rest/widget/Widget.html" title <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/juneau/rest/widget/ContentTypeMenuItem.html" title="class in org.apache.juneau.rest.widget"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/juneau/rest/widget/PoweredByApacheWidget.html" title="class in org.apache.juneau.rest.widget"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../../org/apache/juneau/rest/widget/PoweredByApache.html" title="class in org.apache.juneau.rest.widget"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/juneau/rest/widget/MenuItemWidget.html" target="_top">Frames</a></li> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/org/apache/juneau/rest/widget/PoweredByApache.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/widget/PoweredByApache.html b/content/site/apidocs/org/apache/juneau/rest/widget/PoweredByApache.html new file mode 100644 index 0000000..13c0f77 --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/rest/widget/PoweredByApache.html @@ -0,0 +1,321 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>PoweredByApache (Apache Juneau (incubating) 6.3.1-incubating-SNAPSHOT)</title> +<link rel="stylesheet" type="text/css" href="../../../../../javadoc.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="PoweredByApache (Apache Juneau (incubating) 6.3.1-incubating-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/juneau/rest/widget/MenuItemWidget.html" title="class in org.apache.juneau.rest.widget"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/juneau/rest/widget/PoweredByJuneau.html" title="class in org.apache.juneau.rest.widget"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/juneau/rest/widget/PoweredByApache.html" target="_top">Frames</a></li> +<li><a href="PoweredByApache.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.juneau.rest.widget</div> +<h2 title="Class PoweredByApache" class="title">Class PoweredByApache</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/juneau/rest/widget/Widget.html" title="class in org.apache.juneau.rest.widget">org.apache.juneau.rest.widget.Widget</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.juneau.rest.widget.PoweredByApache</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <a href="../../../../../src-html/org/apache/juneau/rest/widget/PoweredByApache.html#line.45">PoweredByApache</a> +extends <a href="../../../../../org/apache/juneau/rest/widget/Widget.html" title="class in org.apache.juneau.rest.widget">Widget</a></pre> +<div class="block">Widget that places a powered-by-Apache message on the page. + + <p> + The variable it resolves is <js>"$W{PoweredByApache}"</js>. + + <p> + It produces a simple Apache icon floating on the right. + Typically it's used in the footer of the page, as shown below in the <code>RootResources</code> from the examples: + + <p class='bcode'> + <ja>@RestResource</ja>( + path=<js>"/"</js>, + title=<js>"Root resources"</js>, + description=<js>"Example of a router resource page."</js>, + widgets={ + PoweredByApache.<jk>class</jk> + }, + htmldoc=<ja>@HtmlDoc</ja>( + footer=<js>"$W{PoweredByApache}"</js> + ) + </p> + + <p> + It renders the following image: + <img class='bordered' src='doc-files/PoweredByApacheWidget.png'></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/widget/PoweredByApache.html#PoweredByApache--">PoweredByApache</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" 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/widget/PoweredByApache.html#getHtml-org.apache.juneau.rest.RestRequest-">getHtml</a></span>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)</code> +<div class="block">Returns an Apache image tag hyperlinked to <js>"http://apache.org";</js></div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.rest.widget.Widget"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.juneau.rest.widget.<a href="../../../../../org/apache/juneau/rest/widget/Widget.html" title="class in org.apache.juneau.rest.widget">Widget</a></h3> +<code><a href="../../../../../org/apache/juneau/rest/widget/Widget.html#getName--">getName</a>, <a href="../../../../../org/apache/juneau/rest/widget/Widget.html#getResourceAsString-java.lang.String-">getResourceAsString</a>, <a href="../../../../../org/apache/juneau/rest/widget/Widget.html#getResourceAsString-java.lang.String-java.util.Locale-">getResourceAsString</a>, <a href="../../../../../org/apache/juneau/rest/widget/Widget.html#getScript-org.apache.juneau.rest.RestRequest-">getScript</a>, <a href="../../../../../org/apache/juneau/rest/widget/Widget.html#getStyle-org.apache.juneau.rest.RestRequest-">getStyle</a>, <a href="../../../../../org/apache/juneau/rest/widget/Widget.html#loadHtml-java.lang.String-">loadHtml</a>, <a href="../../../../../org/apache/juneau/rest/widget/Widget.html#loadScript-java.lang.String-">loadScript</a>, <a href="../../../../../org/apache/juneau/rest/widget/Widget.html#loadStyle-java.lang.String-">loadStyle</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<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></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <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>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="PoweredByApache--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PoweredByApache</h4> +<pre>public <a href="../../../../../src-html/org/apache/juneau/rest/widget/PoweredByApache.html#line.45">PoweredByApache</a>()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getHtml-org.apache.juneau.rest.RestRequest-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getHtml</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/widget/PoweredByApache.html#line.51">getHtml</a>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block">Returns an Apache image tag hyperlinked to <js>"http://apache.org";</js></div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/juneau/rest/widget/Widget.html#getHtml-org.apache.juneau.rest.RestRequest-">getHtml</a></code> in class <code><a href="../../../../../org/apache/juneau/rest/widget/Widget.html" title="class in org.apache.juneau.rest.widget">Widget</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>req</code> - The HTTP request object.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The HTML content of this widget.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/juneau/rest/widget/MenuItemWidget.html" title="class in org.apache.juneau.rest.widget"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/juneau/rest/widget/PoweredByJuneau.html" title="class in org.apache.juneau.rest.widget"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/juneau/rest/widget/PoweredByApache.html" target="_top">Frames</a></li> +<li><a href="PoweredByApache.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2017 <a href="http://www.apache.org/";>Apache</a>. All rights reserved.</small></p> +</body> +</html>
