This is an automated email from the ASF dual-hosted git repository. nfilotto pushed a commit to branch CAMEL-17792/doc-message-headers in repository https://gitbox.apache.org/repos/asf/camel.git
commit 329adbb918842878e8b93fa8e352b427298a2c4c Author: Nicolas Filotto <[email protected]> AuthorDate: Fri Apr 1 15:45:45 2022 +0200 CAMEL-17792: Add doc about the message headers of camel-olingo2 --- .../resources/org/apache/camel/component/olingo2/olingo2.json | 3 +++ .../camel-olingo2-component/src/main/docs/olingo2-component.adoc | 3 +++ .../java/org/apache/camel/component/olingo2/Olingo2Endpoint.java | 2 +- .../java/org/apache/camel/component/olingo2/Olingo2Producer.java | 4 +--- .../apache/camel/component/olingo2/internal/Olingo2Constants.java | 5 +++++ 5 files changed, 13 insertions(+), 4 deletions(-) diff --git a/components/camel-olingo2/camel-olingo2-component/src/generated/resources/org/apache/camel/component/olingo2/olingo2.json b/components/camel-olingo2/camel-olingo2-component/src/generated/resources/org/apache/camel/component/olingo2/olingo2.json index 34950fd..1514125 100644 --- a/components/camel-olingo2/camel-olingo2-component/src/generated/resources/org/apache/camel/component/olingo2/olingo2.json +++ b/components/camel-olingo2/camel-olingo2-component/src/generated/resources/org/apache/camel/component/olingo2/olingo2.json @@ -42,6 +42,9 @@ "sslContextParameters": { "kind": "property", "displayName": "Ssl Context Parameters", "group": "security", "label": "security", "required": false, "type": "object", "javaType": "org.apache.camel.support.jsse.SSLContextParameters", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.olingo2.Olingo2Configuration", "configurationField": "configuration", "description": "To configure security using SSLContextParameters" }, "useGlobalSslContextParameters": { "kind": "property", "displayName": "Use Global Ssl Context Parameters", "group": "security", "label": "security", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Enable usage of global SSL context parameters." } }, + "headers": { + "CamelOlingo2.responseHttpHeaders": { "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "Map<String, String>", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The response Http headers" } + }, "properties": { "apiName": { "kind": "path", "displayName": "Api Name", "group": "common", "label": "", "required": true, "type": "object", "javaType": "org.apache.camel.component.olingo2.internal.Olingo2ApiName", "enum": [ "DEFAULT" ], "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.olingo2.Olingo2Configuration", "configurationField": "configuration", "description": "What kind of operation to perform" }, "methodName": { "kind": "path", "displayName": "Method Name", "group": "common", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.olingo2.Olingo2Configuration", "configurationField": "configuration", "description": "What sub operation to use for the selected operation" }, diff --git a/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc b/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc index 2d18a58..269012a 100644 --- a/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc +++ b/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc @@ -60,6 +60,9 @@ include::partial$component-endpoint-options.adoc[] // endpoint options: END +// component headers: START +include::partial$component-endpoint-headers.adoc[] +// component headers: END == Endpoint HTTP Headers diff --git a/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/Olingo2Endpoint.java b/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/Olingo2Endpoint.java index 63e5fba..628b7d1 100644 --- a/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/Olingo2Endpoint.java +++ b/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/Olingo2Endpoint.java @@ -46,7 +46,7 @@ import org.apache.camel.support.component.ApiMethodPropertiesHelper; */ @UriEndpoint(firstVersion = "2.14.0", scheme = "olingo2", title = "Olingo2", syntax = "olingo2:apiName/methodName", apiSyntax = "apiName/methodName", - category = { Category.CLOUD }) + category = { Category.CLOUD }, headersClass = Olingo2Constants.class) public class Olingo2Endpoint extends AbstractApiEndpoint<Olingo2ApiName, Olingo2Configuration> { protected static final String RESOURCE_PATH_PROPERTY = "resourcePath"; diff --git a/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/Olingo2Producer.java b/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/Olingo2Producer.java index f5d7e4c..f2d4fab 100644 --- a/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/Olingo2Producer.java +++ b/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/Olingo2Producer.java @@ -38,8 +38,6 @@ public class Olingo2Producer extends AbstractApiProducer<Olingo2ApiName, Olingo2 private static final Logger LOG = LoggerFactory.getLogger(Olingo2Producer.class); - private static final String RESPONSE_HTTP_HEADERS = "responseHttpHeaders"; - private Olingo2Index resultIndex; public Olingo2Producer(Olingo2Endpoint endpoint) { @@ -72,7 +70,7 @@ public class Olingo2Producer extends AbstractApiProducer<Olingo2ApiName, Olingo2 exchange.getOut().setHeaders(exchange.getIn().getHeaders()); // Add http response headers - exchange.getOut().setHeader(Olingo2Constants.PROPERTY_PREFIX + RESPONSE_HTTP_HEADERS, responseHeaders); + exchange.getOut().setHeader(Olingo2Constants.RESPONSE_HTTP_HEADERS, responseHeaders); interceptResult(response, exchange); diff --git a/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/internal/Olingo2Constants.java b/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/internal/Olingo2Constants.java index 28bac27..61b4342 100644 --- a/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/internal/Olingo2Constants.java +++ b/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/internal/Olingo2Constants.java @@ -16,6 +16,8 @@ */ package org.apache.camel.component.olingo2.internal; +import org.apache.camel.spi.Metadata; + /** * Constants for Olingo2 component. */ @@ -26,4 +28,7 @@ public interface Olingo2Constants { // thread profile name for this component String THREAD_PROFILE_NAME = "CamelOlingo2"; + + @Metadata(label = "producer", description = "The response Http headers", javaType = "Map<String, String>") + String RESPONSE_HTTP_HEADERS = PROPERTY_PREFIX + "responseHttpHeaders"; }
