Return-Path: X-Original-To: apmail-cxf-commits-archive@www.apache.org Delivered-To: apmail-cxf-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id A9B4317F03 for ; Wed, 4 Feb 2015 17:34:34 +0000 (UTC) Received: (qmail 10576 invoked by uid 500); 4 Feb 2015 17:34:35 -0000 Delivered-To: apmail-cxf-commits-archive@cxf.apache.org Received: (qmail 10510 invoked by uid 500); 4 Feb 2015 17:34:35 -0000 Mailing-List: contact commits-help@cxf.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@cxf.apache.org Delivered-To: mailing list commits@cxf.apache.org Received: (qmail 10501 invoked by uid 99); 4 Feb 2015 17:34:35 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 04 Feb 2015 17:34:35 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 7EF14E01D9; Wed, 4 Feb 2015 17:34:35 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: sergeyb@apache.org To: commits@cxf.apache.org Message-Id: <8395789956cf48e29e41167070c03330@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: cxf git commit: [CXF-6238] Adding a new ResponseStatus annotation Date: Wed, 4 Feb 2015 17:34:35 +0000 (UTC) Repository: cxf Updated Branches: refs/heads/3.0.x-fixes 6e541124a -> fdad7134e [CXF-6238] Adding a new ResponseStatus annotation Project: http://git-wip-us.apache.org/repos/asf/cxf/repo Commit: http://git-wip-us.apache.org/repos/asf/cxf/commit/fdad7134 Tree: http://git-wip-us.apache.org/repos/asf/cxf/tree/fdad7134 Diff: http://git-wip-us.apache.org/repos/asf/cxf/diff/fdad7134 Branch: refs/heads/3.0.x-fixes Commit: fdad7134ede1a19019d11bd4d34dd690c35cb38c Parents: 6e54112 Author: Sergey Beryozkin Authored: Wed Feb 4 17:28:37 2015 +0000 Committer: Sergey Beryozkin Committed: Wed Feb 4 17:34:03 2015 +0000 ---------------------------------------------------------------------- .../apache/cxf/jaxrs/ext/ResponseStatus.java | 31 ++++++++++++++++++++ .../cxf/jaxrs/model/wadl/WadlGenerator.java | 20 +++++++++++-- .../apache/cxf/jaxrs/model/wadl/BookStore.java | 3 +- .../cxf/jaxrs/model/wadl/WadlGeneratorTest.java | 2 ++ 4 files changed, 53 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cxf/blob/fdad7134/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/ext/ResponseStatus.java ---------------------------------------------------------------------- diff --git a/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/ext/ResponseStatus.java b/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/ext/ResponseStatus.java new file mode 100644 index 0000000..19dd4cc --- /dev/null +++ b/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/ext/ResponseStatus.java @@ -0,0 +1,31 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "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.cxf.jaxrs.ext; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +@Retention(RetentionPolicy.RUNTIME) +@Target({ElementType.METHOD }) +public @interface ResponseStatus { + int[] value(); +} + http://git-wip-us.apache.org/repos/asf/cxf/blob/fdad7134/rt/rs/description/src/main/java/org/apache/cxf/jaxrs/model/wadl/WadlGenerator.java ---------------------------------------------------------------------- diff --git a/rt/rs/description/src/main/java/org/apache/cxf/jaxrs/model/wadl/WadlGenerator.java b/rt/rs/description/src/main/java/org/apache/cxf/jaxrs/model/wadl/WadlGenerator.java index dd86d37..fd0946d 100644 --- a/rt/rs/description/src/main/java/org/apache/cxf/jaxrs/model/wadl/WadlGenerator.java +++ b/rt/rs/description/src/main/java/org/apache/cxf/jaxrs/model/wadl/WadlGenerator.java @@ -101,6 +101,7 @@ import org.apache.cxf.helpers.DOMUtils; import org.apache.cxf.helpers.IOUtils; import org.apache.cxf.jaxrs.JAXRSServiceImpl; import org.apache.cxf.jaxrs.ext.Oneway; +import org.apache.cxf.jaxrs.ext.ResponseStatus; import org.apache.cxf.jaxrs.ext.multipart.Multipart; import org.apache.cxf.jaxrs.ext.xml.XMLName; import org.apache.cxf.jaxrs.ext.xml.XMLSource; @@ -578,9 +579,12 @@ public class WadlGenerator implements ContainerRequestFilter { startMethodResponseTag(sb, ori); Class returnType = getMethod(ori).getReturnType(); boolean isVoid = void.class == returnType; - if (isVoid) { + ResponseStatus responseStatus = getMethod(ori).getAnnotation(ResponseStatus.class); + if (responseStatus != null) { + setResponseStatus(sb, responseStatus.value()); + } else if (isVoid) { boolean oneway = getMethod(ori).getAnnotation(Oneway.class) != null; - sb.append(" status=\"" + (oneway ? 202 : 204) + "\""); + setResponseStatus(sb, oneway ? 202 : 204); } sb.append(">"); handleDocs(anns, sb, DocTarget.RESPONSE, false, isJson); @@ -598,6 +602,18 @@ public class WadlGenerator implements ContainerRequestFilter { return resourceTagOpened; } + private void setResponseStatus(StringBuilder sb, int... statuses) { + sb.append(" status=\""); + for (int i = 0; i < statuses.length; i++) { + if (i > 0) { + sb.append(" "); + } + sb.append(statuses[i]); + } + sb.append("\""); + + } + protected boolean compareOperations(OperationResourceInfo ori1, OperationResourceInfo ori2) { if (ori1 == null || ori2 == null || !ori1.getURITemplate().getValue().equals(ori2.getURITemplate().getValue()) http://git-wip-us.apache.org/repos/asf/cxf/blob/fdad7134/rt/rs/description/src/test/java/org/apache/cxf/jaxrs/model/wadl/BookStore.java ---------------------------------------------------------------------- diff --git a/rt/rs/description/src/test/java/org/apache/cxf/jaxrs/model/wadl/BookStore.java b/rt/rs/description/src/test/java/org/apache/cxf/jaxrs/model/wadl/BookStore.java index 23304b3..ceb5969 100644 --- a/rt/rs/description/src/test/java/org/apache/cxf/jaxrs/model/wadl/BookStore.java +++ b/rt/rs/description/src/test/java/org/apache/cxf/jaxrs/model/wadl/BookStore.java @@ -40,6 +40,7 @@ import javax.ws.rs.core.Response; import javax.xml.bind.annotation.XmlTransient; import org.apache.cxf.aegis.type.java5.IgnoreProperty; +import org.apache.cxf.jaxrs.ext.ResponseStatus; import org.apache.cxf.jaxrs.ext.multipart.MultipartBody; import org.apache.cxf.jaxrs.ext.xml.ElementClass; import org.apache.cxf.jaxrs.ext.xml.XMLName; @@ -108,7 +109,7 @@ public class BookStore implements BookDescription { @Description(value = "Response", target = DocTarget.RESPONSE), @Description(value = "Resource books/{bookid}", target = DocTarget.RESOURCE) }) - + @ResponseStatus({201, 200 }) //CHECKSTYLE:OFF @POST @Path("books/{bookid}") http://git-wip-us.apache.org/repos/asf/cxf/blob/fdad7134/rt/rs/description/src/test/java/org/apache/cxf/jaxrs/model/wadl/WadlGeneratorTest.java ---------------------------------------------------------------------- diff --git a/rt/rs/description/src/test/java/org/apache/cxf/jaxrs/model/wadl/WadlGeneratorTest.java b/rt/rs/description/src/test/java/org/apache/cxf/jaxrs/model/wadl/WadlGeneratorTest.java index 09dd51b..82c766f 100644 --- a/rt/rs/description/src/test/java/org/apache/cxf/jaxrs/model/wadl/WadlGeneratorTest.java +++ b/rt/rs/description/src/test/java/org/apache/cxf/jaxrs/model/wadl/WadlGeneratorTest.java @@ -534,6 +534,8 @@ public class WadlGeneratorTest extends Assert { verifyXmlJsonRepresentations(requestEls.get(0), book2El, "InputBook"); List responseEls = getElements(methodEls.get(0), "response", 1); checkDocs(responseEls.get(0), "", "Response", ""); + String status = responseEls.get(0).getAttribute("status"); + assertTrue("201 200".equals(status) || "200 201".equals(status)); verifyXmlJsonRepresentations(responseEls.get(0), bookEl, "Requested Book"); // PUT