You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cxf.apache.org by se...@apache.org on 2009/11/12 23:50:33 UTC
svn commit: r835621 - in /cxf/trunk/rt/frontend/jaxrs/src:
main/java/org/apache/cxf/jaxrs/ext/
main/java/org/apache/cxf/jaxrs/model/wadl/
test/java/org/apache/cxf/jaxrs/model/wadl/
Author: sergeyb
Date: Thu Nov 12 22:50:32 2009
New Revision: 835621
URL: http://svn.apache.org/viewvc?rev=835621&view=rev
Log:
JAXRS : adding Description annotation for better WADLs
Added:
cxf/trunk/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/ext/Description.java (with props)
Modified:
cxf/trunk/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/model/wadl/WadlGenerator.java
cxf/trunk/rt/frontend/jaxrs/src/test/java/org/apache/cxf/jaxrs/model/wadl/BookStore.java
cxf/trunk/rt/frontend/jaxrs/src/test/java/org/apache/cxf/jaxrs/model/wadl/WadlGeneratorTest.java
Added: cxf/trunk/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/ext/Description.java
URL: http://svn.apache.org/viewvc/cxf/trunk/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/ext/Description.java?rev=835621&view=auto
==============================================================================
--- cxf/trunk/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/ext/Description.java (added)
+++ cxf/trunk/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/ext/Description.java Thu Nov 12 22:50:32 2009
@@ -0,0 +1,34 @@
+/**
+ * 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;
+
+@Target({ElementType.TYPE, ElementType.METHOD })
+@Retention(RetentionPolicy.RUNTIME)
+public @interface Description {
+ String value() default "";
+ String lang() default "";
+ String title() default "";
+ String docuri() default "";
+}
Propchange: cxf/trunk/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/ext/Description.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: cxf/trunk/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/ext/Description.java
------------------------------------------------------------------------------
svn:keywords = Rev Date
Modified: cxf/trunk/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/model/wadl/WadlGenerator.java
URL: http://svn.apache.org/viewvc/cxf/trunk/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/model/wadl/WadlGenerator.java?rev=835621&r1=835620&r2=835621&view=diff
==============================================================================
--- cxf/trunk/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/model/wadl/WadlGenerator.java (original)
+++ cxf/trunk/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/model/wadl/WadlGenerator.java Thu Nov 12 22:50:32 2009
@@ -19,7 +19,9 @@
package org.apache.cxf.jaxrs.model.wadl;
import java.io.IOException;
+import java.io.InputStream;
import java.io.StringWriter;
+import java.lang.annotation.Annotation;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
@@ -50,6 +52,7 @@
import org.w3c.dom.Element;
import org.w3c.dom.Node;
+import org.apache.cxf.BusFactory;
import org.apache.cxf.common.logging.LogUtils;
import org.apache.cxf.common.util.ReflectionInvokationHandler;
import org.apache.cxf.common.util.StringUtils;
@@ -58,10 +61,12 @@
import org.apache.cxf.common.xmlschema.XmlSchemaConstants;
import org.apache.cxf.helpers.CastUtils;
import org.apache.cxf.helpers.DOMUtils;
+import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.jaxb.JAXBBeanInfo;
import org.apache.cxf.jaxb.JAXBContextProxy;
import org.apache.cxf.jaxb.JAXBUtils;
import org.apache.cxf.jaxrs.JAXRSServiceImpl;
+import org.apache.cxf.jaxrs.ext.Description;
import org.apache.cxf.jaxrs.ext.RequestHandler;
import org.apache.cxf.jaxrs.impl.HttpHeadersImpl;
import org.apache.cxf.jaxrs.impl.UriInfoImpl;
@@ -73,6 +78,7 @@
import org.apache.cxf.jaxrs.utils.InjectionUtils;
import org.apache.cxf.jaxrs.utils.JAXRSUtils;
import org.apache.cxf.jaxrs.utils.ResourceUtils;
+import org.apache.cxf.jaxrs.utils.schemas.SchemaHandler;
import org.apache.cxf.message.Message;
import org.apache.cxf.service.Service;
import org.apache.cxf.staxutils.StaxUtils;
@@ -87,6 +93,7 @@
private static final Logger LOG = LogUtils.getL7dLogger(WadlGenerator.class);
private static final String JAXB_DEFAULT_NAMESPACE = "##default";
private static final String JAXB_DEFAULT_NAME = "##default";
+ private static final String CLASSPATH_PREFIX = "classpath:";
private boolean ignoreMessageWriters = true;
@@ -177,7 +184,7 @@
Set<ClassResourceInfo> visitedResources) {
visitedResources.add(cri);
sb.append("<resource path=\"").append(path).append("\">");
-
+ handleDocs(cri.getServiceClass().getAnnotations(), sb);
List<OperationResourceInfo> sortedOps = sortOperationsByPath(
cri.getMethodDispatcher().getOperationResourceInfos());
@@ -206,6 +213,7 @@
boolean useResource = useResource(ori);
if (useResource) {
sb.append("<resource path=\"").append(path).append("\">");
+ handleDocs(ori.getAnnotatedMethod().getAnnotations(), sb);
}
handleParams(sb, ori, ParameterType.PATH);
handleParams(sb, ori, ParameterType.MATRIX);
@@ -605,5 +613,39 @@
this.ignoreMessageWriters = ignoreMessageWriters;
}
-
+ private void handleDocs(Annotation[] anns, StringBuilder sb) {
+ for (Annotation a : anns) {
+ if (a.annotationType() == Description.class) {
+ Description d = (Description)a;
+
+ sb.append("<doc");
+ if (d.lang().length() > 0) {
+ sb.append(" xml:lang=\"" + d.lang() + "\"");
+ }
+ if (d.title().length() > 0) {
+ sb.append(" title=\"" + d.title() + "\"");
+ }
+ sb.append(">");
+ if (d.value().length() > 0) {
+ sb.append(d.value());
+ } else if (d.docuri().length() > 0) {
+ InputStream is = null;
+ if (d.docuri().startsWith(CLASSPATH_PREFIX)) {
+ String path = d.docuri().substring(CLASSPATH_PREFIX.length());
+ is = ResourceUtils.getClasspathResourceStream(path, SchemaHandler.class,
+ BusFactory.getDefaultBus());
+ if (is != null) {
+ try {
+ sb.append(IOUtils.toString(is));
+ } catch (IOException ex) {
+ // ignore
+ }
+ }
+ }
+ }
+ sb.append("</doc>");
+ }
+ }
+ }
+
}
Modified: cxf/trunk/rt/frontend/jaxrs/src/test/java/org/apache/cxf/jaxrs/model/wadl/BookStore.java
URL: http://svn.apache.org/viewvc/cxf/trunk/rt/frontend/jaxrs/src/test/java/org/apache/cxf/jaxrs/model/wadl/BookStore.java?rev=835621&r1=835620&r2=835621&view=diff
==============================================================================
--- cxf/trunk/rt/frontend/jaxrs/src/test/java/org/apache/cxf/jaxrs/model/wadl/BookStore.java (original)
+++ cxf/trunk/rt/frontend/jaxrs/src/test/java/org/apache/cxf/jaxrs/model/wadl/BookStore.java Thu Nov 12 22:50:32 2009
@@ -31,11 +31,13 @@
import javax.ws.rs.core.Context;
import javax.ws.rs.core.HttpHeaders;
+import org.apache.cxf.jaxrs.ext.Description;
import org.apache.cxf.jaxrs.fortest.jaxb.packageinfo.Book2;
@Path("/bookstore/{id}")
@Consumes({"application/xml", "application/json" })
@Produces({"application/xml", "application/json" })
+@Description(lang = "en-us", title = "book store resource", value = "super resource")
public class BookStore {
@GET
Modified: cxf/trunk/rt/frontend/jaxrs/src/test/java/org/apache/cxf/jaxrs/model/wadl/WadlGeneratorTest.java
URL: http://svn.apache.org/viewvc/cxf/trunk/rt/frontend/jaxrs/src/test/java/org/apache/cxf/jaxrs/model/wadl/WadlGeneratorTest.java?rev=835621&r1=835620&r2=835621&view=diff
==============================================================================
--- cxf/trunk/rt/frontend/jaxrs/src/test/java/org/apache/cxf/jaxrs/model/wadl/WadlGeneratorTest.java (original)
+++ cxf/trunk/rt/frontend/jaxrs/src/test/java/org/apache/cxf/jaxrs/model/wadl/WadlGeneratorTest.java Thu Nov 12 22:50:32 2009
@@ -130,6 +130,13 @@
private void checkBookStoreInfo(Element resource) {
assertEquals("/bookstore/{id}", resource.getAttribute("path"));
+ List<Element> docsEls = DOMUtils.getChildrenWithName(resource,
+ WadlGenerator.WADL_NS, "doc");
+ assertEquals(1, docsEls.size());
+ assertEquals("book store resource", docsEls.get(0).getAttribute("title"));
+ assertEquals("en-us",
+ docsEls.get(0).getAttributeNS("http://www.w3.org/XML/1998/namespace", "lang"));
+
List<Element> resourceEls = DOMUtils.getChildrenWithName(resource,
WadlGenerator.WADL_NS, "resource");
assertEquals(6, resourceEls.size());