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 4996515e1988e7eae47736d3420f5cf110c55348 Author: Nicolas Filotto <[email protected]> AuthorDate: Mon Mar 21 12:40:54 2022 +0100 CAMEL-17792: Add doc about the message headers of camel-facebook --- .../resources/org/apache/camel/component/facebook/facebook.json | 3 +++ components/camel-facebook/src/main/docs/facebook-component.adoc | 4 +++- .../java/org/apache/camel/component/facebook/FacebookConstants.java | 3 +++ .../java/org/apache/camel/component/facebook/FacebookEndpoint.java | 2 +- .../java/org/apache/camel/component/facebook/FacebookProducer.java | 3 +-- 5 files changed, 11 insertions(+), 4 deletions(-) diff --git a/components/camel-facebook/src/generated/resources/org/apache/camel/component/facebook/facebook.json b/components/camel-facebook/src/generated/resources/org/apache/camel/component/facebook/facebook.json index 0452200..d87a3a7 100644 --- a/components/camel-facebook/src/generated/resources/org/apache/camel/component/facebook/facebook.json +++ b/components/camel-facebook/src/generated/resources/org/apache/camel/component/facebook/facebook.json @@ -54,6 +54,9 @@ "oAuthAuthorizationURL": { "kind": "property", "displayName": "OAuth Authorization URL", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "https:\/\/www.facebook.com\/dialog\/oauth", "configurationClass": "org.apache.camel.component.facebook.config.FacebookConfiguration", "configurationField": "configuration", "description": "OAuth authorization URL" }, "oAuthPermissions": { "kind": "property", "displayName": "OAuth Permissions", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.facebook.config.FacebookConfiguration", "configurationField": "configuration", "description": "Default OAuth permissions. Comma separated permission names. See https:\/\/developers.facebook.c [...] }, + "headers": { + "CamelFacebook.rawJSON": { "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The raw json" } + }, "properties": { "methodName": { "kind": "path", "displayName": "Method Name", "group": "common", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "What operation to perform" }, "achievementURL": { "kind": "parameter", "displayName": "Achievement URL", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.net.URL", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.facebook.config.FacebookEndpointConfiguration", "configurationField": "configuration", "description": "The unique URL of the achievement" }, diff --git a/components/camel-facebook/src/main/docs/facebook-component.adoc b/components/camel-facebook/src/main/docs/facebook-component.adoc index 7c3f8bd..de92a45 100644 --- a/components/camel-facebook/src/main/docs/facebook-component.adoc +++ b/components/camel-facebook/src/main/docs/facebook-component.adoc @@ -70,7 +70,9 @@ include::partial$component-endpoint-options.adoc[] // endpoint options: END - +// component headers: START +include::partial$component-endpoint-headers.adoc[] +// component headers: END == Producer Endpoints: diff --git a/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookConstants.java b/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookConstants.java index 85f13d3..47fbd14 100644 --- a/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookConstants.java +++ b/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookConstants.java @@ -16,6 +16,8 @@ */ package org.apache.camel.component.facebook; +import org.apache.camel.spi.Metadata; + /** * Common constants. */ @@ -33,5 +35,6 @@ public interface FacebookConstants { // date format used by Facebook Reading since and until fields String FACEBOOK_DATE_FORMAT = "yyyy-MM-dd'T'HH:mm:ssZ"; + @Metadata(description = "The raw json", javaType = "String") String RAW_JSON_HEADER = FACEBOOK_PROPERTY_PREFIX + "rawJSON"; } diff --git a/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookEndpoint.java b/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookEndpoint.java index 75d8b31..0744191 100644 --- a/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookEndpoint.java +++ b/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookEndpoint.java @@ -55,7 +55,7 @@ import static org.apache.camel.component.facebook.data.FacebookPropertiesHelper. * locations, etc. */ @UriEndpoint(firstVersion = "2.14.0", scheme = "facebook", title = "Facebook", syntax = "facebook:methodName", - category = { Category.SOCIAL }) + category = { Category.SOCIAL }, headersClass = FacebookConstants.class) public class FacebookEndpoint extends DefaultEndpoint implements FacebookConstants { private static final Logger LOG = LoggerFactory.getLogger(FacebookEndpoint.class); diff --git a/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookProducer.java b/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookProducer.java index 3119c2e..e70f92a 100644 --- a/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookProducer.java +++ b/components/camel-facebook/src/main/java/org/apache/camel/component/facebook/FacebookProducer.java @@ -109,8 +109,7 @@ public class FacebookProducer extends DefaultAsyncProducer { // copy headers exchange.getMessage().setHeaders(exchange.getIn().getHeaders()); if (rawJSON != null) { - exchange.getMessage().setHeader(FacebookConstants.FACEBOOK_PROPERTY_PREFIX + "rawJSON", - rawJSON); + exchange.getMessage().setHeader(FacebookConstants.RAW_JSON_HEADER, rawJSON); } } catch (Exception t) {
