camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From acosent...@apache.org
Subject [7/8] camel git commit: Components/Endpoints docs updated
Date Thu, 09 Jun 2016 12:19:56 GMT
http://git-wip-us.apache.org/repos/asf/camel/blob/02a6a4de/components/camel-cache/src/main/docs/cache.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cache/src/main/docs/cache.adoc b/components/camel-cache/src/main/docs/cache.adoc
index c0c2d6e..0183d48 100644
--- a/components/camel-cache/src/main/docs/cache.adoc
+++ b/components/camel-cache/src/main/docs/cache.adoc
@@ -45,12 +45,57 @@ You can append query options to the URI in the following format,
 Options
 ^^^^^^^
 
+
 // component options: START
+The EHCache component supports 3 options which are listed below.
+
+
+
+{% raw %}
+[width="100%",cols="2s,1m,8",options="header"]
+|=======================================================================
+| Name | Java Type | Description
+| cacheManagerFactory | CacheManagerFactory | To use the given CacheManagerFactory for creating
the CacheManager. By default the DefaultCacheManagerFactory is used.
+| configuration | CacheConfiguration | Sets the Cache configuration
+| configurationFile | String | Sets the location of the ehcache.xml file to load from classpath
or file system. By default the file is loaded from classpath:ehcache.xml
+|=======================================================================
+{% endraw %}
 // component options: END
 
+
+
 // endpoint options: START
+The EHCache component supports 20 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| cacheName | common |  | String | *Required* Name of the cache
+| diskExpiryThreadIntervalSeconds | common |  | long | The number of seconds between runs
of the disk expiry thread.
+| diskPersistent | common | false | boolean | Whether the disk store persists between restarts
of the application.
+| diskStorePath | common |  | String | This parameter is ignored. CacheManager sets it using
setter injection.
+| eternal | common | false | boolean | Sets whether elements are eternal. If eternal timeouts
are ignored and the element never expires.
+| key | common |  | String | The default key to use. If a key is provided in the message
header then the key from the header takes precedence.
+| maxElementsInMemory | common | 1000 | int | The number of elements that may be stored in
the defined cache in memory.
+| memoryStoreEvictionPolicy | common | LFU | MemoryStoreEvictionPolicy | Which eviction strategy
to use when maximum number of elements in memory is reached. The strategy defines which elements
to be removed. LRU - Lest Recently Used LFU - Lest Frequently Used FIFO - First In First Out
+| objectCache | common | false | boolean | Whether to turn on allowing to store non serializable
objects in the cache. If this option is enabled then overflow to disk cannot be enabled as
well.
+| operation | common |  | String | The default cache operation to use. If an operation in
the message header then the operation from the header takes precedence.
+| overflowToDisk | common | true | boolean | Specifies whether cache may overflow to disk
+| timeToIdleSeconds | common | 300 | long | The maximum amount of time between accesses before
an element expires
+| timeToLiveSeconds | common | 300 | long | The maximum time between creation time and when
an element expires. Is used only if the element is not eternal
+| bridgeErrorHandler | consumer | false | boolean | 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/ERROR level and ignored.
+| exceptionHandler | consumer (advanced) |  | ExceptionHandler | To let the consumer use
a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options
is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR
level and ignored.
+| cacheLoaderRegistry | advanced |  | CacheLoaderRegistry | To configure cache loader using
the CacheLoaderRegistry
+| cacheManagerFactory | advanced |  | CacheManagerFactory | To use a custom CacheManagerFactory
for creating the CacheManager to be used by this endpoint. By default the CacheManagerFactory
configured on the component is used.
+| eventListenerRegistry | advanced |  | CacheEventListenerRegistry | To configure event listeners
using the CacheEventListenerRegistry
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern
when creating an exchange
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be
strictly used or Camel is allowed to use asynchronous processing (if supported).
+|=======================================================================
+{% endraw %}
 // endpoint options: END
 
+
 [[Cache-SendingReceivingMessagestofromthecache]]
 Sending/Receiving Messages to/from the cache
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

http://git-wip-us.apache.org/repos/asf/camel/blob/02a6a4de/components/camel-chunk/src/main/docs/chunk.adoc
----------------------------------------------------------------------
diff --git a/components/camel-chunk/src/main/docs/chunk.adoc b/components/camel-chunk/src/main/docs/chunk.adoc
index c0996b7..97b2efe 100644
--- a/components/camel-chunk/src/main/docs/chunk.adoc
+++ b/components/camel-chunk/src/main/docs/chunk.adoc
@@ -40,12 +40,34 @@ format, `?option=value&option=value&...`
 Options
 ^^^^^^^
 
+
 // component options: START
+The Chunk component has no options.
 // component options: END
 
+
+
 // endpoint options: START
+The Chunk component supports 9 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| resourceUri | producer |  | String | *Required* Path to the resource or a reference to
lookup a bean in the Registry to use as the resource
+| contentCache | producer | false | boolean | Sets whether to use resource content cache
or not
+| encoding | producer |  | String | Define the encoding of the body
+| extension | producer |  | String | Define the file extension of the template
+| themeFolder | producer |  | String | Define the themes folder to scan
+| themeLayer | producer |  | String | Define the theme layer to elaborate
+| themeSubfolder | producer |  | String | Define the themes subfolder to scan
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern
when creating an exchange
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be
strictly used or Camel is allowed to use asynchronous processing (if supported).
+|=======================================================================
+{% endraw %}
 // endpoint options: END
 
+
 Chunk component will look for a specific template in _themes_ folder
 with extensions _.chtml_ or _.cxml. _If you need to specify a different
 folder or extensions, you will need to use the specific options listed

http://git-wip-us.apache.org/repos/asf/camel/blob/02a6a4de/components/camel-cmis/src/main/docs/cmis.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cmis/src/main/docs/cmis.adoc b/components/camel-cmis/src/main/docs/cmis.adoc
index 3fc8bab..725bcfe 100644
--- a/components/camel-cmis/src/main/docs/cmis.adoc
+++ b/components/camel-cmis/src/main/docs/cmis.adoc
@@ -24,12 +24,31 @@ You can append query options to the URI in the following format,
 CMIS Options
 ^^^^^^^^^^^^
 
+
 // component options: START
+The CMIS component has no options.
 // component options: END
 
+
+
 // endpoint options: START
+The CMIS component supports 6 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| url | common |  | String | *Required* the cmis url
+| bridgeErrorHandler | consumer | false | boolean | 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/ERROR level and ignored.
+| exceptionHandler | consumer (advanced) |  | ExceptionHandler | To let the consumer use
a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options
is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR
level and ignored.
+| queryMode | producer | false | boolean | If true will execute the cmis query from the message
body and return result otherwise will create a node in the cmis repository
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern
when creating an exchange
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be
strictly used or Camel is allowed to use asynchronous processing (if supported).
+|=======================================================================
+{% endraw %}
 // endpoint options: END
 
+
 [[CMIS-Usage]]
 Usage
 ^^^^^


Mime
View raw message