CAMEL-24961: Catalog body types for netty, netty-http, jetty, servlet, undertow, cxf, cxfrs, spring-ws and four more

catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/atmosphere-websocket.json

@@ -45,6 +45,11 @@
     "CamelAtmosphereWebsocketEventType": { "index": 2, "kind": "header", "displayName": "", "group": "consumer", "label": "consumer", "required": false, "javaType": "int", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "important": true, "description": "The type of event received. It can be ONOPEN_EVENT_TYPE, ONERROR_EVENT_TYPE or ONCLOSE_EVENT_TYPE.", "constantName": "org.apache.camel.component.atmosphere.websocket.WebsocketConstants#EVENT_TYPE" },
     "CamelAtmosphereWebsocketErrorType": { "index": 3, "kind": "header", "displayName": "", "group": "consumer", "label": "consumer", "required": false, "javaType": "int", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The type of error that occurred. It can be MESSAGE_NOT_SENT_ERROR_TYPE.", "constantName": "org.apache.camel.component.atmosphere.websocket.WebsocketConstants#ERROR_TYPE" }
   },
+  "bodyTypes": {
+    "consumerOut": { "carriers": [ "text", "bytes", "null" ], "byOption": [ { "option": "useStreaming", "value": "true", "carriers": [ "stream", "null" ] } ], "description": "A String for a text message, a byte array for a binary one; null for the open, close and error events (the servlet init parameter events=true). A message the producer could not deliver comes back with the CamelAtmosphereWebsocketErrorType header. The consumer does not reply" },
+    "producerIn": { "carriers": [ "null", "text", "bytes", "stream" ], "description": "Text or a Reader as a text message, bytes or an InputStream as a binary one; other bodies as their toString. No body sends nothing. Sent to all peers with sendToAll, otherwise to the connection key headers" },
+    "producerOut": { "carriers": [ "unchanged" ], "description": "The body is kept" }
+  },
   "properties": {
     "servicePath": { "index": 0, "kind": "path", "displayName": "Service Path", "group": "common", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Name of websocket endpoint" },
     "chunked": { "index": 1, "kind": "parameter", "displayName": "Chunked", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response" },

catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/cxf.json

@@ -41,6 +41,12 @@
     "CamelAuthentication": { "index": 4, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "javax.security.auth.Subject", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The authentication", "constantName": "org.apache.camel.component.cxf.common.message.CxfConstants#AUTHENTICATION" },
     "RequestContext": { "index": 5, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "Object", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The request context", "constantName": "org.apache.camel.component.cxf.common.message.CxfConstants#REQUEST_CONTEXT" }
   },
+  "bodyTypes": {
+    "consumerOut": { "carriers": [ "list", "null" ], "byOption": [ { "option": "dataFormat", "value": "PAYLOAD", "carriers": [ "pojo" ], "javaType": "org.apache.camel.component.cxf.common.CxfPayload" }, { "option": "dataFormat", "value": "RAW", "carriers": [ "stream" ] }, { "option": "dataFormat", "value": "MESSAGE", "carriers": [ "stream" ] }, { "option": "dataFormat", "value": "CXF_MESSAGE", "carriers": [ "pojo" ], "javaType": "jakarta.xml.soap.SOAPMessage" } ], "description": "POJO: a MessageContentsList of the parameters of the operation, typed as the service class declares them, with its name in the CamelCxfOperationName header; null for an operation without parameters. PAYLOAD: a CxfPayload of the elements of the soap:Body and the SOAP headers. RAW: the stream of the whole SOAP envelope, without the operation name. CXF_MESSAGE: the SAAJ SOAPMessage" },
+    "consumerReply": { "carriers": [ "text", "value", "pojo", "list", "null" ], "byOption": [ { "option": "dataFormat", "value": "PAYLOAD", "carriers": [ "pojo", "text", "bytes", "stream", "null" ] }, { "option": "dataFormat", "value": "RAW", "carriers": [ "text", "bytes", "stream", "file", "null" ] }, { "option": "dataFormat", "value": "MESSAGE", "carriers": [ "text", "bytes", "stream", "file", "null" ] }, { "option": "dataFormat", "value": "CXF_MESSAGE", "carriers": [ "pojo" ] } ], "description": "POJO: the return value of the operation, of the type the service class declares, or a List or array of it and the out and holder parameters; another type is a SOAP fault, so the request MessageContentsList only fits an echo. PAYLOAD: a CxfPayload, or the XML of the soap:Body contents as text, bytes, a stream or a DOM; a body that does not convert sends an empty soap:Body. RAW: the whole SOAP envelope as text, bytes, a stream or a file. CXF_MESSAGE: a SOAPMessage or a javax.xml.transform Source; text or a stream sends an empty envelope" },
+    "producerIn": { "carriers": [ "list", "text", "value", "pojo", "null" ], "byOption": [ { "option": "dataFormat", "value": "PAYLOAD", "carriers": [ "pojo", "text", "bytes", "stream", "file" ] }, { "option": "dataFormat", "value": "RAW", "carriers": [ "text", "bytes", "stream", "file" ] }, { "option": "dataFormat", "value": "MESSAGE", "carriers": [ "text", "bytes", "stream", "file" ] }, { "option": "dataFormat", "value": "CXF_MESSAGE", "carriers": [ "pojo" ] } ], "description": "POJO: the parameters of the operation (the CamelCxfOperationName header or defaultOperationName) as a List or an array, or the one parameter as the body; each of the type the service class declares. A body that is not a List is split like the split EIP does, so text with a comma or a byte array is several parameters: wrap it in a List. PAYLOAD: a CxfPayload, or the XML of the soap:Body contents as text, bytes, a stream, a file or a DOM. RAW: the whole SOAP envelope. CXF_MESSAGE: a SOAPMessage or a javax.xml.transform Source" },
+    "producerOut": { "carriers": [ "list", "null", "unchanged" ], "byOption": [ { "option": "dataFormat", "value": "PAYLOAD", "carriers": [ "pojo" ], "javaType": "org.apache.camel.component.cxf.common.CxfPayload" }, { "option": "dataFormat", "value": "RAW", "carriers": [ "stream" ] }, { "option": "dataFormat", "value": "MESSAGE", "carriers": [ "stream" ] }, { "option": "dataFormat", "value": "CXF_MESSAGE", "carriers": [ "pojo" ], "javaType": "jakarta.xml.soap.SOAPMessage" } ], "description": "POJO: a MessageContentsList with the return value of the operation first, then the out and holder parameters; null for a void operation, and the body unchanged for a one-way one. PAYLOAD: a CxfPayload of the soap:Body contents. RAW: the stream of the SOAP envelope of the response, read once. CXF_MESSAGE: the SAAJ SOAPMessage" }
+  },
   "properties": {
     "beanId": { "index": 0, "kind": "path", "displayName": "Bean Id", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "To lookup an existing configured CxfEndpoint. Must used bean: as prefix." },
     "address": { "index": 1, "kind": "path", "displayName": "Address", "group": "service", "label": "service", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The service publish address." },

catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/cxfrs.json

@@ -50,6 +50,12 @@
     "CamelCxfRsQueryMap": { "index": 14, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "Map<String, String>", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The query map", "constantName": "org.apache.camel.component.cxf.common.message.CxfConstants#CAMEL_CXF_RS_QUERY_MAP" },
     "CamelCxfRsOperationResourceInfoStack": { "index": 15, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "org.apache.cxf.jaxrs.model.OperationResourceInfoStack", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The stack of MethodInvocationInfo representing resources path when JAX-RS invocation looks for target.", "constantName": "org.apache.camel.component.cxf.common.message.CxfConstants#CAMEL_CXF_RS_OPERATION_RESOURCE_INFO_STACK" }
   },
+  "bodyTypes": {
+    "consumerOut": { "carriers": [ "list" ], "javaType": "org.apache.cxf.message.MessageContentsList", "dependsOn": [ "performInvocation" ], "byOption": [ { "option": "bindingStyle", "value": "SimpleConsumer", "carriers": [ "unknown" ] }, { "option": "bindingStyle", "value": "Custom", "carriers": [ "unknown" ] } ], "description": "Default: a MessageContentsList of the parameters of the resource method, with its name in the CamelCxfOperationName header. SimpleConsumer: the request entity as the method declares it (a String, an InputStream, a JAXB bean), with the path, query and header parameters in headers; the MessageContentsList when the method has no entity, such as a GET" },
+    "consumerReply": { "carriers": [ "null", "text", "bytes", "stream", "file", "pojo" ], "byOption": [ { "option": "bindingStyle", "value": "Custom", "carriers": [ "any" ] } ], "description": "The response entity: a jakarta.ws.rs.core.Response, or text, bytes, a stream, a file, or an object a JAX-RS provider writes for the Content-Type (a JAXB bean as XML); a Map or a List fails without a provider for it. With the Default binding the request MessageContentsList fails: set the reply body" },
+    "producerIn": { "carriers": [ "null", "text", "bytes", "stream", "file", "pojo" ], "byOption": [ { "option": "httpClientAPI", "value": "false", "carriers": [ "list", "text", "value", "pojo", "null" ] } ], "description": "The request entity, written for the Content-Type header: text, bytes, a stream, a file or an object a JAX-RS provider writes; of a List only the first element is sent, and a Map fails. A GET sends no body. With httpClientAPI=false: the parameters of the resource method named by the CamelCxfOperationName header, as a List or the one parameter" },
+    "producerOut": { "carriers": [ "pojo" ], "byOption": [ { "option": "httpClientAPI", "value": "false", "carriers": [ "unknown" ] } ], "description": "A jakarta.ws.rs.core.Response whose entity is the response stream, read once (it converts to a String or an InputStream); the entity read as the class in the CamelCxfRsResponseClass header when that is set. With httpClientAPI=false: the return value of the resource method, null for a void one" }
+  },
   "properties": {
     "beanId": { "index": 0, "kind": "path", "displayName": "Bean Id", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "To lookup an existing configured CxfRsEndpoint. Must used bean: as prefix." },
     "address": { "index": 1, "kind": "path", "displayName": "Address", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The service publish address." },

catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/jetty.json

@@ -69,6 +69,10 @@
     "CamelServletContextPath": { "index": 0, "kind": "header", "displayName": "", "group": "consumer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The servlet context path used", "constantName": "org.apache.camel.component.jetty.JettyHttpConstants#SERVLET_CONTEXT_PATH" },
     "CamelHttpPath": { "index": 1, "kind": "header", "displayName": "", "group": "consumer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Request URI's path, the header will be used to build the request URI with the HTTP_URI.", "constantName": "org.apache.camel.component.jetty.JettyHttpConstants#HTTP_PATH" }
   },
+  "bodyTypes": {
+    "consumerOut": { "carriers": [ "stream", "null" ], "dependsOn": [ "transferException", "httpBinding" ], "description": "The request body as a stream cache, which can be read again (the raw stream, read once, with disableStreamCache); an empty one for a GET, null with Content-Length 0 or eagerCheckContentAvailable. The fields of a form are also headers; a multipart upload leaves the body empty and gives its files as attachments and DataHandler headers" },
+    "consumerReply": { "carriers": [ "null", "text", "bytes", "stream", "file" ], "description": "The response body: text, bytes, a stream or a file. A Map, a List or a POJO is sent as an empty body (as its toString with chunked=false): marshal it first" }
+  },
   "properties": {
     "httpUri": { "index": 0, "kind": "path", "displayName": "Http Uri", "group": "common", "label": "common", "required": true, "type": "string", "javaType": "java.net.URI", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The url of the HTTP endpoint to call." },
     "headerFilterStrategy": { "index": 1, "kind": "parameter", "displayName": "Header Filter Strategy", "group": "common (advanced)", "label": "common,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.HeaderFilterStrategy", "deprecated": false, "autowired": false, "secret": false, "description": "To use a custom HeaderFilterStrategy to filter header to and from Camel message." },

catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/netty-http.json

@@ -131,6 +131,12 @@
     "CamelNettyRequestTimeout": { "index": 22, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "Long", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The read timeout.", "constantName": "org.apache.camel.component.netty.NettyConstants#NETTY_REQUEST_TIMEOUT" },
     "CamelNettyChannel": { "index": 23, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "io.netty.channel.Channel", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The Netty Channel object.", "constantName": "org.apache.camel.component.netty.NettyConstants#NETTY_CHANNEL" }
   },
+  "bodyTypes": {
+    "consumerOut": { "carriers": [ "stream" ], "javaType": "org.apache.camel.component.netty.http.NettyChannelBufferStreamCache", "dependsOn": [ "nettyHttpBinding" ], "byOption": [ { "option": "disableStreamCache", "value": "true", "carriers": [ "pojo", "stream" ] }, { "option": "protocol", "value": "proxy", "carriers": [ "pojo" ], "javaType": "io.netty.buffer.ByteBuf" } ], "description": "The request body as the stream cache of Camel, which can be read many times; empty for a request without a body, such as a GET. The fields of a form POST are also headers. With disableStreamCache the Netty ByteBuf of the request, or an InputStream for a chunked request, read once" },
+    "consumerReply": { "carriers": [ "null", "text", "bytes", "stream", "file", "value" ], "description": "The response body: text, bytes, a stream, a file, or a Netty ByteBuf or HttpResponse; no body sends 204. A Map or a POJO is written as its toString() and a List is not written at all: marshal it first. A failed exchange sends 500 with an empty body (muteException)" },
+    "producerIn": { "carriers": [ "null", "text", "bytes", "stream", "file" ], "description": "The request body: text, bytes, a stream or a file, or a Netty ByteBuf or HttpRequest. A Map, a List or a POJO fails: marshal it first. Without the CamelHttpMethod header, no body sends a GET and a body a POST" },
+    "producerOut": { "carriers": [ "bytes" ], "javaType": "byte[]", "dependsOn": [ "nettyHttpBinding", "sync" ], "byOption": [ { "option": "disableStreamCache", "value": "true", "carriers": [ "pojo", "stream" ] } ], "description": "The response body as a byte array, empty for a response without a body. With disableStreamCache the Netty ByteBuf of the response, or an InputStream for a chunked response; the ByteBuf is released when the exchange is done" }
+  },
   "properties": {
     "protocol": { "index": 0, "kind": "path", "displayName": "Protocol", "group": "common", "label": "", "required": true, "type": "enum", "javaType": "java.lang.String", "enum": [ "http", "https", "proxy" ], "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.netty.http.NettyHttpConfiguration", "configurationField": "configuration", "description": "The protocol to use which is either http, https or proxy (consumer only)." },
     "host": { "index": 1, "kind": "path", "displayName": "Host", "group": "common", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.netty.http.NettyHttpConfiguration", "configurationField": "configuration", "description": "The local hostname such as localhost, or 0.0.0.0 when being a consumer. The remote HTTP server hostname when using producer." },