http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/org/apache/juneau/rest/RestInfoProvider.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/rest/RestInfoProvider.html
b/content/site/apidocs/org/apache/juneau/rest/RestInfoProvider.html
index 86104a2..5c3819b 100644
--- a/content/site/apidocs/org/apache/juneau/rest/RestInfoProvider.html
+++ b/content/site/apidocs/org/apache/juneau/rest/RestInfoProvider.html
@@ -18,7 +18,7 @@
catch(err) {
}
//-->
-var methods =
{"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10};
+var methods =
{"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance
Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@@ -198,36 +198,42 @@ extends <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
</td>
</tr>
<tr id="i6" 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/RestInfoProvider.html#getSiteName-org.apache.juneau.rest.RestRequest-">getSiteName</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 the localized site name of this REST resource.</div>
+</td>
+</tr>
+<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected <a
href="../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in
org.apache.juneau.dto.swagger">Swagger</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/juneau/rest/RestInfoProvider.html#getSwagger-org.apache.juneau.rest.RestRequest-">getSwagger</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 the localized swagger for this REST resource.</div>
</td>
</tr>
-<tr id="i7" class="rowColor">
+<tr id="i8" class="altColor">
<td class="colFirst"><code>protected <a
href="../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in
org.apache.juneau.dto.swagger">Swagger</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/juneau/rest/RestInfoProvider.html#getSwaggerFromFile-java.util.Locale-">getSwaggerFromFile</a></span>(<a
href="http://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true";
title="class or interface in java.util">Locale</a> locale)</code>
<div class="block">Returns the localized Swagger from the file system.</div>
</td>
</tr>
-<tr id="i8" class="altColor">
+<tr id="i9" class="rowColor">
<td class="colFirst"><code><a
href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util">List</a><<a
href="../../../../org/apache/juneau/dto/swagger/Tag.html" title="class in
org.apache.juneau.dto.swagger">Tag</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/juneau/rest/RestInfoProvider.html#getTags-org.apache.juneau.rest.RestRequest-">getTags</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 the version information of this REST resource.</div>
</td>
</tr>
-<tr id="i9" class="rowColor">
+<tr id="i10" 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/RestInfoProvider.html#getTermsOfService-org.apache.juneau.rest.RestRequest-">getTermsOfService</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 the terms-of-service information of this REST
resource.</div>
</td>
</tr>
-<tr id="i10" class="altColor">
+<tr id="i11" 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/RestInfoProvider.html#getTitle-org.apache.juneau.rest.RestRequest-">getTitle</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 the localized title of this REST resource.</div>
</td>
</tr>
-<tr id="i11" class="rowColor">
+<tr id="i12" 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/RestInfoProvider.html#getVersion-org.apache.juneau.rest.RestRequest-">getVersion</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 the version information of this REST resource.</div>
@@ -261,7 +267,7 @@ extends <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
<ul class="blockListLast">
<li class="blockList">
<h4>RestInfoProvider</h4>
-<pre>public <a
href="../../../../src-html/org/apache/juneau/rest/RestInfoProvider.html#line.63">RestInfoProvider</a>(<a
href="../../../../org/apache/juneau/rest/RestContext.html" title="class in
org.apache.juneau.rest">RestContext</a> context)</pre>
+<pre>public <a
href="../../../../src-html/org/apache/juneau/rest/RestInfoProvider.html#line.64">RestInfoProvider</a>(<a
href="../../../../org/apache/juneau/rest/RestContext.html" title="class in
org.apache.juneau.rest">RestContext</a> context)</pre>
<div class="block">Constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -283,7 +289,7 @@ extends <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
<ul class="blockList">
<li class="blockList">
<h4>getSwagger</h4>
-<pre>protected <a
href="../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in
org.apache.juneau.dto.swagger">Swagger</a> <a
href="../../../../src-html/org/apache/juneau/rest/RestInfoProvider.html#line.121">getSwagger</a>(<a
href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in
org.apache.juneau.rest">RestRequest</a> req)
+<pre>protected <a
href="../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in
org.apache.juneau.dto.swagger">Swagger</a> <a
href="../../../../src-html/org/apache/juneau/rest/RestInfoProvider.html#line.126">getSwagger</a>(<a
href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in
org.apache.juneau.rest">RestRequest</a> req)
throws <a
href="../../../../org/apache/juneau/rest/RestException.html" title="class in
org.apache.juneau.rest">RestException</a></pre>
<div class="block">Returns the localized swagger for this REST resource.</div>
<dl>
@@ -302,7 +308,7 @@ extends <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
<ul class="blockList">
<li class="blockList">
<h4>getSwaggerFromFile</h4>
-<pre>protected <a
href="../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in
org.apache.juneau.dto.swagger">Swagger</a> <a
href="../../../../src-html/org/apache/juneau/rest/RestInfoProvider.html#line.172">getSwaggerFromFile</a>(<a
href="http://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true";
title="class or interface in java.util">Locale</a> locale)
+<pre>protected <a
href="../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in
org.apache.juneau.dto.swagger">Swagger</a> <a
href="../../../../src-html/org/apache/juneau/rest/RestInfoProvider.html#line.177">getSwaggerFromFile</a>(<a
href="http://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true";
title="class or interface in java.util">Locale</a> locale)
throws <a
href="../../../../org/apache/juneau/rest/RestException.html" title="class in
org.apache.juneau.rest">RestException</a></pre>
<div class="block">Returns the localized Swagger from the file system.
@@ -328,7 +334,7 @@ extends <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
<ul class="blockList">
<li class="blockList">
<h4>getMethodSummary</h4>
-<pre>public <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> <a
href="../../../../src-html/org/apache/juneau/rest/RestInfoProvider.html#line.205">getMethodSummary</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> javaMethodName,
+<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/RestInfoProvider.html#line.210">getMethodSummary</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> javaMethodName,
<a
href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in
org.apache.juneau.rest">RestRequest</a> req)</pre>
<div class="block">Returns the localized summary of the specified java method
on this servlet.
@@ -359,7 +365,7 @@ extends <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
<ul class="blockList">
<li class="blockList">
<h4>getMethodDescription</h4>
-<pre>protected <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> <a
href="../../../../src-html/org/apache/juneau/rest/RestInfoProvider.html#line.232">getMethodDescription</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> javaMethodName,
+<pre>protected <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> <a
href="../../../../src-html/org/apache/juneau/rest/RestInfoProvider.html#line.237">getMethodDescription</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> javaMethodName,
<a
href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in
org.apache.juneau.rest">RestRequest</a> req)</pre>
<div class="block">Returns the localized description of the specified java
method on this servlet.
@@ -384,13 +390,43 @@ extends <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
</dl>
</li>
</ul>
+<a name="getSiteName-org.apache.juneau.rest.RestRequest-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getSiteName</h4>
+<pre>public <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> <a
href="../../../../src-html/org/apache/juneau/rest/RestInfoProvider.html#line.264">getSiteName</a>(<a
href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in
org.apache.juneau.rest">RestRequest</a> req)</pre>
+<div class="block">Returns the localized site name of this REST resource.
+
+ <p>
+ Subclasses can override this method to provide their own site name.
+
+ <p>
+ The default implementation returns the description from the following
locations (whichever matches first):
+ <ol>
+ <li><a
href="../../../../org/apache/juneau/rest/annotation/RestResource.html#siteName--"><code>@RestResource.siteName()</code></a>
annotation on this class, and then any parent classes.
+ <li><ck>[ClassName].siteName</ck> property in resource bundle identified by
+ <a
href="../../../../org/apache/juneau/rest/annotation/RestResource.html#messages--"><code>@ResourceBundle.messages()</code></a>
annotation for this class, then any parent
+ classes.
+ <li><ck>siteName</ck> in resource bundle identified by <a
href="../../../../org/apache/juneau/rest/annotation/RestResource.html#messages--"><code>@RestResource.messages()</code></a>
+ annotation for this class, then any parent classes.
+ </ol></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>req</code> - The current request.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The localized description of this REST resource, or <jk>null</jk> if no
resource description was found.</dd>
+</dl>
+</li>
+</ul>
<a name="getTitle-org.apache.juneau.rest.RestRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTitle</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/RestInfoProvider.html#line.260">getTitle</a>(<a
href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in
org.apache.juneau.rest">RestRequest</a> req)</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/RestInfoProvider.html#line.295">getTitle</a>(<a
href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in
org.apache.juneau.rest">RestRequest</a> req)</pre>
<div class="block">Returns the localized title of this REST resource.
<p>
@@ -399,7 +435,7 @@ extends <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
<p>
The default implementation returns the description from the following
locations (whichever matches first):
<ol>
- <li><a
href="../../../../org/apache/juneau/rest/annotation/RestResource.html#title--"><code>@RestResourcel.title()</code></a>
annotation on this class, and then any parent classes.
+ <li><a
href="../../../../org/apache/juneau/rest/annotation/RestResource.html#title--"><code>@RestResource.title()</code></a>
annotation on this class, and then any parent classes.
<li><ck>[ClassName].title</ck> property in resource bundle identified by
<a
href="../../../../org/apache/juneau/rest/annotation/RestResource.html#messages--"><code>@ResourceBundle.messages()</code></a>
annotation for this class, then any parent
classes.
@@ -421,7 +457,7 @@ extends <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
<ul class="blockList">
<li class="blockList">
<h4>getDescription</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/RestInfoProvider.html#line.294">getDescription</a>(<a
href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in
org.apache.juneau.rest">RestRequest</a> req)</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/RestInfoProvider.html#line.329">getDescription</a>(<a
href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in
org.apache.juneau.rest">RestRequest</a> req)</pre>
<div class="block">Returns the localized description of this REST resource.
<p>
@@ -452,7 +488,7 @@ extends <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
<ul class="blockList">
<li class="blockList">
<h4>getContact</h4>
-<pre>public <a
href="../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in
org.apache.juneau.dto.swagger">Contact</a> <a
href="../../../../src-html/org/apache/juneau/rest/RestInfoProvider.html#line.329">getContact</a>(<a
href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in
org.apache.juneau.rest">RestRequest</a> req)</pre>
+<pre>public <a
href="../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in
org.apache.juneau.dto.swagger">Contact</a> <a
href="../../../../src-html/org/apache/juneau/rest/RestInfoProvider.html#line.364">getContact</a>(<a
href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in
org.apache.juneau.rest">RestRequest</a> req)</pre>
<div class="block">Returns the localized contact information of this REST
resource.
<p>
@@ -483,7 +519,7 @@ extends <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
<ul class="blockList">
<li class="blockList">
<h4>getLicense</h4>
-<pre>public <a
href="../../../../org/apache/juneau/dto/swagger/License.html" title="class in
org.apache.juneau.dto.swagger">License</a> <a
href="../../../../src-html/org/apache/juneau/rest/RestInfoProvider.html#line.369">getLicense</a>(<a
href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in
org.apache.juneau.rest">RestRequest</a> req)</pre>
+<pre>public <a
href="../../../../org/apache/juneau/dto/swagger/License.html" title="class in
org.apache.juneau.dto.swagger">License</a> <a
href="../../../../src-html/org/apache/juneau/rest/RestInfoProvider.html#line.404">getLicense</a>(<a
href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in
org.apache.juneau.rest">RestRequest</a> req)</pre>
<div class="block">Returns the localized license information of this REST
resource.
<p>
@@ -514,7 +550,7 @@ extends <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
<ul class="blockList">
<li class="blockList">
<h4>getTermsOfService</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/RestInfoProvider.html#line.410">getTermsOfService</a>(<a
href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in
org.apache.juneau.rest">RestRequest</a> req)</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/RestInfoProvider.html#line.445">getTermsOfService</a>(<a
href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in
org.apache.juneau.rest">RestRequest</a> req)</pre>
<div class="block">Returns the terms-of-service information of this REST
resource.
<p>
@@ -546,7 +582,7 @@ extends <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
<ul class="blockList">
<li class="blockList">
<h4>getVersion</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/RestInfoProvider.html#line.445">getVersion</a>(<a
href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in
org.apache.juneau.rest">RestRequest</a> req)</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/RestInfoProvider.html#line.480">getVersion</a>(<a
href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in
org.apache.juneau.rest">RestRequest</a> req)</pre>
<div class="block">Returns the version information of this REST resource.
<p>
@@ -577,7 +613,7 @@ extends <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
<ul class="blockList">
<li class="blockList">
<h4>getTags</h4>
-<pre>public <a
href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util">List</a><<a
href="../../../../org/apache/juneau/dto/swagger/Tag.html" title="class in
org.apache.juneau.dto.swagger">Tag</a>> <a
href="../../../../src-html/org/apache/juneau/rest/RestInfoProvider.html#line.480">getTags</a>(<a
href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in
org.apache.juneau.rest">RestRequest</a> req)</pre>
+<pre>public <a
href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util">List</a><<a
href="../../../../org/apache/juneau/dto/swagger/Tag.html" title="class in
org.apache.juneau.dto.swagger">Tag</a>> <a
href="../../../../src-html/org/apache/juneau/rest/RestInfoProvider.html#line.515">getTags</a>(<a
href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in
org.apache.juneau.rest">RestRequest</a> req)</pre>
<div class="block">Returns the version information of this REST resource.
<p>
@@ -608,7 +644,7 @@ extends <a
href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
<ul class="blockListLast">
<li class="blockList">
<h4>getExternalDocs</h4>
-<pre>public <a
href="../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html"
title="class in
org.apache.juneau.dto.swagger">ExternalDocumentation</a> <a
href="../../../../src-html/org/apache/juneau/rest/RestInfoProvider.html#line.520">getExternalDocs</a>(<a
href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in
org.apache.juneau.rest">RestRequest</a> req)</pre>
+<pre>public <a
href="../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html"
title="class in
org.apache.juneau.dto.swagger">ExternalDocumentation</a> <a
href="../../../../src-html/org/apache/juneau/rest/RestInfoProvider.html#line.555">getExternalDocs</a>(<a
href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in
org.apache.juneau.rest">RestRequest</a> req)</pre>
<div class="block">Returns the version information of this REST resource.
<p>
