You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2018/07/29 13:26:31 UTC
[juneau] branch master updated: New org.apache.juneau.rest.response
package.
This is an automated email from the ASF dual-hosted git repository.
jamesbognar pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/juneau.git
The following commit(s) were added to refs/heads/master by this push:
new 8a798c6 New org.apache.juneau.rest.response package.
8a798c6 is described below
commit 8a798c6491f376ee67972fc02624c609d375fbd3
Author: JamesBognar <ja...@apache.org>
AuthorDate: Sun Jul 29 09:26:18 2018 -0400
New org.apache.juneau.rest.response package.
---
juneau-doc/src/main/javadoc/overview.html | 77 ++++++++++++----------
.../src/main/resources/ReleaseNotes/5.1.0.17.html | 2 +-
.../src/main/resources/ReleaseNotes/5.2.0.0.html | 4 +-
.../src/main/resources/ReleaseNotes/7.1.0.html | 2 +-
.../06.RestMethod/10.MethodReturnTypes.html | 14 ++--
.../06.RestMethod/11.ReaderResource.html | 2 +-
.../06.RestMethod/12.StreamResource.html | 2 +-
.../06.RestMethod/13.Redirect.html | 2 +-
.../06.RestMethod/15.PredefinedHelperBeans.html | 47 +++++++------
.../examples/rest/petstore/PetStoreResource.java | 3 +-
.../org/apache/juneau/rest/ResponseHandler.java | 2 +-
.../java/org/apache/juneau/rest/RestContext.java | 2 +-
.../org/apache/juneau/rest/RestContextBuilder.java | 2 +-
.../apache/juneau/rest/helper/ReaderResource.java | 2 +-
.../apache/juneau/rest/helper/StreamResource.java | 2 +-
.../{response => reshandlers}/DefaultHandler.java | 2 +-
.../InputStreamHandler.java | 2 +-
.../{response => reshandlers}/ReaderHandler.java | 2 +-
.../{response => reshandlers}/RedirectHandler.java | 2 +-
.../StreamableHandler.java | 2 +-
.../{response => reshandlers}/WritableHandler.java | 2 +-
.../ZipFileListResponseHandler.java | 2 +-
.../{response => reshandlers}/package-info.java | 2 +-
.../{helper/Ok.java => response/Accepted.java} | 29 +++-----
.../Ok.java => response/AlreadyReported.java} | 28 +++-----
.../{helper/Ok.java => response/Continue.java} | 32 ++++-----
.../rest/{helper/Ok.java => response/Created.java} | 28 +++-----
.../{helper/Ok.java => response/EarlyHints.java} | 28 +++-----
.../rest/{helper/Ok.java => response/Found.java} | 48 ++++++++++----
.../rest/{helper/Ok.java => response/IMUsed.java} | 28 +++-----
.../Ok.java => response/MovedPermanently.java} | 44 +++++++++----
.../{helper/Ok.java => response/MultiStatus.java} | 28 +++-----
.../Ok.java => response/MultipleChoices.java} | 29 +++-----
.../{helper/Ok.java => response/NoContent.java} | 28 +++-----
.../NonAuthoritiveInformation.java} | 28 +++-----
.../{helper/Ok.java => response/NotModified.java} | 29 +++-----
.../juneau/rest/{helper => response}/Ok.java | 24 +++----
.../Ok.java => response/PartialContent.java} | 29 +++-----
.../Ok.java => response/PermanentRedirect.java} | 45 +++++++++----
.../{helper/Ok.java => response/Processing.java} | 30 +++------
.../{helper/Ok.java => response/ResetContent.java} | 29 +++-----
.../{helper/Ok.java => response/SeeOther.java} | 45 +++++++++----
.../Ok.java => response/SwitchingProtocols.java} | 28 +++-----
.../Ok.java => response/TemporaryRedirect.java} | 47 +++++++++----
.../{helper/Ok.java => response/UseProxy.java} | 27 +++-----
45 files changed, 404 insertions(+), 488 deletions(-)
diff --git a/juneau-doc/src/main/javadoc/overview.html b/juneau-doc/src/main/javadoc/overview.html
index 79f3ec9..ec3f74e 100644
--- a/juneau-doc/src/main/javadoc/overview.html
+++ b/juneau-doc/src/main/javadoc/overview.html
@@ -298,7 +298,7 @@
<li><p class=''><a class='doclink' href='#juneau-rest-server.RestMethod.StreamResource'>StreamResource</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-server.RestMethod.Redirect'>Redirect</a></p>
<li><p class=''><a class='doclink' href='#juneau-rest-server.RestMethod.RestMethodMatchers'>@RestMethod.matchers()</a></p>
- <li><p class='todo'><a class='doclink' href='#juneau-rest-server.RestMethod.PredefinedHelperBeans'>Helper Beans</a></p>
+ <li><p class='new'><a class='doclink' href='#juneau-rest-server.RestMethod.PredefinedHelperBeans'>Helper Beans</a></p>
<li><p class='new'><a class='doclink' href='#juneau-rest-server.RestMethod.PredefinedThrowables'>Predefined Throwables</a></p>
</ol>
<li><p class='new'><a class='doclink' href='#juneau-rest-server.OpenApiSchemaPartParsing'>OpenAPI Schema Part Parsing</a></p>
@@ -13711,13 +13711,13 @@ TODO(7.2.0)
<ul class='doctree'>
<li class='jic'>{@link org.apache.juneau.rest.ResponseHandler}
<ul>
- <li class='jc'>{@link org.apache.juneau.rest.response.DefaultHandler}
- <li class='jc'>{@link org.apache.juneau.rest.response.InputStreamHandler}
- <li class='jc'>{@link org.apache.juneau.rest.response.ReaderHandler}
- <li class='jc'>{@link org.apache.juneau.rest.response.RedirectHandler}
- <li class='jc'>{@link org.apache.juneau.rest.response.StreamableHandler}
- <li class='jc'>{@link org.apache.juneau.rest.response.WritableHandler}
- <li class='jc'>{@link org.apache.juneau.rest.response.ZipFileListResponseHandler}
+ <li class='jc'>{@link org.apache.juneau.rest.reshandlers.DefaultHandler}
+ <li class='jc'>{@link org.apache.juneau.rest.reshandlers.InputStreamHandler}
+ <li class='jc'>{@link org.apache.juneau.rest.reshandlers.ReaderHandler}
+ <li class='jc'>{@link org.apache.juneau.rest.reshandlers.RedirectHandler}
+ <li class='jc'>{@link org.apache.juneau.rest.reshandlers.StreamableHandler}
+ <li class='jc'>{@link org.apache.juneau.rest.reshandlers.WritableHandler}
+ <li class='jc'>{@link org.apache.juneau.rest.reshandlers.ZipFileListResponseHandler}
</ul>
</ul>
<p>
@@ -13779,7 +13779,7 @@ TODO(7.2.0)
</p>
<p>
The {@link org.apache.juneau.rest.helper.ReaderResource} class implements the {@link org.apache.juneau.Writable}
- interface which is handled by the {@link org.apache.juneau.rest.response.WritableHandler} class.
+ interface which is handled by the {@link org.apache.juneau.rest.reshandlers.WritableHandler} class.
<br>This allows these objects to be returned as responses by REST methods.
</p>
<h5 class='figure'>Example:</h5>
@@ -13820,7 +13820,7 @@ TODO(7.2.0)
</p>
<p>
The {@link org.apache.juneau.rest.helper.StreamResource} class implements the {@link org.apache.juneau.Streamable}
- interface which is handled by the {@link org.apache.juneau.rest.response.StreamableHandler} class.
+ interface which is handled by the {@link org.apache.juneau.rest.reshandlers.StreamableHandler} class.
<br>This allows these objects to be returned as responses by REST methods.
</p>
<h5 class='figure'>Example:</h5>
@@ -13857,7 +13857,7 @@ TODO(7.2.0)
The {@link org.apache.juneau.rest.helper.Redirect} object is a convenience shortcut for performing <code>HTTP 302</code> redirects.
</p>
<p>
- <l>Redirect</l> objects are handled by the {@link org.apache.juneau.rest.response.RedirectHandler} class.
+ <l>Redirect</l> objects are handled by the {@link org.apache.juneau.rest.reshandlers.RedirectHandler} class.
<br>This allows these objects to be returned as responses by REST methods.
</p>
<p>
@@ -13968,24 +13968,29 @@ TODO(7.2.0)
<!-- ==================================================================================================== -->
-<h4 class='topic todo' onclick='toggle(this)'><a href='#juneau-rest-server.RestMethod.PredefinedHelperBeans' id='juneau-rest-server.RestMethod.PredefinedHelperBeans'>7.6.15 - Helper Beans</a></h4>
+<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.RestMethod.PredefinedHelperBeans' id='juneau-rest-server.RestMethod.PredefinedHelperBeans'>7.6.15 - Helper Beans</a></h4>
<div class='topic'><!-- START: 7.6.15 - juneau-rest-server.RestMethod.PredefinedHelperBeans -->
-org.apache.juneau.rest.helper
-BeanDescription
-ChildResourceDescriptions
-Ok
-ReaderResource
-ReaderResourceBuilder
-Redirect
-RedirectToServletRoot
-ResourceDescription
-StreamResource
-StreamResourceBuilder
-
<p>
- The {@link org.apache.juneau.rest.helper} package contains some reusable beans that are useful for
- creating linked items in HTML views.
+ The {@link org.apache.juneau.rest.help} package contains several predefined beans to help when constructing
+ REST interfaces.
</p>
+<ul class='doctree'>
+ <li class='jp'>{@link org.apache.juneau.rest.help}
+ <ul>
+ <li class='jc'>{@link org.apache.juneau.rest.help.BeanDescription}
+ <li class='jc'>{@link org.apache.juneau.rest.help.ChildResourceDescriptions}
+ <li class='jc'>{@link org.apache.juneau.rest.help.Ok}
+ <li class='jc'>{@link org.apache.juneau.rest.help.ReaderResource}
+ <li class='jc'>{@link org.apache.juneau.rest.help.ReaderResourceBuilder}
+ <li class='jc'>{@link org.apache.juneau.rest.help.Redirect}
+ <li class='jc'>{@link org.apache.juneau.rest.help.RedirectToServletRoot}
+ <li class='jc'>{@link org.apache.juneau.rest.help.ResourceDescription}
+ <li class='jc'>{@link org.apache.juneau.rest.help.StreamResource}
+ <li class='jc'>{@link org.apache.juneau.rest.help.StreamResourceBuilder}
+ </ul>
+</ul>
+
+<h5 class='topic'>ResourceDescription, BeanDescription, ChildResourceDescriptions</h5>
<p>
The {@link org.apache.juneau.rest.helper.ResourceDescription} class is a bean with name/description
properties for labeling and linking to child resources.
@@ -14057,16 +14062,16 @@ StreamResourceBuilder
}
</p>
<p>
- The {@link org.apache.juneau.dto.LinkString Action} bean is a predefined <ja>@HtmlLink</ja> bean provided
+ The {@link org.apache.juneau.dto.LinkString LinkString} bean is a predefined <ja>@HtmlLink</ja> bean provided
to simplify specifying actions.
<br>The following is equivalent to above.
</p>
<p class='bpcode w800'>
<ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/htmlLinks"</js>)
- <jk>public</jk> Action[] htmlLinks() {
- <jk>return new</jk> Action[] {
- <jk>new</jk> Action(<js>"apache"</js>, <js>"http://apache.org"</js>),
- <jk>new</jk> Action(<js>"juneau"</js>, <js>"http://juneau.apache.org"</js>)
+ <jk>public</jk> LinkString[] htmlLinks() {
+ <jk>return new</jk> LinkString[] {
+ <jk>new</jk> LinkString(<js>"apache"</js>, <js>"http://apache.org"</js>),
+ <jk>new</jk> LinkString(<js>"juneau"</js>, <js>"http://juneau.apache.org"</js>)
};
}
</p>
@@ -14074,6 +14079,8 @@ StreamResourceBuilder
Both examples render the following consisting of a list of hyperlinks:
</p>
<img class='bordered' src='doc-files/juneau-rest-server.PredefinedLabelBeans.3.png' style='width:92px'/>
+
+<h5 class='topic'>ResourceDescription, BeanDescription, ChildResourceDescriptions</h5>
</div><!-- END: 7.6.15 - juneau-rest-server.RestMethod.PredefinedHelperBeans -->
<!-- ==================================================================================================== -->
@@ -27025,7 +27032,7 @@ TODO(7.2.0)
<h5 class='topic w800'>Server</h5>
<ul class='spaced-list'>
- <li>New {@link org.apache.juneau.rest.response.ZipFileListResponseHandler} class.
+ <li>New {@link org.apache.juneau.rest.reshandlers.ZipFileListResponseHandler} class.
<li>Simplified labels in servlet resource bundles:
<ul>
<li><code>"[ClassName].ResourceDescription"</code> is now <code>"[ClassName].label"</code>.
@@ -27622,8 +27629,8 @@ TODO(7.2.0)
<li>New <code><del>ResourceLink.ResourceLink(String,RestRequest,String,Object[])</del></code> constructor.
<li>New response handlers:
<ul>
- <li>{@link org.apache.juneau.rest.response.StreamableHandler} - Allows REST Java methods to return instances of {@link org.apache.juneau.Streamable}.
- <li>{@link org.apache.juneau.rest.response.WritableHandler} - Allows REST Java methods to return instances of {@link org.apache.juneau.Writable}.
+ <li>{@link org.apache.juneau.rest.reshandlers.StreamableHandler} - Allows REST Java methods to return instances of {@link org.apache.juneau.Streamable}.
+ <li>{@link org.apache.juneau.rest.reshandlers.WritableHandler} - Allows REST Java methods to return instances of {@link org.apache.juneau.Writable}.
</ul>
<li>New DevOps stylesheet.
<li>Servlet initialization and HTTP requests are now logged at <JSF>FINE</JSF> level.
@@ -30152,7 +30159,7 @@ TODO(7.2.0)
<code><del>FinishableServletOutputStream</del></code> and {@link org.apache.juneau.rest.RestResponse#getNegotiatedWriter()}
now returns a <code><del>FinishablePrintWriter</del></code> that allows you to finish the output
without closing the stream.
- <br>The {@link org.apache.juneau.rest.response.DefaultHandler} class now calls <code>finish()</code>
+ <br>The {@link org.apache.juneau.rest.reshandlers.DefaultHandler} class now calls <code>finish()</code>
instead of <code>close()</code> on the stream.
<li>
Added the following annotations to the {@link org.apache.juneau.rest.BasicRestServlet} class
diff --git a/juneau-doc/src/main/resources/ReleaseNotes/5.1.0.17.html b/juneau-doc/src/main/resources/ReleaseNotes/5.1.0.17.html
index d54211d..a84d016 100644
--- a/juneau-doc/src/main/resources/ReleaseNotes/5.1.0.17.html
+++ b/juneau-doc/src/main/resources/ReleaseNotes/5.1.0.17.html
@@ -52,7 +52,7 @@
<h5 class='topic w800'>Server</h5>
<ul class='spaced-list'>
- <li>New {@link org.apache.juneau.rest.response.ZipFileListResponseHandler} class.
+ <li>New {@link org.apache.juneau.rest.reshandlers.ZipFileListResponseHandler} class.
<li>Simplified labels in servlet resource bundles:
<ul>
<li><code>"[ClassName].ResourceDescription"</code> is now <code>"[ClassName].label"</code>.
diff --git a/juneau-doc/src/main/resources/ReleaseNotes/5.2.0.0.html b/juneau-doc/src/main/resources/ReleaseNotes/5.2.0.0.html
index f5615d3..53bb88e 100644
--- a/juneau-doc/src/main/resources/ReleaseNotes/5.2.0.0.html
+++ b/juneau-doc/src/main/resources/ReleaseNotes/5.2.0.0.html
@@ -370,8 +370,8 @@
<li>New <code><del>ResourceLink.ResourceLink(String,RestRequest,String,Object[])</del></code> constructor.
<li>New response handlers:
<ul>
- <li>{@link org.apache.juneau.rest.response.StreamableHandler} - Allows REST Java methods to return instances of {@link org.apache.juneau.Streamable}.
- <li>{@link org.apache.juneau.rest.response.WritableHandler} - Allows REST Java methods to return instances of {@link org.apache.juneau.Writable}.
+ <li>{@link org.apache.juneau.rest.reshandlers.StreamableHandler} - Allows REST Java methods to return instances of {@link org.apache.juneau.Streamable}.
+ <li>{@link org.apache.juneau.rest.reshandlers.WritableHandler} - Allows REST Java methods to return instances of {@link org.apache.juneau.Writable}.
</ul>
<li>New DevOps stylesheet.
<li>Servlet initialization and HTTP requests are now logged at <JSF>FINE</JSF> level.
diff --git a/juneau-doc/src/main/resources/ReleaseNotes/7.1.0.html b/juneau-doc/src/main/resources/ReleaseNotes/7.1.0.html
index d41003c..2e40203 100644
--- a/juneau-doc/src/main/resources/ReleaseNotes/7.1.0.html
+++ b/juneau-doc/src/main/resources/ReleaseNotes/7.1.0.html
@@ -405,7 +405,7 @@
<code><del>FinishableServletOutputStream</del></code> and {@link org.apache.juneau.rest.RestResponse#getNegotiatedWriter()}
now returns a <code><del>FinishablePrintWriter</del></code> that allows you to finish the output
without closing the stream.
- <br>The {@link org.apache.juneau.rest.response.DefaultHandler} class now calls <code>finish()</code>
+ <br>The {@link org.apache.juneau.rest.reshandlers.DefaultHandler} class now calls <code>finish()</code>
instead of <code>close()</code> on the stream.
<li>
Added the following annotations to the {@link org.apache.juneau.rest.BasicRestServlet} class
diff --git a/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/10.MethodReturnTypes.html b/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/10.MethodReturnTypes.html
index bfd8bb0..21c2a6a 100644
--- a/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/10.MethodReturnTypes.html
+++ b/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/10.MethodReturnTypes.html
@@ -56,13 +56,13 @@ Method Return Types
<ul class='doctree'>
<li class='jic'>{@link org.apache.juneau.rest.ResponseHandler}
<ul>
- <li class='jc'>{@link org.apache.juneau.rest.response.DefaultHandler}
- <li class='jc'>{@link org.apache.juneau.rest.response.InputStreamHandler}
- <li class='jc'>{@link org.apache.juneau.rest.response.ReaderHandler}
- <li class='jc'>{@link org.apache.juneau.rest.response.RedirectHandler}
- <li class='jc'>{@link org.apache.juneau.rest.response.StreamableHandler}
- <li class='jc'>{@link org.apache.juneau.rest.response.WritableHandler}
- <li class='jc'>{@link org.apache.juneau.rest.response.ZipFileListResponseHandler}
+ <li class='jc'>{@link org.apache.juneau.rest.reshandlers.DefaultHandler}
+ <li class='jc'>{@link org.apache.juneau.rest.reshandlers.InputStreamHandler}
+ <li class='jc'>{@link org.apache.juneau.rest.reshandlers.ReaderHandler}
+ <li class='jc'>{@link org.apache.juneau.rest.reshandlers.RedirectHandler}
+ <li class='jc'>{@link org.apache.juneau.rest.reshandlers.StreamableHandler}
+ <li class='jc'>{@link org.apache.juneau.rest.reshandlers.WritableHandler}
+ <li class='jc'>{@link org.apache.juneau.rest.reshandlers.ZipFileListResponseHandler}
</ul>
</ul>
<p>
diff --git a/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/11.ReaderResource.html b/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/11.ReaderResource.html
index cf22b91..3c6ba7e 100644
--- a/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/11.ReaderResource.html
+++ b/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/11.ReaderResource.html
@@ -23,7 +23,7 @@ ReaderResource
</p>
<p>
The {@link org.apache.juneau.rest.helper.ReaderResource} class implements the {@link org.apache.juneau.Writable}
- interface which is handled by the {@link org.apache.juneau.rest.response.WritableHandler} class.
+ interface which is handled by the {@link org.apache.juneau.rest.reshandlers.WritableHandler} class.
<br>This allows these objects to be returned as responses by REST methods.
</p>
<h5 class='figure'>Example:</h5>
diff --git a/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/12.StreamResource.html b/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/12.StreamResource.html
index 7c05977..e9f1d0a 100644
--- a/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/12.StreamResource.html
+++ b/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/12.StreamResource.html
@@ -21,7 +21,7 @@ StreamResource
</p>
<p>
The {@link org.apache.juneau.rest.helper.StreamResource} class implements the {@link org.apache.juneau.Streamable}
- interface which is handled by the {@link org.apache.juneau.rest.response.StreamableHandler} class.
+ interface which is handled by the {@link org.apache.juneau.rest.reshandlers.StreamableHandler} class.
<br>This allows these objects to be returned as responses by REST methods.
</p>
<h5 class='figure'>Example:</h5>
diff --git a/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/13.Redirect.html b/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/13.Redirect.html
index 80bd268..46e353e 100644
--- a/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/13.Redirect.html
+++ b/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/13.Redirect.html
@@ -19,7 +19,7 @@ Redirect
The {@link org.apache.juneau.rest.helper.Redirect} object is a convenience shortcut for performing <code>HTTP 302</code> redirects.
</p>
<p>
- <l>Redirect</l> objects are handled by the {@link org.apache.juneau.rest.response.RedirectHandler} class.
+ <l>Redirect</l> objects are handled by the {@link org.apache.juneau.rest.reshandlers.RedirectHandler} class.
<br>This allows these objects to be returned as responses by REST methods.
</p>
<p>
diff --git a/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/15.PredefinedHelperBeans.html b/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/15.PredefinedHelperBeans.html
index f8f0c9a..1baf4c4 100644
--- a/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/15.PredefinedHelperBeans.html
+++ b/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/15.PredefinedHelperBeans.html
@@ -13,24 +13,28 @@
***************************************************************************************************************************/
-->
-{todo} Helper Beans
-
-org.apache.juneau.rest.helper
-BeanDescription
-ChildResourceDescriptions
-Ok
-ReaderResource
-ReaderResourceBuilder
-Redirect
-RedirectToServletRoot
-ResourceDescription
-StreamResource
-StreamResourceBuilder
+{new} Helper Beans
<p>
- The {@link org.apache.juneau.rest.helper} package contains some reusable beans that are useful for
- creating linked items in HTML views.
+ The {@link org.apache.juneau.rest.helper} package contains several predefined beans to help when constructing
+ REST interfaces.
</p>
+<ul class='doctree'>
+ <li class='jp'>{@link org.apache.juneau.rest.helper}
+ <ul>
+ <li class='jc'>{@link org.apache.juneau.rest.helper.BeanDescription}
+ <li class='jc'>{@link org.apache.juneau.rest.helper.ChildResourceDescriptions}
+ <li class='jc'>{@link org.apache.juneau.rest.helper.ReaderResource}
+ <li class='jc'>{@link org.apache.juneau.rest.helper.ReaderResourceBuilder}
+ <li class='jc'>{@link org.apache.juneau.rest.helper.Redirect}
+ <li class='jc'>{@link org.apache.juneau.rest.helper.RedirectToServletRoot}
+ <li class='jc'>{@link org.apache.juneau.rest.helper.ResourceDescription}
+ <li class='jc'>{@link org.apache.juneau.rest.helper.StreamResource}
+ <li class='jc'>{@link org.apache.juneau.rest.helper.StreamResourceBuilder}
+ </ul>
+</ul>
+
+<h5 class='topic'>ResourceDescription, BeanDescription, ChildResourceDescriptions</h5>
<p>
The {@link org.apache.juneau.rest.helper.ResourceDescription} class is a bean with name/description
properties for labeling and linking to child resources.
@@ -102,16 +106,16 @@ StreamResourceBuilder
}
</p>
<p>
- The {@link org.apache.juneau.dto.LinkString Action} bean is a predefined <ja>@HtmlLink</ja> bean provided
+ The {@link org.apache.juneau.dto.LinkString LinkString} bean is a predefined <ja>@HtmlLink</ja> bean provided
to simplify specifying actions.
<br>The following is equivalent to above.
</p>
<p class='bpcode w800'>
<ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/htmlLinks"</js>)
- <jk>public</jk> Action[] htmlLinks() {
- <jk>return new</jk> Action[] {
- <jk>new</jk> Action(<js>"apache"</js>, <js>"http://apache.org"</js>),
- <jk>new</jk> Action(<js>"juneau"</js>, <js>"http://juneau.apache.org"</js>)
+ <jk>public</jk> LinkString[] htmlLinks() {
+ <jk>return new</jk> LinkString[] {
+ <jk>new</jk> LinkString(<js>"apache"</js>, <js>"http://apache.org"</js>),
+ <jk>new</jk> LinkString(<js>"juneau"</js>, <js>"http://juneau.apache.org"</js>)
};
}
</p>
@@ -119,3 +123,6 @@ StreamResourceBuilder
Both examples render the following consisting of a list of hyperlinks:
</p>
<img class='bordered' src='doc-files/juneau-rest-server.PredefinedLabelBeans.3.png' style='width:92px'/>
+
+<h5 class='topic'>ResourceDescription, BeanDescription, ChildResourceDescriptions</h5>
+
diff --git a/juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/petstore/PetStoreResource.java b/juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/petstore/PetStoreResource.java
index 75065e4..dd1f7f1 100644
--- a/juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/petstore/PetStoreResource.java
+++ b/juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/petstore/PetStoreResource.java
@@ -16,7 +16,7 @@ import static org.apache.juneau.dto.html5.HtmlBuilder.*;
import static org.apache.juneau.dto.swagger.ui.SwaggerUI.*;
import static org.apache.juneau.http.HttpMethodName.*;
import static org.apache.juneau.rest.annotation.HookEvent.*;
-import static org.apache.juneau.rest.helper.Ok.*;
+import static org.apache.juneau.rest.response.Ok.*;
import java.util.*;
import java.util.Map;
@@ -32,6 +32,7 @@ import org.apache.juneau.rest.*;
import org.apache.juneau.rest.annotation.*;
import org.apache.juneau.rest.exception.*;
import org.apache.juneau.rest.helper.*;
+import org.apache.juneau.rest.response.*;
import org.apache.juneau.rest.widget.*;
import org.apache.juneau.transforms.*;
import org.apache.juneau.rest.converters.*;
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ResponseHandler.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ResponseHandler.java
index 1bbf148..39cedbe 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ResponseHandler.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ResponseHandler.java
@@ -19,7 +19,7 @@ import javax.servlet.http.*;
import org.apache.juneau.*;
import org.apache.juneau.rest.annotation.*;
import org.apache.juneau.rest.helper.*;
-import org.apache.juneau.rest.response.*;
+import org.apache.juneau.rest.reshandlers.*;
/**
* Defines the interface for handlers that convert POJOs to appropriate HTTP responses.
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContext.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContext.java
index a926559..5cb30c2 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContext.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContext.java
@@ -50,7 +50,7 @@ import org.apache.juneau.rest.annotation.*;
import org.apache.juneau.rest.converters.*;
import org.apache.juneau.rest.exception.*;
import org.apache.juneau.rest.helper.*;
-import org.apache.juneau.rest.response.*;
+import org.apache.juneau.rest.reshandlers.*;
import org.apache.juneau.rest.util.*;
import org.apache.juneau.rest.vars.*;
import org.apache.juneau.rest.widget.*;
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContextBuilder.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContextBuilder.java
index d7e32b6..69f4ac0 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContextBuilder.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContextBuilder.java
@@ -37,7 +37,7 @@ import org.apache.juneau.httppart.*;
import org.apache.juneau.internal.*;
import org.apache.juneau.parser.*;
import org.apache.juneau.rest.annotation.*;
-import org.apache.juneau.rest.response.*;
+import org.apache.juneau.rest.reshandlers.*;
import org.apache.juneau.rest.util.*;
import org.apache.juneau.rest.vars.*;
import org.apache.juneau.rest.widget.*;
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/ReaderResource.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/ReaderResource.java
index 8315d05..65f3b43 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/ReaderResource.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/ReaderResource.java
@@ -20,7 +20,7 @@ import java.util.*;
import org.apache.juneau.*;
import org.apache.juneau.http.*;
-import org.apache.juneau.rest.response.*;
+import org.apache.juneau.rest.reshandlers.*;
import org.apache.juneau.svl.*;
/**
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/StreamResource.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/StreamResource.java
index 94d0f92..b29d971 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/StreamResource.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/StreamResource.java
@@ -20,7 +20,7 @@ import java.util.*;
import org.apache.juneau.*;
import org.apache.juneau.http.*;
-import org.apache.juneau.rest.response.*;
+import org.apache.juneau.rest.reshandlers.*;
/**
* Represents the contents of a byte stream file with convenience methods for adding HTTP response headers.
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/DefaultHandler.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/reshandlers/DefaultHandler.java
similarity index 96%
rename from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/DefaultHandler.java
rename to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/reshandlers/DefaultHandler.java
index 89ed2a9..9821f3d 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/DefaultHandler.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/reshandlers/DefaultHandler.java
@@ -10,7 +10,7 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.response;
+package org.apache.juneau.rest.reshandlers;
import java.io.*;
import java.util.*;
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/InputStreamHandler.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/reshandlers/InputStreamHandler.java
similarity index 96%
rename from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/InputStreamHandler.java
rename to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/reshandlers/InputStreamHandler.java
index 1696aaa..4fe68be 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/InputStreamHandler.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/reshandlers/InputStreamHandler.java
@@ -10,7 +10,7 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.response;
+package org.apache.juneau.rest.reshandlers;
import java.io.*;
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/ReaderHandler.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/reshandlers/ReaderHandler.java
similarity index 96%
rename from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/ReaderHandler.java
rename to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/reshandlers/ReaderHandler.java
index a4afa28..027f6fa 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/ReaderHandler.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/reshandlers/ReaderHandler.java
@@ -10,7 +10,7 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.response;
+package org.apache.juneau.rest.reshandlers;
import java.io.*;
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/RedirectHandler.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/reshandlers/RedirectHandler.java
similarity index 96%
rename from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/RedirectHandler.java
rename to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/reshandlers/RedirectHandler.java
index 99f5352..354b4a3 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/RedirectHandler.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/reshandlers/RedirectHandler.java
@@ -10,7 +10,7 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.response;
+package org.apache.juneau.rest.reshandlers;
import java.io.*;
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/StreamableHandler.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/reshandlers/StreamableHandler.java
similarity index 96%
rename from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/StreamableHandler.java
rename to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/reshandlers/StreamableHandler.java
index 89b9f9e..d8d1486 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/StreamableHandler.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/reshandlers/StreamableHandler.java
@@ -10,7 +10,7 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.response;
+package org.apache.juneau.rest.reshandlers;
import static org.apache.juneau.internal.StringUtils.*;
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/WritableHandler.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/reshandlers/WritableHandler.java
similarity index 96%
rename from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/WritableHandler.java
rename to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/reshandlers/WritableHandler.java
index f83b2e2..61299e6 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/WritableHandler.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/reshandlers/WritableHandler.java
@@ -10,7 +10,7 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.response;
+package org.apache.juneau.rest.reshandlers;
import static org.apache.juneau.internal.StringUtils.*;
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/ZipFileListResponseHandler.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/reshandlers/ZipFileListResponseHandler.java
similarity index 96%
rename from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/ZipFileListResponseHandler.java
rename to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/reshandlers/ZipFileListResponseHandler.java
index 5473357..c548d05 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/ZipFileListResponseHandler.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/reshandlers/ZipFileListResponseHandler.java
@@ -10,7 +10,7 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.response;
+package org.apache.juneau.rest.reshandlers;
import java.io.*;
import java.util.zip.*;
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/package-info.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/reshandlers/package-info.java
similarity index 96%
rename from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/package-info.java
rename to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/reshandlers/package-info.java
index d8d8b9c..3d47527 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/package-info.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/reshandlers/package-info.java
@@ -15,4 +15,4 @@
/**
* HTTP Response Handlers
*/
-package org.apache.juneau.rest.response;
\ No newline at end of file
+package org.apache.juneau.rest.reshandlers;
\ No newline at end of file
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/Accepted.java
similarity index 77%
copy from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
copy to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/Accepted.java
index 33e5706..5e391d7 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/Accepted.java
@@ -10,36 +10,25 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.helper;
+package org.apache.juneau.rest.response;
import org.apache.juneau.http.annotation.*;
/**
- * Represents a simple OK REST response.
+ * Represents an <code>HTTP 202 Accepted</code> response.
*
* <p>
- * The response consist of the serialized string <js>"OK"</js>.
+ * The request has been accepted for processing, but the processing has not been completed.
+ * The request might or might not be eventually acted upon, and may be disallowed when processing occurs.
*/
-@Response(code=200, example="'OK'")
-public class Ok {
+@Response(code=202, example="'Accepted'")
+public class Accepted {
- /**
- * Reusable instance.
- */
- public static final Ok OK = new Ok();
+ /** Reusable instance. */
+ public static final Accepted INSTANCE = new Accepted();
@Override /* Object */
public String toString() {
- return "OK";
- }
-
- /**
- * Used to convert example into an OK object.
- *
- * @param s Ignored.
- * @return The static {@link #OK} object.
- */
- public static Ok fromString(String s) {
- return OK;
+ return "Accepted";
}
}
\ No newline at end of file
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/AlreadyReported.java
similarity index 77%
copy from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
copy to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/AlreadyReported.java
index 33e5706..9168864 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/AlreadyReported.java
@@ -10,36 +10,24 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.helper;
+package org.apache.juneau.rest.response;
import org.apache.juneau.http.annotation.*;
/**
- * Represents a simple OK REST response.
+ * Represents an <code>HTTP 208 Already Reported</code> response.
*
* <p>
- * The response consist of the serialized string <js>"OK"</js>.
+ * The members of a DAV binding have already been enumerated in a preceding part of the (multistatus) response, and are not being included again.
*/
-@Response(code=200, example="'OK'")
-public class Ok {
+@Response(code=208, example="'Already Reported'")
+public class AlreadyReported {
- /**
- * Reusable instance.
- */
- public static final Ok OK = new Ok();
+ /** Reusable instance. */
+ public static final AlreadyReported INSTANCE = new AlreadyReported();
@Override /* Object */
public String toString() {
- return "OK";
- }
-
- /**
- * Used to convert example into an OK object.
- *
- * @param s Ignored.
- * @return The static {@link #OK} object.
- */
- public static Ok fromString(String s) {
- return OK;
+ return "Already Reported";
}
}
\ No newline at end of file
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/Continue.java
similarity index 58%
copy from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
copy to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/Continue.java
index 33e5706..9297d10 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/Continue.java
@@ -10,36 +10,28 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.helper;
+package org.apache.juneau.rest.response;
import org.apache.juneau.http.annotation.*;
/**
- * Represents a simple OK REST response.
+ * Represents an <code>HTTP 100 Continue</code> response.
*
* <p>
- * The response consist of the serialized string <js>"OK"</js>.
+ * The server has received the request headers and the client should proceed to send the request body (in the case of a request for which a body needs to be sent; for example, a POST request).
+ * Sending a large request body to a server after a request has been rejected for inappropriate headers would be inefficient.
+ * To have a server check the request's headers, a client must send Expect: 100-continue as a header in its initial request and receive a 100 Continue status code in response before sending the body.
+ * If the client receives an error code such as 403 (Forbidden) or 405 (Method Not Allowed) then it shouldn't send the request's body.
+ * The response 417 Expectation Failed indicates that the request should be repeated without the Expect header as it indicates that the server doesn't support expectations (this is the case, for example, of HTTP/1.0 servers).
*/
-@Response(code=200, example="'OK'")
-public class Ok {
+@Response(code=100, example="'Continue'")
+public class Continue {
- /**
- * Reusable instance.
- */
- public static final Ok OK = new Ok();
+ /** Reusable instance.*/
+ public static final Continue INSTANCE = new Continue();
@Override /* Object */
public String toString() {
- return "OK";
- }
-
- /**
- * Used to convert example into an OK object.
- *
- * @param s Ignored.
- * @return The static {@link #OK} object.
- */
- public static Ok fromString(String s) {
- return OK;
+ return "Continue";
}
}
\ No newline at end of file
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/Created.java
similarity index 77%
copy from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
copy to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/Created.java
index 33e5706..44b2c40 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/Created.java
@@ -10,36 +10,24 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.helper;
+package org.apache.juneau.rest.response;
import org.apache.juneau.http.annotation.*;
/**
- * Represents a simple OK REST response.
+ * Represents an <code>HTTP 201 Created</code> response.
*
* <p>
- * The response consist of the serialized string <js>"OK"</js>.
+ * The request has been fulfilled, resulting in the creation of a new resource.
*/
-@Response(code=200, example="'OK'")
-public class Ok {
+@Response(code=201, example="'Created'")
+public class Created {
- /**
- * Reusable instance.
- */
- public static final Ok OK = new Ok();
+ /** Reusable instance. */
+ public static final Created INSTANCE = new Created();
@Override /* Object */
public String toString() {
- return "OK";
- }
-
- /**
- * Used to convert example into an OK object.
- *
- * @param s Ignored.
- * @return The static {@link #OK} object.
- */
- public static Ok fromString(String s) {
- return OK;
+ return "Created";
}
}
\ No newline at end of file
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/EarlyHints.java
similarity index 77%
copy from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
copy to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/EarlyHints.java
index 33e5706..80ff48f 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/EarlyHints.java
@@ -10,36 +10,24 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.helper;
+package org.apache.juneau.rest.response;
import org.apache.juneau.http.annotation.*;
/**
- * Represents a simple OK REST response.
+ * Represents an <code>HTTP 103 Early Hints</code> response.
*
* <p>
- * The response consist of the serialized string <js>"OK"</js>.
+ * Used to return some response headers before final HTTP message.
*/
-@Response(code=200, example="'OK'")
-public class Ok {
+@Response(code=103, example="'Early Hints'")
+public class EarlyHints {
- /**
- * Reusable instance.
- */
- public static final Ok OK = new Ok();
+ /** Reusable instance. */
+ public static final EarlyHints INSTANCE = new EarlyHints();
@Override /* Object */
public String toString() {
- return "OK";
- }
-
- /**
- * Used to convert example into an OK object.
- *
- * @param s Ignored.
- * @return The static {@link #OK} object.
- */
- public static Ok fromString(String s) {
- return OK;
+ return "Early Hints";
}
}
\ No newline at end of file
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/Found.java
similarity index 57%
copy from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
copy to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/Found.java
index 33e5706..e39ca1e 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/Found.java
@@ -10,36 +10,56 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.helper;
+package org.apache.juneau.rest.response;
+
+import java.net.*;
import org.apache.juneau.http.annotation.*;
/**
- * Represents a simple OK REST response.
+ * Represents an <code>HTTP 302 Found</code> response.
*
* <p>
- * The response consist of the serialized string <js>"OK"</js>.
+ * Tells the client to look at (browse to) another url. 302 has been superseded by 303 and 307.
+ * This is an example of industry practice contradicting the standard.
+ * The HTTP/1.0 specification (RFC 1945) required the client to perform a temporary redirect (the original describing phrase was "Moved Temporarily"), but popular browsers implemented 302 with the functionality of a 303 See Other.
+ * Therefore, HTTP/1.1 added status codes 303 and 307 to distinguish between the two behaviours.
+ * However, some Web applications and frameworks use the 302 status code as if it were the 303.
*/
-@Response(code=200, example="'OK'")
-public class Ok {
+@Response(code=302, example="'Found'")
+public class Found {
+
+ /** Reusable instance. */
+ public static final Found INSTANCE = new Found();
+
+ private final URI location;
+
+ /**
+ * Constructor.
+ */
+ public Found() {
+ this(null);
+ }
/**
- * Reusable instance.
+ * Constructor.
+ *
+ * @param location <code>Location</code> header value.
*/
- public static final Ok OK = new Ok();
+ public Found(URI location) {
+ this.location = location;
+ }
@Override /* Object */
public String toString() {
- return "OK";
+ return "Found";
}
/**
- * Used to convert example into an OK object.
- *
- * @param s Ignored.
- * @return The static {@link #OK} object.
+ * @return <code>Location</code> header value.
*/
- public static Ok fromString(String s) {
- return OK;
+ @Header(name="Location", description="")
+ public URI getLocation() {
+ return location;
}
}
\ No newline at end of file
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/IMUsed.java
similarity index 77%
copy from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
copy to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/IMUsed.java
index 33e5706..6ea392c 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/IMUsed.java
@@ -10,36 +10,24 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.helper;
+package org.apache.juneau.rest.response;
import org.apache.juneau.http.annotation.*;
/**
- * Represents a simple OK REST response.
+ * Represents an <code>HTTP 226 IM Used</code> response.
*
* <p>
- * The response consist of the serialized string <js>"OK"</js>.
+ * The server has fulfilled a request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance.
*/
-@Response(code=200, example="'OK'")
-public class Ok {
+@Response(code=226, example="'IM Used'")
+public class IMUsed {
- /**
- * Reusable instance.
- */
- public static final Ok OK = new Ok();
+ /** Reusable instance. */
+ public static final IMUsed INSTANCE = new IMUsed();
@Override /* Object */
public String toString() {
- return "OK";
- }
-
- /**
- * Used to convert example into an OK object.
- *
- * @param s Ignored.
- * @return The static {@link #OK} object.
- */
- public static Ok fromString(String s) {
- return OK;
+ return "IM Used";
}
}
\ No newline at end of file
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/MovedPermanently.java
similarity index 67%
copy from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
copy to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/MovedPermanently.java
index 33e5706..780f441 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/MovedPermanently.java
@@ -10,36 +10,52 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.helper;
+package org.apache.juneau.rest.response;
+
+import java.net.*;
import org.apache.juneau.http.annotation.*;
/**
- * Represents a simple OK REST response.
+ * Represents an <code>HTTP 301 Moved Permanently</code> response.
*
* <p>
- * The response consist of the serialized string <js>"OK"</js>.
+ * This and all future requests should be directed to the given URI.
*/
-@Response(code=200, example="'OK'")
-public class Ok {
+@Response(code=301, example="'Moved Permanently'")
+public class MovedPermanently {
+
+ /** Reusable instance. */
+ public static final MovedPermanently INSTANCE = new MovedPermanently();
+
+ private final URI location;
+
+ /**
+ * Constructor.
+ */
+ public MovedPermanently() {
+ this(null);
+ }
/**
- * Reusable instance.
+ * Constructor.
+ *
+ * @param location <code>Location</code> header value.
*/
- public static final Ok OK = new Ok();
+ public MovedPermanently(URI location) {
+ this.location = location;
+ }
@Override /* Object */
public String toString() {
- return "OK";
+ return "Moved Permanently";
}
/**
- * Used to convert example into an OK object.
- *
- * @param s Ignored.
- * @return The static {@link #OK} object.
+ * @return <code>Location</code> header value.
*/
- public static Ok fromString(String s) {
- return OK;
+ @Header(name="Location", description="")
+ public URI getLocation() {
+ return location;
}
}
\ No newline at end of file
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/MultiStatus.java
similarity index 77%
copy from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
copy to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/MultiStatus.java
index 33e5706..284506e 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/MultiStatus.java
@@ -10,36 +10,24 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.helper;
+package org.apache.juneau.rest.response;
import org.apache.juneau.http.annotation.*;
/**
- * Represents a simple OK REST response.
+ * Represents an <code>HTTP 207 Multi-Status</code> response.
*
* <p>
- * The response consist of the serialized string <js>"OK"</js>.
+ * The message body that follows is by default an XML message and can contain a number of separate response codes, depending on how many sub-requests were made.
*/
-@Response(code=200, example="'OK'")
-public class Ok {
+@Response(code=207, example="'Multi-Status'")
+public class MultiStatus {
- /**
- * Reusable instance.
- */
- public static final Ok OK = new Ok();
+ /** Reusable instance. */
+ public static final MultiStatus INSTANCE = new MultiStatus();
@Override /* Object */
public String toString() {
- return "OK";
- }
-
- /**
- * Used to convert example into an OK object.
- *
- * @param s Ignored.
- * @return The static {@link #OK} object.
- */
- public static Ok fromString(String s) {
- return OK;
+ return "Multi-Status";
}
}
\ No newline at end of file
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/MultipleChoices.java
similarity index 72%
copy from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
copy to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/MultipleChoices.java
index 33e5706..b005d57 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/MultipleChoices.java
@@ -10,36 +10,25 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.helper;
+package org.apache.juneau.rest.response;
import org.apache.juneau.http.annotation.*;
/**
- * Represents a simple OK REST response.
+ * Represents an <code>HTTP 300 Multiple Choices</code> response.
*
* <p>
- * The response consist of the serialized string <js>"OK"</js>.
+ * Indicates multiple options for the resource from which the client may choose (via agent-driven content negotiation).
+ * For example, this code could be used to present multiple video format options, to list files with different filename extensions, or to suggest word-sense disambiguation.
*/
-@Response(code=200, example="'OK'")
-public class Ok {
+@Response(code=300, example="'Multiple Choices'")
+public class MultipleChoices {
- /**
- * Reusable instance.
- */
- public static final Ok OK = new Ok();
+ /** Reusable instance. */
+ public static final MultipleChoices INSTANCE = new MultipleChoices();
@Override /* Object */
public String toString() {
- return "OK";
- }
-
- /**
- * Used to convert example into an OK object.
- *
- * @param s Ignored.
- * @return The static {@link #OK} object.
- */
- public static Ok fromString(String s) {
- return OK;
+ return "Multiple Choices";
}
}
\ No newline at end of file
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/NoContent.java
similarity index 77%
copy from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
copy to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/NoContent.java
index 33e5706..9b933ca 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/NoContent.java
@@ -10,36 +10,24 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.helper;
+package org.apache.juneau.rest.response;
import org.apache.juneau.http.annotation.*;
/**
- * Represents a simple OK REST response.
+ * Represents an <code>HTTP 204 No Content</code> response.
*
* <p>
- * The response consist of the serialized string <js>"OK"</js>.
+ * The server successfully processed the request and is not returning any content.
*/
-@Response(code=200, example="'OK'")
-public class Ok {
+@Response(code=204, example="'No Content'")
+public class NoContent {
- /**
- * Reusable instance.
- */
- public static final Ok OK = new Ok();
+ /** Reusable instance. */
+ public static final NoContent INSTANCE = new NoContent();
@Override /* Object */
public String toString() {
- return "OK";
- }
-
- /**
- * Used to convert example into an OK object.
- *
- * @param s Ignored.
- * @return The static {@link #OK} object.
- */
- public static Ok fromString(String s) {
- return OK;
+ return "No Content";
}
}
\ No newline at end of file
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/NonAuthoritiveInformation.java
similarity index 74%
copy from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
copy to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/NonAuthoritiveInformation.java
index 33e5706..9448483 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/NonAuthoritiveInformation.java
@@ -10,36 +10,24 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.helper;
+package org.apache.juneau.rest.response;
import org.apache.juneau.http.annotation.*;
/**
- * Represents a simple OK REST response.
+ * Represents an <code>HTTP 203 Non-Authoritative Information</code> response.
*
* <p>
- * The response consist of the serialized string <js>"OK"</js>.
+ * The server is a transforming proxy (e.g. a Web accelerator) that received a 200 OK from its origin, but is returning a modified version of the origin's response.
*/
-@Response(code=200, example="'OK'")
-public class Ok {
+@Response(code=203, example="'Non-Authoritative Information'")
+public class NonAuthoritiveInformation {
- /**
- * Reusable instance.
- */
- public static final Ok OK = new Ok();
+ /** Reusable instance. */
+ public static final NonAuthoritiveInformation INSTANCE = new NonAuthoritiveInformation();
@Override /* Object */
public String toString() {
- return "OK";
- }
-
- /**
- * Used to convert example into an OK object.
- *
- * @param s Ignored.
- * @return The static {@link #OK} object.
- */
- public static Ok fromString(String s) {
- return OK;
+ return "Non-Authoritative Information";
}
}
\ No newline at end of file
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/NotModified.java
similarity index 74%
copy from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
copy to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/NotModified.java
index 33e5706..4cb078d 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/NotModified.java
@@ -10,36 +10,25 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.helper;
+package org.apache.juneau.rest.response;
import org.apache.juneau.http.annotation.*;
/**
- * Represents a simple OK REST response.
+ * Represents an <code>HTTP 304 Not Modified</code> response.
*
* <p>
- * The response consist of the serialized string <js>"OK"</js>.
+ * Indicates that the resource has not been modified since the version specified by the request headers If-Modified-Since or If-None-Match.
+ * In such case, there is no need to retransmit the resource since the client still has a previously-downloaded copy.
*/
-@Response(code=200, example="'OK'")
-public class Ok {
+@Response(code=304, example="'Not Modified'")
+public class NotModified {
- /**
- * Reusable instance.
- */
- public static final Ok OK = new Ok();
+ /** Reusable instance. */
+ public static final NotModified INSTANCE = new NotModified();
@Override /* Object */
public String toString() {
- return "OK";
- }
-
- /**
- * Used to convert example into an OK object.
- *
- * @param s Ignored.
- * @return The static {@link #OK} object.
- */
- public static Ok fromString(String s) {
- return OK;
+ return "Not Modified";
}
}
\ No newline at end of file
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/Ok.java
similarity index 77%
copy from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
copy to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/Ok.java
index 33e5706..fc486b9 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/Ok.java
@@ -10,36 +10,28 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.helper;
+package org.apache.juneau.rest.response;
import org.apache.juneau.http.annotation.*;
/**
- * Represents a simple OK REST response.
+ * Represents an <code>HTTP 200 OK</code> response.
*
* <p>
- * The response consist of the serialized string <js>"OK"</js>.
+ * Standard response for successful HTTP requests. The actual response will depend on the request method used.
+ * In a GET request, the response will contain an entity corresponding to the requested resource.
+ * In a POST request, the response will contain an entity describing or containing the result of the action.
*/
@Response(code=200, example="'OK'")
public class Ok {
- /**
- * Reusable instance.
- */
+ /** Reusable instance. */
+ public static final Ok INSTANCE = new Ok();
+ /** Reusable instance. */
public static final Ok OK = new Ok();
@Override /* Object */
public String toString() {
return "OK";
}
-
- /**
- * Used to convert example into an OK object.
- *
- * @param s Ignored.
- * @return The static {@link #OK} object.
- */
- public static Ok fromString(String s) {
- return OK;
- }
}
\ No newline at end of file
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/PartialContent.java
similarity index 74%
copy from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
copy to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/PartialContent.java
index 33e5706..d5cdead 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/PartialContent.java
@@ -10,36 +10,25 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.helper;
+package org.apache.juneau.rest.response;
import org.apache.juneau.http.annotation.*;
/**
- * Represents a simple OK REST response.
+ * Represents an <code>HTTP 206 Partial Content</code> response.
*
* <p>
- * The response consist of the serialized string <js>"OK"</js>.
+ * The server is delivering only part of the resource (byte serving) due to a range header sent by the client.
+ * The range header is used by HTTP clients to enable resuming of interrupted downloads, or split a download into multiple simultaneous streams.
*/
-@Response(code=200, example="'OK'")
-public class Ok {
+@Response(code=206, example="'Partial Content'")
+public class PartialContent {
- /**
- * Reusable instance.
- */
- public static final Ok OK = new Ok();
+ /** Reusable instance. */
+ public static final PartialContent INSTANCE = new PartialContent();
@Override /* Object */
public String toString() {
- return "OK";
- }
-
- /**
- * Used to convert example into an OK object.
- *
- * @param s Ignored.
- * @return The static {@link #OK} object.
- */
- public static Ok fromString(String s) {
- return OK;
+ return "Partial Content";
}
}
\ No newline at end of file
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/PermanentRedirect.java
similarity index 62%
copy from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
copy to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/PermanentRedirect.java
index 33e5706..c94c23b 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/PermanentRedirect.java
@@ -10,36 +10,53 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.helper;
+package org.apache.juneau.rest.response;
+
+import java.net.*;
import org.apache.juneau.http.annotation.*;
/**
- * Represents a simple OK REST response.
+ * Represents an <code>HTTP 308 Permanent Redirect</code> response.
*
* <p>
- * The response consist of the serialized string <js>"OK"</js>.
+ * The request and all future requests should be repeated using another URI. 307 and 308 parallel the behaviors of 302 and 301, but do not allow the HTTP method to change.
+ * So, for example, submitting a form to a permanently redirected resource may continue smoothly.
*/
-@Response(code=200, example="'OK'")
-public class Ok {
+@Response(code=308, example="'Permanent Redirect'")
+public class PermanentRedirect {
+
+ /** Reusable instance. */
+ public static final PermanentRedirect INSTANCE = new PermanentRedirect();
+
+ private final URI location;
+
+ /**
+ * Constructor.
+ */
+ public PermanentRedirect() {
+ this(null);
+ }
/**
- * Reusable instance.
+ * Constructor.
+ *
+ * @param location <code>Location</code> header value.
*/
- public static final Ok OK = new Ok();
+ public PermanentRedirect(URI location) {
+ this.location = location;
+ }
@Override /* Object */
public String toString() {
- return "OK";
+ return "Permanent Redirect";
}
/**
- * Used to convert example into an OK object.
- *
- * @param s Ignored.
- * @return The static {@link #OK} object.
+ * @return <code>Location</code> header value.
*/
- public static Ok fromString(String s) {
- return OK;
+ @Header(name="Location", description="")
+ public URI getLocation() {
+ return location;
}
}
\ No newline at end of file
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/Processing.java
similarity index 73%
copy from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
copy to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/Processing.java
index 33e5706..3156368 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/Processing.java
@@ -10,36 +10,26 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.helper;
+package org.apache.juneau.rest.response;
import org.apache.juneau.http.annotation.*;
/**
- * Represents a simple OK REST response.
+ * Represents an <code>HTTP 102 Processing</code> response.
*
* <p>
- * The response consist of the serialized string <js>"OK"</js>.
+ * A WebDAV request may contain many sub-requests involving file operations, requiring a long time to complete the request.
+ * This code indicates that the server has received and is processing the request, but no response is available yet.
+ * This prevents the client from timing out and assuming the request was lost.
*/
-@Response(code=200, example="'OK'")
-public class Ok {
+@Response(code=102, example="'Processing'")
+public class Processing {
- /**
- * Reusable instance.
- */
- public static final Ok OK = new Ok();
+ /** Reusable instance. */
+ public static final Processing INSTANCE = new Processing();
@Override /* Object */
public String toString() {
- return "OK";
- }
-
- /**
- * Used to convert example into an OK object.
- *
- * @param s Ignored.
- * @return The static {@link #OK} object.
- */
- public static Ok fromString(String s) {
- return OK;
+ return "Processing";
}
}
\ No newline at end of file
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/ResetContent.java
similarity index 77%
copy from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
copy to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/ResetContent.java
index 33e5706..532137f 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/ResetContent.java
@@ -10,36 +10,25 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.helper;
+package org.apache.juneau.rest.response;
import org.apache.juneau.http.annotation.*;
/**
- * Represents a simple OK REST response.
+ * Represents an <code>HTTP 205 Reset Content</code> response.
*
* <p>
- * The response consist of the serialized string <js>"OK"</js>.
+ * The server successfully processed the request, but is not returning any content.
+ * Unlike a 204 response, this response requires that the requester reset the document view.
*/
-@Response(code=200, example="'OK'")
-public class Ok {
+@Response(code=205, example="'Reset Content'")
+public class ResetContent {
- /**
- * Reusable instance.
- */
- public static final Ok OK = new Ok();
+ /** Reusable instance. */
+ public static final ResetContent INSTANCE = new ResetContent();
@Override /* Object */
public String toString() {
- return "OK";
- }
-
- /**
- * Used to convert example into an OK object.
- *
- * @param s Ignored.
- * @return The static {@link #OK} object.
- */
- public static Ok fromString(String s) {
- return OK;
+ return "Reset Content";
}
}
\ No newline at end of file
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/SeeOther.java
similarity index 64%
copy from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
copy to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/SeeOther.java
index 33e5706..b2f9056 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/SeeOther.java
@@ -10,36 +10,53 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.helper;
+package org.apache.juneau.rest.response;
+
+import java.net.*;
import org.apache.juneau.http.annotation.*;
/**
- * Represents a simple OK REST response.
+ * Represents an <code>HTTP 303 See Other</code> response.
*
* <p>
- * The response consist of the serialized string <js>"OK"</js>.
+ * The response to the request can be found under another URI using the GET method.
+ * When received in response to a POST (or PUT/DELETE), the client should presume that the server has received the data and should issue a new GET request to the given URI.
*/
-@Response(code=200, example="'OK'")
-public class Ok {
+@Response(code=303, example="'See Other'")
+public class SeeOther {
+
+ /** Reusable instance. */
+ public static final SeeOther INSTANCE = new SeeOther();
+
+ private final URI location;
+
+ /**
+ * Constructor.
+ */
+ public SeeOther() {
+ this(null);
+ }
/**
- * Reusable instance.
+ * Constructor.
+ *
+ * @param location <code>Location</code> header value.
*/
- public static final Ok OK = new Ok();
+ public SeeOther(URI location) {
+ this.location = location;
+ }
@Override /* Object */
public String toString() {
- return "OK";
+ return "See Other";
}
/**
- * Used to convert example into an OK object.
- *
- * @param s Ignored.
- * @return The static {@link #OK} object.
+ * @return <code>Location</code> header value.
*/
- public static Ok fromString(String s) {
- return OK;
+ @Header(name="Location", description="")
+ public URI getLocation() {
+ return location;
}
}
\ No newline at end of file
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/SwitchingProtocols.java
similarity index 77%
copy from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
copy to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/SwitchingProtocols.java
index 33e5706..21c62e0 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/SwitchingProtocols.java
@@ -10,36 +10,24 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.helper;
+package org.apache.juneau.rest.response;
import org.apache.juneau.http.annotation.*;
/**
- * Represents a simple OK REST response.
+ * Represents an <code>HTTP 101 Switching Protocols</code> response.
*
* <p>
- * The response consist of the serialized string <js>"OK"</js>.
+ * The requester has asked the server to switch protocols and the server has agreed to do so.
*/
-@Response(code=200, example="'OK'")
-public class Ok {
+@Response(code=101, example="'Switching Protocols'")
+public class SwitchingProtocols {
- /**
- * Reusable instance.
- */
- public static final Ok OK = new Ok();
+ /** Reusable instance. */
+ public static final SwitchingProtocols INSTANCE = new SwitchingProtocols();
@Override /* Object */
public String toString() {
- return "OK";
- }
-
- /**
- * Used to convert example into an OK object.
- *
- * @param s Ignored.
- * @return The static {@link #OK} object.
- */
- public static Ok fromString(String s) {
- return OK;
+ return "Switching Protocols";
}
}
\ No newline at end of file
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/TemporaryRedirect.java
similarity index 60%
copy from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
copy to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/TemporaryRedirect.java
index 33e5706..f24197f 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/TemporaryRedirect.java
@@ -10,36 +10,55 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.helper;
+package org.apache.juneau.rest.response;
+
+import java.net.*;
import org.apache.juneau.http.annotation.*;
/**
- * Represents a simple OK REST response.
+ * Represents an <code>HTTP 307 Temporary Redirect</code> response.
*
* <p>
- * The response consist of the serialized string <js>"OK"</js>.
+ * In this case, the request should be repeated with another URI; however, future requests should still use the original URI.
+ * In contrast to how 302 was historically implemented, the request method is not allowed to be changed when reissuing the original request.
+ * For example, a POST request should be repeated using another POST request.
*/
-@Response(code=200, example="'OK'")
-public class Ok {
+@Response(code=307, example="'Temporary Redirect'")
+public class TemporaryRedirect {
+
+ /** Reusable instance. */
+ public static final TemporaryRedirect INSTANCE = new TemporaryRedirect();
+
+ private final URI location;
/**
- * Reusable instance.
+ * Constructor.
*/
- public static final Ok OK = new Ok();
+ public TemporaryRedirect() {
+ this(null);
+ }
+
+ /**
+ * Constructor.
+ *
+ * @param location <code>Location</code> header value.
+ */
+ public TemporaryRedirect(URI location) {
+ this.location = location;
+ }
@Override /* Object */
public String toString() {
- return "OK";
+ return "Temporary Redirect";
}
+
/**
- * Used to convert example into an OK object.
- *
- * @param s Ignored.
- * @return The static {@link #OK} object.
+ * @return <code>Location</code> header value.
*/
- public static Ok fromString(String s) {
- return OK;
+ @Header(name="Location", description="")
+ public URI getLocation() {
+ return location;
}
}
\ No newline at end of file
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/UseProxy.java
similarity index 76%
rename from juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
rename to juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/UseProxy.java
index 33e5706..60bb16d 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/Ok.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/UseProxy.java
@@ -10,36 +10,25 @@
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
-package org.apache.juneau.rest.helper;
+package org.apache.juneau.rest.response;
import org.apache.juneau.http.annotation.*;
/**
- * Represents a simple OK REST response.
+ * Represents an <code>HTTP 305 Use Proxy</code> response.
*
* <p>
- * The response consist of the serialized string <js>"OK"</js>.
+ * The requested resource is available only through a proxy, the address for which is provided in the response.
+ * Many HTTP clients (such as Mozilla and Internet Explorer) do not correctly handle responses with this status code, primarily for security reasons.
*/
-@Response(code=200, example="'OK'")
-public class Ok {
+@Response(code=305, example="'Use Proxy'")
+public class UseProxy {
- /**
- * Reusable instance.
- */
- public static final Ok OK = new Ok();
+ /** Reusable instance. */
+ public static final UseProxy INSTANCE = new UseProxy();
@Override /* Object */
public String toString() {
return "OK";
}
-
- /**
- * Used to convert example into an OK object.
- *
- * @param s Ignored.
- * @return The static {@link #OK} object.
- */
- public static Ok fromString(String s) {
- return OK;
- }
}
\ No newline at end of file