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.git
commit eb4b10e602d48336a2ae278138b65b3f45177a37
Author: Claus Ibsen <claus.ib...@gmail.com>
AuthorDate: Thu Aug 5 13:07:30 2021 +0200
CAMEL-16844: component docs - prepare for regen tables with better titles
---
.../src/main/docs/language-component.adoc | 63 +-------------
.../camel-ldap/src/main/docs/ldap-component.adoc | 59 -------------
.../camel-ldif/src/main/docs/ldif-component.adoc | 44 +---------
.../camel-log/src/main/docs/log-component.adoc | 96 +---------------------
.../src/main/docs/lucene-component.adoc | 67 ---------------
.../src/main/docs/lumberjack-component.adoc | 64 ---------------
6 files changed, 6 insertions(+), 387 deletions(-)
diff --git a/components/camel-language/src/main/docs/language-component.adoc
b/components/camel-language/src/main/docs/language-component.adoc
index 29f4561..153557d 100644
--- a/components/camel-language/src/main/docs/language-component.adoc
+++ b/components/camel-language/src/main/docs/language-component.adoc
@@ -29,7 +29,6 @@ xref:languages:groovy-language.adoc[Groovy] or
xref:languages:groovy-language.ad
== URI format
-[source]
----
language://languageName[:script][?options]
----
@@ -38,63 +37,13 @@ You can refer to an external resource for
the script using same notation as supported by the other
xref:language-component.adoc[Language]s in Camel
-[source]
----
language://languageName:resource:scheme:location][?options]
----
-== URI Options
-
-
// component options: START
-The Language component supports 2 options, which are listed below.
-
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *lazyStartProducer* (producer) | Whether the producer should be started lazy
(on the first message). By starting lazy you can use this to allow CamelContext
and routes to startup in situations where a producer may otherwise fail during
starting and cause the route to fail being started. By deferring this startup
to be lazy then the startup failure can be handled during routing messages via
Camel's routing error handlers. Beware that when the first message is processed
then creating and [...]
-| *autowiredEnabled* (advanced) | Whether autowiring is enabled. This is used
for automatic autowiring options (the option must be marked as autowired) by
looking up in the registry to find if there is a single instance of matching
type, which then gets configured on the component. This can be used for
automatic configuring JDBC data sources, JMS connection factories, AWS Clients,
etc. | true | boolean
-|===
// component options: END
-
-
-
// endpoint options: START
-The Language endpoint is configured using URI syntax:
-
-----
-language:languageName:resourceUri
-----
-
-with the following path and query parameters:
-
-=== Path Parameters (2 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *languageName* | *Required* Sets the name of the language to use. There are
20 enums and the value can be one of: bean, constant, exchangeProperty, file,
groovy, header, javascript, jsonpath, mvel, ognl, , ref, simple, spel, sql,
terser, tokenize, xpath, xquery, xtokenize | | String
-| *resourceUri* | Path to the resource, or a reference to lookup a bean in the
Registry to use as the resource | | String
-|===
-
-
-=== Query Parameters (7 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *allowContextMapAll* (producer) | Sets whether the context map should allow
access to all details. By default only the message body and headers can be
accessed. This option can be enabled for full access to the current Exchange
and CamelContext. Doing so impose a potential security risk as this opens
access to the full power of CamelContext API. | false | boolean
-| *binary* (producer) | Whether the script is binary content or text content.
By default the script is read as text content (eg java.lang.String) | false |
boolean
-| *cacheScript* (producer) | Whether to cache the compiled script and reuse
Notice reusing the script can cause side effects from processing one Camel
org.apache.camel.Exchange to the next org.apache.camel.Exchange. | false |
boolean
-| *contentCache* (producer) | Sets whether to use resource content cache or
not | true | boolean
-| *lazyStartProducer* (producer) | Whether the producer should be started lazy
(on the first message). By starting lazy you can use this to allow CamelContext
and routes to startup in situations where a producer may otherwise fail during
starting and cause the route to fail being started. By deferring this startup
to be lazy then the startup failure can be handled during routing messages via
Camel's routing error handlers. Beware that when the first message is processed
then creating and [...]
-| *script* (producer) | Sets the script to execute | | String
-| *transform* (producer) | Whether or not the result of the script should be
used as message body. This options is default true. | true | boolean
-|===
// endpoint options: END
@@ -134,19 +83,13 @@ assertEquals("Hello World", out);
== Loading scripts from resources
-*Since Camel 2.9*
-
You can specify a resource uri for a script to load in either the
-endpoint uri, or in the `Exchange.LANGUAGE_SCRIPT` header. +
- The uri must start with one of the following schemes: file:,
-classpath:, or http:
-
-For example to load a script from the classpath:
+endpoint uri, or in the `Exchange.LANGUAGE_SCRIPT` header.
+The uri must start with one of the following schemes: file:, classpath:, or
http:
By default the script is loaded once and cached. However you can disable
the `contentCache` option and have the script loaded on each
-evaluation. +
- For example if the file myscript.txt is changed on disk, then the
+evaluation. For example if the file myscript.txt is changed on disk, then the
updated script is used:
You can refer to the resource similar to the
diff --git a/components/camel-ldap/src/main/docs/ldap-component.adoc
b/components/camel-ldap/src/main/docs/ldap-component.adoc
index 3fd862c..06a659c 100644
--- a/components/camel-ldap/src/main/docs/ldap-component.adoc
+++ b/components/camel-ldap/src/main/docs/ldap-component.adoc
@@ -32,7 +32,6 @@ for this component:
== URI format
-[source,java]
-----------------------------
ldap:ldapServerBean[?options]
-----------------------------
@@ -43,64 +42,12 @@ bean in the registry. The LDAP component only supports
producer
endpoints, which means that an `ldap` URI cannot appear in the `from` at
the start of a route.
-You can append query options to the URI in the following format,
-`?option=value&option=value&...`
-
-== Options
-
// component options: START
-The LDAP component supports 2 options, which are listed below.
-
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *lazyStartProducer* (producer) | Whether the producer should be started lazy
(on the first message). By starting lazy you can use this to allow CamelContext
and routes to startup in situations where a producer may otherwise fail during
starting and cause the route to fail being started. By deferring this startup
to be lazy then the startup failure can be handled during routing messages via
Camel's routing error handlers. Beware that when the first message is processed
then creating and [...]
-| *autowiredEnabled* (advanced) | Whether autowiring is enabled. This is used
for automatic autowiring options (the option must be marked as autowired) by
looking up in the registry to find if there is a single instance of matching
type, which then gets configured on the component. This can be used for
automatic configuring JDBC data sources, JMS connection factories, AWS Clients,
etc. | true | boolean
-|===
// component options: END
-
-
-
-
// endpoint options: START
-The LDAP endpoint is configured using URI syntax:
-
-----
-ldap:dirContextName
-----
-
-with the following path and query parameters:
-
-=== Path Parameters (1 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *dirContextName* | *Required* Name of either a
javax.naming.directory.DirContext, or java.util.Hashtable, or Map bean to
lookup in the registry. If the bean is either a Hashtable or Map then a new
javax.naming.directory.DirContext instance is created for each use. If the bean
is a javax.naming.directory.DirContext then the bean is used as given. The
latter may not be possible in all situations where the
javax.naming.directory.DirContext must not be shared, and in those situations
it ca [...]
-|===
-
-
-=== Query Parameters (5 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *base* (producer) | The base DN for searches. | ou=system | String
-| *lazyStartProducer* (producer) | Whether the producer should be started lazy
(on the first message). By starting lazy you can use this to allow CamelContext
and routes to startup in situations where a producer may otherwise fail during
starting and cause the route to fail being started. By deferring this startup
to be lazy then the startup failure can be handled during routing messages via
Camel's routing error handlers. Beware that when the first message is processed
then creating and [...]
-| *pageSize* (producer) | When specified the ldap module uses paging to
retrieve all results (most LDAP Servers throw an exception when trying to
retrieve more than 1000 entries in one query). To be able to use this a
LdapContext (subclass of DirContext) has to be passed in as ldapServerBean
(otherwise an exception is thrown) | | Integer
-| *returnedAttributes* (producer) | Comma-separated list of attributes that
should be set in each entry of the result | | String
-| *scope* (producer) | Specifies how deeply to search the tree of entries,
starting at the base DN. There are 3 enums and the value can be one of: object,
onelevel, subtree | subtree | String
-|===
// endpoint options: END
-
-
-
== Result
The result is returned in the Out body as a
@@ -171,7 +118,6 @@ If no specific filter is required - for example, you just
need to look
up a single entry - specify a wildcard filter expression. For example,
if the LDAP entry has a Common Name, use a filter expression like:
-[source,java]
------
(cn=*)
------
@@ -293,13 +239,10 @@ public class CustomSocketFactory extends SSLSocketFactory
{
* Called by the getDefault() method.
*/
public CustomSocketFactory() {
-
}
/**
* Called by Blueprint DI to initialise an instance of SocketFactory
- *
- * @param sslContextParameters
*/
public CustomSocketFactory(SSLContextParameters sslContextParameters) {
try {
@@ -360,7 +303,5 @@ public class CustomSocketFactory extends SSLSocketFactory {
}
-----------------------------------------------------------------------------------------------------
-
-
include::{page-component-version}@camel-spring-boot::page$ldap-starter.adoc[]
diff --git a/components/camel-ldif/src/main/docs/ldif-component.adoc
b/components/camel-ldif/src/main/docs/ldif-component.adoc
index a0d725c..2e2c3e0 100644
--- a/components/camel-ldif/src/main/docs/ldif-component.adoc
+++ b/components/camel-ldif/src/main/docs/ldif-component.adoc
@@ -39,7 +39,6 @@ for this component:
== URI format
-[source]
----
ldif:ldapServerBean[?options]
----
@@ -53,51 +52,10 @@ the start of a route.
For SSL configuration, refer to the `camel-ldap` component where there is an
example
of setting up a custom SocketFactory instance.
-You can append query options to the URI in the following format,
-`?option=value&option=value&...`
-
-== Options
// component options: START
-The LDIF component supports 2 options, which are listed below.
-
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *lazyStartProducer* (producer) | Whether the producer should be started lazy
(on the first message). By starting lazy you can use this to allow CamelContext
and routes to startup in situations where a producer may otherwise fail during
starting and cause the route to fail being started. By deferring this startup
to be lazy then the startup failure can be handled during routing messages via
Camel's routing error handlers. Beware that when the first message is processed
then creating and [...]
-| *autowiredEnabled* (advanced) | Whether autowiring is enabled. This is used
for automatic autowiring options (the option must be marked as autowired) by
looking up in the registry to find if there is a single instance of matching
type, which then gets configured on the component. This can be used for
automatic configuring JDBC data sources, JMS connection factories, AWS Clients,
etc. | true | boolean
-|===
// component options: END
-
// endpoint options: START
-The LDIF endpoint is configured using URI syntax:
-
-----
-ldif:ldapConnectionName
-----
-
-with the following path and query parameters:
-
-=== Path Parameters (1 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *ldapConnectionName* | *Required* The name of the LdapConnection bean to
pull from the registry. Note that this must be of scope prototype to avoid it
being shared among threads or using a connection that has timed out. | | String
-|===
-
-
-=== Query Parameters (1 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *lazyStartProducer* (producer) | Whether the producer should be started lazy
(on the first message). By starting lazy you can use this to allow CamelContext
and routes to startup in situations where a producer may otherwise fail during
starting and cause the route to fail being started. By deferring this startup
to be lazy then the startup failure can be handled during routing messages via
Camel's routing error handlers. Beware that when the first message is processed
then creating and [...]
-|===
// endpoint options: END
@@ -106,7 +64,6 @@ with the following path and query parameters:
The body can be a URL to an LDIF file or an inline LDIF file. To signify the
difference
in body types, an inline LDIF must start with:
-[source]
----
version: 1
----
@@ -147,6 +104,7 @@ The `LdapConnection` bean may be defined as follows in
Spring XML:
----
or in a OSGi blueprint.xml:
+
[source,xml]
----
<bean id="ldapConnectionOptions"
class="org.apache.directory.ldap.client.api.LdapConnectionConfig">
diff --git a/components/camel-log/src/main/docs/log-component.adoc
b/components/camel-log/src/main/docs/log-component.adoc
index d75ef6c..535f19c 100644
--- a/components/camel-log/src/main/docs/log-component.adoc
+++ b/components/camel-log/src/main/docs/log-component.adoc
@@ -25,7 +25,6 @@ logging via, among others:
== URI format
-[source]
----
log:loggingCategory[?options]
----
@@ -50,7 +49,6 @@ using *loggingCategory*.
For example, a log endpoint typically specifies the logging level using
the `level` option, as follows:
-[source]
----
log:org.apache.camel.example?level=DEBUG
----
@@ -68,80 +66,10 @@ purpose. Its meant for lightweight and human logs. See more
details at
LogEIP.
====
-== Options
-
-
// component options: START
-The Log component supports 3 options, which are listed below.
-
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *lazyStartProducer* (producer) | Whether the producer should be started lazy
(on the first message). By starting lazy you can use this to allow CamelContext
and routes to startup in situations where a producer may otherwise fail during
starting and cause the route to fail being started. By deferring this startup
to be lazy then the startup failure can be handled during routing messages via
Camel's routing error handlers. Beware that when the first message is processed
then creating and [...]
-| *autowiredEnabled* (advanced) | Whether autowiring is enabled. This is used
for automatic autowiring options (the option must be marked as autowired) by
looking up in the registry to find if there is a single instance of matching
type, which then gets configured on the component. This can be used for
automatic configuring JDBC data sources, JMS connection factories, AWS Clients,
etc. | true | boolean
-| *exchangeFormatter* (advanced) | *Autowired* Sets a custom ExchangeFormatter
to convert the Exchange to a String suitable for logging. If not specified, we
default to DefaultExchangeFormatter. | | ExchangeFormatter
-|===
// component options: END
-
-
-
-
// endpoint options: START
-The Log endpoint is configured using URI syntax:
-
-----
-log:loggerName
-----
-
-with the following path and query parameters:
-
-=== Path Parameters (1 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *loggerName* | *Required* Name of the logging category to use | | String
-|===
-
-
-=== Query Parameters (27 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *groupActiveOnly* (producer) | If true, will hide stats when no new messages
have been received for a time interval, if false, show stats regardless of
message traffic. | true | Boolean
-| *groupDelay* (producer) | Set the initial delay for stats (in millis) | |
Long
-| *groupInterval* (producer) | If specified will group message stats by this
time interval (in millis) | | Long
-| *groupSize* (producer) | An integer that specifies a group size for
throughput logging. | | Integer
-| *lazyStartProducer* (producer) | Whether the producer should be started lazy
(on the first message). By starting lazy you can use this to allow CamelContext
and routes to startup in situations where a producer may otherwise fail during
starting and cause the route to fail being started. By deferring this startup
to be lazy then the startup failure can be handled during routing messages via
Camel's routing error handlers. Beware that when the first message is processed
then creating and [...]
-| *level* (producer) | Logging level to use. The default value is INFO. There
are 6 enums and the value can be one of: ERROR, WARN, INFO, DEBUG, TRACE, OFF |
INFO | String
-| *logMask* (producer) | If true, mask sensitive information like password or
passphrase in the log. | | Boolean
-| *marker* (producer) | An optional Marker name to use. | | String
-| *exchangeFormatter* (advanced) | To use a custom exchange formatter | |
ExchangeFormatter
-| *maxChars* (formatting) | Limits the number of characters logged per line. |
10000 | int
-| *multiline* (formatting) | If enabled then each information is outputted on
a newline. | false | boolean
-| *showAll* (formatting) | Quick option for turning all options on.
(multiline, maxChars has to be manually set if to be used) | false | boolean
-| *showAllProperties* (formatting) | Show all of the exchange properties (both
internal and custom). | false | boolean
-| *showBody* (formatting) | Show the message body. | true | boolean
-| *showBodyType* (formatting) | Show the body Java type. | true | boolean
-| *showCaughtException* (formatting) | If the exchange has a caught exception,
show the exception message (no stack trace). A caught exception is stored as a
property on the exchange (using the key
org.apache.camel.Exchange#EXCEPTION_CAUGHT) and for instance a doCatch can
catch exceptions. | false | boolean
-| *showException* (formatting) | If the exchange has an exception, show the
exception message (no stacktrace) | false | boolean
-| *showExchangeId* (formatting) | Show the unique exchange ID. | false |
boolean
-| *showExchangePattern* (formatting) | Shows the Message Exchange Pattern (or
MEP for short). | true | boolean
-| *showFiles* (formatting) | If enabled Camel will output files | false |
boolean
-| *showFuture* (formatting) | If enabled Camel will on Future objects wait for
it to complete to obtain the payload to be logged. | false | boolean
-| *showHeaders* (formatting) | Show the message headers. | false | boolean
-| *showProperties* (formatting) | Show the exchange properties (only custom).
Use showAllProperties to show both internal and custom properties. | false |
boolean
-| *showStackTrace* (formatting) | Show the stack trace, if an exchange has an
exception. Only effective if one of showAll, showException or
showCaughtException are enabled. | false | boolean
-| *showStreams* (formatting) | Whether Camel should show stream bodies or not
(eg such as java.io.InputStream). Beware if you enable this option then you may
not be able later to access the message body as the stream have already been
read by this logger. To remedy this you will have to use Stream Caching. |
false | boolean
-| *skipBodyLineSeparator* (formatting) | Whether to skip line separators when
logging the message body. This allows to log the message body in one line,
setting this option to false will preserve any line separators from the body,
which then will log the body as is. | true | boolean
-| *style* (formatting) | Sets the outputs style to use. There are 3 enums and
the value can be one of: Default, Tab, Fixed | Default | OutputStyle
-|===
// endpoint options: END
@@ -202,13 +130,11 @@ from("activemq:orders").
The following will be logged:
-[source]
----
"Received: 1000 new messages, with total 2000 so far. Last group took: 10000
millis which is: 100 messages per second. average: 100"
----
== Masking sensitive information like password
-*Since Camel 2.19*
You can enable security masking for logging by setting `logMask` flag to
`true`.
Note that this option also affects Log EIP.
@@ -234,6 +160,7 @@ from("direct:start").to("log:foo?logMask=true");
----
And in XML:
+
[source,xml]
----
<route>
@@ -248,13 +175,10 @@ Note that the masking formatter must implement
`org.apache.camel.spi.MaskingForm
== Full customization of the logging output
-*Since Camel 2.11*
-
With the options outlined in the xref:log-component.adoc[#Formatting] section,
you
can control much of the output of the logger. However, log lines will
always follow this structure:
-[source]
----
Exchange[Id:ID-machine-local-50656-1234567901234-1-2, ExchangePattern:InOut,
Properties:{CamelToEndpoint=log://org.apache.camel.component.log.TEST?showAll=true,
@@ -285,7 +209,7 @@ in either of two ways:
*Explicitly instantiating the LogComponent in your Registry:*
-[source,java]
+[source,xml]
----
<bean name="log" class="org.apache.camel.component.log.LogComponent">
<property name="exchangeFormatter" ref="myCustomFormatter" />
@@ -332,21 +256,5 @@ options:
<to uri="log:bar?param1=bar&param2=200"/>
---------------------------------------------
-== Using Log component in OSGi
-
-*Improvement as of Camel 2.12.4/2.13.1*
-
-When using Log component inside OSGi (e.g., in Karaf), the underlying
-logging mechanisms are provided by PAX logging. It searches for a bundle
-which invokes `org.slf4j.LoggerFactory.getLogger()` method and
-associates the bundle with the logger instance. Without specifying
-custom `org.slf4j.Logger` instance, the logger created by Log component
-is associated with `camel-core` bundle.
-
-In some scenarios it is required that the bundle associated with logger
-should be the bundle which contains route definition. To do this, either
-register single instance of `org.slf4j.Logger` in the Registry or
-reference it using `logger` URI parameter.
-
include::{page-component-version}@camel-spring-boot::page$log-starter.adoc[]
diff --git a/components/camel-lucene/src/main/docs/lucene-component.adoc
b/components/camel-lucene/src/main/docs/lucene-component.adoc
index fc66c0a..1d6ebdf 100644
--- a/components/camel-lucene/src/main/docs/lucene-component.adoc
+++ b/components/camel-lucene/src/main/docs/lucene-component.adoc
@@ -28,8 +28,6 @@ lucene component does the following
Lucene Endpoint
* facilitates performing of indexed searches in Camel
-This component only supports producer endpoints.
-
Maven users will need to add the following dependency to their `pom.xml`
for this component:
@@ -45,82 +43,17 @@ for this component:
== URI format
-[source,java]
------------------------------------
lucene:searcherName:insert[?options]
lucene:searcherName:query[?options]
------------------------------------
-You can append query options to the URI in the following format,
-`?option=value&option=value&...`
-
-== Insert Options
-
-
-
-
-
// component options: START
-The Lucene component supports 7 options, which are listed below.
-
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *analyzer* (producer) | An Analyzer builds TokenStreams, which analyze text.
It thus represents a policy for extracting index terms from text. The value for
analyzer can be any class that extends the abstract class
org.apache.lucene.analysis.Analyzer. Lucene also offers a rich set of analyzers
out of the box | | Analyzer
-| *indexDir* (producer) | A file system directory in which index files are
created upon analysis of the document by the specified analyzer | | File
-| *lazyStartProducer* (producer) | Whether the producer should be started lazy
(on the first message). By starting lazy you can use this to allow CamelContext
and routes to startup in situations where a producer may otherwise fail during
starting and cause the route to fail being started. By deferring this startup
to be lazy then the startup failure can be handled during routing messages via
Camel's routing error handlers. Beware that when the first message is processed
then creating and [...]
-| *maxHits* (producer) | An integer value that limits the result set of the
search operation | | int
-| *srcDir* (producer) | An optional directory containing files to be used to
be analyzed and added to the index at producer startup. | | File
-| *autowiredEnabled* (advanced) | Whether autowiring is enabled. This is used
for automatic autowiring options (the option must be marked as autowired) by
looking up in the registry to find if there is a single instance of matching
type, which then gets configured on the component. This can be used for
automatic configuring JDBC data sources, JMS connection factories, AWS Clients,
etc. | true | boolean
-| *config* (advanced) | To use a shared lucene configuration | |
LuceneConfiguration
-|===
// component options: END
-
-
-
-
-
-
-
// endpoint options: START
-The Lucene endpoint is configured using URI syntax:
-
-----
-lucene:host:operation
-----
-
-with the following path and query parameters:
-
-=== Path Parameters (2 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *host* | *Required* The URL to the lucene server | | String
-| *operation* | *Required* Operation to do such as insert or query. There are
2 enums and the value can be one of: insert, query | | LuceneOperation
-|===
-
-
-=== Query Parameters (5 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *analyzer* (producer) | An Analyzer builds TokenStreams, which analyze text.
It thus represents a policy for extracting index terms from text. The value for
analyzer can be any class that extends the abstract class
org.apache.lucene.analysis.Analyzer. Lucene also offers a rich set of analyzers
out of the box | | Analyzer
-| *indexDir* (producer) | A file system directory in which index files are
created upon analysis of the document by the specified analyzer | | File
-| *lazyStartProducer* (producer) | Whether the producer should be started lazy
(on the first message). By starting lazy you can use this to allow CamelContext
and routes to startup in situations where a producer may otherwise fail during
starting and cause the route to fail being started. By deferring this startup
to be lazy then the startup failure can be handled during routing messages via
Camel's routing error handlers. Beware that when the first message is processed
then creating and [...]
-| *maxHits* (producer) | An integer value that limits the result set of the
search operation | | int
-| *srcDir* (producer) | An optional directory containing files to be used to
be analyzed and added to the index at producer startup. | | File
-|===
// endpoint options: END
-
-
== Sending/Receiving Messages to/from the cache
=== Message Headers
diff --git
a/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc
b/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc
index 8eb870d..f52896f 100644
--- a/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc
+++ b/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc
@@ -16,8 +16,6 @@ The Lumberjack component retrieves logs sent over the network
using the Lumberja
from https://www.elastic.co/fr/products/beats/filebeat[Filebeat] for instance.
The network communication can be secured with SSL.
-This component only supports consumer endpoints.
-
Maven users will need to add the following dependency to their `pom.xml` for
this component:
[source,xml]
@@ -32,79 +30,17 @@ Maven users will need to add the following dependency to
their `pom.xml` for thi
== URI format
-[source,java]
------------------------------------
lumberjack:host
lumberjack:host:port
------------------------------------
-You can append query options to the URI in the following format,
-`?option=value&option=value&...`
-
-== Options
-
-
-
-
// component options: START
-The Lumberjack component supports 4 options, which are listed below.
-
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *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
-| *autowiredEnabled* (advanced) | Whether autowiring is enabled. This is used
for automatic autowiring options (the option must be marked as autowired) by
looking up in the registry to find if there is a single instance of matching
type, which then gets configured on the component. This can be used for
automatic configuring JDBC data sources, JMS connection factories, AWS Clients,
etc. | true | boolean
-| *sslContextParameters* (security) | Sets the default SSL configuration to
use for all the endpoints. You can also configure it directly at the endpoint
level. | | SSLContextParameters
-| *useGlobalSslContextParameters* (security) | Enable usage of global SSL
context parameters. | false | boolean
-|===
// component options: END
-
-
-
-
-
-
-
// endpoint options: START
-The Lumberjack endpoint is configured using URI syntax:
-
-----
-lumberjack:host:port
-----
-
-with the following path and query parameters:
-
-=== Path Parameters (2 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *host* | *Required* Network interface on which to listen for Lumberjack | |
String
-| *port* | Network port on which to listen for Lumberjack | 5044 | int
-|===
-
-
-=== Query Parameters (4 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *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
-| *sslContextParameters* (consumer) | SSL configuration | |
SSLContextParameters
-| *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. There are 3 enums and the value can be one of: InOnly,
InOut, InOptionalOut | | ExchangePattern
-|===
// endpoint options: END
-
-
-
-
== Result
The result body is a `Map<String, Object>` object.
