This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
commit eeb9a595fdccaedd79aa10c76bc64c94cc0fd510
Author: Claus Ibsen <claus.ib...@gmail.com>
AuthorDate: Wed Jun 5 12:14:23 2019 +0200
Regen
---
.../camel-jetty/src/main/docs/jetty-component.adoc | 4 +-
.../camel-rest/src/main/docs/rest-component.adoc | 6 +-
.../modules/ROOT/pages/jetty-component.adoc | 189 ++++-----------------
.../modules/ROOT/pages/mongodb3-component.adoc | 62 +++++--
.../modules/ROOT/pages/rest-api-component.adoc | 2 +-
.../modules/ROOT/pages/rest-component.adoc | 17 +-
6 files changed, 98 insertions(+), 182 deletions(-)
diff --git a/components/camel-jetty/src/main/docs/jetty-component.adoc
b/components/camel-jetty/src/main/docs/jetty-component.adoc
index 0371910..5b4cac1 100644
--- a/components/camel-jetty/src/main/docs/jetty-component.adoc
+++ b/components/camel-jetty/src/main/docs/jetty-component.adoc
@@ -120,7 +120,7 @@ with the following path and query parameters:
|===
-==== Query Parameters (35 parameters):
+==== Query Parameters (33 parameters):
[width="100%",cols="2,5,^1,2",options="header"]
@@ -150,9 +150,7 @@ with the following path and query parameters:
| *filterInitParameters* (consumer) | Configuration of the filter init
parameters. These parameters will be applied to the filter list before starting
the jetty server. | | Map
| *filtersRef* (consumer) | Allows using a custom filters which is putted into
a list and can be find in the Registry. Multiple values can be separated by
comma. | | String
| *handlers* (consumer) | Specifies a comma-delimited set of Handler instances
to lookup in your Registry. These handlers are added to the Jetty servlet
context (for example, to add security). Important: You can not use different
handlers with different Jetty endpoints using the same port number. The
handlers is associated to the port number. If you need different handlers, then
use different port numbers. | | String
-| *httpBindingRef* (consumer) | *Deprecated* Option to disable throwing the
HttpOperationFailedException in case of failed responses from the remote
server. This allows you to get all responses regardless of the HTTP status
code. | | String
| *multipartFilter* (consumer) | Allows using a custom multipart filter. Note:
setting multipartFilterRef forces the value of enableMultipartFilter to true. |
| Filter
-| *multipartFilterRef* (consumer) | *Deprecated* Allows using a custom
multipart filter. Note: setting multipartFilterRef forces the value of
enableMultipartFilter to true. | | String
| *optionsEnabled* (consumer) | Specifies whether to enable HTTP OPTIONS for
this Servlet consumer. By default OPTIONS is turned off. | false | boolean
| *traceEnabled* (consumer) | Specifies whether to enable HTTP TRACE for this
Servlet consumer. By default TRACE is turned off. | false | boolean
| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic
property binding (Camel 2.x) or the newer property binding with additional
capabilities | false | boolean
diff --git a/components/camel-rest/src/main/docs/rest-component.adoc
b/components/camel-rest/src/main/docs/rest-component.adoc
index 675d43f..8811b64 100644
--- a/components/camel-rest/src/main/docs/rest-component.adoc
+++ b/components/camel-rest/src/main/docs/rest-component.adoc
@@ -99,7 +99,7 @@ When using Spring Boot make sure to use the following Maven
dependency to have s
----
-The component supports 6 options, which are listed below.
+The component supports 8 options, which are listed below.
@@ -108,10 +108,12 @@ The component supports 6 options, which are listed below.
| Name | Description | Default | Type
| *camel.component.rest.api-doc* | The swagger api doc resource to use. The
resource is loaded from classpath by default and must be in JSon format. | |
String
| *camel.component.rest.basic-property-binding* | Whether the component should
use basic property binding (Camel 2.x) or the newer property binding with
additional capabilities | false | Boolean
-| *camel.component.rest.component-name* | The Camel Rest component to use for
the REST transport, such as restlet, spark-rest. If no component has been
explicit configured, then Camel will lookup if there is a Camel component that
integrates with the Rest DSL, or if a org.apache.camel.spi.RestConsumerFactory
(consumer) or org.apache.camel.spi.RestProducerFactory (producer) is registered
in the registry. If either one is found, then that is being used. | | String
+| *camel.component.rest.consumer-component-name* | The Camel Rest component to
use for (consumer) the REST transport, such as jetty, servlet, undertow. If no
component has been explicit configured, then Camel will lookup if there is a
Camel component that integrates with the Rest DSL, or if a
org.apache.camel.spi.RestConsumerFactory is registered in the registry. If
either one is found, then that is being used. | | String
| *camel.component.rest.enabled* | Whether to enable auto configuration of the
rest component. This is enabled by default. | | Boolean
| *camel.component.rest.host* | Host and port of HTTP service to use (override
host in swagger schema) | | String
+| *camel.component.rest.producer-component-name* | The Camel Rest component to
use for (producer) the REST transport, such as http, undertow. If no component
has been explicit configured, then Camel will lookup if there is a Camel
component that integrates with the Rest DSL, or if a
org.apache.camel.spi.RestProducerFactory is registered in the registry. If
either one is found, then that is being used. | | String
| *camel.component.rest.resolve-property-placeholders* | Whether the component
should resolve property placeholders on itself when starting. Only properties
which are of String type can use property placeholders. | true | Boolean
+| *camel.component.rest.component-name* | The Camel Rest component to use for
(producer) the REST transport, such as http, undertow. If no component has been
explicit configured, then Camel will lookup if there is a Camel component that
integrates with the Rest DSL, or if a org.apache.camel.spi.RestProducerFactory
is registered in the registry. If either one is found, then that is being used.
| | String
|===
// spring-boot-auto-configure options: END
diff --git a/docs/components/modules/ROOT/pages/jetty-component.adoc
b/docs/components/modules/ROOT/pages/jetty-component.adoc
index ce80b40..5b4cac1 100644
--- a/docs/components/modules/ROOT/pages/jetty-component.adoc
+++ b/docs/components/modules/ROOT/pages/jetty-component.adoc
@@ -3,13 +3,9 @@
*Available as of Camel version 1.2*
-WARNING: The producer is deprecated - do not use. We only recommend using
jetty as consumer (eg from jetty)
-
The *jetty* component provides HTTP-based endpoints
for consuming and producing HTTP requests. That is, the Jetty component
-behaves as a simple Web server. +
- Jetty can also be used as a http client which mean you can also use it
-with Camel as a producer.
+behaves as a simple Web server.
*Stream*
@@ -71,7 +67,7 @@ The Jetty component supports 34 options, which are listed
below.
| *minThreads* (consumer) | To set a value for minimum number of threads in
server thread pool. Notice that both a min and max size must be configured. |
| Integer
| *maxThreads* (consumer) | To set a value for maximum number of threads in
server thread pool. Notice that both a min and max size must be configured. |
| Integer
| *threadPool* (consumer) | To use a custom thread pool for the server. This
option should only be used in special circumstances. | | ThreadPool
-| *enableJmx* (common) | If this option is true, Jetty JMX support will be
enabled for this endpoint. | false | boolean
+| *enableJmx* (consumer) | If this option is true, Jetty JMX support will be
enabled for this endpoint. | false | boolean
| *jettyHttpBinding* (advanced) | To use a custom
org.apache.camel.component.jetty.JettyHttpBinding, which are used to customize
how a response should be written for the producer. | | JettyHttpBinding
| *httpBinding* (advanced) | Not to be used - use JettyHttpBinding instead. |
| HttpBinding
| *httpConfiguration* (advanced) | Jetty component does not use
HttpConfiguration. | | HttpConfiguration
@@ -82,13 +78,13 @@ The Jetty component supports 34 options, which are listed
below.
| *useContinuation* (consumer) | Whether or not to use Jetty continuations for
the Jetty Server. | true | boolean
| *sslContextParameters* (security) | To configure security using
SSLContextParameters | | SSLContextParameters
| *useGlobalSslContext Parameters* (security) | Enable usage of global SSL
context parameters | false | boolean
-| *responseBufferSize* (common) | Allows to configure a custom value of the
response buffer size on the Jetty connectors. | | Integer
-| *requestBufferSize* (common) | Allows to configure a custom value of the
request buffer size on the Jetty connectors. | | Integer
-| *requestHeaderSize* (common) | Allows to configure a custom value of the
request header size on the Jetty connectors. | | Integer
-| *responseHeaderSize* (common) | Allows to configure a custom value of the
response header size on the Jetty connectors. | | Integer
+| *responseBufferSize* (consumer) | Allows to configure a custom value of the
response buffer size on the Jetty connectors. | | Integer
+| *requestBufferSize* (consumer) | Allows to configure a custom value of the
request buffer size on the Jetty connectors. | | Integer
+| *requestHeaderSize* (consumer) | Allows to configure a custom value of the
request header size on the Jetty connectors. | | Integer
+| *responseHeaderSize* (consumer) | Allows to configure a custom value of the
response header size on the Jetty connectors. | | Integer
| *proxyHost* (proxy) | To use a http proxy to configure the hostname. | |
String
| *proxyPort* (proxy) | To use a http proxy to configure the port number. | |
Integer
-| *useXForwardedFor Header* (common) | To use the X-Forwarded-For header in
HttpServletRequest.getRemoteAddr. | false | boolean
+| *useXForwardedFor Header* (consumer) | To use the X-Forwarded-For header in
HttpServletRequest.getRemoteAddr. | false | boolean
| *sendServerVersion* (consumer) | If the option is true, jetty will send the
server header with the jetty version information to the client which sends the
request. NOTE please make sure there is no any other camel-jetty endpoint is
share the same port, otherwise this option may not work as expected. | true |
boolean
| *allowJavaSerialized Object* (advanced) | Whether to allow java
serialization when a request uses
context-type=application/x-java-serialized-object. This is by default turned
off. If you enable this then be aware that Java will deserialize the incoming
data from the request to Java and that can be a potential security risk. |
false | boolean
| *headerFilterStrategy* (filter) | To use a custom
org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel
message. | | HeaderFilterStrategy
@@ -124,29 +120,29 @@ with the following path and query parameters:
|===
-==== Query Parameters (55 parameters):
+==== Query Parameters (33 parameters):
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
-| *chunked* (common) | If this option is false the Servlet will disable the
HTTP streaming and set the content-length header on the response | true |
boolean
| *disableStreamCache* (common) | Determines whether or not the raw input
stream from Servlet is cached or not (Camel will read the stream into a in
memory/overflow to file, Stream caching) cache. By default Camel will cache the
Servlet input stream to support reading it multiple times to ensure it Camel
can retrieve all data from the stream. However you can set this option to true
when you for example need to access the raw stream, such as streaming it
directly to a file or other persis [...]
-| *enableMultipartFilter* (common) | Whether Jetty
org.eclipse.jetty.servlets.MultiPartFilter is enabled or not. You should set
this value to false when bridging endpoints, to ensure multipart requests is
proxied/bridged as well. | false | boolean
| *headerFilterStrategy* (common) | To use a custom HeaderFilterStrategy to
filter header to and from Camel message. | | HeaderFilterStrategy
-| *transferException* (common) | If enabled and an Exchange failed processing
on the consumer side, and if the caused Exception was send back serialized in
the response as a application/x-java-serialized-object content type. On the
producer side the exception will be deserialized and thrown as is, instead of
the HttpOperationFailedException. The caused exception is required to be
serialized. This is by default turned off. If you enable this then be aware
that Java will deserialize the in [...]
| *httpBinding* (common) | To use a custom HttpBinding to control the mapping
between Camel message and HttpClient. | | HttpBinding
| *async* (consumer) | Configure the consumer to work in async mode | false |
boolean
| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the
Camel routing Error Handler, which mean any exceptions occurred while the
consumer is trying to pickup incoming messages, or the likes, will now be
processed as a message and handled by the routing Error Handler. By default the
consumer will use the org.apache.camel.spi.ExceptionHandler to deal with
exceptions, that will be logged at WARN or ERROR level and ignored. | false |
boolean
+| *chunked* (consumer) | If this option is false the Servlet will disable the
HTTP streaming and set the content-length header on the response | true |
boolean
| *continuationTimeout* (consumer) | Allows to set a timeout in millis when
using Jetty as consumer (server). By default Jetty uses 30000. You can use a
value of = 0 to never expire. If a timeout occurs then the request will be
expired and Jetty will return back a http error 503 to the client. This option
is only in use when using Jetty with the Asynchronous Routing Engine. | 30000 |
Long
| *enableCORS* (consumer) | If the option is true, Jetty server will setup the
CrossOriginFilter which supports the CORS out of box. | false | boolean
| *enableJmx* (consumer) | If this option is true, Jetty JMX support will be
enabled for this endpoint. See Jetty JMX support for more details. | false |
boolean
+| *enableMultipartFilter* (consumer) | Whether Jetty
org.eclipse.jetty.servlets.MultiPartFilter is enabled or not. You should set
this value to false when bridging endpoints, to ensure multipart requests is
proxied/bridged as well. | false | boolean
| *httpMethodRestrict* (consumer) | Used to only allow consuming if the
HttpMethod matches, such as GET/POST/PUT etc. Multiple methods can be specified
separated by comma. | | String
| *matchOnUriPrefix* (consumer) | Whether or not the consumer should try to
find a target consumer by matching the URI prefix if no exact match is found. |
false | boolean
| *responseBufferSize* (consumer) | To use a custom buffer size on the
javax.servlet.ServletResponse. | | Integer
| *sendDateHeader* (consumer) | If the option is true, jetty server will send
the date header to the client which sends the request. NOTE please make sure
there is no any other camel-jetty endpoint is share the same port, otherwise
this option may not work as expected. | false | boolean
| *sendServerVersion* (consumer) | If the option is true, jetty will send the
server header with the jetty version information to the client which sends the
request. NOTE please make sure there is no any other camel-jetty endpoint is
share the same port, otherwise this option may not work as expected. | true |
boolean
| *sessionSupport* (consumer) | Specifies whether to enable the session
manager on the server side of Jetty. | false | boolean
+| *transferException* (consumer) | If enabled and an Exchange failed
processing on the consumer side, and if the caused Exception was send back
serialized in the response as a application/x-java-serialized-object content
type. On the producer side the exception will be deserialized and thrown as is,
instead of the HttpOperationFailedException. The caused exception is required
to be serialized. This is by default turned off. If you enable this then be
aware that Java will deserialize the [...]
| *useContinuation* (consumer) | Whether or not to use Jetty continuations for
the Jetty Server. | | Boolean
| *eagerCheckContentAvailable* (consumer) | Whether to eager check whether the
HTTP requests has content if the content-length header is 0 or not present.
This can be turned on in case HTTP clients do not send streamed data. | false |
boolean
| *exceptionHandler* (consumer) | To let the consumer use a custom
ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this
option is not in use. By default the consumer will deal with exceptions, that
will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
@@ -154,36 +150,14 @@ with the following path and query parameters:
| *filterInitParameters* (consumer) | Configuration of the filter init
parameters. These parameters will be applied to the filter list before starting
the jetty server. | | Map
| *filtersRef* (consumer) | Allows using a custom filters which is putted into
a list and can be find in the Registry. Multiple values can be separated by
comma. | | String
| *handlers* (consumer) | Specifies a comma-delimited set of Handler instances
to lookup in your Registry. These handlers are added to the Jetty servlet
context (for example, to add security). Important: You can not use different
handlers with different Jetty endpoints using the same port number. The
handlers is associated to the port number. If you need different handlers, then
use different port numbers. | | String
-| *httpBindingRef* (consumer) | *Deprecated* Option to disable throwing the
HttpOperationFailedException in case of failed responses from the remote
server. This allows you to get all responses regardless of the HTTP status
code. | | String
| *multipartFilter* (consumer) | Allows using a custom multipart filter. Note:
setting multipartFilterRef forces the value of enableMultipartFilter to true. |
| Filter
-| *multipartFilterRef* (consumer) | *Deprecated* Allows using a custom
multipart filter. Note: setting multipartFilterRef forces the value of
enableMultipartFilter to true. | | String
| *optionsEnabled* (consumer) | Specifies whether to enable HTTP OPTIONS for
this Servlet consumer. By default OPTIONS is turned off. | false | boolean
| *traceEnabled* (consumer) | Specifies whether to enable HTTP TRACE for this
Servlet consumer. By default TRACE is turned off. | false | boolean
-| *bridgeEndpoint* (producer) | If the option is true, HttpProducer will
ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request.
You may also set the option throwExceptionOnFailure to be false to let the
HttpProducer send all the fault response back. | false | boolean
-| *connectionClose* (producer) | Specifies whether a Connection Close header
must be added to HTTP Request. By default connectionClose is false. | false |
boolean
-| *cookieHandler* (producer) | Configure a cookie handler to maintain a HTTP
session | | CookieHandler
-| *copyHeaders* (producer) | If this option is true then IN exchange headers
will be copied to OUT exchange headers according to copy strategy. Setting this
to false, allows to only include the headers from the HTTP response (not
propagating IN headers). | true | boolean
-| *httpClientMaxThreads* (producer) | To set a value for maximum number of
threads in HttpClient thread pool. This setting override any setting configured
on component level. Notice that both a min and max size must be configured. If
not set it default to max 254 threads used in Jettys thread pool. | 254 |
Integer
-| *httpClientMinThreads* (producer) | To set a value for minimum number of
threads in HttpClient thread pool. This setting override any setting configured
on component level. Notice that both a min and max size must be configured. If
not set it default to min 8 threads used in Jettys thread pool. | 8 | Integer
-| *httpMethod* (producer) | Configure the HTTP method to use. The HttpMethod
header cannot override this option if set. | | HttpMethods
-| *ignoreResponseBody* (producer) | If this option is true, The http producer
won't read response body and cache the input stream | false | boolean
-| *preserveHostHeader* (producer) | If the option is true, HttpProducer will
set the Host header to the value contained in the current exchange Host header,
useful in reverse proxy applications where you want the Host header received by
the downstream server to reflect the URL called by the upstream client, this
allows applications which use the Host header to generate accurate URL's for a
proxied service | false | boolean
-| *throwExceptionOnFailure* (producer) | Option to disable throwing the
HttpOperationFailedException in case of failed responses from the remote
server. This allows you to get all responses regardless of the HTTP status
code. | true | boolean
-| *httpClient* (producer) | Sets a shared HttpClient to use for all producers
created by this endpoint. By default each producer will use a new http client,
and not share. Important: Make sure to handle the lifecycle of the shared
client, such as stopping the client, when it is no longer in use. Camel will
call the start method on the client to ensure its started when this endpoint
creates a producer. This options should only be used in special circumstances.
| | HttpClient
-| *httpClientParameters* (producer) | Configuration of Jetty's HttpClient. For
example, setting httpClient.idleTimeout=30000 sets the idle timeout to 30
seconds. And httpClient.timeout=30000 sets the request timeout to 30 seconds,
in case you want to timeout sooner if you have long running request/response
calls. | | Map
-| *jettyBinding* (producer) | To use a custom JettyHttpBinding which be used
to customize how a response should be written for the producer. | |
JettyHttpBinding
-| *jettyBindingRef* (producer) | *Deprecated* To use a custom JettyHttpBinding
which be used to customize how a response should be written for the producer. |
| String
-| *okStatusCodeRange* (producer) | The status codes which are considered a
success response. The values are inclusive. Multiple ranges can be defined,
separated by comma, e.g. 200-204,209,301-304. Each range must be a single
number or from-to with the dash included. | 200-299 | String
-| *urlRewrite* (producer) | *Deprecated* Refers to a custom
org.apache.camel.component.http.UrlRewrite which allows you to rewrite urls
when you bridge/proxy endpoints. See more details at
http://camel.apache.org/urlrewrite.html | | UrlRewrite
| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic
property binding (Camel 2.x) or the newer property binding with additional
capabilities | false | boolean
| *mapHttpMessageBody* (advanced) | If this option is true then IN exchange
Body of the exchange will be mapped to HTTP body. Setting this to false will
avoid the HTTP mapping. | true | boolean
| *mapHttpMessageFormUrl EncodedBody* (advanced) | If this option is true then
IN exchange Form Encoded body of the exchange will be mapped to HTTP. Setting
this to false will avoid the HTTP Form Encoded body mapping. | true | boolean
| *mapHttpMessageHeaders* (advanced) | If this option is true then IN exchange
Headers of the exchange will be mapped to HTTP headers. Setting this to false
will avoid the HTTP Headers mapping. | true | boolean
| *synchronous* (advanced) | Sets whether synchronous processing should be
strictly used, or Camel is allowed to use asynchronous processing (if
supported). | false | boolean
-| *proxyAuthScheme* (proxy) | Proxy authentication scheme to use | | String
-| *proxyHost* (proxy) | Proxy hostname to use | | String
-| *proxyPort* (proxy) | Proxy port to use | | int
-| *authHost* (security) | Authentication host to use with NTML | | String
| *sslContextParameters* (security) | To configure security using
SSLContextParameters | | SSLContextParameters
|===
// endpoint options: END
@@ -269,34 +243,7 @@ message header not only from Get Method, but also other
HTTP method.
=== Usage
-The Jetty component supports both consumer and producer endpoints.
-Another option for producing to other HTTP endpoints, is to use the
-<<http-component,HTTP Component>>
-
-=== Producer Example
-
-WARNING: The producer is deprecated - do not use. We only recommend using
jetty as consumer (eg from jetty)
-
-The following is a basic example of how to send an HTTP request to an
-existing HTTP endpoint.
-
-in Java DSL
-
-[source,java]
-----
-from("direct:start")
- .to("jetty://http://www.google.com";);
-----
-
-or in Spring XML
-
-[source,xml]
-----
-<route>
- <from uri="direct:start"/>
- <to uri="jetty://http://www.google.com"/>
-<route>
-----
+The Jetty component supports consumer endpoints.
=== Consumer Example
@@ -351,7 +298,7 @@ exchange. For example, the following route enables sessions:
<route>
<from uri="jetty:http://0.0.0.0/myapp/myservice/?sessionSupport=true"/>
<processRef ref="myCode"/>
-<route>
+</route>
----
The `myCode` Processor can be instantiated by a
@@ -359,7 +306,7 @@ Spring `bean` element:
[source,xml]
----
-<bean id="myCode"class="com.mycompany.MyCodeProcessor"/>
+<bean id="myCode" class="com.mycompany.MyCodeProcessor"/>
----
Where the processor implementation can access the `HttpSession` as
@@ -410,7 +357,6 @@ Spring DSL based configuration of endpoint
[source,xml]
----
-...
<camel:sslContextParameters
id="sslContextParameters">
<camel:keyManagers
@@ -419,10 +365,10 @@ Spring DSL based configuration of endpoint
resource="/users/home/server/keystore.jks"
password="keystorePassword"/>
</camel:keyManagers>
- </camel:sslContextParameters>...
-...
+ </camel:sslContextParameters>
+
<to
uri="jetty:https://127.0.0.1/mail/?sslContextParameters=#sslContextParameters"/>
-...
+
----
[[Jetty-ConfiguringJettyDirectly]]
@@ -440,21 +386,6 @@ Jetty also needs to know where to load your keystore from
and what
passwords to use in order to load the correct SSL certificate. Set the
following JVM System Properties:
-*until Camel 2.2*
-
-* `jetty.ssl.keystore` specifies the location of the Java keystore file,
-which contains the Jetty server's own X.509 certificate in a _key
-entry_. A key entry stores the X.509 certificate (effectively, the
-_public key_) and also its associated private key.
-* `jetty.ssl.password` the store password, which is required to access
-the keystore file (this is the same password that is supplied to the
-`keystore` command's `-storepass` option).
-* `jetty.ssl.keypassword` the key password, which is used to access the
-certificate's key entry in the keystore (this is the same password that
-is supplied to the `keystore` command's `-keypass` option).
-
-*from Camel 2.3 onwards*
-
* `org.eclipse.jetty.ssl.keystore` specifies the location of the Java
keystore file, which contains the Jetty server's own X.509 certificate
in a _key entry_. A key entry stores the X.509 certificate (effectively,
@@ -475,52 +406,7 @@ Some SSL properties aren't exposed directly by Camel,
however Camel does
expose the underlying SslSocketConnector, which will allow you to set
properties like needClientAuth for mutual authentication requiring a
client certificate or wantClientAuth for mutual authentication where a
-client doesn't need a certificate but can have one. There's a slight
-difference between the various Camel versions:
-
-*Up to Camel 2.2*
-
-[source,xml]
-----
-<bean id="jetty" class="org.apache.camel.component.jetty.JettyHttpComponent">
- <property name="sslSocketConnectors">
- <map>
- <entry key="8043">
- <bean class="org.mortbay.jetty.security.SslSocketConnector">
- <property name="password"value="..."/>
- <property name="keyPassword"value="..."/>
- <property name="keystore"value="..."/>
- <property name="needClientAuth"value="..."/>
- <property name="truststore"value="..."/>
- </bean>
- </entry>
- </map>
- </property>
-</bean>
-----
-
-*Camel 2.3, 2.4*
-
-[source,xml]
-----
-<bean id="jetty" class="org.apache.camel.component.jetty.JettyHttpComponent">
- <property name="sslSocketConnectors">
- <map>
- <entry key="8043">
- <bean class="org.eclipse.jetty.server.ssl.SslSocketConnector">
- <property name="password"value="..."/>
- <property name="keyPassword"value="..."/>
- <property name="keystore"value="..."/>
- <property name="needClientAuth"value="..."/>
- <property name="truststore"value="..."/>
- </bean>
- </entry>
- </map>
- </property>
-</bean>
-----
-
-*From Camel 2.5 we switch to use SslSelectChannelConnector *
+client doesn't need a certificate but can have one.
[source,xml]
----
@@ -529,11 +415,11 @@ difference between the various Camel versions:
<map>
<entry key="8043">
<bean
class="org.eclipse.jetty.server.ssl.SslSelectChannelConnector">
- <property name="password"value="..."/>
- <property name="keyPassword"value="..."/>
- <property name="keystore"value="..."/>
- <property name="needClientAuth"value="..."/>
- <property name="truststore"value="..."/>
+ <property name="password" value="..."/>
+ <property name="keyPassword" value="..."/>
+ <property name="keystore" value="..."/>
+ <property name="needClientAuth" value="..."/>
+ <property name="truststore" value="..."/>
</bean>
</entry>
</map>
@@ -546,8 +432,6 @@ Jetty to listen on.
==== Configuring general SSL properties
-*Available as of Camel 2.5*
-
Instead of a per port number specific SSL socket connector (as shown
above) you can now configure general properties which applies for all
SSL socket connectors (which is not explicit configured as above with
@@ -558,11 +442,11 @@ the port number as entry).
<bean id="jetty" class="org.apache.camel.component.jetty.JettyHttpComponent">
<property name="sslSocketConnectorProperties">
<map>
- <entry key="password"value="..."/>
- <entry key="keyPassword"value="..."/>
- <entry key="keystore"value="..."/>
- <entry key="needClientAuth"value="..."/>
- <entry key="truststore"value="..."/>
+ <entry key="password" value="..."/>
+ <entry key="keyPassword" value="..."/>
+ <entry key="keystore" value="..."/>
+ <entry key="needClientAuth" value="..."/>
+ <entry key="truststore" value="..."/>
</map>
</property>
</bean>
@@ -581,8 +465,6 @@ X509Certificate cert = (X509Certificate)
req.getAttribute("javax.servlet.request
==== Configuring general HTTP properties
-*Available as of Camel 2.5*
-
Instead of a per port number specific HTTP socket connector (as shown
above) you can now configure general properties which applies for all
HTTP socket connectors (which is not explicit configured as above with
@@ -661,7 +543,7 @@ Spring registry as follows:
[source,xml]
----
-<bean id="mybinding"class="com.mycompany.MyHttpBinding"/>
+<bean id="mybinding" class="com.mycompany.MyHttpBinding"/>
----
And then we can reference this binding when we define the route:
@@ -682,7 +564,6 @@ configured in Spring XML as follows:
[source,xml]
----
-<-- Jetty Security handling -->
<bean id="userRealm" class="org.mortbay.jetty.plus.jaas.JAASUserRealm">
<property name="name" value="tracker-users"/>
<property name="loginModuleName" value="ldaploginmodule"/>
@@ -705,12 +586,10 @@ configured in Spring XML as follows:
</bean>
----
-*And from Camel 2.3 onwards* you can configure a list of Jetty handlers
-as follows:
+You can configure a list of Jetty handlers as follows:
[source,xml]
----
-<-- Jetty Security handling -->
<bean id="constraint" class="org.eclipse.jetty.http.security.Constraint">
<property name="name" value="BASIC"/>
<property name="roles" value="tracker-users"/>
@@ -757,19 +636,15 @@ reply message. For example as show here, where we return
=== Multi-part Form support
-From Camel 2.3.0, camel-jetty support to multipart form post out of box.
+The camel-jetty component supports multipart form post out of box.
The submitted form-data are mapped into the message header. Camel-jetty
creates an attachment for each uploaded file. The file name is mapped to
the name of the attachment. The content type is set as the content type
of the attachment file name. You can find the example here.
-*Note: getName() functions as shown below in versions 2.5 and higher. In
-earlier versions you receive the temporary file name for the attachment
-instead*
-
=== Jetty JMX support
-From Camel 2.3.0, camel-jetty supports the enabling of Jetty's JMX
+The camel-jetty component supports the enabling of Jetty's JMX
capabilities at the component and endpoint level with the endpoint
configuration taking priority. Note that JMX must be enabled within the
Camel context in order to enable JMX support in this component as the
diff --git a/docs/components/modules/ROOT/pages/mongodb3-component.adoc
b/docs/components/modules/ROOT/pages/mongodb3-component.adoc
index 0c75bbc..d20124c 100644
--- a/docs/components/modules/ROOT/pages/mongodb3-component.adoc
+++ b/docs/components/modules/ROOT/pages/mongodb3-component.adoc
@@ -3,7 +3,8 @@
*Available as of Camel version 2.19*
-Note: Camel MongoDB3 component Use the Mongo Driver for Java 3.4. If your are
looking for previews versions look the Camel MongoDB component
+Note: Camel MongoDB3 component Use the Mongo Driver for Java 3.x.
+If your are looking for previews versions look the Camel MongoDB component.
According to Wikipedia: "NoSQL is a movement promoting a loosely defined
class of non-relational data stores that break with a long history of
@@ -90,7 +91,7 @@ with the following path and query parameters:
|===
-==== Query Parameters (20 parameters):
+==== Query Parameters (22 parameters):
[width="100%",cols="2,5,^1,2",options="header"]
@@ -103,6 +104,7 @@ with the following path and query parameters:
| *operation* (common) | Sets the operation this endpoint will execute against
MongoDB. For possible values, see MongoDbOperation. | | MongoDbOperation
| *outputType* (common) | Convert the output of the producer to the selected
type : DocumentList Document or MongoIterable. DocumentList or MongoIterable
applies to findAll and aggregate. Document applies to all other operations. |
| MongoDbOutputType
| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the
Camel routing Error Handler, which mean any exceptions occurred while the
consumer is trying to pickup incoming messages, or the likes, will now be
processed as a message and handled by the routing Error Handler. By default the
consumer will use the org.apache.camel.spi.ExceptionHandler to deal with
exceptions, that will be logged at WARN or ERROR level and ignored. | false |
boolean
+| *consumerType* (consumer) | Consumer type. | | String
| *exceptionHandler* (consumer) | To let the consumer use a custom
ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this
option is not in use. By default the consumer will deal with exceptions, that
will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer
creates an exchange. | | ExchangePattern
| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic
property binding (Camel 2.x) or the newer property binding with additional
capabilities | false | boolean
@@ -110,6 +112,7 @@ with the following path and query parameters:
| *dynamicity* (advanced) | Sets whether this endpoint will attempt to
dynamically resolve the target database and collection from the incoming
Exchange properties. Can be used to override at runtime the database and
collection specified on the otherwise static endpoint URI. It is disabled by
default to boost performance. Enabling it will take a minimal performance hit.
| false | boolean
| *synchronous* (advanced) | Sets whether synchronous processing should be
strictly used, or Camel is allowed to use asynchronous processing (if
supported). | false | boolean
| *writeResultAsHeader* (advanced) | In write operations, it determines
whether instead of returning WriteResult as the body of the OUT message, we
transfer the IN message to the OUT and attach the WriteResult as a header. |
false | boolean
+| *streamFilter* (changeStream) | Filter condition for change streams
consumer. | | String
| *persistentId* (tail) | One tail tracking collection can host many trackers
for several tailable consumers. To keep them separate, each tracker should have
its own unique persistentId. | | String
| *persistentTailTracking* (tail) | Enable persistent tail tracking, which is
a mechanism to keep track of the last consumed message across system restarts.
The next time the system is up, the endpoint will recover the cursor from the
point where it last stopped slurping records. | false | boolean
| *tailTrackCollection* (tail) | Collection where tail tracking information
will be persisted. If not specified,
MongoDbTailTrackingConfig#DEFAULT_COLLECTION will be used by default. | |
String
@@ -148,7 +151,7 @@ The component supports 3 options, which are listed below.
// spring-boot-auto-configure options: END
-Note on options of MoongoDB component
+Note on options of MongoDB component
writeConcern *Remove in camel 2.19.* See Mongo client options
<<MongoDB-ConfigurationofdatabaseinSpringXML>>. Set the WriteConcern for write
operations on MongoDB using the standard ones. Resolved from the fields of the
WriteConcern class by calling the link WriteConcernvalueOf(String) method.
@@ -431,8 +434,7 @@ to a single field, based on the `documentTimestamp` field:
.setHeader(MongoDbConstants.FIELDS_PROJECTION).constant(Projection.include("documentTimestamp"))
.setBody().constant("{}")
.to("mongodb3:myDb?database=local&collection=myDemoCollection&operation=findOneByQuery")
-.to("direct:aMyBatisParameterizedSelect")
-;
+.to("direct:aMyBatisParameterizedSelect");
----------------------------------------------------------------------------------------------------------------------------
==== Create/update operations
@@ -783,8 +785,8 @@ in the shell, in the form of a `Document` in the OUT
message body.
===== command
-Run the body as a command on database. Usefull for admin operation as
-getting host informations, replication or sharding status.
+Run the body as a command on database. Useful for admin operation as
+getting host information, replication or sharding status.
Collection parameter is not use for this operation.
@@ -813,7 +815,13 @@ Object result =
template.requestBodyAndHeader("direct:insert", "irrelevantBody",
assertTrue("Result is not of type Long", result instanceof Long);
-----------------------------------------------------------------------------------------------------------------------------
-=== Tailable Cursor Consumer
+=== Consumers
+There are several types of consumers:
+
+. Tailable Cursor Consumer
+. Change Streams Consumer
+
+==== Tailable Cursor Consumer
MongoDB offers a mechanism to instantaneously consume ongoing data from
a collection, by keeping the cursor open just like the `tail -f` command
@@ -835,7 +843,7 @@ new objects are inserted, MongoDB will push them as
`Document` in natural
order to your tailable cursor consumer, who will transform them to an
Exchange and will trigger your route logic.
-=== How the tailable cursor consumer works
+===== How the tailable cursor consumer works
To turn a cursor into a tailable cursor, a few special flags are to be
signalled to MongoDB when first generating the cursor. Once created, the
@@ -886,7 +894,7 @@ The above route will consume from the
"flights.cancellations" capped
collection, using "departureTime" as the increasing field, with a
default regeneration cursor delay of 1000ms.
-=== Persistent tail tracking
+===== Persistent tail tracking
Standard tail tracking is volatile and the last value is only kept in
memory. However, in practice you will need to restart your Camel
@@ -906,7 +914,7 @@ persisting at regular intervals too in the future (flush
every 5
seconds) for added robustness if the demand is there. To request this
feature, please open a ticket in the Camel JIRA.
-=== Enabling persistent tail tracking
+===== Enabling persistent tail tracking
To enable this function, set at least the following options on the
endpoint URI:
@@ -952,6 +960,35 @@
from("mongodb3:myDb?database=flights&collection=cancellations&tailTrackIncreasin
.to("mock:test");
-----------------------------------------------------------------------------------------------------------------------------------
+==== Change Streams Consumer
+
+Change Streams allow applications to access real-time data changes without the
complexity and risk of tailing the MongoDB oplog.
+Applications can use change streams to subscribe to all data changes on a
collection and immediately react to them.
+Because change streams use the aggregation framework, applications can also
filter for specific changes or transform the notifications at will.
+
+To configure Change Streams Consumer you need to specify `consumerType`,
`database`, `collection`
+and optional JSON property `streamFilter` to filter events.
+That JSON property is standart MongoDB `$match` aggregation.
+It could be easily specified using XML DSL configuration:
+
+[source,xml]
+-------------
+<route id="filterConsumer">
+ <from
uri="mongodb3:myDb?consumerType=changeStreams&database=flights&collection=tickets"/>
+ <to uri="mock:test"/>
+
+ <routeProperty key="streamFilter"
value="{'$match':{'$or':[{'fullDocument.stringValue': 'specificValue'}]}}"/>
+</route>
+-------------
+
+Java configuration:
+[source,java]
+-------------
+from("mongodb3:myDb?consumerType=changeStreams&database=flights&collection=tickets")
+ .routeProperty("streamFilter",
"{'$match':{'$or':[{'fullDocument.stringValue': 'specificValue'}]}}")
+ .to("mock:test");
+-------------
+
=== Type conversions
The `MongoDbBasicConverters` type converter included with the
@@ -970,8 +1007,7 @@ object to a `Map`, which is in turn used to initialise a
new
|fromStringToList |`String` |`List<Bson>` |uses
`org.bson.codecs.configuration.CodecRegistries` to convert to BsonArray then to
List<Bson>.
|=======================================================================
-This type converter is auto-discovered, so you don't need to configure
-anything manually.
+This type converter is auto-discovered, so you don't need to configure
anything manually.
=== See also
diff --git a/docs/components/modules/ROOT/pages/rest-api-component.adoc
b/docs/components/modules/ROOT/pages/rest-api-component.adoc
index d8fef02..256181e 100644
--- a/docs/components/modules/ROOT/pages/rest-api-component.adoc
+++ b/docs/components/modules/ROOT/pages/rest-api-component.adoc
@@ -51,7 +51,7 @@ with the following path and query parameters:
| Name | Description | Default | Type
| *apiComponentName* (consumer) | The Camel Rest API component to use for
generating the API of the REST services, such as swagger. | | String
| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the
Camel routing Error Handler, which mean any exceptions occurred while the
consumer is trying to pickup incoming messages, or the likes, will now be
processed as a message and handled by the routing Error Handler. By default the
consumer will use the org.apache.camel.spi.ExceptionHandler to deal with
exceptions, that will be logged at WARN or ERROR level and ignored. | false |
boolean
-| *componentName* (consumer) | The Camel Rest component to use for the REST
transport, such as restlet, spark-rest. If no component has been explicit
configured, then Camel will lookup if there is a Camel component that
integrates with the Rest DSL, or if a org.apache.camel.spi.RestConsumerFactory
is registered in the registry. If either one is found, then that is being used.
| | String
+| *consumerComponentName* (consumer) | The Camel Rest component to use for
(consumer) the REST transport, such as jetty, servlet, undertow. If no
component has been explicit configured, then Camel will lookup if there is a
Camel component that integrates with the Rest DSL, or if a
org.apache.camel.spi.RestConsumerFactory is registered in the registry. If
either one is found, then that is being used. | | String
| *exceptionHandler* (consumer) | To let the consumer use a custom
ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this
option is not in use. By default the consumer will deal with exceptions, that
will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer
creates an exchange. | | ExchangePattern
| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic
property binding (Camel 2.x) or the newer property binding with additional
capabilities | false | boolean
diff --git a/docs/components/modules/ROOT/pages/rest-component.adoc
b/docs/components/modules/ROOT/pages/rest-component.adoc
index 07a2cc2..8811b64 100644
--- a/docs/components/modules/ROOT/pages/rest-component.adoc
+++ b/docs/components/modules/ROOT/pages/rest-component.adoc
@@ -19,14 +19,16 @@ rest://method:path[:uriTemplate]?[options]
=== URI Options
// component options: START
-The REST component supports 5 options, which are listed below.
+The REST component supports 7 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
-| *componentName* (common) | The Camel Rest component to use for the REST
transport, such as restlet, spark-rest. If no component has been explicit
configured, then Camel will lookup if there is a Camel component that
integrates with the Rest DSL, or if a org.apache.camel.spi.RestConsumerFactory
(consumer) or org.apache.camel.spi.RestProducerFactory (producer) is registered
in the registry. If either one is found, then that is being used. | | String
+| *consumerComponentName* (consumer) | The Camel Rest component to use for
(consumer) the REST transport, such as jetty, servlet, undertow. If no
component has been explicit configured, then Camel will lookup if there is a
Camel component that integrates with the Rest DSL, or if a
org.apache.camel.spi.RestConsumerFactory is registered in the registry. If
either one is found, then that is being used. | | String
+| *producerComponentName* (producer) | The Camel Rest component to use for
(producer) the REST transport, such as http, undertow. If no component has been
explicit configured, then Camel will lookup if there is a Camel component that
integrates with the Rest DSL, or if a org.apache.camel.spi.RestProducerFactory
is registered in the registry. If either one is found, then that is being used.
| | String
+| *componentName* (producer) | *Deprecated* The Camel Rest component to use
for (producer) the REST transport, such as http, undertow. If no component has
been explicit configured, then Camel will lookup if there is a Camel component
that integrates with the Rest DSL, or if a
org.apache.camel.spi.RestProducerFactory is registered in the registry. If
either one is found, then that is being used. | | String
| *apiDoc* (producer) | The swagger api doc resource to use. The resource is
loaded from classpath by default and must be in JSon format. | | String
| *host* (producer) | Host and port of HTTP service to use (override host in
swagger schema) | | String
| *resolveProperty Placeholders* (advanced) | Whether the component should
resolve property placeholders on itself when starting. Only properties which
are of String type can use property placeholders. | true | boolean
@@ -55,25 +57,26 @@ with the following path and query parameters:
|===
-==== Query Parameters (16 parameters):
+==== Query Parameters (17 parameters):
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
-| *componentName* (common) | The Camel Rest component to use for the REST
transport, such as restlet, spark-rest. If no component has been explicit
configured, then Camel will lookup if there is a Camel component that
integrates with the Rest DSL, or if a org.apache.camel.spi.RestConsumerFactory
is registered in the registry. If either one is found, then that is being used.
| | String
| *consumes* (common) | Media type such as: 'text/xml', or 'application/json'
this REST service accepts. By default we accept all kinds of types. | | String
| *inType* (common) | To declare the incoming POJO binding type as a FQN class
name | | String
| *outType* (common) | To declare the outgoing POJO binding type as a FQN
class name | | String
| *produces* (common) | Media type such as: 'text/xml', or 'application/json'
this REST service returns. | | String
| *routeId* (common) | Name of the route this REST services creates | | String
| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the
Camel routing Error Handler, which mean any exceptions occurred while the
consumer is trying to pickup incoming messages, or the likes, will now be
processed as a message and handled by the routing Error Handler. By default the
consumer will use the org.apache.camel.spi.ExceptionHandler to deal with
exceptions, that will be logged at WARN or ERROR level and ignored. | false |
boolean
+| *consumerComponentName* (consumer) | The Camel Rest component to use for
(consumer) the REST transport, such as jetty, servlet, undertow. If no
component has been explicit configured, then Camel will lookup if there is a
Camel component that integrates with the Rest DSL, or if a
org.apache.camel.spi.RestConsumerFactory is registered in the registry. If
either one is found, then that is being used. | | String
| *description* (consumer) | Human description to document this REST service |
| String
| *exceptionHandler* (consumer) | To let the consumer use a custom
ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this
option is not in use. By default the consumer will deal with exceptions, that
will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer
creates an exchange. | | ExchangePattern
| *apiDoc* (producer) | The swagger api doc resource to use. The resource is
loaded from classpath by default and must be in JSon format. | | String
| *bindingMode* (producer) | Configures the binding mode for the producer. If
set to anything other than 'off' the producer will try to convert the body of
the incoming message from inType to the json or xml, and the response from json
or xml to outType. | | RestBindingMode
| *host* (producer) | Host and port of HTTP service to use (override host in
swagger schema) | | String
+| *producerComponentName* (producer) | The Camel Rest component to use for
(producer) the REST transport, such as http, undertow. If no component has been
explicit configured, then Camel will lookup if there is a Camel component that
integrates with the Rest DSL, or if a org.apache.camel.spi.RestProducerFactory
is registered in the registry. If either one is found, then that is being used.
| | String
| *queryParameters* (producer) | Query parameters for the HTTP service to call
| | String
| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic
property binding (Camel 2.x) or the newer property binding with additional
capabilities | false | boolean
| *synchronous* (advanced) | Sets whether synchronous processing should be
strictly used, or Camel is allowed to use asynchronous processing (if
supported). | false | boolean
@@ -96,7 +99,7 @@ When using Spring Boot make sure to use the following Maven
dependency to have s
----
-The component supports 6 options, which are listed below.
+The component supports 8 options, which are listed below.
@@ -105,10 +108,12 @@ The component supports 6 options, which are listed below.
| Name | Description | Default | Type
| *camel.component.rest.api-doc* | The swagger api doc resource to use. The
resource is loaded from classpath by default and must be in JSon format. | |
String
| *camel.component.rest.basic-property-binding* | Whether the component should
use basic property binding (Camel 2.x) or the newer property binding with
additional capabilities | false | Boolean
-| *camel.component.rest.component-name* | The Camel Rest component to use for
the REST transport, such as restlet, spark-rest. If no component has been
explicit configured, then Camel will lookup if there is a Camel component that
integrates with the Rest DSL, or if a org.apache.camel.spi.RestConsumerFactory
(consumer) or org.apache.camel.spi.RestProducerFactory (producer) is registered
in the registry. If either one is found, then that is being used. | | String
+| *camel.component.rest.consumer-component-name* | The Camel Rest component to
use for (consumer) the REST transport, such as jetty, servlet, undertow. If no
component has been explicit configured, then Camel will lookup if there is a
Camel component that integrates with the Rest DSL, or if a
org.apache.camel.spi.RestConsumerFactory is registered in the registry. If
either one is found, then that is being used. | | String
| *camel.component.rest.enabled* | Whether to enable auto configuration of the
rest component. This is enabled by default. | | Boolean
| *camel.component.rest.host* | Host and port of HTTP service to use (override
host in swagger schema) | | String
+| *camel.component.rest.producer-component-name* | The Camel Rest component to
use for (producer) the REST transport, such as http, undertow. If no component
has been explicit configured, then Camel will lookup if there is a Camel
component that integrates with the Rest DSL, or if a
org.apache.camel.spi.RestProducerFactory is registered in the registry. If
either one is found, then that is being used. | | String
| *camel.component.rest.resolve-property-placeholders* | Whether the component
should resolve property placeholders on itself when starting. Only properties
which are of String type can use property placeholders. | true | Boolean
+| *camel.component.rest.component-name* | The Camel Rest component to use for
(producer) the REST transport, such as http, undertow. If no component has been
explicit configured, then Camel will lookup if there is a Camel component that
integrates with the Rest DSL, or if a org.apache.camel.spi.RestProducerFactory
is registered in the registry. If either one is found, then that is being used.
| | String
|===
// spring-boot-auto-configure options: END
