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 0402940 Remove redundancy in HttpPart annotations.
0402940 is described below
commit 040294071595ce433c8195aceb1ed193d6a19cf5
Author: JamesBognar <[email protected]>
AuthorDate: Fri Nov 26 16:04:34 2021 -0500
Remove redundancy in HttpPart annotations.
---
.../{ResponseStatus.java => ResponseCode.java} | 10 ++--
...Annotation.java => ResponseCodeAnnotation.java} | 30 +++++------
.../juneau/httppart/bean/RequestBeanMeta.java | 2 +-
.../juneau/httppart/bean/ResponseBeanMeta.java | 6 +--
.../Topics/01.Overview/05.RestServerOverview.html | 2 +-
.../03.RestOpAnnotatedMethods.html | 2 +-
.../Topics/06.juneau-rest-server/04.HttpParts.html | 2 +-
.../05.ReponseHeader_ResponseStatus.html | 14 ++---
.../23.RestSwagger/07.RestSwaggerResponses.html | 2 +-
.../11.RestcProxies/09.RestcResponse.html | 4 +-
.../20.Glossaries/02.GlossaryAnnotations.html | 2 +-
juneau-doc/src/main/javadoc/overview.html | 60 +++++++++++-----------
juneau-doc/src/main/javadoc/resources/docs.txt | 4 +-
.../src/main/javadoc/resources/fragments/toc.html | 4 +-
.../java/org/apache/juneau/rest/RestContext.java | 2 +-
.../java/org/apache/juneau/rest/RestParamType.java | 2 +-
...ResponseStatusArg.java => ResponseCodeArg.java} | 16 +++---
.../http/annotation/AnnotationUtils_Test.java | 6 +--
.../annotation/ResponseStatusAnnotation_Test.java | 18 +++----
.../remote/Remote_ResponseAnnotation_Test.java | 2 +-
.../java/org/apache/juneau/rest/Swagger_Test.java | 16 +++---
.../rest/annotation/ResponseStatus_Test.java | 2 +-
22 files changed, 104 insertions(+), 104 deletions(-)
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/ResponseStatus.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/ResponseCode.java
similarity index 92%
rename from
juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/ResponseStatus.java
rename to
juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/ResponseCode.java
index b5855fd..944cea0 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/ResponseStatus.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/ResponseCode.java
@@ -41,7 +41,7 @@ import org.apache.juneau.annotation.*;
* <h5 class='section'>Example:</h5>
* <p class='bcode w800'>
* <ja>@RestPost</ja>
- * <jk>public void</jk> addPet(<ja>@Body</ja> Pet <jv>pet</jv>,
<ja>@ResponseStatus</ja> Value<Integer> <jv>status</jv>) {
+ * <jk>public void</jk> addPet(<ja>@Body</ja> Pet <jv>pet</jv>,
<ja>@ResponseCode</ja> Value<Integer> <jv>status</jv>) {
* <jsm>addPet</jsm>(<jv>pet</jv>);
* <jv>status</jv>.set(200);
* }
@@ -69,7 +69,7 @@ import org.apache.juneau.annotation.*;
* <ja>@Response</ja>
* <jk>public class</jk> Success {
*
- * <ja>@ResponseStatus</ja>
+ * <ja>@ResponseCode</ja>
* <jk>public int</jk> getStatus() {
* <jk>return</jk> 201;
* }
@@ -99,9 +99,9 @@ import org.apache.juneau.annotation.*;
@Target({PARAMETER,METHOD,TYPE})
@Retention(RUNTIME)
@Inherited
-@Repeatable(ResponseStatusAnnotation.Array.class)
-@ContextApply(ResponseStatusAnnotation.Applier.class)
-public @interface ResponseStatus {
+@Repeatable(ResponseCodeAnnotation.Array.class)
+@ContextApply(ResponseCodeAnnotation.Applier.class)
+public @interface ResponseCode {
/**
* Dynamically apply this annotation to the specified classes.
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/ResponseStatusAnnotation.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/ResponseCodeAnnotation.java
similarity index 84%
rename from
juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/ResponseStatusAnnotation.java
rename to
juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/ResponseCodeAnnotation.java
index ae2ca00..77031b4 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/ResponseStatusAnnotation.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/ResponseCodeAnnotation.java
@@ -23,16 +23,16 @@ import org.apache.juneau.reflect.*;
import org.apache.juneau.svl.*;
/**
- * Utility classes and methods for the {@link ResponseStatus @ResponseStatus}
annotation.
+ * Utility classes and methods for the {@link ResponseCode @ResponseCode}
annotation.
*/
-public class ResponseStatusAnnotation {
+public class ResponseCodeAnnotation {
//-----------------------------------------------------------------------------------------------------------------
// Static
//-----------------------------------------------------------------------------------------------------------------
/** Default value */
- public static final ResponseStatus DEFAULT = create().build();
+ public static final ResponseCode DEFAULT = create().build();
/**
* Instantiates a new builder for this class.
@@ -80,15 +80,15 @@ public class ResponseStatusAnnotation {
* Constructor.
*/
protected Builder() {
- super(ResponseStatus.class);
+ super(ResponseCode.class);
}
/**
- * Instantiates a new {@link ResponseStatus @ResponseStatus}
object initialized with this builder.
+ * Instantiates a new {@link ResponseCode @ResponseCode} object
initialized with this builder.
*
- * @return A new {@link ResponseStatus @ResponseStatus} object.
+ * @return A new {@link ResponseCode @ResponseCode} object.
*/
- public ResponseStatus build() {
+ public ResponseCode build() {
return new Impl(this);
}
@@ -125,7 +125,7 @@ public class ResponseStatusAnnotation {
// Implementation
//-----------------------------------------------------------------------------------------------------------------
- private static class Impl extends TargetedAnnotationTImpl implements
ResponseStatus {
+ private static class Impl extends TargetedAnnotationTImpl implements
ResponseCode {
Impl(Builder b) {
super(b);
@@ -138,9 +138,9 @@ public class ResponseStatusAnnotation {
//-----------------------------------------------------------------------------------------------------------------
/**
- * Applies targeted {@link ResponseStatus} annotations to a {@link
org.apache.juneau.BeanContext.Builder}.
+ * Applies targeted {@link ResponseCode} annotations to a {@link
org.apache.juneau.BeanContext.Builder}.
*/
- public static class Applier extends
AnnotationApplier<ResponseStatus,BeanContext.Builder> {
+ public static class Applier extends
AnnotationApplier<ResponseCode,BeanContext.Builder> {
/**
* Constructor.
@@ -148,12 +148,12 @@ public class ResponseStatusAnnotation {
* @param vr The resolver for resolving values in annotations.
*/
public Applier(VarResolverSession vr) {
- super(ResponseStatus.class, BeanContext.Builder.class,
vr);
+ super(ResponseCode.class, BeanContext.Builder.class,
vr);
}
@Override
- public void apply(AnnotationInfo<ResponseStatus> ai,
BeanContext.Builder b) {
- ResponseStatus a = ai.getAnnotation();
+ public void apply(AnnotationInfo<ResponseCode> ai,
BeanContext.Builder b) {
+ ResponseCode a = ai.getAnnotation();
if (isEmpty(a.on()) && isEmpty(a.onClass()))
return;
@@ -167,7 +167,7 @@ public class ResponseStatusAnnotation {
//-----------------------------------------------------------------------------------------------------------------
/**
- * A collection of {@link ResponseStatus @ResponseStatus annotations}.
+ * A collection of {@link ResponseCode @ResponseCode annotations}.
*/
@Documented
@Target({METHOD,TYPE})
@@ -178,6 +178,6 @@ public class ResponseStatusAnnotation {
/**
* The child annotations.
*/
- ResponseStatus[] value();
+ ResponseCode[] value();
}
}
\ No newline at end of file
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/bean/RequestBeanMeta.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/bean/RequestBeanMeta.java
index 6a3c32d..b252c1f 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/bean/RequestBeanMeta.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/bean/RequestBeanMeta.java
@@ -96,7 +96,7 @@ public class RequestBeanMeta {
for (MethodInfo m : cm.getInfo().getAllMethods()) {
if (m.isPublic()) {
- assertNoInvalidAnnotations(m,
ResponseHeader.class, ResponseBody.class, ResponseStatus.class);
+ assertNoInvalidAnnotations(m,
ResponseHeader.class, ResponseBody.class, ResponseCode.class);
String n = m.getSimpleName();
if (m.hasAnnotation(Header.class)) {
assertNoArgs(m, Header.class);
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/bean/ResponseBeanMeta.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/bean/ResponseBeanMeta.java
index 22f4d8f..0248737 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/bean/ResponseBeanMeta.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/bean/ResponseBeanMeta.java
@@ -158,7 +158,7 @@ public class ResponseBeanMeta {
assertReturnNotVoid(m,
ResponseHeader.class);
HttpPartSchema s =
HttpPartSchema.create(m.getLastAnnotation(ResponseHeader.class),
m.getPropertyName());
headerMethods.put(s.getName(),
ResponseBeanPropertyMeta.create(RESPONSE_HEADER, s, m));
- } else if
(m.hasAnnotation(ResponseStatus.class)) {
+ } else if
(m.hasAnnotation(ResponseCode.class)) {
assertNoArgs(m,
ResponseHeader.class);
assertReturnType(m,
ResponseHeader.class, int.class, Integer.class);
statusMethod =
ResponseBeanPropertyMeta.create(RESPONSE_STATUS, m);
@@ -231,9 +231,9 @@ public class ResponseBeanMeta {
}
/**
- * Returns the <ja>@ResponseStatus</ja>-annotated method.
+ * Returns the <ja>@ResponseCode</ja>-annotated method.
*
- * @return The <ja>@ResponseStatus</ja>-annotated method, or
<jk>null</jk> if it doesn't exist.
+ * @return The <ja>@ResponseCode</ja>-annotated method, or
<jk>null</jk> if it doesn't exist.
*/
public ResponseBeanPropertyMeta getStatusMethod() {
return statusMethod;
diff --git a/juneau-doc/docs/Topics/01.Overview/05.RestServerOverview.html
b/juneau-doc/docs/Topics/01.Overview/05.RestServerOverview.html
index d53b26e..1686827 100644
--- a/juneau-doc/docs/Topics/01.Overview/05.RestServerOverview.html
+++ b/juneau-doc/docs/Topics/01.Overview/05.RestServerOverview.html
@@ -196,7 +196,7 @@
<ul>
<li>Typically a POJO serialized based on {@link
oaj.http.header.Accept} request header.
<li>Support for raw values such as <c>Readers</c> and
<c>InputStreams</c> (among others).
- <li>Support for response beans annotated with {@link
oaj.http.annotation.Response @Response} / {@link
oaj.http.annotation.ResponseBody @ResponseBody} / {@link
oaj.http.annotation.ResponseHeader @ResponseHeader} / {@link
oaj.http.annotation.ResponseStatus @ResponseStatus}.
+ <li>Support for response beans annotated with {@link
oaj.http.annotation.Response @Response} / {@link
oaj.http.annotation.ResponseBody @ResponseBody} / {@link
oaj.http.annotation.ResponseHeader @ResponseHeader} / {@link
oaj.http.annotation.ResponseCode @ResponseCode}.
<li>Support for Apache Http Core interfaces: {@link
org.apache.http.HttpEntity} / {@link org.apache.http.HttpResponse} / {@link
oaj.http.resource.HttpResource}.
<li>Standard HTTP responses such as {@link
oaj.http.response.Ok} and {@link oaj.http.response.TemporaryRedirect} provided
in {@link oaj.http.response} package.
<li>Extensible API for defining custom return types.
diff --git
a/juneau-doc/docs/Topics/06.juneau-rest-server/03.RestOpAnnotatedMethods.html
b/juneau-doc/docs/Topics/06.juneau-rest-server/03.RestOpAnnotatedMethods.html
index 5c11cd2..238b53e 100644
---
a/juneau-doc/docs/Topics/06.juneau-rest-server/03.RestOpAnnotatedMethods.html
+++
b/juneau-doc/docs/Topics/06.juneau-rest-server/03.RestOpAnnotatedMethods.html
@@ -271,7 +271,7 @@
<li class='ja'>{@link oaj.http.annotation.Request}
<li class='ja'>{@link oaj.http.annotation.Response}
<li class='ja'>{@link
oaj.http.annotation.ResponseHeader}
- <li class='ja'>{@link
oaj.http.annotation.ResponseStatus}
+ <li class='ja'>{@link oaj.http.annotation.ResponseCode}
</ul>
</ul>
<p>
diff --git a/juneau-doc/docs/Topics/06.juneau-rest-server/04.HttpParts.html
b/juneau-doc/docs/Topics/06.juneau-rest-server/04.HttpParts.html
index e5a7b68..06541e8 100644
--- a/juneau-doc/docs/Topics/06.juneau-rest-server/04.HttpParts.html
+++ b/juneau-doc/docs/Topics/06.juneau-rest-server/04.HttpParts.html
@@ -54,7 +54,7 @@
<ul class='javatreec'>
<li class='ja'>{@link oaj.http.annotation.ResponseBody}
<li class='ja'>{@link oaj.http.annotation.ResponseHeader}
- <li class='ja'>{@link oaj.http.annotation.ResponseStatus}
+ <li class='ja'>{@link oaj.http.annotation.ResponseCode}
<li class='ja'>{@link oaj.http.annotation.Response}
</ul>
<li>Sub-annotations:
diff --git
a/juneau-doc/docs/Topics/06.juneau-rest-server/04.HttpParts/05.ReponseHeader_ResponseStatus.html
b/juneau-doc/docs/Topics/06.juneau-rest-server/04.HttpParts/05.ReponseHeader_ResponseStatus.html
index 08dd3c4..a938508 100644
---
a/juneau-doc/docs/Topics/06.juneau-rest-server/04.HttpParts/05.ReponseHeader_ResponseStatus.html
+++
b/juneau-doc/docs/Topics/06.juneau-rest-server/04.HttpParts/05.ReponseHeader_ResponseStatus.html
@@ -13,10 +13,10 @@
***************************************************************************************************************************/
-->
-{title:'@Response / @ResponseHeader / @ResponseStatus', updated:'8.1.0,9.0.0'}
+{title:'@Response / @ResponseHeader / @ResponseCode', updated:'8.1.0,9.0.0'}
<p>
- The {@link oaj.http.annotation.Response @Response} / {@link
oaj.http.annotation.ResponseHeader @ResponseHeader} / {@link
oaj.http.annotation.ResponseStatus @ResponseStatus} annotations
+ The {@link oaj.http.annotation.Response @Response} / {@link
oaj.http.annotation.ResponseHeader @ResponseHeader} / {@link
oaj.http.annotation.ResponseCode @ResponseCode} annotations
allow you to define method parameters for setting HTTP response parts:
</p>
@@ -47,10 +47,10 @@
<li class='jm'>{@link
oaj.http.annotation.ResponseHeader#serializer() serializer()}
<li class='jm'>{@link
oaj.http.annotation.ResponseHeader#value() value()}
</ul>
- <li class='ja'>{@link oaj.http.annotation.ResponseStatus}
+ <li class='ja'>{@link oaj.http.annotation.ResponseCode}
<ul class='javatreec'>
- <li class='jm'>{@link oaj.http.annotation.ResponseStatus#on()
on()}
- <li class='jm'>{@link
oaj.http.annotation.ResponseStatus#onClass() onClass()}
+ <li class='jm'>{@link oaj.http.annotation.ResponseCode#on()
on()}
+ <li class='jm'>{@link
oaj.http.annotation.ResponseCode#onClass() onClass()}
</ul>
</ul>
<p>
@@ -113,7 +113,7 @@
}
</p>
<p>
- The {@link oaj.http.annotation.ResponseStatus @ResponseStatus}
annotation annotation can be used to
+ The {@link oaj.http.annotation.ResponseCode @ResponseCode} annotation
annotation can be used to
set the HTTP response code:
</p>
<h5 class='figure'>Examples:</h5>
@@ -123,7 +123,7 @@
<jk>public void</jk> login(
<ja>@FormData</ja>(<js>"username"</js>) String
<jv>username</jv>,
<ja>@FormData</ja>(<js>"password"</js>) String
<jv>password</jv>,
- <ja>@ResponseStatus</ja> Value<Integer> <jv>status</jv>
+ <ja>@ResponseCode</ja> Value<Integer> <jv>status</jv>
)
{
<jk>if</jk> (! <jsm>isValid</jsm>(<jv>username</jv>,
<jv>password</jv>))
diff --git
a/juneau-doc/docs/Topics/06.juneau-rest-server/23.RestSwagger/07.RestSwaggerResponses.html
b/juneau-doc/docs/Topics/06.juneau-rest-server/23.RestSwagger/07.RestSwaggerResponses.html
index 08fa452..148bac4 100644
---
a/juneau-doc/docs/Topics/06.juneau-rest-server/23.RestSwagger/07.RestSwaggerResponses.html
+++
b/juneau-doc/docs/Topics/06.juneau-rest-server/23.RestSwagger/07.RestSwaggerResponses.html
@@ -51,7 +51,7 @@
<ul class='seealso'>
<li class='link'>{@doc RestResponseAnnotation}
<li class='link'>{@doc RestResponseHeaderAnnotation}
- <li class='link'>{@doc RestResponseStatusAnnotation}
+ <li class='link'>{@doc RestResponseCodeAnnotation}
</ul>
diff --git
a/juneau-doc/docs/Topics/09.juneau-rest-client/11.RestcProxies/09.RestcResponse.html
b/juneau-doc/docs/Topics/09.juneau-rest-client/11.RestcProxies/09.RestcResponse.html
index 3709a0e..f5eaa03 100644
---
a/juneau-doc/docs/Topics/09.juneau-rest-client/11.RestcProxies/09.RestcResponse.html
+++
b/juneau-doc/docs/Topics/09.juneau-rest-client/11.RestcProxies/09.RestcResponse.html
@@ -46,7 +46,7 @@
<ja>@ResponseHeader</ja>(<js>"E-Tag"</js>)
UUID getUUID();
- <ja>@ResponseStatus</ja>
+ <ja>@ResponseCode</ja>
<jk>int</jk> getStatus();
}
</p>
@@ -68,7 +68,7 @@
<ul class='javatree'>
<li class='ja'>{@link oaj.http.annotation.ResponseBody}
<li class='ja'>{@link oaj.http.annotation.ResponseHeader}
- <li class='ja'>{@link oaj.http.annotation.ResponseStatus}
+ <li class='ja'>{@link oaj.http.annotation.ResponseCode}
</ul>
<p>
The behavior and functionality of all of the annotations are the same
as if they were used on method arguments directly. This means full support for
OpenAPI serialization and validation.
diff --git a/juneau-doc/docs/Topics/20.Glossaries/02.GlossaryAnnotations.html
b/juneau-doc/docs/Topics/20.Glossaries/02.GlossaryAnnotations.html
index 6f7b932..c35ab5b 100644
--- a/juneau-doc/docs/Topics/20.Glossaries/02.GlossaryAnnotations.html
+++ b/juneau-doc/docs/Topics/20.Glossaries/02.GlossaryAnnotations.html
@@ -316,7 +316,7 @@
<td>Denotes a method as an HTTP response header on a
<ja>@Response</ja>-annotated bean.</td>
</tr>
<tr>
- <td><ul style='margin-left:20px'><li class='ja'>{@link
oaj.http.annotation.ResponseStatus}</ul></td>
+ <td><ul style='margin-left:20px'><li class='ja'>{@link
oaj.http.annotation.ResponseCode}</ul></td>
<td><ul><li>Methods<li>Parameters</ul></td>
<td>Denotes a method as an HTTP response status code on a
<ja>@Response</ja>-annotated bean.</td>
</tr>
diff --git a/juneau-doc/src/main/javadoc/overview.html
b/juneau-doc/src/main/javadoc/overview.html
index aa80f1e..93b298e 100644
--- a/juneau-doc/src/main/javadoc/overview.html
+++ b/juneau-doc/src/main/javadoc/overview.html
@@ -354,7 +354,7 @@
<li><p><a class='doclink'
href='#juneau-rest-server.HttpParts.Header_Path_Query_FormData'>@Header / @Path
/ @Query / @FormData</a><span class='update'>updated:
8.1.0,<b>9.0.0</b></span></p>
<li><p><a class='doclink'
href='#juneau-rest-server.HttpParts.Body'>@Body and Request Bodies</a><span
class='update'>updated: 8.1.0,<b>9.0.0</b></span></p>
<li><p><a class='doclink'
href='#juneau-rest-server.HttpParts.RequestBeans'>@Request beans</a><span
class='update'>updated: 8.1.0,<b>9.0.0</b></span></p>
- <li><p><a class='doclink'
href='#juneau-rest-server.HttpParts.ReponseHeader_ResponseStatus'>@Response /
@ResponseHeader / @ResponseStatus</a><span class='update'>updated:
8.1.0,<b>9.0.0</b></span></p>
+ <li><p><a class='doclink'
href='#juneau-rest-server.HttpParts.ReponseHeader_ResponseCode'>@Response /
@ResponseHeader / @ResponseCode</a><span class='update'>updated:
8.1.0,<b>9.0.0</b></span></p>
<li><p><a class='doclink'
href='#juneau-rest-server.HttpParts.ResponseBeans'>@Response beans</a><span
class='update'>updated: 8.1.0,<b>9.0.0</b></span></p>
<li><p><a class='doclink'
href='#juneau-rest-server.HttpParts.RequestHeader_RequestQueryParams_RequestFormParams_RequestPathParams'>RequestHeaders
/ RequestQueryParams / RequestFormParams / RequestPathParams</a><span
class='update'>created: <b>9.0.0</b></span></p>
</ol>
@@ -430,7 +430,7 @@
<li><p><a class='doclink'
href='#juneau-rest-client.RestcRequestQueryParameters'>Request Query
Parameters</a><span class='update'>created: 8.2.0,
<b><red>todo</red></b></span></p>
<li><p><a class='doclink'
href='#juneau-rest-client.RestcRequestFormData'>Request Form Data</a><span
class='update'>created: 8.2.0, <b><red>todo</red></b></span></p>
<li><p><a class='doclink'
href='#juneau-rest-client.RestcRequestBody'>Request Body</a><span
class='update'>created: 8.2.0, <b><red>todo</red></b></span></p>
- <li><p><a class='doclink'
href='#juneau-rest-client.RestcResponseStatus'>Response Status</a><span
class='update'>created: 8.1.0, <b><red>todo</red></b></span></p>
+ <li><p><a class='doclink'
href='#juneau-rest-client.RestcResponseCode'>Response Status</a><span
class='update'>created: 8.1.0, <b><red>todo</red></b></span></p>
<li><p><a class='doclink'
href='#juneau-rest-client.RestcResponseHeaders'>Response Headers</a><span
class='update'>created: 8.2.0, <b><red>todo</red></b></span></p>
<li><p><a class='doclink'
href='#juneau-rest-client.RestcResponseBody'>Response Body</a><span
class='update'>created: 8.2.0, <b><red>todo</red></b></span></p>
<li><p><a class='doclink'
href='#juneau-rest-client.RestcCustomCallHandlers'>Custom Call
Handlers</a><span class='update'>created: 8.2.0,
<b><red>todo</red></b></span></p>
@@ -1805,7 +1805,7 @@
<ul>
<li>Typically a POJO serialized based on {@link
org.apache.juneau.http.header.Accept} request header.
<li>Support for raw values such as <c>Readers</c> and
<c>InputStreams</c> (among others).
- <li>Support for response beans annotated with {@link
org.apache.juneau.http.annotation.Response @Response} / {@link
org.apache.juneau.http.annotation.ResponseBody @ResponseBody} / {@link
org.apache.juneau.http.annotation.ResponseHeader @ResponseHeader} / {@link
org.apache.juneau.http.annotation.ResponseStatus @ResponseStatus}.
+ <li>Support for response beans annotated with {@link
org.apache.juneau.http.annotation.Response @Response} / {@link
org.apache.juneau.http.annotation.ResponseBody @ResponseBody} / {@link
org.apache.juneau.http.annotation.ResponseHeader @ResponseHeader} / {@link
org.apache.juneau.http.annotation.ResponseCode @ResponseCode}.
<li>Support for Apache Http Core interfaces: {@link
org.apache.http.HttpEntity} / {@link org.apache.http.HttpResponse} / {@link
org.apache.juneau.http.resource.HttpResource}.
<li>Standard HTTP responses such as {@link
org.apache.juneau.http.response.Ok} and {@link
org.apache.juneau.http.response.TemporaryRedirect} provided in {@link
org.apache.juneau.http.response} package.
<li>Extensible API for defining custom return types.
@@ -15124,7 +15124,7 @@
<li class='ja'>{@link
org.apache.juneau.http.annotation.Request}
<li class='ja'>{@link
org.apache.juneau.http.annotation.Response}
<li class='ja'>{@link
org.apache.juneau.http.annotation.ResponseHeader}
- <li class='ja'>{@link
org.apache.juneau.http.annotation.ResponseStatus}
+ <li class='ja'>{@link
org.apache.juneau.http.annotation.ResponseCode}
</ul>
</ul>
<p>
@@ -15574,7 +15574,7 @@
<ul class='javatreec'>
<li class='ja'>{@link
org.apache.juneau.http.annotation.ResponseBody}
<li class='ja'>{@link
org.apache.juneau.http.annotation.ResponseHeader}
- <li class='ja'>{@link
org.apache.juneau.http.annotation.ResponseStatus}
+ <li class='ja'>{@link
org.apache.juneau.http.annotation.ResponseCode}
<li class='ja'>{@link
org.apache.juneau.http.annotation.Response}
</ul>
<li>Sub-annotations:
@@ -16143,10 +16143,10 @@
<!--
====================================================================================================
-->
-<h5 class='topic' onclick='toggle(this)'><a
href='#juneau-rest-server.HttpParts.ReponseHeader_ResponseStatus'
id='juneau-rest-server.HttpParts.ReponseHeader_ResponseStatus'>6.4.5 -
@Response / @ResponseHeader / @ResponseStatus</a><span class='update'>updated:
8.1.0,<b>9.0.0</b></span></h4>
-<div class='topic'><!-- START: 6.4.5 -
juneau-rest-server.HttpParts.ReponseHeader_ResponseStatus -->
+<h5 class='topic' onclick='toggle(this)'><a
href='#juneau-rest-server.HttpParts.ReponseHeader_ResponseCode'
id='juneau-rest-server.HttpParts.ReponseHeader_ResponseCode'>6.4.5 - @Response
/ @ResponseHeader / @ResponseCode</a><span class='update'>updated:
8.1.0,<b>9.0.0</b></span></h4>
+<div class='topic'><!-- START: 6.4.5 -
juneau-rest-server.HttpParts.ReponseHeader_ResponseCode -->
<p>
- The {@link org.apache.juneau.http.annotation.Response @Response} /
{@link org.apache.juneau.http.annotation.ResponseHeader @ResponseHeader} /
{@link org.apache.juneau.http.annotation.ResponseStatus @ResponseStatus}
annotations
+ The {@link org.apache.juneau.http.annotation.Response @Response} /
{@link org.apache.juneau.http.annotation.ResponseHeader @ResponseHeader} /
{@link org.apache.juneau.http.annotation.ResponseCode @ResponseCode} annotations
allow you to define method parameters for setting HTTP response parts:
</p>
@@ -16177,10 +16177,10 @@
<li class='jm'>{@link
org.apache.juneau.http.annotation.ResponseHeader#serializer() serializer()}
<li class='jm'>{@link
org.apache.juneau.http.annotation.ResponseHeader#value() value()}
</ul>
- <li class='ja'>{@link org.apache.juneau.http.annotation.ResponseStatus}
+ <li class='ja'>{@link org.apache.juneau.http.annotation.ResponseCode}
<ul class='javatreec'>
- <li class='jm'>{@link
org.apache.juneau.http.annotation.ResponseStatus#on() on()}
- <li class='jm'>{@link
org.apache.juneau.http.annotation.ResponseStatus#onClass() onClass()}
+ <li class='jm'>{@link
org.apache.juneau.http.annotation.ResponseCode#on() on()}
+ <li class='jm'>{@link
org.apache.juneau.http.annotation.ResponseCode#onClass() onClass()}
</ul>
</ul>
<p>
@@ -16243,7 +16243,7 @@
}
</p>
<p>
- The {@link org.apache.juneau.http.annotation.ResponseStatus
@ResponseStatus} annotation annotation can be used to
+ The {@link org.apache.juneau.http.annotation.ResponseCode
@ResponseCode} annotation annotation can be used to
set the HTTP response code:
</p>
<h5 class='figure'>Examples:</h5>
@@ -16253,14 +16253,14 @@
<jk>public void</jk> login(
<ja>@FormData</ja>(<js>"username"</js>) String
<jv>username</jv>,
<ja>@FormData</ja>(<js>"password"</js>) String
<jv>password</jv>,
- <ja>@ResponseStatus</ja> Value<Integer> <jv>status</jv>
+ <ja>@ResponseCode</ja> Value<Integer> <jv>status</jv>
)
{
<jk>if</jk> (! <jsm>isValid</jsm>(<jv>username</jv>,
<jv>password</jv>))
<jv>status</jv>.set(401);
}
</p>
-</div><!-- END: 6.4.5 -
juneau-rest-server.HttpParts.ReponseHeader_ResponseStatus -->
+</div><!-- END: 6.4.5 -
juneau-rest-server.HttpParts.ReponseHeader_ResponseCode -->
<!--
====================================================================================================
-->
@@ -16279,7 +16279,7 @@
public non-static methods of the class to identify parts of a response:
</p>
<ul class='javatree'>
- <li class='ja'>{@link org.apache.juneau.http.annotation.ResponseStatus}
+ <li class='ja'>{@link org.apache.juneau.http.annotation.ResponseCode}
<li class='ja'>{@link org.apache.juneau.http.annotation.ResponseHeader}
<li class='ja'>{@link org.apache.juneau.http.annotation.ResponseBody}
</ul>
@@ -16464,9 +16464,9 @@
}
</p>
-<h5 class='topic'>@ResponseStatus on methods of @Response-annotated types</h5>
+<h5 class='topic'>@ResponseCode on methods of @Response-annotated types</h5>
<p>
- The {@link org.apache.juneau.http.annotation.ResponseStatus
@ResponseStatus} annotation can be used on
+ The {@link org.apache.juneau.http.annotation.ResponseCode
@ResponseCode} annotation can be used on
the method of a <ja>@Response</ja>-annotated class to identify HTTP
response
statuses other than <c>200</c> (the default).
</p>
@@ -16476,7 +16476,7 @@
<ja>@Response</ja>
<jk>public class</jk> AddPetSuccess {
- <ja>@ResponseStatus</ja>
+ <ja>@ResponseCode</ja>
<jk>public int</jk> getStatus() {
<jk>return</jk> 201;
}
@@ -16724,10 +16724,10 @@
</p>
<p>
- The {@link org.apache.juneau.http.annotation.ResponseStatus
@ResponseStatus} annotation annotation can be applied to
<ja>@RestOp</ja>-annotated parameters to denote them as an HTTP response status
codes.
+ The {@link org.apache.juneau.http.annotation.ResponseCode
@ResponseCode} annotation annotation can be applied to
<ja>@RestOp</ja>-annotated parameters to denote them as an HTTP response status
codes.
</p>
<ul class='javatree'>
- <li class='ja'>{@link org.apache.juneau.http.annotation.ResponseStatus}
+ <li class='ja'>{@link org.apache.juneau.http.annotation.ResponseCode}
</ul>
<p>
This can only be applied to parameters of the {@link
org.apache.juneau.Value} class with an {@link java.lang.Integer} type.
@@ -16740,7 +16740,7 @@
<jk>public void</jk> login(
<ja>@FormData</ja>(<js>"username"</js>) String
<jv>username</jv>,
<ja>@FormData</ja>(<js>"password"</js>) String
<jv>password</jv>,
- <ja>@ResponseStatus</ja> Value<Integer> <jv>status</jv>
+ <ja>@ResponseCode</ja> Value<Integer> <jv>status</jv>
)
{
<jk>if</jk> (! <jsm>isValid</jsm>(<jv>username</jv>,
<jv>password</jv>))
@@ -19120,7 +19120,7 @@ Resource bundles are searched using the following base
name patterns:
<ul class='seealso'>
<li class='link'>{@doc RestResponseAnnotation}
<li class='link'>{@doc RestResponseHeaderAnnotation}
- <li class='link'>{@doc RestResponseStatusAnnotation}
+ <li class='link'>{@doc RestResponseCodeAnnotation}
</ul>
</div><!-- END: 6.23.7 - juneau-rest-server.RestSwagger.RestSwaggerResponses
-->
@@ -21837,7 +21837,7 @@ Resource bundles are searched using the following base
name patterns:
RestClient <jv>client</jv> = <jv>builder</jv>.build();
RestRequest <jv>req</jv> = <jv>client</jv>.get(<jsf>URI</jsf>);
RestResponse <jv>res</jv> = <jv>req</jv>.run();
- RestResponseStatusLineAssertion <jv>statusLineAssertion</jv> =
<jv>res</jv>.assertStatus();
+ RestResponseCodeLineAssertion <jv>statusLineAssertion</jv> =
<jv>res</jv>.assertStatus();
FluentIntegerAssertion<RestResponse> <jv>codeAssertion</jv> =
<jv>statusLineAssertion</jv>.code();
<jv>res</jv> = <jv>codeAssertion</jv>.is(200);
FluentStringAssertion<RestResponse> <jv>headerAssertion</jv> =
<jv>res</jv>.assertHeader(<js>"Content-Type"</js>);
@@ -22422,8 +22422,8 @@ Resource bundles are searched using the following base
name patterns:
<!--
====================================================================================================
-->
-<h3 class='topic' onclick='toggle(this)'><a
href='#juneau-rest-client.RestcResponseStatus'
id='juneau-rest-client.RestcResponseStatus'>9.6 - Response Status</a><span
class='update'>created: 8.1.0, <b><red>todo</red></b></span></h3>
-<div class='topic'><!-- START: 9.6 - juneau-rest-client.RestcResponseStatus -->
+<h3 class='topic' onclick='toggle(this)'><a
href='#juneau-rest-client.RestcResponseCode'
id='juneau-rest-client.RestcResponseCode'>9.6 - Response Status</a><span
class='update'>created: 8.1.0, <b><red>todo</red></b></span></h3>
+<div class='topic'><!-- START: 9.6 - juneau-rest-client.RestcResponseCode -->
<p>
After execution using {@del
org.apache.juneau.rest.client2.RestRequest#run()} or {@del
org.apache.juneau.rest.client2.RestRequest#complete()}, the following methods
can be used
to get the response status:
@@ -22434,7 +22434,7 @@ Resource bundles are searched using the following base
name patterns:
<li class='jm'><c>{@del
org.apache.juneau.rest.client2.RestResponse#getStatusLine() getStatusLine()}
<jk>returns</jk> {@link org.apache.http.StatusLine}</c>
<li class='jm'><c>{@del
org.apache.juneau.rest.client2.RestResponse#getStatusCode() getStatusCode()}
<jk>returns</jk> <jk>int</jk></c>
<li class='jm'><c>{@del
org.apache.juneau.rest.client2.RestResponse#getReasonPhrase()
getReasonPhrase()} <jk>returns</jk> String</c>
- <li class='jm'><c>{@del
org.apache.juneau.rest.client2.RestResponse#assertStatus() assertStatus()}
<jk>returns</jk> {@del
org.apache.juneau.rest.client2.RestResponseStatusLineAssertion}</c>
+ <li class='jm'><c>{@del
org.apache.juneau.rest.client2.RestResponse#assertStatus() assertStatus()}
<jk>returns</jk> {@del
org.apache.juneau.rest.client2.RestResponseCodeLineAssertion}</c>
</ul>
</ul>
@@ -22482,7 +22482,7 @@ Resource bundles are searched using the following base
name patterns:
.assertStatus().code().passes(<jv>x</jv> ->
<jv>x</jv><400)
.getBody().asString();
</p>
-</div><!-- END: 9.6 - juneau-rest-client.RestcResponseStatus -->
+</div><!-- END: 9.6 - juneau-rest-client.RestcResponseCode -->
<!--
====================================================================================================
-->
@@ -23925,7 +23925,7 @@ Resource bundles are searched using the following base
name patterns:
<ja>@ResponseHeader</ja>(<js>"E-Tag"</js>)
UUID getUUID();
- <ja>@ResponseStatus</ja>
+ <ja>@ResponseCode</ja>
<jk>int</jk> getStatus();
}
</p>
@@ -23947,7 +23947,7 @@ Resource bundles are searched using the following base
name patterns:
<ul class='javatree'>
<li class='ja'>{@link org.apache.juneau.http.annotation.ResponseBody}
<li class='ja'>{@link org.apache.juneau.http.annotation.ResponseHeader}
- <li class='ja'>{@link org.apache.juneau.http.annotation.ResponseStatus}
+ <li class='ja'>{@link org.apache.juneau.http.annotation.ResponseCode}
</ul>
<p>
The behavior and functionality of all of the annotations are the same
as if they were used on method arguments directly. This means full support for
OpenAPI serialization and validation.
@@ -28813,7 +28813,7 @@ Resource bundles are searched using the following base
name patterns:
<td>Denotes a method as an HTTP response header on a
<ja>@Response</ja>-annotated bean.</td>
</tr>
<tr>
- <td><ul style='margin-left:20px'><li class='ja'>{@link
org.apache.juneau.http.annotation.ResponseStatus}</ul></td>
+ <td><ul style='margin-left:20px'><li class='ja'>{@link
org.apache.juneau.http.annotation.ResponseCode}</ul></td>
<td><ul><li>Methods<li>Parameters</ul></td>
<td>Denotes a method as an HTTP response status code on a
<ja>@Response</ja>-annotated bean.</td>
</tr>
diff --git a/juneau-doc/src/main/javadoc/resources/docs.txt
b/juneau-doc/src/main/javadoc/resources/docs.txt
index 35e22a6..a265086 100644
--- a/juneau-doc/src/main/javadoc/resources/docs.txt
+++ b/juneau-doc/src/main/javadoc/resources/docs.txt
@@ -183,7 +183,7 @@ RdfUriProperties =
#juneau-marshall-rdf.RdfDetails.RdfUriProperties, Overview >
ReadOnlyConfigs = #juneau-config.ReadOnlyConfigs, Overview > juneau-config >
Read-only Configs
ReadingContinuousStreams = #juneau-marshall.ReadingContinuousStreams, Overview
> juneau-marshall > Reading Continuous Streams
Recursion = #juneau-marshall.Recursion, Overview > juneau-marshall > Non-Tree
Models and Recursion Detection
-ReponseHeader_ResponseStatus =
#juneau-rest-server.HttpParts.ReponseHeader_ResponseStatus, Overview >
juneau-rest-server > HTTP Parts > @Response / @ResponseHeader / @ResponseStatus
+ReponseHeader_ResponseCode =
#juneau-rest-server.HttpParts.ReponseHeader_ResponseCode, Overview >
juneau-rest-server > HTTP Parts > @Response / @ResponseHeader / @ResponseCode
RequestBeans = #juneau-rest-server.HttpParts.RequestBeans, Overview >
juneau-rest-server > HTTP Parts > @Request beans
RequestHeader_RequestQueryParams_RequestFormParams_RequestPathParams =
#juneau-rest-server.HttpParts.RequestHeader_RequestQueryParams_RequestFormParams_RequestPathParams,
Overview > juneau-rest-server > HTTP Parts > RequestHeaders /
RequestQueryParams / RequestFormParams / RequestPathParams
ResponseBeans = #juneau-rest-server.HttpParts.ResponseBeans, Overview >
juneau-rest-server > HTTP Parts > @Response beans
@@ -278,7 +278,7 @@ RestcRequestQueryParameters =
#juneau-rest-client.RestcRequestQueryParameters, O
RestcResponse = #juneau-rest-client.RestcProxies.RestcResponse, Overview >
juneau-rest-client > REST Proxies > @Response
RestcResponseBody = #juneau-rest-client.RestcResponseBody, Overview >
juneau-rest-client > Response Body
RestcResponseHeaders = #juneau-rest-client.RestcResponseHeaders, Overview >
juneau-rest-client > Response Headers
-RestcResponseStatus = #juneau-rest-client.RestcResponseStatus, Overview >
juneau-rest-client > Response Status
+RestcResponseCode = #juneau-rest-client.RestcResponseCode, Overview >
juneau-rest-client > Response Status
Security = #Security, Overview > Security Best-Practices
SecurityMarshall = #Security.SecurityMarshall, Overview > Security
Best-Practices > juneau-marshall
SecurityRest = #Security.SecurityRest, Overview > Security Best-Practices >
juneau-rest-server
diff --git a/juneau-doc/src/main/javadoc/resources/fragments/toc.html
b/juneau-doc/src/main/javadoc/resources/fragments/toc.html
index 2ff111a..e0abcf5 100644
--- a/juneau-doc/src/main/javadoc/resources/fragments/toc.html
+++ b/juneau-doc/src/main/javadoc/resources/fragments/toc.html
@@ -208,7 +208,7 @@
<li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-server.HttpParts.Header_Path_Query_FormData'>@Header
/ @Path / @Query / @FormData</a><span class='update'>updated:
8.1.0,<b>9.0.0</b></span></p>
<li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-server.HttpParts.Body'>@Body and Request
Bodies</a><span class='update'>updated: 8.1.0,<b>9.0.0</b></span></p>
<li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-server.HttpParts.RequestBeans'>@Request
beans</a><span class='update'>updated: 8.1.0,<b>9.0.0</b></span></p>
- <li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-server.HttpParts.ReponseHeader_ResponseStatus'>@Response
/ @ResponseHeader / @ResponseStatus</a><span class='update'>updated:
8.1.0,<b>9.0.0</b></span></p>
+ <li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-server.HttpParts.ReponseHeader_ResponseCode'>@Response
/ @ResponseHeader / @ResponseCode</a><span class='update'>updated:
8.1.0,<b>9.0.0</b></span></p>
<li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-server.HttpParts.ResponseBeans'>@Response
beans</a><span class='update'>updated: 8.1.0,<b>9.0.0</b></span></p>
<li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-server.HttpParts.RequestHeader_RequestQueryParams_RequestFormParams_RequestPathParams'>RequestHeaders
/ RequestQueryParams / RequestFormParams / RequestPathParams</a><span
class='update'>created: <b>9.0.0</b></span></p>
</ol>
@@ -284,7 +284,7 @@
<li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-client.RestcRequestQueryParameters'>Request
Query Parameters</a><span class='update'>created: 8.2.0,
<b><red>todo</red></b></span></p>
<li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-client.RestcRequestFormData'>Request Form
Data</a><span class='update'>created: 8.2.0, <b><red>todo</red></b></span></p>
<li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-client.RestcRequestBody'>Request Body</a><span
class='update'>created: 8.2.0, <b><red>todo</red></b></span></p>
- <li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-client.RestcResponseStatus'>Response
Status</a><span class='update'>created: 8.1.0, <b><red>todo</red></b></span></p>
+ <li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-client.RestcResponseCode'>Response
Status</a><span class='update'>created: 8.1.0, <b><red>todo</red></b></span></p>
<li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-client.RestcResponseHeaders'>Response
Headers</a><span class='update'>created: 8.2.0,
<b><red>todo</red></b></span></p>
<li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-client.RestcResponseBody'>Response
Body</a><span class='update'>created: 8.2.0, <b><red>todo</red></b></span></p>
<li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-client.RestcCustomCallHandlers'>Custom Call
Handlers</a><span class='update'>created: 8.2.0,
<b><red>todo</red></b></span></p>
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 bf4fc18..d101697 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
@@ -3483,7 +3483,7 @@ public class RestContext extends Context {
RequestBeanArg.class,
ResponseBeanArg.class,
ResponseHeaderArg.class,
- ResponseStatusArg.class,
+ ResponseCodeArg.class,
RestContextArgs.class,
RestSessionArgs.class,
RestOpContextArgs.class,
diff --git
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestParamType.java
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestParamType.java
index d684e29..5b24b6a 100644
---
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestParamType.java
+++
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestParamType.java
@@ -50,7 +50,7 @@ public enum RestParamType {
RESPONSE_HEADER("responseHeader"),
/** Response status value */
- RESPONSE_STATUS("responseStatus"),
+ RESPONSE_CODE("responseCode"),
/** Not a standard Swagger-defined field */
OTHER("other");
diff --git
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/args/ResponseStatusArg.java
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/args/ResponseCodeArg.java
similarity index 81%
rename from
juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/args/ResponseStatusArg.java
rename to
juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/args/ResponseCodeArg.java
index df9efed..7423ea6 100644
---
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/args/ResponseStatusArg.java
+++
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/args/ResponseCodeArg.java
@@ -21,9 +21,9 @@ import org.apache.juneau.rest.*;
import org.apache.juneau.rest.annotation.*;
/**
- * Resolves method parameters annotated with {@link ResponseStatus} on {@link
RestOp}-annotated Java methods.
+ * Resolves method parameters annotated with {@link ResponseCode} on {@link
RestOp}-annotated Java methods.
*/
-public class ResponseStatusArg implements RestOpArg {
+public class ResponseCodeArg implements RestOpArg {
private final Type type;
@@ -31,11 +31,11 @@ public class ResponseStatusArg implements RestOpArg {
* Static creator.
*
* @param paramInfo The Java method parameter being resolved.
- * @return A new {@link ResponseStatusArg}, or <jk>null</jk> if the
parameter is not annotated with {@link ResponseStatus}.
+ * @return A new {@link ResponseCodeArg}, or <jk>null</jk> if the
parameter is not annotated with {@link ResponseCode}.
*/
- public static ResponseStatusArg create(ParamInfo paramInfo) {
- if (paramInfo.hasAnnotation(ResponseStatus.class) ||
paramInfo.getParameterType().hasAnnotation(ResponseStatus.class))
- return new ResponseStatusArg(paramInfo);
+ public static ResponseCodeArg create(ParamInfo paramInfo) {
+ if (paramInfo.hasAnnotation(ResponseCode.class) ||
paramInfo.getParameterType().hasAnnotation(ResponseCode.class))
+ return new ResponseCodeArg(paramInfo);
return null;
}
@@ -44,11 +44,11 @@ public class ResponseStatusArg implements RestOpArg {
*
* @param paramInfo The Java method parameter being resolved.
*/
- protected ResponseStatusArg(ParamInfo paramInfo) {
+ protected ResponseCodeArg(ParamInfo paramInfo) {
this.type = paramInfo.getParameterType().innerType();
Class<?> c = type instanceof Class ? (Class<?>)type : type
instanceof ParameterizedType ? (Class<?>)((ParameterizedType)type).getRawType()
: null;
if (c != Value.class || Value.getParameterType(type) !=
Integer.class)
- throw new ArgException(paramInfo, "Type must be
Value<Integer> on parameter annotated with @ResponseStatus annotation");
+ throw new ArgException(paramInfo, "Type must be
Value<Integer> on parameter annotated with @ResponseCode annotation");
}
@SuppressWarnings({ "unchecked", "rawtypes" })
diff --git
a/juneau-utest/src/test/java/org/apache/juneau/http/annotation/AnnotationUtils_Test.java
b/juneau-utest/src/test/java/org/apache/juneau/http/annotation/AnnotationUtils_Test.java
index 0c602d8..8252335 100644
---
a/juneau-utest/src/test/java/org/apache/juneau/http/annotation/AnnotationUtils_Test.java
+++
b/juneau-utest/src/test/java/org/apache/juneau/http/annotation/AnnotationUtils_Test.java
@@ -228,7 +228,7 @@ public class AnnotationUtils_Test {
@Test
public void a14_ResponseStatus() throws Exception {
-
assertObject(responseStatus().build().annotationType()).asJson().contains("ResponseStatus");
+
assertObject(responseCode().build().annotationType()).asJson().contains("ResponseCode");
}
@Test
@@ -461,8 +461,8 @@ public class AnnotationUtils_Test {
return ResponseHeaderAnnotation.create();
}
- private static ResponseStatusAnnotation.Builder responseStatus() {
- return ResponseStatusAnnotation.create();
+ private static ResponseCodeAnnotation.Builder responseCode() {
+ return ResponseCodeAnnotation.create();
}
private static TagAnnotation.Builder tag() {
diff --git
a/juneau-utest/src/test/java/org/apache/juneau/http/annotation/ResponseStatusAnnotation_Test.java
b/juneau-utest/src/test/java/org/apache/juneau/http/annotation/ResponseStatusAnnotation_Test.java
index d1abe84..43a8f58 100644
---
a/juneau-utest/src/test/java/org/apache/juneau/http/annotation/ResponseStatusAnnotation_Test.java
+++
b/juneau-utest/src/test/java/org/apache/juneau/http/annotation/ResponseStatusAnnotation_Test.java
@@ -30,12 +30,12 @@ public class ResponseStatusAnnotation_Test {
// Basic tests
//------------------------------------------------------------------------------------------------------------------
- ResponseStatus a1 = ResponseStatusAnnotation.create()
+ ResponseCode a1 = ResponseCodeAnnotation.create()
.on("on")
.onClass(X1.class)
.build();
- ResponseStatus a2 = ResponseStatusAnnotation.create()
+ ResponseCode a2 = ResponseCodeAnnotation.create()
.on("on")
.onClass(X1.class)
.build();
@@ -82,9 +82,9 @@ public class ResponseStatusAnnotation_Test {
@Test
public void c01_otherMethods() throws Exception {
- ResponseStatus c1 =
ResponseStatusAnnotation.create(C1.class).on(C2.class).build();
- ResponseStatus c2 =
ResponseStatusAnnotation.create("a").on("b").build();
- ResponseStatus c4 =
ResponseStatusAnnotation.create().on(C1.class.getMethod("m1")).on(C2.class.getMethod("m2")).build();
+ ResponseCode c1 =
ResponseCodeAnnotation.create(C1.class).on(C2.class).build();
+ ResponseCode c2 =
ResponseCodeAnnotation.create("a").on("b").build();
+ ResponseCode c4 =
ResponseCodeAnnotation.create().on(C1.class.getMethod("m1")).on(C2.class.getMethod("m2")).build();
assertObject(c1).asJson().contains("on:['"+CNAME+"$C1','"+CNAME+"$C2']");
assertObject(c2).asJson().contains("on:['a','b']");
@@ -95,19 +95,19 @@ public class ResponseStatusAnnotation_Test {
// Comparison with declared annotations.
//------------------------------------------------------------------------------------------------------------------
- @ResponseStatus(
+ @ResponseCode(
on="on",
onClass=X1.class
)
public static class D1 {}
- ResponseStatus d1 =
D1.class.getAnnotationsByType(ResponseStatus.class)[0];
+ ResponseCode d1 = D1.class.getAnnotationsByType(ResponseCode.class)[0];
- @ResponseStatus(
+ @ResponseCode(
on="on",
onClass=X1.class
)
public static class D2 {}
- ResponseStatus d2 =
D2.class.getAnnotationsByType(ResponseStatus.class)[0];
+ ResponseCode d2 = D2.class.getAnnotationsByType(ResponseCode.class)[0];
@Test
public void d01_comparisonWithDeclarativeAnnotations() {
diff --git
a/juneau-utest/src/test/java/org/apache/juneau/http/remote/Remote_ResponseAnnotation_Test.java
b/juneau-utest/src/test/java/org/apache/juneau/http/remote/Remote_ResponseAnnotation_Test.java
index a93ecdd..1ec2cc5 100644
---
a/juneau-utest/src/test/java/org/apache/juneau/http/remote/Remote_ResponseAnnotation_Test.java
+++
b/juneau-utest/src/test/java/org/apache/juneau/http/remote/Remote_ResponseAnnotation_Test.java
@@ -64,7 +64,7 @@ public class Remote_ResponseAnnotation_Test {
public interface A1a {
@ResponseBody Reader getBody();
@ResponseHeader("X") String getHeader();
- @ResponseStatus int getStatus();
+ @ResponseCode int getStatus();
}
@Remote
diff --git
a/juneau-utest/src/test/java/org/apache/juneau/rest/Swagger_Test.java
b/juneau-utest/src/test/java/org/apache/juneau/rest/Swagger_Test.java
index 608990b..40b20f7 100644
--- a/juneau-utest/src/test/java/org/apache/juneau/rest/Swagger_Test.java
+++ b/juneau-utest/src/test/java/org/apache/juneau/rest/Swagger_Test.java
@@ -1689,7 +1689,7 @@ public class Swagger_Test {
@Rest(swagger=@Swagger("paths:{'/path/{foo}/responses/100':{get:{responses:{100:{description:'a-100-description'}}}}}"))
public static class O2 {
@RestGet(path="/path/{foo}/responses/100")
- public void a(@ResponseStatus Value<Integer> foo) {}
+ public void a(@ResponseCode Value<Integer> foo) {}
}
@Test
@@ -1701,7 +1701,7 @@ public class Swagger_Test {
@Rest(swagger=@Swagger("paths:{'/path/{foo}/responses/100':{get:{responses:{100:{description:'a-100-description'}}}}}"))
public static class O3 {
@RestGet(path="/path/{foo}/responses/100",swagger=@OpSwagger("responses:{100:{description:'b-100-description'}}"))
- public void a(@ResponseStatus Value<Integer> foo) {}
+ public void a(@ResponseCode Value<Integer> foo) {}
}
@Test
@@ -1791,7 +1791,7 @@ public class Swagger_Test {
@Rest(swagger=@Swagger("paths:{'/path/{foo}/responses/100':{get:{responses:{100:{headers:{'X-Foo':{description:'b-description',type:'integer',format:'int32'}}}}}}}"))
public static class P2 {
@RestGet(path="/path/{foo}/responses/100")
- public X a(@ResponseStatus Value<Integer> foo) {
+ public X a(@ResponseCode Value<Integer> foo) {
return null;
}
}
@@ -1805,7 +1805,7 @@ public class Swagger_Test {
@Rest(swagger=@Swagger("paths:{'/path/{foo}/responses/100':{get:{responses:{100:{headers:{'X-Foo':{description:'b-description',type:'integer',format:'int32'}}}}}}}"))
public static class P3 {
@RestGet(path="/path/{foo}/responses/100",swagger=@OpSwagger("responses:{100:{headers:{'X-Foo':{description:'c-description',type:'integer',format:'int32'}}}}"))
- public X a(@ResponseStatus Value<Integer> foo) {
+ public X a(@ResponseCode Value<Integer> foo) {
return null;
}
}
@@ -1897,7 +1897,7 @@ public class Swagger_Test {
@Rest(swagger=@Swagger("paths:{'/path/{foo}/responses/100':{get:{responses:{100:{examples:{foo:{bar:'b'}}}}}}}"))
public static class R2 {
@RestGet(path="/path/{foo}/responses/100")
- public void a(@ResponseStatus Value<Integer> foo) {}
+ public void a(@ResponseCode Value<Integer> foo) {}
}
@Test
@@ -1909,7 +1909,7 @@ public class Swagger_Test {
@Rest(swagger=@Swagger("paths:{'/path/{foo}/responses/100':{get:{responses:{100:{examples:{foo:{bar:'b'}}}}}}}"))
public static class R3 {
@RestGet(path="/path/{foo}/responses/100",swagger=@OpSwagger("responses:{100:{examples:{foo:{bar:'c'}}}}"))
- public void a(@ResponseStatus Value<Integer> foo) {}
+ public void a(@ResponseCode Value<Integer> foo) {}
}
@Test
@@ -1997,7 +1997,7 @@ public class Swagger_Test {
@Rest(swagger=@Swagger("paths:{'/path/{foo}/responses/100':{get:{responses:{100:{schema:{$ref:'b'}}}}}}"))
public static class S2 {
@RestGet(path="/path/{foo}/responses/100")
- public void a(@ResponseStatus Value<Integer> foo) {}
+ public void a(@ResponseCode Value<Integer> foo) {}
}
@Test
@@ -2009,7 +2009,7 @@ public class Swagger_Test {
@Rest(swagger=@Swagger("paths:{'/path/{foo}/responses/100':{get:{responses:{100:{schema:{$ref:'b'}}}}}}"))
public static class S3 {
@RestGet(path="/path/{foo}/responses/100",swagger=@OpSwagger("responses:{100:{schema:{$ref:'c'}}}}"))
- public void a(@ResponseStatus Value<Integer> foo) {}
+ public void a(@ResponseCode Value<Integer> foo) {}
}
@Test
diff --git
a/juneau-utest/src/test/java/org/apache/juneau/rest/annotation/ResponseStatus_Test.java
b/juneau-utest/src/test/java/org/apache/juneau/rest/annotation/ResponseStatus_Test.java
index 44ed6ed..0c415dc 100644
---
a/juneau-utest/src/test/java/org/apache/juneau/rest/annotation/ResponseStatus_Test.java
+++
b/juneau-utest/src/test/java/org/apache/juneau/rest/annotation/ResponseStatus_Test.java
@@ -26,7 +26,7 @@ public class ResponseStatus_Test {
@Rest
public static class A {
@RestGet
- public void a(@ResponseStatus Value<Integer> status) {
+ public void a(@ResponseCode Value<Integer> status) {
status.set(202);
}
}