CAMEL-8897: Polished the rest param a bit and added for the xml example

apache · Jul 1, 2015 · a80e4d1 · a80e4d1
1 parent 46d5e4d
commit a80e4d1
Show file tree

Hide file tree

Showing 15 changed files with 58 additions and 62 deletions.
diff --git a/camel-core/src/main/java/org/apache/camel/model/rest/RestOperationParamDefinition.java b/camel-core/src/main/java/org/apache/camel/model/rest/RestOperationParamDefinition.java
@@ -46,11 +46,11 @@ public class RestOperationParamDefinition {
     private VerbDefinition verb;
 
     @XmlAttribute(required = true)
-    @Metadata(defaultValue = "path")
+    private String name;
-    private RestParamType paramType;
 
     @XmlAttribute(required = true)
-    private String name;
+    @Metadata(defaultValue = "path")
+    private RestParamType type;
 
     @XmlAttribute
     @Metadata(defaultValue = "")
@@ -78,7 +78,7 @@ public class RestOperationParamDefinition {
 
     @XmlAttribute
     @Metadata(defaultValue = "")
-    private String paramAccess;
+    private String access;
 
     public RestOperationParamDefinition() {
     }
@@ -87,15 +87,15 @@ public RestOperationParamDefinition(VerbDefinition verb) {
         this.verb = verb;
     }
 
-    public RestParamType getParamType() {
+    public RestParamType getType() {
-        return paramType != null ? paramType : RestParamType.path;
+        return type != null ? type : RestParamType.path;
     }
 
     /**
      * Sets the Swagger Parameter type.
      */
-    public void setParamType(RestParamType paramType) {
+    public void setType(RestParamType type) {
-        this.paramType = paramType;
+        this.type = type;
     }
 
     public String getName() {
@@ -154,7 +154,7 @@ public void setAllowMultiple(Boolean allowMultiple) {
     }
 
     public String getDataType() {
-        return dataType != null ? dataType : "string";
+        return dataType;
     }
 
     /**
@@ -179,15 +179,15 @@ public void setAllowableValues(List<String> allowableValues) {
         this.allowableValues = allowableValues;
     }
 
-    public String getParamAccess() {
+    public String getAccess() {
-        return paramAccess != null ? paramAccess : "";
+        return access != null ? access : "";
     }
 
     /**
      * Sets the Swagger Parameter paramAccess flag.
      */
-    public void setParamAccess(String paramAccess) {
+    public void setAccess(String access) {
-        this.paramAccess = paramAccess;
+        this.access = access;
     }
 
     /**
@@ -233,7 +233,7 @@ public RestOperationParamDefinition allowMultiple(Boolean allowMultiple) {
     }
 
     /**
-     * The data type of the parameter such as string,int
+     * The data type of the parameter such as <tt>string</tt>, <tt>long</tt>, <tt>int</tt>, <tt>boolean</tt>
      */
     public RestOperationParamDefinition dataType(String type) {
         setDataType(type);
@@ -260,15 +260,16 @@ public RestOperationParamDefinition allowableValues(String... allowableValues) {
      * The parameter type such as body, form, header, path, query
      */
     public RestOperationParamDefinition type(RestParamType type) {
-        setParamType(type);
+        setType(type);
         return this;
     }
 
     /**
-     * A flag to hide the parameter if set to false
+     * Parameter access. Use <tt>false</tt> or <tt>internal</tt> to indicate the parameter
+     * should be hidden for the public.
      */
-    public RestOperationParamDefinition paramAccess(String paramAccess) {
+    public RestOperationParamDefinition access(String paramAccess) {
-        setParamAccess(paramAccess);
+        setAccess(paramAccess);
         return this;
     }
 

diff --git a/camel-core/src/test/java/org/apache/camel/component/rest/FromRestExplicitComponentTest.java b/camel-core/src/test/java/org/apache/camel/component/rest/FromRestExplicitComponentTest.java
@@ -16,8 +16,6 @@
  */
 package org.apache.camel.component.rest;
 
-import java.util.Arrays;
-
 import org.apache.camel.builder.RouteBuilder;
 import org.apache.camel.model.rest.RestParamType;
 
@@ -37,10 +35,10 @@ public void configure() throws Exception {
                 rest("dummy-rest").path("/say/bye")
                         .get().consumes("application/json")
                         .param().type(RestParamType.header).description("header param description1").dataType("integer").allowableValues("1", "2", "3", "4")
-                        .defaultValue("1").allowMultiple(false).name("header_count").required(true).paramAccess("acc1")
+                        .defaultValue("1").allowMultiple(false).name("header_count").required(true).access("acc1")
                         .endParam().
                         param().type(RestParamType.query).description("header param description2").dataType("string").allowableValues("a", "b", "c", "d")
-                        .defaultValue("b").allowMultiple(true).name("header_letter").required(false).paramAccess("acc2")
+                        .defaultValue("b").allowMultiple(true).name("header_letter").required(false).access("acc2")
                         .endParam()
                         .responseMessage().code(300).message("test msg").responseModel(Integer.class).endResponseMessage()
                         .to("direct:bye")

diff --git a/camel-core/src/test/java/org/apache/camel/component/rest/FromRestGetTest.java b/camel-core/src/test/java/org/apache/camel/component/rest/FromRestGetTest.java
@@ -56,8 +56,8 @@ public void testFromRestModel() throws Exception {
         assertEquals("application/json", rest.getVerbs().get(0).getConsumes());
 
         assertEquals(2, rest.getVerbs().get(0).getParams().size());
-        assertEquals(RestParamType.header, rest.getVerbs().get(0).getParams().get(0).getParamType());
+        assertEquals(RestParamType.header, rest.getVerbs().get(0).getParams().get(0).getType());
-        assertEquals(RestParamType.query, rest.getVerbs().get(0).getParams().get(1).getParamType());
+        assertEquals(RestParamType.query, rest.getVerbs().get(0).getParams().get(1).getType());
 
         assertEquals("header param description1", rest.getVerbs().get(0).getParams().get(0).getDescription());
         assertEquals("header param description2", rest.getVerbs().get(0).getParams().get(1).getDescription());
@@ -76,8 +76,8 @@ public void testFromRestModel() throws Exception {
         assertEquals("header_letter", rest.getVerbs().get(0).getParams().get(1).getName());
         assertEquals(Boolean.TRUE, rest.getVerbs().get(0).getParams().get(0).getRequired());
         assertEquals(Boolean.FALSE, rest.getVerbs().get(0).getParams().get(1).getRequired());
-        assertEquals("acc1", rest.getVerbs().get(0).getParams().get(0).getParamAccess());
+        assertEquals("acc1", rest.getVerbs().get(0).getParams().get(0).getAccess());
-        assertEquals("acc2", rest.getVerbs().get(0).getParams().get(1).getParamAccess());
+        assertEquals("acc2", rest.getVerbs().get(0).getParams().get(1).getAccess());
 
         assertEquals(300, rest.getVerbs().get(0).getResponseMsgs().get(0).getCode());
         assertEquals("test msg", rest.getVerbs().get(0).getResponseMsgs().get(0).getMessage());
@@ -109,10 +109,10 @@ public void configure() throws Exception {
                 rest("/say/bye")
                         .get().consumes("application/json")
                         .param().type(RestParamType.header).description("header param description1").dataType("integer").allowableValues("1", "2", "3", "4")
-                        .defaultValue("1").allowMultiple(false).name("header_count").required(true).paramAccess("acc1")
+                        .defaultValue("1").allowMultiple(false).name("header_count").required(true).access("acc1")
                         .endParam().
                         param().type(RestParamType.query).description("header param description2").dataType("string").allowableValues("a", "b", "c", "d")
-                        .defaultValue("b").allowMultiple(true).name("header_letter").required(false).paramAccess("acc2")
+                        .defaultValue("b").allowMultiple(true).name("header_letter").required(false).access("acc2")
                         .endParam()
                         .responseMessage().code(300).message("test msg").responseModel(Integer.class).endResponseMessage()
                         .to("direct:bye")

diff --git a/camel-core/src/test/java/org/apache/camel/component/rest/FromRestIdAndDescriptionTest.java b/camel-core/src/test/java/org/apache/camel/component/rest/FromRestIdAndDescriptionTest.java
@@ -16,8 +16,6 @@
  */
 package org.apache.camel.component.rest;
 
-import java.util.Arrays;
-
 import org.apache.camel.builder.RouteBuilder;
 import org.apache.camel.model.rest.RestDefinition;
 import org.apache.camel.model.rest.RestParamType;
@@ -55,10 +53,10 @@ public void configure() throws Exception {
                 rest("/say/bye").description("bye", "Bye Service", "en")
                         .get().description("Says bye to you").consumes("application/json")
                         .param().type(RestParamType.header).description("header param description1").dataType("integer").allowableValues("1", "2", "3", "4")
-                        .defaultValue("1").allowMultiple(false).name("header_count").required(true).paramAccess("acc1")
+                        .defaultValue("1").allowMultiple(false).name("header_count").required(true).access("acc1")
                         .endParam().
                         param().type(RestParamType.query).description("header param description2").dataType("string").allowableValues("a", "b", "c", "d")
-                        .defaultValue("b").allowMultiple(true).name("header_letter").required(false).paramAccess("acc2")
+                        .defaultValue("b").allowMultiple(true).name("header_letter").required(false).access("acc2")
                         .endParam()
                         .responseMessage().code(300).message("test msg").responseModel(Integer.class).endResponseMessage()
                         .to("direct:bye")

diff --git a/camel-core/src/test/java/org/apache/camel/management/ManagedFromRestGetTest.java b/camel-core/src/test/java/org/apache/camel/management/ManagedFromRestGetTest.java
@@ -61,17 +61,15 @@ public void testFromRestModel() throws Exception {
         assertTrue(xml.contains("application/json"));
         assertTrue(xml.contains("</rests>"));
 
-        assertTrue(xml.contains("<param paramType=\"query\" name=\"header_letter\" description=\"header param description2\""
+        assertTrue(xml.contains("<param name=\"header_letter\" type=\"query\" description=\"header param description2\""
-                + " defaultValue=\"b\" required=\"false\" allowMultiple=\"true\" dataType=\"string\" paramAccess=\"acc2\">"));
+                + " defaultValue=\"b\" required=\"false\" allowMultiple=\"true\" dataType=\"string\" access=\"acc2\">"));
-        assertTrue(xml.contains("<param paramType=\"header\" name=\"header_count\" description=\"header param description1\" "
+        assertTrue(xml.contains("<param name=\"header_count\" type=\"header\" description=\"header param description1\" "
-                + "defaultValue=\"1\" required=\"true\" allowMultiple=\"false\" dataType=\"integer\" paramAccess=\"acc1\">"));
+                + "defaultValue=\"1\" required=\"true\" allowMultiple=\"false\" dataType=\"integer\" access=\"acc1\">"));
         assertTrue(xml.contains("<value>1</value>"));
         assertTrue(xml.contains("<value>a</value>"));
 
         assertTrue(xml.contains("<responseMessage code=\"300\" message=\"test msg\" responseModel=\"java.lang.Integer\"/>"));
 
-
-
         String xml2 = (String) mbeanServer.invoke(on, "dumpRoutesAsXml", null, null);
         log.info(xml2);
         // and we should have rest in the routes that indicate its from a rest dsl
@@ -93,10 +91,10 @@ public void configure() throws Exception {
                 rest("/say/bye")
                     .get().consumes("application/json")
                         .param().type(RestParamType.header).description("header param description1").dataType("integer").allowableValues(Arrays.asList("1", "2", "3", "4"))
-                        .defaultValue("1").allowMultiple(false).name("header_count").required(true).paramAccess("acc1")
+                            .defaultValue("1").allowMultiple(false).name("header_count").required(true).access("acc1")
                         .endParam().
                         param().type(RestParamType.query).description("header param description2").dataType("string").allowableValues(Arrays.asList("a", "b", "c", "d"))
-                        .defaultValue("b").allowMultiple(true).name("header_letter").required(false).paramAccess("acc2")
+                            .defaultValue("b").allowMultiple(true).name("header_letter").required(false).access("acc2")
                         .endParam()
                         .responseMessage().code(300).message("test msg").responseModel(Integer.class).endResponseMessage()
                         .to("direct:bye")

diff --git a/...ng/src/test/resources/org/apache/camel/component/rest/SpringFromRestConfigurationTest.xml b/...ng/src/test/resources/org/apache/camel/component/rest/SpringFromRestConfigurationTest.xml
@@ -41,15 +41,15 @@
     </rest>
     <rest path="/say/bye">
       <get consumes="application/json">
-          <param paramType="header" description="header param description1" dataType="integer" defaultValue="1" allowMultiple="false" name="header_count" required="true" paramAccess="acc1">
+          <param name="header_count" type="header" description="header param description1" dataType="integer" defaultValue="1" allowMultiple="false" required="true" access="acc1">
               <allowableValues>
                   <value>1</value>
                   <value>2</value>
                   <value>3</value>
                   <value>4</value>
               </allowableValues>
           </param>
-          <param paramType="query" description="header param description2" dataType="string" defaultValue="b" allowMultiple="true" name="header_letter" required="false" paramAccess="acc2">
+          <param name="header_letter" type="query" description="header param description2" dataType="string" defaultValue="b" allowMultiple="true" required="false" access="acc2">
               <allowableValues>
                   <value>a</value>
                   <value>b</value>

diff --git a/...camel-spring/src/test/resources/org/apache/camel/component/rest/SpringFromRestGetTest.xml b/...camel-spring/src/test/resources/org/apache/camel/component/rest/SpringFromRestGetTest.xml
@@ -34,15 +34,15 @@
     </rest>
     <rest path="/say/bye">
       <get consumes="application/json">
-          <param paramType="header" description="header param description1" dataType="integer" defaultValue="1" allowMultiple="false" name="header_count" required="true" paramAccess="acc1">
+          <param name="header_count" type="header" description="header param description1" dataType="integer" defaultValue="1" allowMultiple="false" required="true" access="acc1">
               <allowableValues>
                   <value>1</value>
                   <value>2</value>
                   <value>3</value>
                   <value>4</value>
               </allowableValues>
           </param>
-          <param paramType="query" description="header param description2" dataType="string" defaultValue="b" allowMultiple="true" name="header_letter" required="false" paramAccess="acc2">
+          <param name="header_letter" type="query" description="header param description2" dataType="string" defaultValue="b" allowMultiple="true" required="false" access="acc2">
               <allowableValues>
                   <value>a</value>
                   <value>b</value>

diff --git a/...src/test/resources/org/apache/camel/component/rest/SpringFromRestIdAndDescriptionTest.xml b/...src/test/resources/org/apache/camel/component/rest/SpringFromRestIdAndDescriptionTest.xml
@@ -38,15 +38,15 @@
       <description lang="en">Bye Service</description>
       <get consumes="application/json">
         <description>Says bye to you</description>
-          <param paramType="header" description="header param description1" dataType="integer" defaultValue="1" allowMultiple="false" name="header_count" required="true" paramAccess="acc1">
+          <param name="header_count" type="header" description="header param description1" dataType="integer" defaultValue="1" allowMultiple="false" required="true" access="acc1">
               <allowableValues>
                   <value>1</value>
                   <value>2</value>
                   <value>3</value>
                   <value>4</value>
               </allowableValues>
           </param>
-          <param paramType="query" description="header param description2" dataType="string" defaultValue="b" allowMultiple="true" name="header_letter" required="false" paramAccess="acc2">
+          <param name="header_letter" type="query" description="header param description2" dataType="string" defaultValue="b" allowMultiple="true" required="false" access="acc2">
               <allowableValues>
                   <value>a</value>
                   <value>b</value>

diff --git a/...s/camel-swagger/src/main/scala/org/apache/camel/component/swagger/RestSwaggerReader.scala b/...s/camel-swagger/src/main/scala/org/apache/camel/component/swagger/RestSwaggerReader.scala
@@ -205,8 +205,8 @@ class RestSwaggerReader {
         if (param.getAllowMultiple != null) param.getAllowMultiple.booleanValue() else false,
         param.getDataType,
         allowValues,
-        param.getParamType.toString,
+        param.getType.toString,
-        Some(param.getParamAccess)
+        Some(param.getAccess)
       )
     }
 

diff --git a/...ueprint/src/test/java/org/apache/camel/test/blueprint/component/rest/FromRestGetTest.java b/...ueprint/src/test/java/org/apache/camel/test/blueprint/component/rest/FromRestGetTest.java
@@ -53,8 +53,8 @@ public void testFromRestModel() throws Exception {
         assertEquals("application/json", rest.getVerbs().get(0).getConsumes());
 
         assertEquals(2, rest.getVerbs().get(0).getParams().size());
-        assertEquals(RestParamType.header, rest.getVerbs().get(0).getParams().get(0).getParamType());
+        assertEquals(RestParamType.header, rest.getVerbs().get(0).getParams().get(0).getType());
-        assertEquals(RestParamType.query, rest.getVerbs().get(0).getParams().get(1).getParamType());
+        assertEquals(RestParamType.query, rest.getVerbs().get(0).getParams().get(1).getType());
 
         assertEquals("header param description1", rest.getVerbs().get(0).getParams().get(0).getDescription());
         assertEquals("header param description2", rest.getVerbs().get(0).getParams().get(1).getDescription());
@@ -73,8 +73,8 @@ public void testFromRestModel() throws Exception {
         assertEquals("header_letter", rest.getVerbs().get(0).getParams().get(1).getName());
         assertEquals(Boolean.TRUE, rest.getVerbs().get(0).getParams().get(0).getRequired());
         assertEquals(Boolean.FALSE, rest.getVerbs().get(0).getParams().get(1).getRequired());
-        assertEquals("acc1", rest.getVerbs().get(0).getParams().get(0).getParamAccess());
+        assertEquals("acc1", rest.getVerbs().get(0).getParams().get(0).getAccess());
-        assertEquals("acc2", rest.getVerbs().get(0).getParams().get(1).getParamAccess());
+        assertEquals("acc2", rest.getVerbs().get(0).getParams().get(1).getAccess());
 
         assertEquals(300, rest.getVerbs().get(0).getResponseMsgs().get(0).getCode());
         assertEquals("test msg", rest.getVerbs().get(0).getResponseMsgs().get(0).getMessage());

diff --git a/...st/resources/org/apache/camel/test/blueprint/component/rest/FromRestConfigurationTest.xml b/...st/resources/org/apache/camel/test/blueprint/component/rest/FromRestConfigurationTest.xml
@@ -39,15 +39,15 @@
     </rest>
     <rest path="/say/bye">
       <get consumes="application/json">
-        <param paramType="header" description="header param description1" dataType="integer" defaultValue="1" allowMultiple="false" name="header_count" required="true" paramAccess="acc1">
+        <param name="header_count" type="header" description="header param description1" dataType="integer" defaultValue="1" allowMultiple="false" required="true" access="acc1">
           <allowableValues>
               <value>1</value>
               <value>2</value>
               <value>3</value>
               <value>4</value>
           </allowableValues>
         </param>
-        <param paramType="query" description="header param description2" dataType="string" defaultValue="b" allowMultiple="true" name="header_letter" required="false" paramAccess="acc2">
+        <param name="header_letter" type="query" description="header param description2" dataType="string" defaultValue="b" allowMultiple="true" required="false" access="acc2">
           <allowableValues>
               <value>a</value>
               <value>b</value>

diff --git a/...int/src/test/resources/org/apache/camel/test/blueprint/component/rest/FromRestGetTest.xml b/...int/src/test/resources/org/apache/camel/test/blueprint/component/rest/FromRestGetTest.xml
@@ -32,15 +32,15 @@
     </rest>
     <rest path="/say/bye">
       <get consumes="application/json">
-         <param paramType="header" description="header param description1" dataType="integer" defaultValue="1" allowMultiple="false" name="header_count" required="true" paramAccess="acc1">
+         <param name="header_count" type="header" description="header param description1" dataType="integer" defaultValue="1" allowMultiple="false" required="true" access="acc1">
             <allowableValues>
                <value>1</value>
                <value>2</value>
                <value>3</value>
                <value>4</value>
             </allowableValues>
          </param>
-         <param paramType="query" description="header param description2" dataType="string" defaultValue="b" allowMultiple="true" name="header_letter" required="false" paramAccess="acc2">
+         <param name="header_letter" type="query" description="header param description2" dataType="string" defaultValue="b" allowMultiple="true" required="false" access="acc2">
             <allowableValues>
                <value>a</value>
                <value>b</value>