This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel-spring-boot.git
The following commit(s) were added to refs/heads/main by this push: new a25b6894bf6 camel-pubnub: upgrade to v10 client a25b6894bf6 is described below commit a25b6894bf6b6f7e8bd5dbaf8fbfd259ca7e3fa9 Author: Claus Ibsen <claus.ib...@gmail.com> AuthorDate: Fri Nov 15 10:52:41 2024 +0100 camel-pubnub: upgrade to v10 client --- .../springboot/catalog/components/pubnub.json | 24 ++++++++++------------ .../camel-pubnub-starter/src/main/docs/pubnub.json | 20 ++++++++---------- .../springboot/PubNubComponentConfiguration.java | 22 ++++++++------------ 3 files changed, 28 insertions(+), 38 deletions(-) diff --git a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/pubnub.json b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/pubnub.json index ccaa2712668..f9bec18a265 100644 --- a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/pubnub.json +++ b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/pubnub.json @@ -31,12 +31,11 @@ "lazyStartProducer": { "index": 4, "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail [...] "operation": { "index": 5, "kind": "property", "displayName": "Operation", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "HERENOW", "GETSTATE", "SETSTATE", "GETHISTORY", "PUBLISH", "FIRE" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.pubnub.PubNubConfiguration", "configurationField": "configuration", "description": "The operation to perform. PUBL [...] "autowiredEnabled": { "index": 6, "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching t [...] - "authKey": { "index": 7, "kind": "property", "displayName": "Auth Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.pubnub.PubNubConfiguration", "configurationField": "configuration", "description": "If Access Manager is utilized, client will use this authKey in all restricted requests." }, - "cipherKey": { "index": 8, "kind": "property", "displayName": "Cipher Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.pubnub.PubNubConfiguration", "configurationField": "configuration", "description": "If cipher is passed, all communications to\/from PubNub will be encrypted." }, - "publishKey": { "index": 9, "kind": "property", "displayName": "Publish Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.pubnub.PubNubConfiguration", "configurationField": "configuration", "description": "The publish key obtained from your PubNub account. Required when publishing messages." }, - "secretKey": { "index": 10, "kind": "property", "displayName": "Secret Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.pubnub.PubNubConfiguration", "configurationField": "configuration", "description": "The secret key used for message signing." }, - "secure": { "index": 11, "kind": "property", "displayName": "Secure", "group": "security", "label": "security", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "configurationClass": "org.apache.camel.component.pubnub.PubNubConfiguration", "configurationField": "configuration", "description": "Use SSL for secure transmission." }, - "subscribeKey": { "index": 12, "kind": "property", "displayName": "Subscribe Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.pubnub.PubNubConfiguration", "configurationField": "configuration", "description": "The subscribe key obtained from your PubNub account. Required when subscribing to channels or listening [...] + "authKey": { "index": 7, "kind": "property", "displayName": "Auth Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": true, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.pubnub.PubNubConfiguration", "configurationField": "configuration", "description": "If Access Manager is utilized, client will use this authKey in all restricted requests. Default value notice: This [...] + "publishKey": { "index": 8, "kind": "property", "displayName": "Publish Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.pubnub.PubNubConfiguration", "configurationField": "configuration", "description": "The publish key obtained from your PubNub account. Required when publishing messages." }, + "secretKey": { "index": 9, "kind": "property", "displayName": "Secret Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.pubnub.PubNubConfiguration", "configurationField": "configuration", "description": "The secret key used for message signing." }, + "secure": { "index": 10, "kind": "property", "displayName": "Secure", "group": "security", "label": "security", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "configurationClass": "org.apache.camel.component.pubnub.PubNubConfiguration", "configurationField": "configuration", "description": "Use SSL for secure transmission." }, + "subscribeKey": { "index": 11, "kind": "property", "displayName": "Subscribe Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.pubnub.PubNubConfiguration", "configurationField": "configuration", "description": "The subscribe key obtained from your PubNub account. Required when subscribing to channels or listening [...] }, "headers": { "CamelPubNubOperation": { "index": 0, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The operation to perform.", "constantName": "org.apache.camel.component.pubnub.PubNubConstants#OPERATION" }, @@ -53,12 +52,11 @@ "exchangePattern": { "index": 5, "kind": "parameter", "displayName": "Exchange Pattern", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut" ], "deprecated": false, "autowired": false, "secret": false, "description": "Sets the exchange pattern when the consumer creates an exchange." }, "operation": { "index": 6, "kind": "parameter", "displayName": "Operation", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "HERENOW", "GETSTATE", "SETSTATE", "GETHISTORY", "PUBLISH", "FIRE" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.pubnub.PubNubConfiguration", "configurationField": "configuration", "description": "The operation to perform. PUB [...] "lazyStartProducer": { "index": 7, "kind": "parameter", "displayName": "Lazy Start Producer", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a produc [...] - "pubnub": { "index": 8, "kind": "parameter", "displayName": "Pubnub", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "com.pubnub.api.PubNub", "deprecated": false, "deprecationNote": "", "autowired": true, "secret": false, "description": "Reference to a Pubnub client in the registry." }, - "authKey": { "index": 9, "kind": "parameter", "displayName": "Auth Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.pubnub.PubNubConfiguration", "configurationField": "configuration", "description": "If Access Manager is utilized, client will use this authKey in all restricted requests." }, - "cipherKey": { "index": 10, "kind": "parameter", "displayName": "Cipher Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.pubnub.PubNubConfiguration", "configurationField": "configuration", "description": "If cipher is passed, all communications to\/from PubNub will be encrypted." }, - "publishKey": { "index": 11, "kind": "parameter", "displayName": "Publish Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.pubnub.PubNubConfiguration", "configurationField": "configuration", "description": "The publish key obtained from your PubNub account. Required when publishing messages." }, - "secretKey": { "index": 12, "kind": "parameter", "displayName": "Secret Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.pubnub.PubNubConfiguration", "configurationField": "configuration", "description": "The secret key used for message signing." }, - "secure": { "index": 13, "kind": "parameter", "displayName": "Secure", "group": "security", "label": "security", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "configurationClass": "org.apache.camel.component.pubnub.PubNubConfiguration", "configurationField": "configuration", "description": "Use SSL for secure transmission." }, - "subscribeKey": { "index": 14, "kind": "parameter", "displayName": "Subscribe Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.pubnub.PubNubConfiguration", "configurationField": "configuration", "description": "The subscribe key obtained from your PubNub account. Required when subscribing to channels or listenin [...] + "pubnub": { "index": 8, "kind": "parameter", "displayName": "Pubnub", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "com.pubnub.api.java.PubNub", "deprecated": false, "deprecationNote": "", "autowired": true, "secret": false, "description": "Reference to a Pubnub client in the registry." }, + "authKey": { "index": 9, "kind": "parameter", "displayName": "Auth Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": true, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.pubnub.PubNubConfiguration", "configurationField": "configuration", "description": "If Access Manager is utilized, client will use this authKey in all restricted requests. Default value notice: This [...] + "publishKey": { "index": 10, "kind": "parameter", "displayName": "Publish Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.pubnub.PubNubConfiguration", "configurationField": "configuration", "description": "The publish key obtained from your PubNub account. Required when publishing messages." }, + "secretKey": { "index": 11, "kind": "parameter", "displayName": "Secret Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.pubnub.PubNubConfiguration", "configurationField": "configuration", "description": "The secret key used for message signing." }, + "secure": { "index": 12, "kind": "parameter", "displayName": "Secure", "group": "security", "label": "security", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "configurationClass": "org.apache.camel.component.pubnub.PubNubConfiguration", "configurationField": "configuration", "description": "Use SSL for secure transmission." }, + "subscribeKey": { "index": 13, "kind": "parameter", "displayName": "Subscribe Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.pubnub.PubNubConfiguration", "configurationField": "configuration", "description": "The subscribe key obtained from your PubNub account. Required when subscribing to channels or listenin [...] } } diff --git a/components-starter/camel-pubnub-starter/src/main/docs/pubnub.json b/components-starter/camel-pubnub-starter/src/main/docs/pubnub.json index 4047048a7d0..0fba57e57a7 100644 --- a/components-starter/camel-pubnub-starter/src/main/docs/pubnub.json +++ b/components-starter/camel-pubnub-starter/src/main/docs/pubnub.json @@ -13,12 +13,6 @@ } ], "properties": [ - { - "name": "camel.component.pubnub.auth-key", - "type": "java.lang.String", - "description": "If Access Manager is utilized, client will use this authKey in all restricted requests.", - "sourceType": "org.apache.camel.component.pubnub.springboot.PubNubComponentConfiguration" - }, { "name": "camel.component.pubnub.autowired-enabled", "type": "java.lang.Boolean", @@ -33,12 +27,6 @@ "sourceType": "org.apache.camel.component.pubnub.springboot.PubNubComponentConfiguration", "defaultValue": false }, - { - "name": "camel.component.pubnub.cipher-key", - "type": "java.lang.String", - "description": "If cipher is passed, all communications to\/from PubNub will be encrypted.", - "sourceType": "org.apache.camel.component.pubnub.springboot.PubNubComponentConfiguration" - }, { "name": "camel.component.pubnub.configuration", "type": "org.apache.camel.component.pubnub.PubNubConfiguration", @@ -106,6 +94,14 @@ "description": "Also subscribe to related presence information", "sourceType": "org.apache.camel.component.pubnub.springboot.PubNubComponentConfiguration", "defaultValue": false + }, + { + "name": "camel.component.pubnub.auth-key", + "type": "java.lang.String", + "description": "If Access Manager is utilized, client will use this authKey in all restricted requests. Default value notice: This setting is deprecated because it relates to deprecated Access Manager (PAM V2) and will be removed in the future. Please, migrate to new Access Manager (PAM V3) https:\/\/www.pubnub.com\/docs\/general\/resources\/migration-guides\/pam-v3-migration", + "sourceType": "org.apache.camel.component.pubnub.springboot.PubNubComponentConfiguration", + "deprecated": true, + "deprecation": {} } ], "hints": [] diff --git a/components-starter/camel-pubnub-starter/src/main/java/org/apache/camel/component/pubnub/springboot/PubNubComponentConfiguration.java b/components-starter/camel-pubnub-starter/src/main/java/org/apache/camel/component/pubnub/springboot/PubNubComponentConfiguration.java index 23eb323035f..45c56f9eadf 100644 --- a/components-starter/camel-pubnub-starter/src/main/java/org/apache/camel/component/pubnub/springboot/PubNubComponentConfiguration.java +++ b/components-starter/camel-pubnub-starter/src/main/java/org/apache/camel/component/pubnub/springboot/PubNubComponentConfiguration.java @@ -19,6 +19,7 @@ package org.apache.camel.component.pubnub.springboot; import org.apache.camel.component.pubnub.PubNubConfiguration; import org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon; import org.springframework.boot.context.properties.ConfigurationProperties; +import org.springframework.boot.context.properties.DeprecatedConfigurationProperty; /** * Send and receive messages to/from PubNub data stream network for connected @@ -99,13 +100,13 @@ public class PubNubComponentConfiguration private Boolean autowiredEnabled = true; /** * If Access Manager is utilized, client will use this authKey in all - * restricted requests. + * restricted requests. Default value notice: This setting is deprecated + * because it relates to deprecated Access Manager (PAM V2) and will be + * removed in the future. Please, migrate to new Access Manager (PAM V3) + * https://www.pubnub.com/docs/general/resources/migration-guides/pam-v3-migration */ + @Deprecated private String authKey; - /** - * If cipher is passed, all communications to/from PubNub will be encrypted. - */ - private String cipherKey; /** * The publish key obtained from your PubNub account. Required when * publishing messages. @@ -181,22 +182,17 @@ public class PubNubComponentConfiguration this.autowiredEnabled = autowiredEnabled; } + @Deprecated + @DeprecatedConfigurationProperty public String getAuthKey() { return authKey; } + @Deprecated public void setAuthKey(String authKey) { this.authKey = authKey; } - public String getCipherKey() { - return cipherKey; - } - - public void setCipherKey(String cipherKey) { - this.cipherKey = cipherKey; - } - public String getPublishKey() { return publishKey; }