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-kamelets.git
The following commit(s) were added to refs/heads/main by this push:
new 669078445 chore: http-sink and http-source take the login options,
http-secured-* are deprecated (#3162, group 2) (#3168)
669078445 is described below
commit 6690784456bebb9784f2b401a0383f6a6ff6b1f6
Author: Claus Ibsen <[email protected]>
AuthorDate: Tue Nov 17 16:06:54 2026 +0100
chore: http-sink and http-source take the login options, http-secured-* are
deprecated (#3162, group 2) (#3168)
http-sink and http-source get the eight optional login options of their
secured variants (Basic, Digest, NTLM and OAuth 2.0 client credentials),
with
the same names. http-secured-sink and http-secured-source keep working,
unchanged, with the support level Deprecated and a description that points
to
the plain Kamelets. The security model no longer lists http-source and
http-secured-source as sources that open a listener: they poll.
Co-authored-by: Claude Opus 5.5 <[email protected]>
---
docs/modules/ROOT/pages/security-model.adoc | 4 +-
kamelets/http-secured-sink.kamelet.yaml | 6 +-
kamelets/http-secured-source.kamelet.yaml | 6 +-
kamelets/http-sink.kamelet.yaml | 64 +++++++++++++++++++++-
kamelets/http-source.kamelet.yaml | 64 +++++++++++++++++++++-
kamelets/rest-openapi-sink.kamelet.yaml | 2 +-
.../main/resources/META-INF/kamelets-index.json | 18 +++---
.../kamelets/http-secured-sink.kamelet.yaml | 6 +-
.../kamelets/http-secured-source.kamelet.yaml | 6 +-
.../main/resources/kamelets/http-sink.kamelet.yaml | 64 +++++++++++++++++++++-
.../resources/kamelets/http-source.kamelet.yaml | 64 +++++++++++++++++++++-
.../kamelets/rest-openapi-sink.kamelet.yaml | 2 +-
12 files changed, 273 insertions(+), 33 deletions(-)
diff --git a/docs/modules/ROOT/pages/security-model.adoc
b/docs/modules/ROOT/pages/security-model.adoc
index 27b1e83b2..e8c59a323 100644
--- a/docs/modules/ROOT/pages/security-model.adoc
+++ b/docs/modules/ROOT/pages/security-model.adoc
@@ -307,8 +307,8 @@ such, with a reference to this page.
input is operator responsibility - the behaviour is the Kamelet's documented
contract, analogous to Camel's "bean-based dispatch via internal headers is
intentional" limitation.
-* *Network exposure of a source Kamelet.* `webhook-source`, `http-source`,
- `http-secured-source` and similar open a `platform-http` listener. The
catalog
+* *Network exposure of a source Kamelet.* `webhook-source` and similar open a
+ `platform-http` listener. The catalog
does not add authentication except where a Kamelet's name and properties say
it does (`*-secured-*` variants expose auth *options* the operator must
configure). Exposing a source to untrusted networks, or not configuring the
diff --git a/kamelets/http-secured-sink.kamelet.yaml
b/kamelets/http-secured-sink.kamelet.yaml
index bfe8044de..8167666a0 100644
--- a/kamelets/http-secured-sink.kamelet.yaml
+++ b/kamelets/http-secured-sink.kamelet.yaml
@@ -19,7 +19,7 @@ kind: Kamelet
metadata:
name: http-secured-sink
annotations:
- camel.apache.org/kamelet.support.level: "Stable"
+ camel.apache.org/kamelet.support.level: "Deprecated"
camel.apache.org/catalog.version: "4.24.0-SNAPSHOT"
camel.apache.org/kamelet.icon:
"data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI0MjAiCmhlaWdodD0iNDIwIiBzdHJva2U9IiMwMDAiIGZpbGw9Im5vbmUiPgo8cGF0aCBzdHJva2Utd2lkdGg9IjI2IgpkPSJNMjA5LDE1YTE5NSwxOTUgMCAxLDAgMiwweiIvPgo8cGF0aCBzdHJva2Utd2lkdGg9IjE4IgpkPSJtMjEwLDE1djM5MG0xOTUtMTk1SDE1TTU5LDkwYTI2MCwyNjAgMCAwLDAgMzAyLDAgbTAsMjQwIGEyNjAsMjYwIDAgMCwwLTMwMiwwTTE5NSwyMGEyNTAsMjUwIDAgMCwwIDAsMzgyIG0zMC
[...]
camel.apache.org/provider: "Apache Software Foundation"
@@ -31,9 +31,9 @@ spec:
definition:
title: "Secured HTTP Sink"
description: |-
- Sends each message to a web service or REST API as an HTTP or HTTPS
request, logging in with a user and password or with an OAuth 2.0 token.
+ Deprecated, use `http-sink` instead, which has the same login options:
sends each message to a web service or REST API over HTTP or HTTPS, with a
login.
- Use it to push data to a service that needs a login, such as a protected
webhook, an internal REST API, or an API that gives out OAuth 2.0 tokens to
applications. If the service needs no login, use `http-sink` instead.
+ Use it to push data to a service that needs a login, such as a protected
webhook, an internal REST API, or an API that gives out OAuth 2.0 tokens to
applications. This Kamelet will be removed in a later release: `http-sink` now
takes the same options, so change only the name of the Kamelet.
Input: the body is sent as the request body, as text, bytes or a stream.
Turn structured data such as a Map into JSON text first, for example with
`json-serialize-action`. The `Content-Type` header is sent as the content type
of the request, and the other headers of the message, except the Camel ones,
are sent as HTTP headers.
diff --git a/kamelets/http-secured-source.kamelet.yaml
b/kamelets/http-secured-source.kamelet.yaml
index 192c23a59..ed6cea582 100644
--- a/kamelets/http-secured-source.kamelet.yaml
+++ b/kamelets/http-secured-source.kamelet.yaml
@@ -19,7 +19,7 @@ kind: Kamelet
metadata:
name: http-secured-source
annotations:
- camel.apache.org/kamelet.support.level: "Stable"
+ camel.apache.org/kamelet.support.level: "Deprecated"
camel.apache.org/catalog.version: "4.24.0-SNAPSHOT"
camel.apache.org/kamelet.icon:
"data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI0MjAiCmhlaWdodD0iNDIwIiBzdHJva2U9IiMwMDAiIGZpbGw9Im5vbmUiPgo8cGF0aCBzdHJva2Utd2lkdGg9IjI2IgpkPSJNMjA5LDE1YTE5NSwxOTUgMCAxLDAgMiwweiIvPgo8cGF0aCBzdHJva2Utd2lkdGg9IjE4IgpkPSJtMjEwLDE1djM5MG0xOTUtMTk1SDE1TTU5LDkwYTI2MCwyNjAgMCAwLDAgMzAyLDAgbTAsMjQwIGEyNjAsMjYwIDAgMCwwLTMwMiwwTTE5NSwyMGEyNTAsMjUwIDAgMCwwIDAsMzgyIG0zMC
[...]
camel.apache.org/provider: "Apache Software Foundation"
@@ -31,9 +31,9 @@ spec:
definition:
title: "HTTP Secured Source"
description: |-
- Fetches a web address with an HTTP GET request at a regular interval,
logging in with a user and password or with an OAuth 2.0 token, and sends each
response as a message.
+ Deprecated, use `http-source` instead, which has the same login options:
fetches a web address at a regular interval with a login, one message per
response.
- Use it to poll a protected REST API or feed for its current data, for
example fetch the state of the orders every minute. If the address needs no
login, use `http-source`. To receive the requests that other systems send
instead, use `webhook-source`.
+ Use it to poll a protected REST API or feed for its current data, for
example fetch the state of the orders every minute. This Kamelet will be
removed in a later release: `http-source` now takes the same options, so change
only the name of the Kamelet. To receive the requests that other systems send
instead, use `webhook-source`.
Output: the body is the body of the response, as bytes. The headers of
the response, such as `Content-Type`, are copied to the message, and
`CamelHttpResponseCode` holds the status code.
diff --git a/kamelets/http-sink.kamelet.yaml b/kamelets/http-sink.kamelet.yaml
index ad61dc7e2..742fcb171 100644
--- a/kamelets/http-sink.kamelet.yaml
+++ b/kamelets/http-sink.kamelet.yaml
@@ -33,13 +33,13 @@ spec:
description: |-
Sends each message to a web service or REST API as an HTTP or HTTPS
request, for example a POST of JSON to a webhook.
- Use it to push data to any service that accepts HTTP calls, such as a
webhook, a REST API or a serverless function. If the service needs a login
(Basic or OAuth), use `http-secured-sink` instead.
+ Use it to push data to any service that accepts HTTP calls, such as a
webhook, a REST API or a serverless function.
Input: the body is sent as the request body, as text, bytes or a stream.
Turn structured data such as a Map into JSON text first, for example with
`json-serialize-action`. The `Content-Type` header is sent as the content type
of the request, and the other headers of the message, except the Camel ones,
are sent as HTTP headers.
Output: when it is used inside a route, the body afterwards is the
response of the service.
- Good to know: a response with a status code of 300 or higher fails the
message. The address and the method come only from the options; headers on the
message cannot change where it is sent.
+ Good to know: a response with a status code of 300 or higher fails the
message. The address and the method come only from the options; headers on the
message cannot change where it is sent. Log in either with `authUsername` and
`authPassword`, or with `oauth2ClientId`, `oauth2ClientSecret` and
`oauth2TokenEndpoint`: the Kamelet then gets a token from that URL and sends it
as a Bearer token. Without `authenticationPreemptive`, the user and password
are sent only after the service as [...]
required:
- url
type: object
@@ -56,6 +56,57 @@ spec:
type: string
default: POST
enum: ["GET", "POST", "PUT", "DELETE", "HEAD", "OPTIONS", "TRACE",
"PATCH"]
+ authMethod:
+ title: Authentication Method
+ description: The login methods to allow when the service asks for a
login, as a comma-separated list of `Basic`, `Digest` and `NTLM`. Basic login
with `authUsername` and `authPassword` works without it.
+ type: string
+ example: Basic
+ authenticationPreemptive:
+ title: Authentication Preemptive
+ description: If true, `authUsername` and `authPassword` are sent with
Basic login on the first request. If false, they are sent only after the
service answers 401 and asks for them, which takes a second request.
+ type: boolean
+ default: false
+ authUsername:
+ title: Authentication Username
+ description: The user to log in as, together with `authPassword`.
+ type: string
+ x-descriptors:
+ - urn:camel:group:credentials
+ authPassword:
+ title: Authentication Password
+ description: The password of `authUsername`.
+ type: string
+ format: password
+ x-descriptors:
+ - urn:camel:group:credentials
+ oauth2ClientId:
+ title: OAuth2 Client ID
+ description: The client ID of the application, as registered with the
OAuth 2.0 provider. With `oauth2ClientSecret`, it is used to get a token from
`oauth2TokenEndpoint` (client credentials grant).
+ type: string
+ format: password
+ x-descriptors:
+ - urn:camel:group:credentials
+ oauth2ClientSecret:
+ title: OAuth2 Client Secret
+ description: The client secret of the application, as given by the
OAuth 2.0 provider.
+ type: string
+ format: password
+ x-descriptors:
+ - urn:camel:group:credentials
+ oauth2TokenEndpoint:
+ title: OAuth2 Token URL
+ description: The URL to get the tokens from, as given by the OAuth 2.0
provider. The Kamelet logs in to it with `oauth2ClientId` and
`oauth2ClientSecret`.
+ type: string
+ example: https://login.example.com/oauth2/token
+ x-descriptors:
+ - urn:camel:group:credentials
+ oauth2Scope:
+ title: OAuth2 Scope
+ description: The scope to ask for in the token request, when the OAuth
2.0 provider needs one.
+ type: string
+ example: orders.write
+ x-descriptors:
+ - urn:camel:group:credentials
dependencies:
- "camel:http"
- "camel:kamelet"
@@ -82,3 +133,12 @@ spec:
expression: "{{method}}"
- to:
uri: "{{url}}"
+ parameters:
+ authMethod: "{{?authMethod}}"
+ authUsername: "{{?authUsername}}"
+ authPassword: "{{?authPassword}}"
+ oauth2ClientId: "{{?oauth2ClientId}}"
+ oauth2ClientSecret: "{{?oauth2ClientSecret}}"
+ oauth2Scope: "{{?oauth2Scope}}"
+ oauth2TokenEndpoint: "{{?oauth2TokenEndpoint}}"
+ authenticationPreemptive: "{{authenticationPreemptive}}"
diff --git a/kamelets/http-source.kamelet.yaml
b/kamelets/http-source.kamelet.yaml
index dd236b0d8..82379d633 100644
--- a/kamelets/http-source.kamelet.yaml
+++ b/kamelets/http-source.kamelet.yaml
@@ -33,11 +33,11 @@ spec:
description: |-
Fetches a web address with an HTTP GET request at a regular interval,
and sends each response as a message.
- Use it to poll a REST API, a feed or a status page for its current data,
for example fetch the state of the orders every minute. If the address needs a
login, use `http-secured-source`. To receive the requests that other systems
send instead, use `webhook-source`.
+ Use it to poll a REST API, a feed or a status page for its current data,
for example fetch the state of the orders every minute. To receive the requests
that other systems send instead, use `webhook-source`.
Output: the body is the body of the response, as bytes. The headers of
the response, such as `Content-Type`, are copied to the message, and
`CamelHttpResponseCode` holds the status code.
- Good to know: it fetches the address every `period` and sends a message
for each response, even when the data has not changed. A response with a status
code of 300 or higher sends no message: the error is logged, and the address is
fetched again at the next period.
+ Good to know: it fetches the address every `period` and sends a message
for each response, even when the data has not changed. A response with a status
code of 300 or higher sends no message: the error is logged, and the address is
fetched again at the next period. Log in either with `authUsername` and
`authPassword`, or with `oauth2ClientId`, `oauth2ClientSecret` and
`oauth2TokenEndpoint`: the Kamelet then gets a token from that URL and sends it
as a Bearer token.
required:
- url
type: object
@@ -60,6 +60,57 @@ spec:
type: string
example: "https://api.example.com/v1/orders/status"
pattern: "^(http|https)://.*"
+ authMethod:
+ title: Authentication Method
+ description: The login methods to allow when the service asks for a
login, as a comma-separated list of `Basic`, `Digest` and `NTLM`. Basic login
with `authUsername` and `authPassword` works without it.
+ type: string
+ example: Basic
+ authenticationPreemptive:
+ title: Authentication Preemptive
+ description: If true, `authUsername` and `authPassword` are sent with
Basic login on the first request. If false, they are sent only after the
service answers 401 and asks for them, which takes a second request.
+ type: boolean
+ default: false
+ authUsername:
+ title: Authentication Username
+ description: The user to log in as, together with `authPassword`.
+ type: string
+ x-descriptors:
+ - urn:camel:group:credentials
+ authPassword:
+ title: Authentication Password
+ description: The password of `authUsername`.
+ type: string
+ format: password
+ x-descriptors:
+ - urn:camel:group:credentials
+ oauth2ClientId:
+ title: OAuth2 Client ID
+ description: The client ID of the application, as registered with the
OAuth 2.0 provider. With `oauth2ClientSecret`, it is used to get a token from
`oauth2TokenEndpoint` (client credentials grant).
+ type: string
+ format: password
+ x-descriptors:
+ - urn:camel:group:credentials
+ oauth2ClientSecret:
+ title: OAuth2 Client Secret
+ description: The client secret of the application, as given by the
OAuth 2.0 provider.
+ type: string
+ format: password
+ x-descriptors:
+ - urn:camel:group:credentials
+ oauth2TokenEndpoint:
+ title: OAuth2 Token URL
+ description: The URL to get the tokens from, as given by the OAuth 2.0
provider. The Kamelet logs in to it with `oauth2ClientId` and
`oauth2ClientSecret`.
+ type: string
+ example: https://login.example.com/oauth2/token
+ x-descriptors:
+ - urn:camel:group:credentials
+ oauth2Scope:
+ title: OAuth2 Scope
+ description: The scope to ask for in the token request, when the OAuth
2.0 provider needs one.
+ type: string
+ example: orders.write
+ x-descriptors:
+ - urn:camel:group:credentials
dataTypes:
out:
headers:
@@ -89,5 +140,14 @@ spec:
expression: "{{contentType}}"
- to:
uri: "{{url}}"
+ parameters:
+ authMethod: "{{?authMethod}}"
+ authUsername: "{{?authUsername}}"
+ authPassword: "{{?authPassword}}"
+ oauth2ClientId: "{{?oauth2ClientId}}"
+ oauth2ClientSecret: "{{?oauth2ClientSecret}}"
+ oauth2Scope: "{{?oauth2Scope}}"
+ oauth2TokenEndpoint: "{{?oauth2TokenEndpoint}}"
+ authenticationPreemptive: "{{authenticationPreemptive}}"
- to:
uri: kamelet:sink
diff --git a/kamelets/rest-openapi-sink.kamelet.yaml
b/kamelets/rest-openapi-sink.kamelet.yaml
index 97c122f18..41834f0c7 100644
--- a/kamelets/rest-openapi-sink.kamelet.yaml
+++ b/kamelets/rest-openapi-sink.kamelet.yaml
@@ -33,7 +33,7 @@ spec:
description: |-
Calls one operation of a REST API for each message, building the request
(method, path, parameters and content type) from the OpenAPI specification of
the API.
- Use it to call an API that publishes an OpenAPI (Swagger) document
without writing its URLs by hand, for example to create a customer or look up
an order in a service of your company. For a call to a fixed URL, use
`http-sink`, or `http-secured-sink` when the service needs a login.
+ Use it to call an API that publishes an OpenAPI (Swagger) document
without writing its URLs by hand, for example to create a customer or look up
an order in a service of your company. For a call to a fixed URL, use
`http-sink`.
Input: the body is the request body, such as JSON text, and is sent with
the content type the specification gives for the operation. The path and query
parameters of the operation come from headers of the same name: for
`/pets/\{petId}`, set the `petId` header. The other headers of the message,
except the Camel ones, are sent as HTTP headers.
diff --git
a/library/camel-kamelets/src/main/resources/META-INF/kamelets-index.json
b/library/camel-kamelets/src/main/resources/META-INF/kamelets-index.json
index 6b3e440d3..775edce4a 100644
--- a/library/camel-kamelets/src/main/resources/META-INF/kamelets-index.json
+++ b/library/camel-kamelets/src/main/resources/META-INF/kamelets-index.json
@@ -1022,20 +1022,20 @@
}, {
"name" : "http-secured-sink",
"type" : "sink",
- "supportLevel" : "Stable",
+ "supportLevel" : "Deprecated",
"title" : "Secured HTTP Sink",
- "summary" : "Sends each message to a web service or REST API as an HTTP or
HTTPS request, logging in with a user and password or with an OAuth 2.0 token.",
- "description" : "Sends each message to a web service or REST API as an
HTTP or HTTPS request, logging in with a user and password or with an OAuth 2.0
token.\n\nUse it to push data to a service that needs a login, such as a
protected webhook, an internal REST API, or an API that gives out OAuth 2.0
tokens to applications. If the service needs no login, use `http-sink`
instead.\n\nInput: the body is sent as the request body, as text, bytes or a
stream. Turn structured data such as a M [...]
+ "summary" : "Deprecated, use `http-sink` instead, which has the same login
options: sends each message to a web service or REST API over HTTP or HTTPS,
with a login.",
+ "description" : "Deprecated, use `http-sink` instead, which has the same
login options: sends each message to a web service or REST API over HTTP or
HTTPS, with a login.\n\nUse it to push data to a service that needs a login,
such as a protected webhook, an internal REST API, or an API that gives out
OAuth 2.0 tokens to applications. This Kamelet will be removed in a later
release: `http-sink` now takes the same options, so change only the name of the
Kamelet.\n\nInput: the body is s [...]
"group" : "HTTP",
"namespace" : "HTTP",
"provider" : "Apache Software Foundation"
}, {
"name" : "http-secured-source",
"type" : "source",
- "supportLevel" : "Stable",
+ "supportLevel" : "Deprecated",
"title" : "HTTP Secured Source",
- "summary" : "Fetches a web address with an HTTP GET request at a regular
interval, logging in with a user and password or with an OAuth 2.0 token, and
sends each response as a message.",
- "description" : "Fetches a web address with an HTTP GET request at a
regular interval, logging in with a user and password or with an OAuth 2.0
token, and sends each response as a message.\n\nUse it to poll a protected REST
API or feed for its current data, for example fetch the state of the orders
every minute. If the address needs no login, use `http-source`. To receive the
requests that other systems send instead, use `webhook-source`.\n\nOutput: the
body is the body of the respon [...]
+ "summary" : "Deprecated, use `http-source` instead, which has the same
login options: fetches a web address at a regular interval with a login, one
message per response.",
+ "description" : "Deprecated, use `http-source` instead, which has the same
login options: fetches a web address at a regular interval with a login, one
message per response.\n\nUse it to poll a protected REST API or feed for its
current data, for example fetch the state of the orders every minute. This
Kamelet will be removed in a later release: `http-source` now takes the same
options, so change only the name of the Kamelet. To receive the requests that
other systems send instead, u [...]
"group" : "HTTP",
"namespace" : "HTTP",
"provider" : "Apache Software Foundation"
@@ -1045,7 +1045,7 @@
"supportLevel" : "Stable",
"title" : "HTTP Sink",
"summary" : "Sends each message to a web service or REST API as an HTTP or
HTTPS request, for example a POST of JSON to a webhook.",
- "description" : "Sends each message to a web service or REST API as an
HTTP or HTTPS request, for example a POST of JSON to a webhook.\n\nUse it to
push data to any service that accepts HTTP calls, such as a webhook, a REST API
or a serverless function. If the service needs a login (Basic or OAuth), use
`http-secured-sink` instead.\n\nInput: the body is sent as the request body, as
text, bytes or a stream. Turn structured data such as a Map into JSON text
first, for example with `jso [...]
+ "description" : "Sends each message to a web service or REST API as an
HTTP or HTTPS request, for example a POST of JSON to a webhook.\n\nUse it to
push data to any service that accepts HTTP calls, such as a webhook, a REST API
or a serverless function.\n\nInput: the body is sent as the request body, as
text, bytes or a stream. Turn structured data such as a Map into JSON text
first, for example with `json-serialize-action`. The `Content-Type` header is
sent as the content type of th [...]
"group" : "HTTP",
"namespace" : "HTTP",
"provider" : "Apache Software Foundation"
@@ -1055,7 +1055,7 @@
"supportLevel" : "Stable",
"title" : "HTTP Source",
"summary" : "Fetches a web address with an HTTP GET request at a regular
interval, and sends each response as a message.",
- "description" : "Fetches a web address with an HTTP GET request at a
regular interval, and sends each response as a message.\n\nUse it to poll a
REST API, a feed or a status page for its current data, for example fetch the
state of the orders every minute. If the address needs a login, use
`http-secured-source`. To receive the requests that other systems send instead,
use `webhook-source`.\n\nOutput: the body is the body of the response, as
bytes. The headers of the response, such as [...]
+ "description" : "Fetches a web address with an HTTP GET request at a
regular interval, and sends each response as a message.\n\nUse it to poll a
REST API, a feed or a status page for its current data, for example fetch the
state of the orders every minute. To receive the requests that other systems
send instead, use `webhook-source`.\n\nOutput: the body is the body of the
response, as bytes. The headers of the response, such as `Content-Type`, are
copied to the message, and `CamelHtt [...]
"group" : "HTTP",
"namespace" : "HTTP",
"provider" : "Apache Software Foundation"
@@ -1925,7 +1925,7 @@
"supportLevel" : "Stable",
"title" : "REST OpenAPI Sink",
"summary" : "Calls one operation of a REST API for each message, building
the request (method, path, parameters and content type) from the OpenAPI
specification of the API.",
- "description" : "Calls one operation of a REST API for each message,
building the request (method, path, parameters and content type) from the
OpenAPI specification of the API.\n\nUse it to call an API that publishes an
OpenAPI (Swagger) document without writing its URLs by hand, for example to
create a customer or look up an order in a service of your company. For a call
to a fixed URL, use `http-sink`, or `http-secured-sink` when the service needs
a login.\n\nInput: the body is the [...]
+ "description" : "Calls one operation of a REST API for each message,
building the request (method, path, parameters and content type) from the
OpenAPI specification of the API.\n\nUse it to call an API that publishes an
OpenAPI (Swagger) document without writing its URLs by hand, for example to
create a customer or look up an order in a service of your company. For a call
to a fixed URL, use `http-sink`.\n\nInput: the body is the request body, such
as JSON text, and is sent with the [...]
"group" : "HTTP",
"namespace" : "HTTP",
"provider" : "Apache Software Foundation"
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/http-secured-sink.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/http-secured-sink.kamelet.yaml
index bfe8044de..8167666a0 100644
---
a/library/camel-kamelets/src/main/resources/kamelets/http-secured-sink.kamelet.yaml
+++
b/library/camel-kamelets/src/main/resources/kamelets/http-secured-sink.kamelet.yaml
@@ -19,7 +19,7 @@ kind: Kamelet
metadata:
name: http-secured-sink
annotations:
- camel.apache.org/kamelet.support.level: "Stable"
+ camel.apache.org/kamelet.support.level: "Deprecated"
camel.apache.org/catalog.version: "4.24.0-SNAPSHOT"
camel.apache.org/kamelet.icon:
"data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI0MjAiCmhlaWdodD0iNDIwIiBzdHJva2U9IiMwMDAiIGZpbGw9Im5vbmUiPgo8cGF0aCBzdHJva2Utd2lkdGg9IjI2IgpkPSJNMjA5LDE1YTE5NSwxOTUgMCAxLDAgMiwweiIvPgo8cGF0aCBzdHJva2Utd2lkdGg9IjE4IgpkPSJtMjEwLDE1djM5MG0xOTUtMTk1SDE1TTU5LDkwYTI2MCwyNjAgMCAwLDAgMzAyLDAgbTAsMjQwIGEyNjAsMjYwIDAgMCwwLTMwMiwwTTE5NSwyMGEyNTAsMjUwIDAgMCwwIDAsMzgyIG0zMC
[...]
camel.apache.org/provider: "Apache Software Foundation"
@@ -31,9 +31,9 @@ spec:
definition:
title: "Secured HTTP Sink"
description: |-
- Sends each message to a web service or REST API as an HTTP or HTTPS
request, logging in with a user and password or with an OAuth 2.0 token.
+ Deprecated, use `http-sink` instead, which has the same login options:
sends each message to a web service or REST API over HTTP or HTTPS, with a
login.
- Use it to push data to a service that needs a login, such as a protected
webhook, an internal REST API, or an API that gives out OAuth 2.0 tokens to
applications. If the service needs no login, use `http-sink` instead.
+ Use it to push data to a service that needs a login, such as a protected
webhook, an internal REST API, or an API that gives out OAuth 2.0 tokens to
applications. This Kamelet will be removed in a later release: `http-sink` now
takes the same options, so change only the name of the Kamelet.
Input: the body is sent as the request body, as text, bytes or a stream.
Turn structured data such as a Map into JSON text first, for example with
`json-serialize-action`. The `Content-Type` header is sent as the content type
of the request, and the other headers of the message, except the Camel ones,
are sent as HTTP headers.
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/http-secured-source.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/http-secured-source.kamelet.yaml
index 192c23a59..ed6cea582 100644
---
a/library/camel-kamelets/src/main/resources/kamelets/http-secured-source.kamelet.yaml
+++
b/library/camel-kamelets/src/main/resources/kamelets/http-secured-source.kamelet.yaml
@@ -19,7 +19,7 @@ kind: Kamelet
metadata:
name: http-secured-source
annotations:
- camel.apache.org/kamelet.support.level: "Stable"
+ camel.apache.org/kamelet.support.level: "Deprecated"
camel.apache.org/catalog.version: "4.24.0-SNAPSHOT"
camel.apache.org/kamelet.icon:
"data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI0MjAiCmhlaWdodD0iNDIwIiBzdHJva2U9IiMwMDAiIGZpbGw9Im5vbmUiPgo8cGF0aCBzdHJva2Utd2lkdGg9IjI2IgpkPSJNMjA5LDE1YTE5NSwxOTUgMCAxLDAgMiwweiIvPgo8cGF0aCBzdHJva2Utd2lkdGg9IjE4IgpkPSJtMjEwLDE1djM5MG0xOTUtMTk1SDE1TTU5LDkwYTI2MCwyNjAgMCAwLDAgMzAyLDAgbTAsMjQwIGEyNjAsMjYwIDAgMCwwLTMwMiwwTTE5NSwyMGEyNTAsMjUwIDAgMCwwIDAsMzgyIG0zMC
[...]
camel.apache.org/provider: "Apache Software Foundation"
@@ -31,9 +31,9 @@ spec:
definition:
title: "HTTP Secured Source"
description: |-
- Fetches a web address with an HTTP GET request at a regular interval,
logging in with a user and password or with an OAuth 2.0 token, and sends each
response as a message.
+ Deprecated, use `http-source` instead, which has the same login options:
fetches a web address at a regular interval with a login, one message per
response.
- Use it to poll a protected REST API or feed for its current data, for
example fetch the state of the orders every minute. If the address needs no
login, use `http-source`. To receive the requests that other systems send
instead, use `webhook-source`.
+ Use it to poll a protected REST API or feed for its current data, for
example fetch the state of the orders every minute. This Kamelet will be
removed in a later release: `http-source` now takes the same options, so change
only the name of the Kamelet. To receive the requests that other systems send
instead, use `webhook-source`.
Output: the body is the body of the response, as bytes. The headers of
the response, such as `Content-Type`, are copied to the message, and
`CamelHttpResponseCode` holds the status code.
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/http-sink.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/http-sink.kamelet.yaml
index ad61dc7e2..742fcb171 100644
--- a/library/camel-kamelets/src/main/resources/kamelets/http-sink.kamelet.yaml
+++ b/library/camel-kamelets/src/main/resources/kamelets/http-sink.kamelet.yaml
@@ -33,13 +33,13 @@ spec:
description: |-
Sends each message to a web service or REST API as an HTTP or HTTPS
request, for example a POST of JSON to a webhook.
- Use it to push data to any service that accepts HTTP calls, such as a
webhook, a REST API or a serverless function. If the service needs a login
(Basic or OAuth), use `http-secured-sink` instead.
+ Use it to push data to any service that accepts HTTP calls, such as a
webhook, a REST API or a serverless function.
Input: the body is sent as the request body, as text, bytes or a stream.
Turn structured data such as a Map into JSON text first, for example with
`json-serialize-action`. The `Content-Type` header is sent as the content type
of the request, and the other headers of the message, except the Camel ones,
are sent as HTTP headers.
Output: when it is used inside a route, the body afterwards is the
response of the service.
- Good to know: a response with a status code of 300 or higher fails the
message. The address and the method come only from the options; headers on the
message cannot change where it is sent.
+ Good to know: a response with a status code of 300 or higher fails the
message. The address and the method come only from the options; headers on the
message cannot change where it is sent. Log in either with `authUsername` and
`authPassword`, or with `oauth2ClientId`, `oauth2ClientSecret` and
`oauth2TokenEndpoint`: the Kamelet then gets a token from that URL and sends it
as a Bearer token. Without `authenticationPreemptive`, the user and password
are sent only after the service as [...]
required:
- url
type: object
@@ -56,6 +56,57 @@ spec:
type: string
default: POST
enum: ["GET", "POST", "PUT", "DELETE", "HEAD", "OPTIONS", "TRACE",
"PATCH"]
+ authMethod:
+ title: Authentication Method
+ description: The login methods to allow when the service asks for a
login, as a comma-separated list of `Basic`, `Digest` and `NTLM`. Basic login
with `authUsername` and `authPassword` works without it.
+ type: string
+ example: Basic
+ authenticationPreemptive:
+ title: Authentication Preemptive
+ description: If true, `authUsername` and `authPassword` are sent with
Basic login on the first request. If false, they are sent only after the
service answers 401 and asks for them, which takes a second request.
+ type: boolean
+ default: false
+ authUsername:
+ title: Authentication Username
+ description: The user to log in as, together with `authPassword`.
+ type: string
+ x-descriptors:
+ - urn:camel:group:credentials
+ authPassword:
+ title: Authentication Password
+ description: The password of `authUsername`.
+ type: string
+ format: password
+ x-descriptors:
+ - urn:camel:group:credentials
+ oauth2ClientId:
+ title: OAuth2 Client ID
+ description: The client ID of the application, as registered with the
OAuth 2.0 provider. With `oauth2ClientSecret`, it is used to get a token from
`oauth2TokenEndpoint` (client credentials grant).
+ type: string
+ format: password
+ x-descriptors:
+ - urn:camel:group:credentials
+ oauth2ClientSecret:
+ title: OAuth2 Client Secret
+ description: The client secret of the application, as given by the
OAuth 2.0 provider.
+ type: string
+ format: password
+ x-descriptors:
+ - urn:camel:group:credentials
+ oauth2TokenEndpoint:
+ title: OAuth2 Token URL
+ description: The URL to get the tokens from, as given by the OAuth 2.0
provider. The Kamelet logs in to it with `oauth2ClientId` and
`oauth2ClientSecret`.
+ type: string
+ example: https://login.example.com/oauth2/token
+ x-descriptors:
+ - urn:camel:group:credentials
+ oauth2Scope:
+ title: OAuth2 Scope
+ description: The scope to ask for in the token request, when the OAuth
2.0 provider needs one.
+ type: string
+ example: orders.write
+ x-descriptors:
+ - urn:camel:group:credentials
dependencies:
- "camel:http"
- "camel:kamelet"
@@ -82,3 +133,12 @@ spec:
expression: "{{method}}"
- to:
uri: "{{url}}"
+ parameters:
+ authMethod: "{{?authMethod}}"
+ authUsername: "{{?authUsername}}"
+ authPassword: "{{?authPassword}}"
+ oauth2ClientId: "{{?oauth2ClientId}}"
+ oauth2ClientSecret: "{{?oauth2ClientSecret}}"
+ oauth2Scope: "{{?oauth2Scope}}"
+ oauth2TokenEndpoint: "{{?oauth2TokenEndpoint}}"
+ authenticationPreemptive: "{{authenticationPreemptive}}"
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/http-source.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/http-source.kamelet.yaml
index dd236b0d8..82379d633 100644
---
a/library/camel-kamelets/src/main/resources/kamelets/http-source.kamelet.yaml
+++
b/library/camel-kamelets/src/main/resources/kamelets/http-source.kamelet.yaml
@@ -33,11 +33,11 @@ spec:
description: |-
Fetches a web address with an HTTP GET request at a regular interval,
and sends each response as a message.
- Use it to poll a REST API, a feed or a status page for its current data,
for example fetch the state of the orders every minute. If the address needs a
login, use `http-secured-source`. To receive the requests that other systems
send instead, use `webhook-source`.
+ Use it to poll a REST API, a feed or a status page for its current data,
for example fetch the state of the orders every minute. To receive the requests
that other systems send instead, use `webhook-source`.
Output: the body is the body of the response, as bytes. The headers of
the response, such as `Content-Type`, are copied to the message, and
`CamelHttpResponseCode` holds the status code.
- Good to know: it fetches the address every `period` and sends a message
for each response, even when the data has not changed. A response with a status
code of 300 or higher sends no message: the error is logged, and the address is
fetched again at the next period.
+ Good to know: it fetches the address every `period` and sends a message
for each response, even when the data has not changed. A response with a status
code of 300 or higher sends no message: the error is logged, and the address is
fetched again at the next period. Log in either with `authUsername` and
`authPassword`, or with `oauth2ClientId`, `oauth2ClientSecret` and
`oauth2TokenEndpoint`: the Kamelet then gets a token from that URL and sends it
as a Bearer token.
required:
- url
type: object
@@ -60,6 +60,57 @@ spec:
type: string
example: "https://api.example.com/v1/orders/status"
pattern: "^(http|https)://.*"
+ authMethod:
+ title: Authentication Method
+ description: The login methods to allow when the service asks for a
login, as a comma-separated list of `Basic`, `Digest` and `NTLM`. Basic login
with `authUsername` and `authPassword` works without it.
+ type: string
+ example: Basic
+ authenticationPreemptive:
+ title: Authentication Preemptive
+ description: If true, `authUsername` and `authPassword` are sent with
Basic login on the first request. If false, they are sent only after the
service answers 401 and asks for them, which takes a second request.
+ type: boolean
+ default: false
+ authUsername:
+ title: Authentication Username
+ description: The user to log in as, together with `authPassword`.
+ type: string
+ x-descriptors:
+ - urn:camel:group:credentials
+ authPassword:
+ title: Authentication Password
+ description: The password of `authUsername`.
+ type: string
+ format: password
+ x-descriptors:
+ - urn:camel:group:credentials
+ oauth2ClientId:
+ title: OAuth2 Client ID
+ description: The client ID of the application, as registered with the
OAuth 2.0 provider. With `oauth2ClientSecret`, it is used to get a token from
`oauth2TokenEndpoint` (client credentials grant).
+ type: string
+ format: password
+ x-descriptors:
+ - urn:camel:group:credentials
+ oauth2ClientSecret:
+ title: OAuth2 Client Secret
+ description: The client secret of the application, as given by the
OAuth 2.0 provider.
+ type: string
+ format: password
+ x-descriptors:
+ - urn:camel:group:credentials
+ oauth2TokenEndpoint:
+ title: OAuth2 Token URL
+ description: The URL to get the tokens from, as given by the OAuth 2.0
provider. The Kamelet logs in to it with `oauth2ClientId` and
`oauth2ClientSecret`.
+ type: string
+ example: https://login.example.com/oauth2/token
+ x-descriptors:
+ - urn:camel:group:credentials
+ oauth2Scope:
+ title: OAuth2 Scope
+ description: The scope to ask for in the token request, when the OAuth
2.0 provider needs one.
+ type: string
+ example: orders.write
+ x-descriptors:
+ - urn:camel:group:credentials
dataTypes:
out:
headers:
@@ -89,5 +140,14 @@ spec:
expression: "{{contentType}}"
- to:
uri: "{{url}}"
+ parameters:
+ authMethod: "{{?authMethod}}"
+ authUsername: "{{?authUsername}}"
+ authPassword: "{{?authPassword}}"
+ oauth2ClientId: "{{?oauth2ClientId}}"
+ oauth2ClientSecret: "{{?oauth2ClientSecret}}"
+ oauth2Scope: "{{?oauth2Scope}}"
+ oauth2TokenEndpoint: "{{?oauth2TokenEndpoint}}"
+ authenticationPreemptive: "{{authenticationPreemptive}}"
- to:
uri: kamelet:sink
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/rest-openapi-sink.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/rest-openapi-sink.kamelet.yaml
index 97c122f18..41834f0c7 100644
---
a/library/camel-kamelets/src/main/resources/kamelets/rest-openapi-sink.kamelet.yaml
+++
b/library/camel-kamelets/src/main/resources/kamelets/rest-openapi-sink.kamelet.yaml
@@ -33,7 +33,7 @@ spec:
description: |-
Calls one operation of a REST API for each message, building the request
(method, path, parameters and content type) from the OpenAPI specification of
the API.
- Use it to call an API that publishes an OpenAPI (Swagger) document
without writing its URLs by hand, for example to create a customer or look up
an order in a service of your company. For a call to a fixed URL, use
`http-sink`, or `http-secured-sink` when the service needs a login.
+ Use it to call an API that publishes an OpenAPI (Swagger) document
without writing its URLs by hand, for example to create a customer or look up
an order in a service of your company. For a call to a fixed URL, use
`http-sink`.
Input: the body is the request body, such as JSON text, and is sent with
the content type the specification gives for the operation. The path and query
parameters of the operation come from headers of the same name: for
`/pets/\{petId}`, set the `petId` header. The other headers of the message,
except the Camel ones, are sent as HTTP headers.