http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/756ffe72/content/site/apidocs/org/apache/juneau/microservice/RestMicroservice.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/microservice/RestMicroservice.html b/content/site/apidocs/org/apache/juneau/microservice/RestMicroservice.html index 5093f47..a94e113 100644 --- a/content/site/apidocs/org/apache/juneau/microservice/RestMicroservice.html +++ b/content/site/apidocs/org/apache/juneau/microservice/RestMicroservice.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":9,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10}; var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -113,7 +113,7 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <hr> <br> -<pre>public class <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.68">RestMicroservice</a> +<pre>public class <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.70">RestMicroservice</a> extends <a href="../../../../org/apache/juneau/microservice/Microservice.html" title="class in org.apache.juneau.microservice">Microservice</a></pre> <div class="block">Entry point for Juneau microservice that implements a REST interface using Jetty on a single port. @@ -189,78 +189,127 @@ extends <a href="../../../../org/apache/juneau/microservice/Microservice.html" t </td> </tr> <tr id="i1" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html#getPort--">getPort</a></span>()</code> +<div class="block">Returns the port that this microservice started up on.</div> +</td> +</tr> +<tr id="i2" class="altColor"> <td class="colFirst"><code>protected <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="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="http://docs.oracle.com/javaee/5/api/javax/servlet/Servlet.html?is-external=true"; title="class or interface in javax.servlet">Servlet</a>>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html#getResourceMap--">getResourceMap</a></span>()</code> <div class="block">Returns the resource map to use for this microservice.</div> </td> </tr> -<tr id="i2" class="altColor"> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net">URI</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html#getURI--">getURI</a></span>()</code> +<div class="block">Returns the URI where this microservice is listening on.</div> +</td> +</tr> +<tr id="i4" class="altColor"> <td class="colFirst"><code>protected void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html#initLogging--">initLogging</a></span>()</code> <div class="block">Initialize the logging for this microservice.</div> </td> </tr> -<tr id="i3" class="rowColor"> +<tr id="i5" class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html" title="class in org.apache.juneau.microservice">RestMicroservice</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html#join--">join</a></span>()</code> <div class="block">Joins the application with the current thread.</div> </td> </tr> -<tr id="i4" class="altColor"> +<tr id="i6" class="altColor"> <td class="colFirst"><code>static void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html#main-java.lang.String:A-">main</a></span>(<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>[] args)</code> <div class="block">Main method.</div> </td> </tr> -<tr id="i5" class="rowColor"> +<tr id="i7" class="rowColor"> <td class="colFirst"><code>protected void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html#onConfigSave-org.apache.juneau.ini.ConfigFile-">onConfigSave</a></span>(<a href="../../../../org/apache/juneau/ini/ConfigFile.html" title="class in org.apache.juneau.ini">ConfigFile</a> cf)</code> <div class="block">Called when <a href="../../../../org/apache/juneau/ini/ConfigFile.html#save--"><code>ConfigFile.save()</code></a> is called on the config file.</div> </td> </tr> -<tr id="i6" class="altColor"> +<tr id="i8" class="altColor"> <td class="colFirst"><code>protected void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html#onCreateServer--">onCreateServer</a></span>()</code> <div class="block">Called before <a href="../../../../org/apache/juneau/microservice/RestMicroservice.html#createServer--"><code>createServer()</code></a> is called.</div> </td> </tr> -<tr id="i7" class="rowColor"> +<tr id="i9" class="rowColor"> <td class="colFirst"><code>protected void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html#onPostStartServer--">onPostStartServer</a></span>()</code> <div class="block">Called after the Jetty server is started.</div> </td> </tr> -<tr id="i8" class="altColor"> +<tr id="i10" class="altColor"> <td class="colFirst"><code>protected void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html#onPostStopServer--">onPostStopServer</a></span>()</code> <div class="block">Called after the Jetty server is stopped.</div> </td> </tr> -<tr id="i9" class="rowColor"> +<tr id="i11" class="rowColor"> <td class="colFirst"><code>protected void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html#onStartServer--">onStartServer</a></span>()</code> <div class="block">Called before <a href="../../../../org/apache/juneau/microservice/RestMicroservice.html#startServer--"><code>startServer()</code></a> is called.</div> </td> </tr> -<tr id="i10" class="altColor"> +<tr id="i12" class="altColor"> <td class="colFirst"><code>protected void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html#onStopServer--">onStopServer</a></span>()</code> <div class="block">Called before the Jetty server is stopped.</div> </td> </tr> -<tr id="i11" class="rowColor"> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html" title="class in org.apache.juneau.microservice">RestMicroservice</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html#setConfig-org.apache.juneau.ini.ConfigFile-">setConfig</a></span>(<a href="../../../../org/apache/juneau/ini/ConfigFile.html" title="class in org.apache.juneau.ini">ConfigFile</a> cf)</code> +<div class="block">Specifies the config file for this microservice.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html" title="class in org.apache.juneau.microservice">RestMicroservice</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html#setConfig-java.lang.String-boolean-">setConfig</a></span>(<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> cfPath, + boolean create)</code> +<div class="block">Specifies the path of the config file for this microservice.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html" title="class in org.apache.juneau.microservice">RestMicroservice</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html#setManifest-java.lang.Class-">setManifest</a></span>(<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><?> c)</code> +<div class="block">Same as <a href="../../../../org/apache/juneau/microservice/Microservice.html#setManifest-java.util.jar.Manifest-"><code>Microservice.setManifest(Manifest)</code></a> except finds and loads the manifest file of the jar file that the specified class is contained within.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html" title="class in org.apache.juneau.microservice">RestMicroservice</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html#setManifest-java.io.File-">setManifest</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> f)</code> +<div class="block">Same as <a href="../../../../org/apache/juneau/microservice/Microservice.html#setManifest-java.util.jar.Manifest-"><code>Microservice.setManifest(Manifest)</code></a> except specified through a <a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io"><code>File</code></a> object.</div> +</td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html" title="class in org.apache.juneau.microservice">RestMicroservice</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html#setManifest-java.util.jar.Manifest-">setManifest</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/jar/Manifest.html?is-external=true"; title="class or interface in java.util.jar">Manifest</a> mf)</code> +<div class="block">Specifies the manifest file of the jar file this microservice is contained within.</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html" title="class in org.apache.juneau.microservice">RestMicroservice</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html#setManifestContents-java.lang.String...-">setManifestContents</a></span>(<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>... contents)</code> +<div class="block">Convenience method for specifying the manifest contents directly.</div> +</td> +</tr> +<tr id="i19" class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html" title="class in org.apache.juneau.microservice">RestMicroservice</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html#start--">start</a></span>()</code> <div class="block">Start this application.</div> </td> </tr> -<tr id="i12" class="altColor"> -<td class="colFirst"><code>protected void</code></td> +<tr id="i20" class="altColor"> +<td class="colFirst"><code>protected int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html#startServer--">startServer</a></span>()</code> <div class="block">Method used to start the Jetty server created by <a href="../../../../org/apache/juneau/microservice/RestMicroservice.html#createServer--"><code>createServer()</code></a>.</div> </td> </tr> -<tr id="i13" class="rowColor"> +<tr id="i21" class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html" title="class in org.apache.juneau.microservice">RestMicroservice</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/RestMicroservice.html#stop--">stop</a></span>()</code> <div class="block">Stop this application.</div> @@ -272,7 +321,7 @@ extends <a href="../../../../org/apache/juneau/microservice/Microservice.html" t <!-- --> </a> <h3>Methods inherited from class org.apache.juneau.microservice.<a href="../../../../org/apache/juneau/microservice/Microservice.html" title="class in org.apache.juneau.microservice">Microservice</a></h3> -<code><a href="../../../../org/apache/juneau/microservice/Microservice.html#createVarResolver--">createVarResolver</a>, <a href="../../../../org/apache/juneau/microservice/Microservice.html#getArgs--">getArgs</a>, <a href="../../../../org/apache/juneau/microservice/Microservice.html#getConfig--">getConfig</a>, <a href="../../../../org/apache/juneau/microservice/Microservice.html#getManifest--">getManifest</a>, <a href="../../../../org/apache/juneau/microservice/Microservice.html#kill--">kill</a>, <a href="../../../../org/apache/juneau/microservice/Microservice.html#onConfigChange-org.apache.juneau.ini.ConfigFile-java.util.Set-">onConfigChange</a>, <a href="../../../../org/apache/juneau/microservice/Microservice.html#onStart--">onStart</a>, <a href="../../../../org/apache/juneau/microservice/Microservice.html#onStop--">onStop</a>, <a href="../../../../org/apache/juneau/microservice/Microservice.html#setConfig-org.apache.juneau.ini.ConfigFile-">setConfig</a>, <a href="../../../../org/ apache/juneau/microservice/Microservice.html#setConfig-java.lang.String-boolean-">setConfig</a>, <a href="../../../../org/apache/juneau/microservice/Microservice.html#setManifest-java.lang.Class-">setManifest</a>, <a href="../../../../org/apache/juneau/microservice/Microservice.html#setManifest-java.io.File-">setManifest</a>, <a href="../../../../org/apache/juneau/microservice/Microservice.html#setManifest-java.util.jar.Manifest-">setManifest</a>, <a href="../../../../org/apache/juneau/microservice/Microservice.html#setManifestContents-java.lang.String...-">setManifestContents</a></code></li> +<code><a href="../../../../org/apache/juneau/microservice/Microservice.html#createVarResolver--">createVarResolver</a>, <a href="../../../../org/apache/juneau/microservice/Microservice.html#getArgs--">getArgs</a>, <a href="../../../../org/apache/juneau/microservice/Microservice.html#getConfig--">getConfig</a>, <a href="../../../../org/apache/juneau/microservice/Microservice.html#getManifest--">getManifest</a>, <a href="../../../../org/apache/juneau/microservice/Microservice.html#kill--">kill</a>, <a href="../../../../org/apache/juneau/microservice/Microservice.html#onConfigChange-org.apache.juneau.ini.ConfigFile-java.util.Set-">onConfigChange</a>, <a href="../../../../org/apache/juneau/microservice/Microservice.html#onStart--">onStart</a>, <a href="../../../../org/apache/juneau/microservice/Microservice.html#onStop--">onStop</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> @@ -301,7 +350,7 @@ extends <a href="../../../../org/apache/juneau/microservice/Microservice.html" t <ul class="blockListLast"> <li class="blockList"> <h4>RestMicroservice</h4> -<pre>public <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.91">RestMicroservice</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>... args) +<pre>public <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.94">RestMicroservice</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>... args) 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">Constructor.</div> <dl> @@ -326,7 +375,7 @@ extends <a href="../../../../org/apache/juneau/microservice/Microservice.html" t <ul class="blockList"> <li class="blockList"> <h4>main</h4> -<pre>public static void <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.81">main</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>[] args) +<pre>public static void <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.84">main</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>[] args) 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">Main method. Subclasses must also implement this method!</div> @@ -344,7 +393,7 @@ extends <a href="../../../../org/apache/juneau/microservice/Microservice.html" t <ul class="blockList"> <li class="blockList"> <h4>start</h4> -<pre>public <a href="../../../../org/apache/juneau/microservice/RestMicroservice.html" title="class in org.apache.juneau.microservice">RestMicroservice</a> <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.101">start</a>() +<pre>public <a href="../../../../org/apache/juneau/microservice/RestMicroservice.html" title="class in org.apache.juneau.microservice">RestMicroservice</a> <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.104">start</a>() 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/microservice/Microservice.html#start--">Microservice</a></code></span></div> <div class="block">Start this application. @@ -368,7 +417,7 @@ extends <a href="../../../../org/apache/juneau/microservice/Microservice.html" t <ul class="blockList"> <li class="blockList"> <h4>join</h4> -<pre>public <a href="../../../../org/apache/juneau/microservice/RestMicroservice.html" title="class in org.apache.juneau.microservice">RestMicroservice</a> <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.110">join</a>() +<pre>public <a href="../../../../org/apache/juneau/microservice/RestMicroservice.html" title="class in org.apache.juneau.microservice">RestMicroservice</a> <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.113">join</a>() 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/microservice/Microservice.html#join--">Microservice</a></code></span></div> <div class="block">Joins the application with the current thread. @@ -390,7 +439,7 @@ extends <a href="../../../../org/apache/juneau/microservice/Microservice.html" t <ul class="blockList"> <li class="blockList"> <h4>stop</h4> -<pre>public <a href="../../../../org/apache/juneau/microservice/RestMicroservice.html" title="class in org.apache.juneau.microservice">RestMicroservice</a> <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.116">stop</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/microservice/RestMicroservice.html" title="class in org.apache.juneau.microservice">RestMicroservice</a> <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.119">stop</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/microservice/Microservice.html#stop--">Microservice</a></code></span></div> <div class="block">Stop this application. <p> @@ -405,13 +454,41 @@ extends <a href="../../../../org/apache/juneau/microservice/Microservice.html" t </dl> </li> </ul> +<a name="getPort--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPort</h4> +<pre>public int <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.154">getPort</a>()</pre> +<div class="block">Returns the port that this microservice started up on.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The port that this microservice started up on.</dd> +</dl> +</li> +</ul> +<a name="getURI--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getURI</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net">URI</a> <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.162">getURI</a>()</pre> +<div class="block">Returns the URI where this microservice is listening on.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The URI where this microservice is listening on.</dd> +</dl> +</li> +</ul> <a name="initLogging--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>initLogging</h4> -<pre>protected void <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.218">initLogging</a>() +<pre>protected void <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.247">initLogging</a>() 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">Initialize the logging for this microservice. <p> @@ -492,7 +569,7 @@ extends <a href="../../../../org/apache/juneau/microservice/Microservice.html" t <ul class="blockList"> <li class="blockList"> <h4>createServer</h4> -<pre>protected org.eclipse.jetty.server.Server <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.304">createServer</a>() +<pre>protected org.eclipse.jetty.server.Server <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.335">createServer</a>() 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">Method used to create (but not start) an instance of a Jetty server. <p> @@ -507,12 +584,14 @@ extends <a href="../../../../org/apache/juneau/microservice/Microservice.html" t <cs>[REST]</cs> <cc># The HTTP port number to use. - # Default is Rest-Port setting in manifest file, or 8000.</cc> + # Default is Rest-Port setting in manifest file, or 8000. + # Can also specify a comma-delimited lists of ports to try, including 0 meaning + # try a random port.</cc> <ck>port</ck> = 10000 <cc># The context root of the Jetty server. # Default is Rest-ContextPath in manifest file, or "/".</cc> - <ck>contextPath</ck> = 10000 + <ck>contextPath</ck> = <cc># Authentication: NONE, BASIC. # Default is Rest-AuthType in manifest file, or NONE.</cc> @@ -559,12 +638,14 @@ extends <a href="../../../../org/apache/juneau/microservice/Microservice.html" t <ul class="blockList"> <li class="blockList"> <h4>startServer</h4> -<pre>protected void <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.365">startServer</a>() - 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> +<pre>protected int <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.418">startServer</a>() + 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">Method used to start the Jetty server created by <a href="../../../../org/apache/juneau/microservice/RestMicroservice.html#createServer--"><code>createServer()</code></a>. <p> Subclasses can override this method to customize server startup.</div> <dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The port that this server started on.</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> @@ -576,7 +657,7 @@ extends <a href="../../../../org/apache/juneau/microservice/Microservice.html" t <ul class="blockList"> <li class="blockList"> <h4>getResourceMap</h4> -<pre>protected <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="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="http://docs.oracle.com/javaee/5/api/javax/servlet/Servlet.html?is-external=true"; title="class or interface in javax.servlet">Servlet</a>>> <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.417">getResourceMap</a>() +<pre>protected <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="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="http://docs.oracle.com/javaee/5/api/javax/servlet/Servlet.html?is-external=true"; title="class or interface in javax.servlet">Servlet</a>>> <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.471">getResourceMap</a>() throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ClassNotFoundException.html?is-external=true"; title="class or interface in java.lang">ClassNotFoundException</a>, <a href="../../../../org/apache/juneau/parser/ParseException.html" title="class in org.apache.juneau.parser">ParseException</a></pre> <div class="block">Returns the resource map to use for this microservice. @@ -632,7 +713,7 @@ extends <a href="../../../../org/apache/juneau/microservice/Microservice.html" t <ul class="blockList"> <li class="blockList"> <h4>onConfigSave</h4> -<pre>protected void <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.464">onConfigSave</a>(<a href="../../../../org/apache/juneau/ini/ConfigFile.html" title="class in org.apache.juneau.ini">ConfigFile</a> cf)</pre> +<pre>protected void <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.518">onConfigSave</a>(<a href="../../../../org/apache/juneau/ini/ConfigFile.html" title="class in org.apache.juneau.ini">ConfigFile</a> cf)</pre> <div class="block">Called when <a href="../../../../org/apache/juneau/ini/ConfigFile.html#save--"><code>ConfigFile.save()</code></a> is called on the config file. <p> The default behavior is configured by the following value in the config file: @@ -661,7 +742,7 @@ extends <a href="../../../../org/apache/juneau/microservice/Microservice.html" t <ul class="blockList"> <li class="blockList"> <h4>onCreateServer</h4> -<pre>protected void <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.498">onCreateServer</a>()</pre> +<pre>protected void <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.552">onCreateServer</a>()</pre> <div class="block">Called before <a href="../../../../org/apache/juneau/microservice/RestMicroservice.html#createServer--"><code>createServer()</code></a> is called. <p> Subclasses can override this method to hook into the lifecycle of this application.</div> @@ -673,7 +754,7 @@ extends <a href="../../../../org/apache/juneau/microservice/Microservice.html" t <ul class="blockList"> <li class="blockList"> <h4>onStartServer</h4> -<pre>protected void <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.505">onStartServer</a>()</pre> +<pre>protected void <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.559">onStartServer</a>()</pre> <div class="block">Called before <a href="../../../../org/apache/juneau/microservice/RestMicroservice.html#startServer--"><code>startServer()</code></a> is called. <p> Subclasses can override this method to hook into the lifecycle of this application.</div> @@ -685,7 +766,7 @@ extends <a href="../../../../org/apache/juneau/microservice/Microservice.html" t <ul class="blockList"> <li class="blockList"> <h4>onPostStartServer</h4> -<pre>protected void <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.512">onPostStartServer</a>()</pre> +<pre>protected void <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.566">onPostStartServer</a>()</pre> <div class="block">Called after the Jetty server is started. <p> Subclasses can override this method to hook into the lifecycle of this application.</div> @@ -697,7 +778,7 @@ extends <a href="../../../../org/apache/juneau/microservice/Microservice.html" t <ul class="blockList"> <li class="blockList"> <h4>onStopServer</h4> -<pre>protected void <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.519">onStopServer</a>()</pre> +<pre>protected void <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.573">onStopServer</a>()</pre> <div class="block">Called before the Jetty server is stopped. <p> Subclasses can override this method to hook into the lifecycle of this application.</div> @@ -706,15 +787,163 @@ extends <a href="../../../../org/apache/juneau/microservice/Microservice.html" t <a name="onPostStopServer--"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>onPostStopServer</h4> -<pre>protected void <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.526">onPostStopServer</a>()</pre> +<pre>protected void <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.580">onPostStopServer</a>()</pre> <div class="block">Called after the Jetty server is stopped. <p> Subclasses can override this method to hook into the lifecycle of this application.</div> </li> </ul> +<a name="setConfig-java.lang.String-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setConfig</h4> +<pre>public <a href="../../../../org/apache/juneau/microservice/RestMicroservice.html" title="class in org.apache.juneau.microservice">RestMicroservice</a> <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.588">setConfig</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> cfPath, + boolean create) + 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"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/microservice/Microservice.html#setConfig-java.lang.String-boolean-">Microservice</a></code></span></div> +<div class="block">Specifies the path of the config file for this microservice. + <p> + If you do not specify the config file location, we attempt to resolve it through the following methods: + <ol> + <li>The first argument in the command line arguments passed in through the constructor. + <li>The value of the <code>Main-ConfigFile</code> entry in the manifest file. + <li>A config file in the same location and with the same name as the executable jar file. + (e.g. <js>"java -jar myjar.jar"</js> will look for <js>"myjar.cfg"</js>). + </ol> + If this path does not exist, a <a href="http://docs.oracle.com/javase/7/docs/api/java/io/FileNotFoundException.html?is-external=true"; title="class or interface in java.io"><code>FileNotFoundException</code></a> will be thrown from the <a href="../../../../org/apache/juneau/microservice/Microservice.html#start--"><code>Microservice.start()</code></a> command.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/microservice/Microservice.html#setConfig-java.lang.String-boolean-">setConfig</a></code> in class <code><a href="../../../../org/apache/juneau/microservice/Microservice.html" title="class in org.apache.juneau.microservice">Microservice</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>cfPath</code> - The absolute or relative path of the config file.</dd> +<dd><code>create</code> - Create the file if it doesn't exist.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><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></code> - If config file does not exist at the specified location or could not be read or created.</dd> +</dl> +</li> +</ul> +<a name="setConfig-org.apache.juneau.ini.ConfigFile-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setConfig</h4> +<pre>public <a href="../../../../org/apache/juneau/microservice/RestMicroservice.html" title="class in org.apache.juneau.microservice">RestMicroservice</a> <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.594">setConfig</a>(<a href="../../../../org/apache/juneau/ini/ConfigFile.html" title="class in org.apache.juneau.ini">ConfigFile</a> cf)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/microservice/Microservice.html#setConfig-org.apache.juneau.ini.ConfigFile-">Microservice</a></code></span></div> +<div class="block">Specifies the config file for this microservice. + <p> + Note that if you use this method instead of <a href="../../../../org/apache/juneau/microservice/Microservice.html#setConfig-java.lang.String-boolean-"><code>Microservice.setConfig(String,boolean)</code></a>, the config file will not use + the variable resolver constructed from <a href="../../../../org/apache/juneau/microservice/Microservice.html#createVarResolver--"><code>Microservice.createVarResolver()</code></a>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/microservice/Microservice.html#setConfig-org.apache.juneau.ini.ConfigFile-">setConfig</a></code> in class <code><a href="../../../../org/apache/juneau/microservice/Microservice.html" title="class in org.apache.juneau.microservice">Microservice</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>cf</code> - The config file for this application, or <jk>null</jk> if no config file is needed.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="setManifest-java.util.jar.Manifest-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setManifest</h4> +<pre>public <a href="../../../../org/apache/juneau/microservice/RestMicroservice.html" title="class in org.apache.juneau.microservice">RestMicroservice</a> <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.600">setManifest</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/jar/Manifest.html?is-external=true"; title="class or interface in java.util.jar">Manifest</a> mf)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/microservice/Microservice.html#setManifest-java.util.jar.Manifest-">Microservice</a></code></span></div> +<div class="block">Specifies the manifest file of the jar file this microservice is contained within. + <p> + If you do not specify the manifest file, we attempt to resolve it through the following methods: + <ol> + <li>Looking on the file system for a file at <js>"META-INF/MANIFEST.MF"</js>. + This is primarily to allow for running microservices from within eclipse workspaces where the manifest file + is located in the project root. + <li>Using the class loader for this class to find the file at the URL <js>"META-INF/MANIFEST.MF"</js>. + </ol></div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/microservice/Microservice.html#setManifest-java.util.jar.Manifest-">setManifest</a></code> in class <code><a href="../../../../org/apache/juneau/microservice/Microservice.html" title="class in org.apache.juneau.microservice">Microservice</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>mf</code> - The manifest file of this microservice.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="setManifestContents-java.lang.String...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setManifestContents</h4> +<pre>public <a href="../../../../org/apache/juneau/microservice/RestMicroservice.html" title="class in org.apache.juneau.microservice">RestMicroservice</a> <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.606">setManifestContents</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>... contents) + 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"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/microservice/Microservice.html#setManifestContents-java.lang.String...-">Microservice</a></code></span></div> +<div class="block">Convenience method for specifying the manifest contents directly.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/microservice/Microservice.html#setManifestContents-java.lang.String...-">setManifestContents</a></code> in class <code><a href="../../../../org/apache/juneau/microservice/Microservice.html" title="class in org.apache.juneau.microservice">Microservice</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>contents</code> - The lines in the manifest file.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><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></code></dd> +</dl> +</li> +</ul> +<a name="setManifest-java.io.File-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setManifest</h4> +<pre>public <a href="../../../../org/apache/juneau/microservice/RestMicroservice.html" title="class in org.apache.juneau.microservice">RestMicroservice</a> <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.612">setManifest</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> f) + 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"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/microservice/Microservice.html#setManifest-java.io.File-">Microservice</a></code></span></div> +<div class="block">Same as <a href="../../../../org/apache/juneau/microservice/Microservice.html#setManifest-java.util.jar.Manifest-"><code>Microservice.setManifest(Manifest)</code></a> except specified through a <a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io"><code>File</code></a> object.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/microservice/Microservice.html#setManifest-java.io.File-">setManifest</a></code> in class <code><a href="../../../../org/apache/juneau/microservice/Microservice.html" title="class in org.apache.juneau.microservice">Microservice</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>f</code> - The manifest file of this microservice.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><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></code> - If a problem occurred while trying to read the manifest file.</dd> +</dl> +</li> +</ul> +<a name="setManifest-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setManifest</h4> +<pre>public <a href="../../../../org/apache/juneau/microservice/RestMicroservice.html" title="class in org.apache.juneau.microservice">RestMicroservice</a> <a href="../../../../src-html/org/apache/juneau/microservice/RestMicroservice.html#line.618">setManifest</a>(<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><?> c) + 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"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/microservice/Microservice.html#setManifest-java.lang.Class-">Microservice</a></code></span></div> +<div class="block">Same as <a href="../../../../org/apache/juneau/microservice/Microservice.html#setManifest-java.util.jar.Manifest-"><code>Microservice.setManifest(Manifest)</code></a> except finds and loads the manifest file of the jar file that the specified class is contained within.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/microservice/Microservice.html#setManifest-java.lang.Class-">setManifest</a></code> in class <code><a href="../../../../org/apache/juneau/microservice/Microservice.html" title="class in org.apache.juneau.microservice">Microservice</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>c</code> - The class whose jar file contains the manifest to use for this microservice.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><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></code> - If a problem occurred while trying to read the manifest file.</dd> +</dl> +</li> +</ul> </li> </ul> </li>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/756ffe72/content/site/apidocs/org/apache/juneau/microservice/package-summary.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/microservice/package-summary.html b/content/site/apidocs/org/apache/juneau/microservice/package-summary.html index bb2d037..1d9fc81 100644 --- a/content/site/apidocs/org/apache/juneau/microservice/package-summary.html +++ b/content/site/apidocs/org/apache/juneau/microservice/package-summary.html @@ -453,6 +453,8 @@ <cs>[REST]</cs> <cc># The HTTP port number to use. + # Can be a comma-delimited list of ports to try. + # 0 means try a random port. # Default is Rest-Port setting in manifest file, or 8000.</cc> <ck>port</ck> = <cv>10000</cv> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/756ffe72/content/site/apidocs/org/apache/juneau/rest/ReaderResource.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/ReaderResource.html b/content/site/apidocs/org/apache/juneau/rest/ReaderResource.html index 31ca73b..521eb61 100644 --- a/content/site/apidocs/org/apache/juneau/rest/ReaderResource.html +++ b/content/site/apidocs/org/apache/juneau/rest/ReaderResource.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -49,7 +49,7 @@ var activeTableTab = "activeTableTab"; <div class="subNav"> <ul class="navList"> <li><a href="../../../../org/apache/juneau/rest/ClientVersionMatcher.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/juneau/rest/Redirect.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/juneau/rest/ReaderResource.Builder.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/juneau/rest/ReaderResource.html" target="_top">Frames</a></li> @@ -73,7 +73,7 @@ var activeTableTab = "activeTableTab"; <div> <ul class="subNavList"> <li>Summary: </li> -<li>Nested | </li> +<li><a href="#nested.class.summary">Nested</a> | </li> <li>Field | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> @@ -112,7 +112,7 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>public class <a href="../../../../src-html/org/apache/juneau/rest/ReaderResource.html#line.29">ReaderResource</a> +<pre>public class <a href="../../../../src-html/org/apache/juneau/rest/ReaderResource.html#line.30">ReaderResource</a> extends <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> implements <a href="../../../../org/apache/juneau/Writable.html" title="interface in org.apache.juneau">Writable</a></pre> <div class="block">Represents the contents of a text file with convenience methods for resolving @@ -125,6 +125,27 @@ implements <a href="../../../../org/apache/juneau/Writable.html" title="interfac <div class="summary"> <ul class="blockList"> <li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/ReaderResource.Builder.html" title="class in org.apache.juneau.rest">ReaderResource.Builder</a></span></code> +<div class="block">Builder class for constructing <a href="../../../../org/apache/juneau/rest/ReaderResource.html" title="class in org.apache.juneau.rest"><code>ReaderResource</code></a> objects.</div> +</td> +</tr> +</table> +</li> +</ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor.summary"> @@ -138,9 +159,18 @@ implements <a href="../../../../org/apache/juneau/Writable.html" title="interfac <th class="colLast" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> +<td class="colFirst"><code> </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/ReaderResource.html#ReaderResource-org.apache.juneau.MediaType-java.util.Map-org.apache.juneau.svl.VarResolverSession-java.lang.Object...-">ReaderResource</a></span>(<a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a> mediaType, + <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="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> headers, + <a href="../../../../org/apache/juneau/svl/VarResolverSession.html" title="class in org.apache.juneau.svl">VarResolverSession</a> varSession, + <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>... contents)</code> +<div class="block">Constructor.</div> +</td> +</tr> +<tr class="rowColor"> <td class="colFirst"><code>protected </code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/ReaderResource.html#ReaderResource-java.lang.String-org.apache.juneau.MediaType-">ReaderResource</a></span>(<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> contents, - <a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a> mediaType)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/ReaderResource.html#ReaderResource-org.apache.juneau.MediaType-java.lang.Object...-">ReaderResource</a></span>(<a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a> mediaType, + <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>... contents)</code> <div class="block">Constructor.</div> </td> </tr> @@ -172,24 +202,10 @@ implements <a href="../../../../org/apache/juneau/Writable.html" title="interfac </td> </tr> <tr id="i2" class="altColor"> -<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/ReaderResource.html" title="class in org.apache.juneau.rest">ReaderResource</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/ReaderResource.html#setHeader-java.lang.String-java.lang.Object-">setHeader</a></span>(<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, - <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> value)</code> -<div class="block">Add an HTTP response header.</div> -</td> -</tr> -<tr id="i3" class="rowColor"> -<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/ReaderResource.html" title="class in org.apache.juneau.rest">ReaderResource</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/ReaderResource.html#setVarSession-org.apache.juneau.svl.VarResolverSession-">setVarSession</a></span>(<a href="../../../../org/apache/juneau/svl/VarResolverSession.html" title="class in org.apache.juneau.svl">VarResolverSession</a> varSession)</code> -<div class="block">Use the specified <a href="../../../../org/apache/juneau/svl/VarResolver.html" title="class in org.apache.juneau.svl"><code>VarResolver</code></a> to resolve any <a href="../../../../org/apache/juneau/rest/annotation/Parameter.html" title="annotation in org.apache.juneau.rest.annotation"><code>StringVars</code></a> in the - contents of this file when the <a href="../../../../org/apache/juneau/rest/ReaderResource.html#writeTo-java.io.Writer-"><code>writeTo(Writer)</code></a> or <a href="../../../../org/apache/juneau/rest/ReaderResource.html#toString--"><code>toString()</code></a> methods are called.</div> -</td> -</tr> -<tr id="i4" 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/ReaderResource.html#toString--">toString</a></span>()</code> </td> </tr> -<tr id="i5" class="rowColor"> +<tr id="i3" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/ReaderResource.html#writeTo-java.io.Writer-">writeTo</a></span>(<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)</code> <div class="block">Serialize this object to the specified writer.</div> @@ -217,72 +233,78 @@ implements <a href="../../../../org/apache/juneau/Writable.html" title="interfac <!-- --> </a> <h3>Constructor Detail</h3> -<a name="ReaderResource-java.lang.String-org.apache.juneau.MediaType-"> +<a name="ReaderResource-org.apache.juneau.MediaType-java.lang.Object...-"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>ReaderResource</h4> -<pre>protected <a href="../../../../src-html/org/apache/juneau/rest/ReaderResource.html#line.42">ReaderResource</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> contents, - <a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a> mediaType)</pre> +<pre>protected <a href="../../../../src-html/org/apache/juneau/rest/ReaderResource.html#line.50">ReaderResource</a>(<a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a> mediaType, + <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>... contents) + 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">Constructor.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>contents</code> - The contents of this resource.</dd> <dd><code>mediaType</code> - The HTTP media type.</dd> +<dd><code>contents</code> - The contents of this resource. + <br>If multiple contents are specified, the results will be concatenated. + <br>Contents can be any of the following: + <ul> + <li><code>CharSequence</code> + <li><code>Reader</code> + <li><code>File</code> + </ul></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><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></code></dd> </dl> </li> </ul> -</li> -</ul> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.detail"> +<a name="ReaderResource-org.apache.juneau.MediaType-java.util.Map-org.apache.juneau.svl.VarResolverSession-java.lang.Object...-"> <!-- --> </a> -<h3>Method Detail</h3> -<a name="setHeader-java.lang.String-java.lang.Object-"> -<!-- --> -</a> -<ul class="blockList"> +<ul class="blockListLast"> <li class="blockList"> -<h4>setHeader</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/ReaderResource.html#line.54">setHeader</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, - <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> value)</pre> -<div class="block">Add an HTTP response header.</div> +<h4>ReaderResource</h4> +<pre>public <a href="../../../../src-html/org/apache/juneau/rest/ReaderResource.html#line.70">ReaderResource</a>(<a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a> mediaType, + <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="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> headers, + <a href="../../../../org/apache/juneau/svl/VarResolverSession.html" title="class in org.apache.juneau.svl">VarResolverSession</a> varSession, + <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>... contents) + 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">Constructor.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>name</code> - The header name.</dd> -<dd><code>value</code> - The header value converted to a string using <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"><code>Object.toString()</code></a>.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>This object (for method chaining).</dd> +<dd><code>mediaType</code> - The resource media type.</dd> +<dd><code>headers</code> - The HTTP response headers for this streamed resource.</dd> +<dd><code>varSession</code> - Optional variable resolver for resolving variables in the string.</dd> +<dd><code>contents</code> - The resource contents. + <br>If multiple contents are specified, the results will be concatenated. + <br>Contents can be any of the following: + <ul> + <li><code>InputStream</code> + <li><code>Reader</code> - Converted to UTF-8 bytes. + <li><code>File</code> + <li><code>CharSequence</code> - Converted to UTF-8 bytes. + </ul></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><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></code></dd> </dl> </li> </ul> -<a name="setVarSession-org.apache.juneau.svl.VarResolverSession-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setVarSession</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/ReaderResource.html#line.66">setVarSession</a>(<a href="../../../../org/apache/juneau/svl/VarResolverSession.html" title="class in org.apache.juneau.svl">VarResolverSession</a> varSession)</pre> -<div class="block">Use the specified <a href="../../../../org/apache/juneau/svl/VarResolver.html" title="class in org.apache.juneau.svl"><code>VarResolver</code></a> to resolve any <a href="../../../../org/apache/juneau/rest/annotation/Parameter.html" title="annotation in org.apache.juneau.rest.annotation"><code>StringVars</code></a> in the - contents of this file when the <a href="../../../../org/apache/juneau/rest/ReaderResource.html#writeTo-java.io.Writer-"><code>writeTo(Writer)</code></a> or <a href="../../../../org/apache/juneau/rest/ReaderResource.html#toString--"><code>toString()</code></a> methods are called.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>varSession</code> - The string variable resolver to use to resolve string variables.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>This object (for method chaining).</dd> -</dl> </li> </ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> <a name="getHeaders--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getHeaders</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="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/ReaderResource.html#line.76">getHeaders</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="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/ReaderResource.html#line.200">getHeaders</a>()</pre> <div class="block">Get the HTTP response headers.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -296,7 +318,7 @@ implements <a href="../../../../org/apache/juneau/Writable.html" title="interfac <ul class="blockList"> <li class="blockList"> <h4>writeTo</h4> -<pre>public void <a href="../../../../src-html/org/apache/juneau/rest/ReaderResource.html#line.81">writeTo</a>(<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) +<pre>public void <a href="../../../../src-html/org/apache/juneau/rest/ReaderResource.html#line.205">writeTo</a>(<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) 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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/juneau/Writable.html#writeTo-java.io.Writer-">Writable</a></code></span></div> <div class="block">Serialize this object to the specified writer.</div> @@ -316,7 +338,7 @@ implements <a href="../../../../org/apache/juneau/Writable.html" title="interfac <ul class="blockList"> <li class="blockList"> <h4>getMediaType</h4> -<pre>public <a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a> <a href="../../../../src-html/org/apache/juneau/rest/ReaderResource.html#line.89">getMediaType</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a> <a href="../../../../src-html/org/apache/juneau/rest/ReaderResource.html#line.215">getMediaType</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/juneau/Writable.html#getMediaType--">Writable</a></code></span></div> <div class="block">Returns the serialized media type for this resource (e.g. <js>"text/html"</js>)</div> <dl> @@ -333,7 +355,7 @@ implements <a href="../../../../org/apache/juneau/Writable.html" title="interfac <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/ReaderResource.html#line.94">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/ReaderResource.html#line.220">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> @@ -368,7 +390,7 @@ implements <a href="../../../../org/apache/juneau/Writable.html" title="interfac <div class="subNav"> <ul class="navList"> <li><a href="../../../../org/apache/juneau/rest/ClientVersionMatcher.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/juneau/rest/Redirect.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/juneau/rest/ReaderResource.Builder.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/juneau/rest/ReaderResource.html" target="_top">Frames</a></li> @@ -392,7 +414,7 @@ implements <a href="../../../../org/apache/juneau/Writable.html" title="interfac <div> <ul class="subNavList"> <li>Summary: </li> -<li>Nested | </li> +<li><a href="#nested.class.summary">Nested</a> | </li> <li>Field | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/756ffe72/content/site/apidocs/org/apache/juneau/rest/Redirect.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/Redirect.html b/content/site/apidocs/org/apache/juneau/rest/Redirect.html index f366a8f..2cbc50c 100644 --- a/content/site/apidocs/org/apache/juneau/rest/Redirect.html +++ b/content/site/apidocs/org/apache/juneau/rest/Redirect.html @@ -48,7 +48,7 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/juneau/rest/ReaderResource.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/rest/ReaderResource.Builder.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../org/apache/juneau/rest/ResponseHandler.html" title="interface in org.apache.juneau.rest"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> @@ -177,21 +177,21 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </td> </tr> <tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/Redirect.html#Redirect-java.lang.CharSequence-java.lang.Object...-">Redirect</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/CharSequence.html?is-external=true"; title="class or interface in java.lang">CharSequence</a> url, +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/Redirect.html#Redirect-int-java.lang.Object-java.lang.Object...-">Redirect</a></span>(int httpResponseCode, + <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> url, <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)</code> <div class="block">Redirect to the specified URL.</div> </td> </tr> <tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/Redirect.html#Redirect-int-java.lang.CharSequence-java.lang.Object...-">Redirect</a></span>(int httpResponseCode, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/CharSequence.html?is-external=true"; title="class or interface in java.lang">CharSequence</a> url, - <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)</code> -<div class="block">Redirect to the specified URL.</div> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/Redirect.html#Redirect-java.lang.Object-">Redirect</a></span>(<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> url)</code> +<div class="block">Convenience method for redirecting to instance of <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net"><code>URL</code></a> and <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net"><code>URI</code></a>.</div> </td> </tr> <tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/Redirect.html#Redirect-java.lang.Object-">Redirect</a></span>(<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> url)</code> -<div class="block">Convenience method for redirecting to instance of <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net"><code>URL</code></a> and <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net"><code>URI</code></a>.</div> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/Redirect.html#Redirect-java.lang.Object-java.lang.Object...-">Redirect</a></span>(<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> url, + <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)</code> +<div class="block">Redirect to the specified URL.</div> </td> </tr> </table> @@ -243,19 +243,25 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <!-- --> </a> <h3>Constructor Detail</h3> -<a name="Redirect-java.lang.CharSequence-java.lang.Object...-"> +<a name="Redirect-java.lang.Object-java.lang.Object...-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>Redirect</h4> -<pre>public <a href="../../../../src-html/org/apache/juneau/rest/Redirect.html#line.80">Redirect</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/CharSequence.html?is-external=true"; title="class or interface in java.lang">CharSequence</a> url, +<pre>public <a href="../../../../src-html/org/apache/juneau/rest/Redirect.html#line.86">Redirect</a>(<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> url, <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">Redirect to the specified URL. Relative paths are interpreted as relative to the servlet path.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>url</code> - The URL to redirect to.</dd> +<dd><code>url</code> - The URL to redirect to. + <br>Can be any of the following: + <ul> + <li><code>URL</code> + <li><code>URI</code> + <li><code>CharSequence</code> + </ul></dd> <dd><code>args</code> - Optional <a href="http://docs.oracle.com/javase/7/docs/api/java/text/MessageFormat.html?is-external=true"; title="class or interface in java.text"><code>MessageFormat</code></a>-style arguments.</dd> </dl> </li> @@ -266,30 +272,42 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>Redirect</h4> -<pre>public <a href="../../../../src-html/org/apache/juneau/rest/Redirect.html#line.91">Redirect</a>(<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> url)</pre> +<pre>public <a href="../../../../src-html/org/apache/juneau/rest/Redirect.html#line.102">Redirect</a>(<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> url)</pre> <div class="block">Convenience method for redirecting to instance of <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net"><code>URL</code></a> and <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net"><code>URI</code></a>. Same as calling <code>toString()</code> on the object and using the other constructor.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>url</code> - The URL to redirect to.</dd> +<dd><code>url</code> - The URL to redirect to. + <br>Can be any of the following: + <ul> + <li><code>URL</code> + <li><code>URI</code> + <li><code>CharSequence</code> + </ul></dd> </dl> </li> </ul> -<a name="Redirect-int-java.lang.CharSequence-java.lang.Object...-"> +<a name="Redirect-int-java.lang.Object-java.lang.Object...-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>Redirect</h4> -<pre>public <a href="../../../../src-html/org/apache/juneau/rest/Redirect.html#line.103">Redirect</a>(int httpResponseCode, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/CharSequence.html?is-external=true"; title="class or interface in java.lang">CharSequence</a> url, +<pre>public <a href="../../../../src-html/org/apache/juneau/rest/Redirect.html#line.120">Redirect</a>(int httpResponseCode, + <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> url, <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">Redirect to the specified URL. Relative paths are interpreted as relative to the servlet path.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>httpResponseCode</code> - The HTTP response code.</dd> -<dd><code>url</code> - The URL to redirect to.</dd> +<dd><code>url</code> - The URL to redirect to. + <br>Can be any of the following: + <ul> + <li><code>URL</code> + <li><code>URI</code> + <li><code>CharSequence</code> + </ul></dd> <dd><code>args</code> - Optional <a href="http://docs.oracle.com/javase/7/docs/api/java/text/MessageFormat.html?is-external=true"; title="class or interface in java.text"><code>MessageFormat</code></a>-style arguments.</dd> </dl> </li> @@ -300,7 +318,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>Redirect</h4> -<pre>public <a href="../../../../src-html/org/apache/juneau/rest/Redirect.html#line.112">Redirect</a>()</pre> +<pre>public <a href="../../../../src-html/org/apache/juneau/rest/Redirect.html#line.129">Redirect</a>()</pre> <div class="block">Shortcut for redirecting to the servlet root.</div> </li> </ul> @@ -318,7 +336,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>toUrl</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/Redirect.html#line.121">toUrl</a>(<a href="../../../../org/apache/juneau/urlencoding/UrlEncodingSerializer.html" title="class in org.apache.juneau.urlencoding">UrlEncodingSerializer</a> s)</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/Redirect.html#line.139">toUrl</a>(<a href="../../../../org/apache/juneau/urlencoding/UrlEncodingSerializer.html" title="class in org.apache.juneau.urlencoding">UrlEncodingSerializer</a> s)</pre> <div class="block">Calculates the URL to redirect to.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -334,7 +352,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>getHttpResponseCode</h4> -<pre>public int <a href="../../../../src-html/org/apache/juneau/rest/Redirect.html#line.135">getHttpResponseCode</a>()</pre> +<pre>public int <a href="../../../../src-html/org/apache/juneau/rest/Redirect.html#line.153">getHttpResponseCode</a>()</pre> <div class="block">Returns the response code passed in through the constructor.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -369,7 +387,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/juneau/rest/ReaderResource.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/rest/ReaderResource.Builder.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../org/apache/juneau/rest/ResponseHandler.html" title="interface in org.apache.juneau.rest"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList">
