http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc b/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc index 623e40a..cbd0e2b 100644 --- a/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc +++ b/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc @@ -53,133 +53,76 @@ with the following path and query parameters: #### Path Parameters (3 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| hostname | | String | *Required* The hostname of the running rabbitmq instance or cluster. -| portNumber | 5672 | int | *Required* Port number for the host with the running rabbitmq instance or cluster. Default value is 5672. -| exchangeName | | String | *Required* The exchange name determines which exchange produced messages will sent to. In the case of consumers the exchange name determines which exchange the queue will bind to. +| Name | Description | Default | Type +| **hostname** | *Required* The hostname of the running rabbitmq instance or cluster. | | String +| **portNumber** | *Required* Port number for the host with the running rabbitmq instance or cluster. Default value is 5672. | 5672 | int +| **exchangeName** | *Required* The exchange name determines which exchange produced messages will sent to. In the case of consumers the exchange name determines which exchange the queue will bind to. | | String |======================================================================= #### Query Parameters (57 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| autoDelete | true | boolean | If it is true the exchange will be deleted when it is no longer in use - -| connectionTimeout | 60000 | int | Connection timeout - -| deadLetterExchange | | String | The name of the dead letter exchange - -| deadLetterExchangeType | direct | String | The type of the dead letter exchange - -| deadLetterQueue | | String | The name of the dead letter queue - -| deadLetterRoutingKey | | String | The routing key for the dead letter exchange - -| declare | true | boolean | If the option is true camel declare the exchange and queue name and bind them together. If the option is false camel won't declare the exchange and queue name on the server. - -| durable | true | boolean | If we are declaring a durable exchange (the exchange will survive a server restart) - -| exchangeType | direct | String | The exchange type such as direct or topic. - -| exclusive | false | boolean | Exclusive queues may only be accessed by the current connection and are deleted when that connection closes. - -| queue | | String | The queue to receive messages from - -| routingKey | | String | The routing key to use when binding a consumer queue to the exchange. For producer routing keys you set the header rabbitmq.ROUTING_KEY. - -| skipExchangeDeclare | false | boolean | This can be used if we need to declare the queue but not the exchange - -| skipQueueBind | false | boolean | If true the queue will not be bound to the exchange after declaring it - -| skipQueueDeclare | false | boolean | If true the producer will not declare and bind a queue. This can be used for directing messages via an existing routing key. - -| vhost | / | String | The vhost for the channel - 4+^s| consumer -| autoAck | true | boolean | If messages should be auto acknowledged - -| bridgeErrorHandler | 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 or ERROR level and ignored. - -| concurrentConsumers | 1 | int | Number of concurrent consumers when consuming from broker. (eg similar as to the same option for the JMS component). - -| prefetchCount | | int | The maximum number of messages that the server will deliver 0 if unlimited. You need to specify the option of prefetchSize prefetchCount prefetchGlobal at the same time - -| prefetchEnabled | false | boolean | Enables the quality of service on the RabbitMQConsumer side. You need to specify the option of prefetchSize prefetchCount prefetchGlobal at the same time - -| prefetchGlobal | false | boolean | If the settings should be applied to the entire channel rather than each consumer You need to specify the option of prefetchSize prefetchCount prefetchGlobal at the same time - -| prefetchSize | | int | The maximum amount of content (measured in octets) that the server will deliver 0 if unlimited. You need to specify the option of prefetchSize prefetchCount prefetchGlobal at the same time - 4+^s| consumer (advanced) -| exceptionHandler | | 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 or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - -| threadPoolSize | 10 | int | The consumer uses a Thread Pool Executor with a fixed number of threads. This setting allows you to set that number of threads. - 4+^s| producer -| bridgeEndpoint | false | boolean | If the bridgeEndpoint is true the producer will ignore the message header of rabbitmq.EXCHANGE_NAME and rabbitmq.ROUTING_KEY - -| channelPoolMaxSize | 10 | int | Get maximum number of opened channel in pool - -| channelPoolMaxWait | 1000 | long | Set the maximum number of milliseconds to wait for a channel from the pool - -| guaranteedDeliveries | false | boolean | When true an exception will be thrown when the message cannot be delivered (basic.return) and the message is marked as mandatory. PublisherAcknowledgement will also be activated in this case See also publisher acknowledgements - When will messages be confirmed - -| immediate | false | boolean | This flag tells the server how to react if the message cannot be routed to a queue consumer immediately. If this flag is set the server will return an undeliverable message with a Return method. If this flag is zero the server will queue the message but with no guarantee that it will ever be consumed. If the header is present rabbitmq.IMMEDIATE it will override this option. - -| mandatory | false | boolean | This flag tells the server how to react if the message cannot be routed to a queue. If this flag is set the server will return an unroutable message with a Return method. If this flag is zero the server silently drops the message. If the header is present rabbitmq.MANDATORY it will override this option. - -| publisherAcknowledgements | false | boolean | When true the message will be published with publisher acknowledgements turned on - -| publisherAcknowledgementsTimeout | | long | The amount of time in milliseconds to wait for a basic.ack response from RabbitMQ server - 4+^s| advanced -| addresses | | Address[] | If this option is set camel-rabbitmq will try to create connection based on the setting of option addresses. The addresses value is a string which looks like server1:12345 server2:12345 - -| args | | Map | Specify arguments for configuring the different RabbitMQ concepts a different prefix is required for each: Exchange: arg.exchange. Queue: arg.queue. Binding: arg.binding. For example to declare a queue with message ttl argument: http://localhost:5672/exchange/queueargs=arg.queue.x-message-ttl=60000 - -| automaticRecoveryEnabled | | Boolean | Enables connection automatic recovery (uses connection implementation that performs automatic recovery when connection shutdown is not initiated by the application) - -| bindingArgs | | Map | Key/value args for configuring the queue binding parameters when declare=true - -| clientProperties | | Map | Connection client properties (client info used in negotiating with the server) - -| connectionFactory | | ConnectionFactory | To use a custom RabbitMQ connection factory. When this option is set all connection options (connectionTimeout requestedChannelMax...) set on URI are not used - -| exchangeArgs | | Map | Key/value args for configuring the exchange parameters when declare=true - -| exchangeArgsConfigurer | | ArgsConfigurer | Set the configurer for setting the exchange args in Channel.exchangeDeclare - -| networkRecoveryInterval | | Integer | Network recovery interval in milliseconds (interval used when recovering from network failure) - -| queueArgs | | Map | Key/value args for configuring the queue parameters when declare=true - -| queueArgsConfigurer | | ArgsConfigurer | Set the configurer for setting the queue args in Channel.queueDeclare - -| requestedChannelMax | 0 | int | Connection requested channel max (max number of channels offered) - -| requestedFrameMax | 0 | int | Connection requested frame max (max size of frame offered) - -| requestedHeartbeat | 60 | int | Connection requested heartbeat (heart-beat in seconds offered) - -| requestTimeout | | long | Set timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds) - -| requestTimeoutCheckerInterval | | long | Set requestTimeoutCheckerInterval for inOut exchange - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - -| topologyRecoveryEnabled | | Boolean | Enables connection topology recovery (should topology recovery be performed) - -| transferException | false | boolean | When true and an inOut Exchange failed on the consumer side send the caused Exception back in the response - 4+^s| security -| password | guest | String | Password for authenticated access - -| sslProtocol | | String | Enables SSL on connection accepted value are true TLS and 'SSLv3 - -| trustManager | | TrustManager | Configure SSL trust manager SSL should be enabled for this option to be effective - -| username | guest | String | Username in case of authenticated access +| Name | Description | Default | Type +| **autoDelete** (common) | If it is true the exchange will be deleted when it is no longer in use | true | boolean +| **connectionTimeout** (common) | Connection timeout | 60000 | int +| **deadLetterExchange** (common) | The name of the dead letter exchange | | String +| **deadLetterExchangeType** (common) | The type of the dead letter exchange | direct | String +| **deadLetterQueue** (common) | The name of the dead letter queue | | String +| **deadLetterRoutingKey** (common) | The routing key for the dead letter exchange | | String +| **declare** (common) | If the option is true camel declare the exchange and queue name and bind them together. If the option is false camel won't declare the exchange and queue name on the server. | true | boolean +| **durable** (common) | If we are declaring a durable exchange (the exchange will survive a server restart) | true | boolean +| **exchangeType** (common) | The exchange type such as direct or topic. | direct | String +| **exclusive** (common) | Exclusive queues may only be accessed by the current connection and are deleted when that connection closes. | false | boolean +| **queue** (common) | The queue to receive messages from | | String +| **routingKey** (common) | The routing key to use when binding a consumer queue to the exchange. For producer routing keys you set the header rabbitmq.ROUTING_KEY. | | String +| **skipExchangeDeclare** (common) | This can be used if we need to declare the queue but not the exchange | false | boolean +| **skipQueueBind** (common) | If true the queue will not be bound to the exchange after declaring it | false | boolean +| **skipQueueDeclare** (common) | If true the producer will not declare and bind a queue. This can be used for directing messages via an existing routing key. | false | boolean +| **vhost** (common) | The vhost for the channel | / | String +| **autoAck** (consumer) | If messages should be auto acknowledged | true | 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 +| **concurrentConsumers** (consumer) | Number of concurrent consumers when consuming from broker. (eg similar as to the same option for the JMS component). | 1 | int +| **prefetchCount** (consumer) | The maximum number of messages that the server will deliver 0 if unlimited. You need to specify the option of prefetchSize prefetchCount prefetchGlobal at the same time | | int +| **prefetchEnabled** (consumer) | Enables the quality of service on the RabbitMQConsumer side. You need to specify the option of prefetchSize prefetchCount prefetchGlobal at the same time | false | boolean +| **prefetchGlobal** (consumer) | If the settings should be applied to the entire channel rather than each consumer You need to specify the option of prefetchSize prefetchCount prefetchGlobal at the same time | false | boolean +| **prefetchSize** (consumer) | The maximum amount of content (measured in octets) that the server will deliver 0 if unlimited. You need to specify the option of prefetchSize prefetchCount prefetchGlobal at the same time | | int +| **exceptionHandler** (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **threadPoolSize** (consumer) | The consumer uses a Thread Pool Executor with a fixed number of threads. This setting allows you to set that number of threads. | 10 | int +| **bridgeEndpoint** (producer) | If the bridgeEndpoint is true the producer will ignore the message header of rabbitmq.EXCHANGE_NAME and rabbitmq.ROUTING_KEY | false | boolean +| **channelPoolMaxSize** (producer) | Get maximum number of opened channel in pool | 10 | int +| **channelPoolMaxWait** (producer) | Set the maximum number of milliseconds to wait for a channel from the pool | 1000 | long +| **guaranteedDeliveries** (producer) | When true an exception will be thrown when the message cannot be delivered (basic.return) and the message is marked as mandatory. PublisherAcknowledgement will also be activated in this case See also publisher acknowledgements - When will messages be confirmed | false | boolean +| **immediate** (producer) | This flag tells the server how to react if the message cannot be routed to a queue consumer immediately. If this flag is set the server will return an undeliverable message with a Return method. If this flag is zero the server will queue the message but with no guarantee that it will ever be consumed. If the header is present rabbitmq.IMMEDIATE it will override this option. | false | boolean +| **mandatory** (producer) | This flag tells the server how to react if the message cannot be routed to a queue. If this flag is set the server will return an unroutable message with a Return method. If this flag is zero the server silently drops the message. If the header is present rabbitmq.MANDATORY it will override this option. | false | boolean +| **publisherAcknowledgements** (producer) | When true the message will be published with publisher acknowledgements turned on | false | boolean +| **publisherAcknowledgements Timeout** (producer) | The amount of time in milliseconds to wait for a basic.ack response from RabbitMQ server | | long +| **addresses** (advanced) | If this option is set camel-rabbitmq will try to create connection based on the setting of option addresses. The addresses value is a string which looks like server1:12345 server2:12345 | | Address[] +| **args** (advanced) | Specify arguments for configuring the different RabbitMQ concepts a different prefix is required for each: Exchange: arg.exchange. Queue: arg.queue. Binding: arg.binding. For example to declare a queue with message ttl argument: http://localhost:5672/exchange/queueargs=arg.queue.x-message-ttl=60000 | | Map +| **automaticRecoveryEnabled** (advanced) | Enables connection automatic recovery (uses connection implementation that performs automatic recovery when connection shutdown is not initiated by the application) | | Boolean +| **bindingArgs** (advanced) | Key/value args for configuring the queue binding parameters when declare=true | | Map +| **clientProperties** (advanced) | Connection client properties (client info used in negotiating with the server) | | Map +| **connectionFactory** (advanced) | To use a custom RabbitMQ connection factory. When this option is set all connection options (connectionTimeout requestedChannelMax...) set on URI are not used | | ConnectionFactory +| **exchangeArgs** (advanced) | Key/value args for configuring the exchange parameters when declare=true | | Map +| **exchangeArgsConfigurer** (advanced) | Set the configurer for setting the exchange args in Channel.exchangeDeclare | | ArgsConfigurer +| **networkRecoveryInterval** (advanced) | Network recovery interval in milliseconds (interval used when recovering from network failure) | | Integer +| **queueArgs** (advanced) | Key/value args for configuring the queue parameters when declare=true | | Map +| **queueArgsConfigurer** (advanced) | Set the configurer for setting the queue args in Channel.queueDeclare | | ArgsConfigurer +| **requestedChannelMax** (advanced) | Connection requested channel max (max number of channels offered) | 0 | int +| **requestedFrameMax** (advanced) | Connection requested frame max (max size of frame offered) | 0 | int +| **requestedHeartbeat** (advanced) | Connection requested heartbeat (heart-beat in seconds offered) | 60 | int +| **requestTimeout** (advanced) | Set timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds) | | long +| **requestTimeoutChecker Interval** (advanced) | Set requestTimeoutCheckerInterval for inOut exchange | | long +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **topologyRecoveryEnabled** (advanced) | Enables connection topology recovery (should topology recovery be performed) | | Boolean +| **transferException** (advanced) | When true and an inOut Exchange failed on the consumer side send the caused Exception back in the response | false | boolean +| **password** (security) | Password for authenticated access | guest | String +| **sslProtocol** (security) | Enables SSL on connection accepted value are true TLS and 'SSLv3 | | String +| **trustManager** (security) | Configure SSL trust manager SSL should be enabled for this option to be effective | | TrustManager +| **username** (security) | Username in case of authenticated access | guest | String |======================================================================= // endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-reactive-streams/src/main/docs/reactive-streams-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-reactive-streams/src/main/docs/reactive-streams-component.adoc b/components/camel-reactive-streams/src/main/docs/reactive-streams-component.adoc index 62fd3fe..0c6fc8a 100644 --- a/components/camel-reactive-streams/src/main/docs/reactive-streams-component.adoc +++ b/components/camel-reactive-streams/src/main/docs/reactive-streams-component.adoc @@ -48,15 +48,12 @@ The Reactive Streams component supports 3 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| common -| internalEngineConfiguration | | ReactiveStreamsEngineConfiguration | Configures the internal engine for Reactive Streams. - -| backpressureStrategy | | ReactiveStreamsBackpressureStrategy | The backpressure strategy to use when pushing events to a slow subscriber. - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **internalEngine Configuration** (common) | Configures the internal engine for Reactive Streams. | | ReactiveStreamsEngine Configuration +| **backpressureStrategy** (common) | The backpressure strategy to use when pushing events to a slow subscriber. | | ReactiveStreams BackpressureStrategy +| **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 |======================================================================= // component options: END @@ -73,37 +70,27 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| stream | | String | Name of the stream channel used by the endpoint to exchange messages. +| Name | Description | Default | Type +| **stream** | Name of the stream channel used by the endpoint to exchange messages. | | String |======================================================================= #### Query Parameters (10 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| serviceName | | String | Allows using an alternative CamelReactiveStreamService implementation. The implementation is looked up from the registry. - 4+^s| consumer -| bridgeErrorHandler | 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 or ERROR level and ignored. - -| concurrentConsumers | 1 | int | Number of threads used to process exchanges in the Camel route. - -| forwardOnComplete | false | boolean | Determines if onComplete events should be pushed to the Camel route. - -| forwardOnError | false | boolean | Determines if onError events should be pushed to the Camel route. Exceptions will be set as message body. - -| maxInflightExchanges | 128 | Integer | Maximum number of exchanges concurrently being processed by Camel. This parameter controls backpressure on the stream. Setting a non-positive value will disable backpressure. - 4+^s| consumer (advanced) -| exceptionHandler | | 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 or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| producer -| backpressureStrategy | | ReactiveStreamsBackpressureStrategy | The backpressure strategy to use when pushing events to a slow subscriber. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **serviceName** (common) | Allows using an alternative CamelReactiveStreamService implementation. The implementation is looked up from the registry. | | 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 +| **concurrentConsumers** (consumer) | Number of threads used to process exchanges in the Camel route. | 1 | int +| **forwardOnComplete** (consumer) | Determines if onComplete events should be pushed to the Camel route. | false | boolean +| **forwardOnError** (consumer) | Determines if onError events should be pushed to the Camel route. Exceptions will be set as message body. | false | boolean +| **maxInflightExchanges** (consumer) | Maximum number of exchanges concurrently being processed by Camel. This parameter controls backpressure on the stream. Setting a non-positive value will disable backpressure. | 128 | Integer +| **exceptionHandler** (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **backpressureStrategy** (producer) | The backpressure strategy to use when pushing events to a slow subscriber. | | ReactiveStreams BackpressureStrategy +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc b/components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc index 9be24f4..0d07e2c 100644 --- a/components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc +++ b/components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc @@ -80,23 +80,16 @@ The REST Swagger component supports 7 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| producer -| basePath | | String | API basePath for example /v2. Default is unset if set overrides the value present in Swagger specification. - -| componentName | | String | Name of the Camel component that will perform the requests. The compnent must be present in Camel registry and it must implement RestProducerFactory service provider interface. If not set CLASSPATH is searched for single component that implements RestProducerFactory SPI. Can be overriden in endpoint configuration. - -| consumes | | String | What payload type this component capable of consuming. Could be one type like application/json or multiple types as application/json application/xml; q=0.5 according to the RFC7231. This equates to the value of Accept HTTP header. If set overrides any value found in the Swagger specification. Can be overriden in endpoint configuration - -| host | | String | Scheme hostname and port to direct the HTTP requests to in the form of https://hostname:port. Can be configured at the endpoint component or in the correspoding REST configuration in the Camel Context. If you give this component a name (e.g. petstore) that REST configuration is consulted first rest-swagger next and global configuration last. If set overrides any value found in the Swagger specification RestConfiguration. Can be overriden in endpoint configuration. - -| produces | | String | What payload type this component is producing. For example application/json according to the RFC7231. This equates to the value of Content-Type HTTP header. If set overrides any value present in the Swagger specification. Can be overriden in endpoint configuration. - -| specificationUri | swagger.json | URI | Path to the Swagger specification file. The scheme host base path are taken from this specification but these can be overriden with properties on the component or endpoint level. If not given the component tries to load swagger.json resource. Note that the host defined on the component and endpoint of this Component should contain the scheme hostname and optionally the port in the URI syntax (i.e. https://api.example.com:8080). Can be overriden in endpoint configuration. - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **basePath** (producer) | API basePath for example /v2. Default is unset if set overrides the value present in Swagger specification. | | String +| **componentName** (producer) | Name of the Camel component that will perform the requests. The compnent must be present in Camel registry and it must implement RestProducerFactory service provider interface. If not set CLASSPATH is searched for single component that implements RestProducerFactory SPI. Can be overriden in endpoint configuration. | | String +| **consumes** (producer) | What payload type this component capable of consuming. Could be one type like application/json or multiple types as application/json application/xml; q=0.5 according to the RFC7231. This equates to the value of Accept HTTP header. If set overrides any value found in the Swagger specification. Can be overriden in endpoint configuration | | String +| **host** (producer) | Scheme hostname and port to direct the HTTP requests to in the form of https://hostname:port. Can be configured at the endpoint component or in the correspoding REST configuration in the Camel Context. If you give this component a name (e.g. petstore) that REST configuration is consulted first rest-swagger next and global configuration last. If set overrides any value found in the Swagger specification RestConfiguration. Can be overriden in endpoint configuration. | | String +| **produces** (producer) | What payload type this component is producing. For example application/json according to the RFC7231. This equates to the value of Content-Type HTTP header. If set overrides any value present in the Swagger specification. Can be overriden in endpoint configuration. | | String +| **specificationUri** (producer) | Path to the Swagger specification file. The scheme host base path are taken from this specification but these can be overriden with properties on the component or endpoint level. If not given the component tries to load swagger.json resource. Note that the host defined on the component and endpoint of this Component should contain the scheme hostname and optionally the port in the URI syntax (i.e. https://api.example.com:8080). Can be overriden in endpoint configuration. | swagger.json | URI +| **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 |======================================================================= // component options: END @@ -109,30 +102,24 @@ with the following path and query parameters: #### Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| specificationUri | swagger.json | URI | Path to the Swagger specification file. The scheme host base path are taken from this specification but these can be overriden with properties on the component or endpoint level. If not given the component tries to load swagger.json resource. Note that the host defined on the component and endpoint of this Component should contain the scheme hostname and optionally the port in the URI syntax (i.e. https://api.example.com:8080). Overrides component configuration. -| operationId | | String | *Required* ID of the operation from the Swagger specification. +| Name | Description | Default | Type +| **specificationUri** | Path to the Swagger specification file. The scheme host base path are taken from this specification but these can be overriden with properties on the component or endpoint level. If not given the component tries to load swagger.json resource. Note that the host defined on the component and endpoint of this Component should contain the scheme hostname and optionally the port in the URI syntax (i.e. https://api.example.com:8080). Overrides component configuration. | swagger.json | URI +| **operationId** | *Required* ID of the operation from the Swagger specification. | | String |======================================================================= #### Query Parameters (6 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| basePath | | String | API basePath for example /v2. Default is unset if set overrides the value present in Swagger specification and in the component configuration. - -| componentName | | String | Name of the Camel component that will perform the requests. The compnent must be present in Camel registry and it must implement RestProducerFactory service provider interface. If not set CLASSPATH is searched for single component that implements RestProducerFactory SPI. Overrides component configuration. - -| consumes | | String | What payload type this component capable of consuming. Could be one type like application/json or multiple types as application/json application/xml; q=0.5 according to the RFC7231. This equates to the value of Accept HTTP header. If set overrides any value found in the Swagger specification and. in the component configuration - -| host | | String | Scheme hostname and port to direct the HTTP requests to in the form of https://hostname:port. Can be configured at the endpoint component or in the correspoding REST configuration in the Camel Context. If you give this component a name (e.g. petstore) that REST configuration is consulted first rest-swagger next and global configuration last. If set overrides any value found in the Swagger specification RestConfiguration. Overrides all other configuration. - -| produces | | String | What payload type this component is producing. For example application/json according to the RFC7231. This equates to the value of Content-Type HTTP header. If set overrides any value present in the Swagger specification. Overrides all other configuration. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **basePath** (producer) | API basePath for example /v2. Default is unset if set overrides the value present in Swagger specification and in the component configuration. | | String +| **componentName** (producer) | Name of the Camel component that will perform the requests. The compnent must be present in Camel registry and it must implement RestProducerFactory service provider interface. If not set CLASSPATH is searched for single component that implements RestProducerFactory SPI. Overrides component configuration. | | String +| **consumes** (producer) | What payload type this component capable of consuming. Could be one type like application/json or multiple types as application/json application/xml; q=0.5 according to the RFC7231. This equates to the value of Accept HTTP header. If set overrides any value found in the Swagger specification and. in the component configuration | | String +| **host** (producer) | Scheme hostname and port to direct the HTTP requests to in the form of https://hostname:port. Can be configured at the endpoint component or in the correspoding REST configuration in the Camel Context. If you give this component a name (e.g. petstore) that REST configuration is consulted first rest-swagger next and global configuration last. If set overrides any value found in the Swagger specification RestConfiguration. Overrides all other configuration. | | String +| **produces** (producer) | What payload type this component is producing. For example application/json according to the RFC7231. This equates to the value of Content-Type HTTP header. If set overrides any value present in the Swagger specification. Overrides all other configuration. | | String +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-restlet/src/main/docs/restlet-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-restlet/src/main/docs/restlet-component.adoc b/components/camel-restlet/src/main/docs/restlet-component.adoc index 7668370..6730bbe 100644 --- a/components/camel-restlet/src/main/docs/restlet-component.adoc +++ b/components/camel-restlet/src/main/docs/restlet-component.adoc @@ -66,51 +66,30 @@ The Restlet component supports 21 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| consumer (advanced) -| controllerDaemon | | Boolean | Indicates if the controller thread should be a daemon (not blocking JVM exit). - -| controllerSleepTimeMs | | Integer | Time for the controller thread to sleep between each control. - 4+^s| consumer -| inboundBufferSize | | Integer | The size of the buffer when reading messages. - 4+^s| common -| maxConnectionsPerHost | | Integer | Maximum number of concurrent connections per host (IP address). - 4+^s| consumer (advanced) -| maxThreads | | Integer | Maximum threads that will service requests. - -| lowThreads | | Integer | Number of worker threads determining when the connector is considered overloaded. - 4+^s| common -| maxTotalConnections | | Integer | Maximum number of concurrent connections in total. - 4+^s| consumer (advanced) -| minThreads | | Integer | Minimum threads waiting to service requests. - 4+^s| consumer -| outboundBufferSize | | Integer | The size of the buffer when writing messages. - 4+^s| consumer (advanced) -| persistingConnections | | Boolean | Indicates if connections should be kept alive after a call. - -| pipeliningConnections | | Boolean | Indicates if pipelining connections are supported. - -| threadMaxIdleTimeMs | | Integer | Time for an idle thread to wait for an operation before being collected. - 4+^s| consumer -| useForwardedForHeader | | Boolean | Lookup the X-Forwarded-For header supported by popular proxies and caches and uses it to populate the Request.getClientAddresses() method result. This information is only safe for intermediary components within your local network. Other addresses could easily be changed by setting a fake header and should not be trusted for serious security checks. - -| reuseAddress | | Boolean | Enable/disable the SO_REUSEADDR socket option. See java.io.ServerSocketreuseAddress property for additional details. - 4+^s| consumer (advanced) -| maxQueued | | Integer | Maximum number of calls that can be queued if there aren't any worker thread available to service them. If the value is '0' then no queue is used and calls are rejected if no worker thread is immediately available. If the value is '-1' then an unbounded queue is used and calls are never rejected. - -| disableStreamCache | false | boolean | Determines whether or not the raw input stream from Restlet 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 Restlet input stream to support reading it multiple times to ensure 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 persistent store. DefaultRestletBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. - 4+^s| consumer -| port | | int | To configure the port number for the restlet consumer routes. This allows to configure this once to reuse the same port for these consumers. - 4+^s| producer -| synchronous | | Boolean | Whether to use synchronous Restlet Client for the producer. Setting this option to true can yield faster performance as it seems the Restlet synchronous Client works better. - 4+^s| advanced -| enabledConverters | | List | A list of converters to enable as full class name or simple class name. All the converters automatically registered are enabled if empty or null - 4+^s| filter -| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **controllerDaemon** (consumer) | Indicates if the controller thread should be a daemon (not blocking JVM exit). | | Boolean +| **controllerSleepTimeMs** (consumer) | Time for the controller thread to sleep between each control. | | Integer +| **inboundBufferSize** (consumer) | The size of the buffer when reading messages. | | Integer +| **maxConnectionsPerHost** (common) | Maximum number of concurrent connections per host (IP address). | | Integer +| **maxThreads** (consumer) | Maximum threads that will service requests. | | Integer +| **lowThreads** (consumer) | Number of worker threads determining when the connector is considered overloaded. | | Integer +| **maxTotalConnections** (common) | Maximum number of concurrent connections in total. | | Integer +| **minThreads** (consumer) | Minimum threads waiting to service requests. | | Integer +| **outboundBufferSize** (consumer) | The size of the buffer when writing messages. | | Integer +| **persistingConnections** (consumer) | Indicates if connections should be kept alive after a call. | | Boolean +| **pipeliningConnections** (consumer) | Indicates if pipelining connections are supported. | | Boolean +| **threadMaxIdleTimeMs** (consumer) | Time for an idle thread to wait for an operation before being collected. | | Integer +| **useForwardedForHeader** (consumer) | Lookup the X-Forwarded-For header supported by popular proxies and caches and uses it to populate the Request.getClientAddresses() method result. This information is only safe for intermediary components within your local network. Other addresses could easily be changed by setting a fake header and should not be trusted for serious security checks. | | Boolean +| **reuseAddress** (consumer) | Enable/disable the SO_REUSEADDR socket option. See java.io.ServerSocketreuseAddress property for additional details. | | Boolean +| **maxQueued** (consumer) | Maximum number of calls that can be queued if there aren't any worker thread available to service them. If the value is '0' then no queue is used and calls are rejected if no worker thread is immediately available. If the value is '-1' then an unbounded queue is used and calls are never rejected. | | Integer +| **disableStreamCache** (consumer) | Determines whether or not the raw input stream from Restlet 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 Restlet input stream to support reading it multiple times to ensure 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 persistent store. DefaultRestletBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. | false | boolean +| **port** (consumer) | To configure the port number for the restlet consumer routes. This allows to configure this once to reuse the same port for these consumers. | | int +| **synchronous** (producer) | Whether to use synchronous Restlet Client for the producer. Setting this option to true can yield faster performance as it seems the Restlet synchronous Client works better. | | Boolean +| **enabledConverters** (advanced) | A list of converters to enable as full class name or simple class name. All the converters automatically registered are enabled if empty or null | | List +| **headerFilterStrategy** (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy +| **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 |======================================================================= // component options: END @@ -126,56 +105,38 @@ with the following path and query parameters: #### Path Parameters (4 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| protocol | | String | *Required* The protocol to use which is http or https -| host | | String | *Required* The hostname of the restlet service -| port | 80 | int | *Required* The port number of the restlet service -| uriPattern | | String | The resource pattern such as /customer/id +| Name | Description | Default | Type +| **protocol** | *Required* The protocol to use which is http or https | | String +| **host** | *Required* The hostname of the restlet service | | String +| **port** | *Required* The port number of the restlet service | 80 | int +| **uriPattern** | The resource pattern such as /customer/id | | String |======================================================================= #### Query Parameters (18 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| restletMethod | GET | Method | On a producer endpoint specifies the request method to use. On a consumer endpoint specifies that the endpoint consumes only restletMethod requests. - 4+^s| consumer -| bridgeErrorHandler | 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 or ERROR level and ignored. - -| restletMethods | | String | Specify one or more methods separated by commas (e.g. restletMethods=postput) to be serviced by a restlet consumer endpoint. If both restletMethod and restletMethods options are specified the restletMethod setting is ignored. The possible methods are: ALLCONNECTDELETEGETHEADOPTIONSPATCHPOSTPUTTRACE - -| restletUriPatterns | | List | Specify one ore more URI templates to be serviced by a restlet consumer endpoint using the notation to reference a List in the Camel Registry. If a URI pattern has been defined in the endpoint URI both the URI pattern defined in the endpoint and the restletUriPatterns option will be honored. - 4+^s| consumer (advanced) -| disableStreamCache | false | boolean | Determines whether or not the raw input stream from Restlet 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 Restlet input stream to support reading it multiple times to ensure 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 persistent store. DefaultRestletBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. - -| exceptionHandler | | 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 or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| producer -| connectTimeout | 30000 | int | The Client will give up connection if the connection is timeout 0 for unlimited wait. - -| cookieHandler | | CookieHandler | Configure a cookie handler to maintain a HTTP session - -| socketTimeout | 30000 | int | The Client socket receive timeout 0 for unlimited wait. - -| throwExceptionOnFailure | true | boolean | Whether to throw exception on a producer failure. If this option is false then the http status code is set as a message header which can be checked if it has an error value. - 4+^s| producer (advanced) -| autoCloseStream | false | boolean | Whether to auto close the stream representation as response from calling a REST service using the restlet producer. If the response is streaming and the option streamRepresentation is enabled then you may want to auto close the InputStream from the streaming response to ensure the input stream is closed when the Camel Exchange is done being routed. However if you need to read the stream outside a Camel route you may need to not auto close the stream. - -| streamRepresentation | false | boolean | Whether to support stream representation as response from calling a REST service using the restlet producer. If the response is streaming then this option can be enabled to use an java.io.InputStream as the message body on the Camel Message body. If using this option you may want to enable the autoCloseStream option as well to ensure the input stream is closed when the Camel Exchange is done being routed. However if you need to read the stream outside a Camel route you may need to not auto close the stream. - 4+^s| advanced -| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message. - -| restletBinding | | RestletBinding | To use a custom RestletBinding to bind between Restlet and Camel message. - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| security -| restletRealm | | Map | To configure the security realms of restlet as a map. - -| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters. +| Name | Description | Default | Type +| **restletMethod** (common) | On a producer endpoint specifies the request method to use. On a consumer endpoint specifies that the endpoint consumes only restletMethod requests. | GET | Method +| **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 +| **restletMethods** (consumer) | Specify one or more methods separated by commas (e.g. restletMethods=postput) to be serviced by a restlet consumer endpoint. If both restletMethod and restletMethods options are specified the restletMethod setting is ignored. The possible methods are: ALLCONNECTDELETEGETHEADOPTIONSPATCHPOSTPUTTRACE | | String +| **restletUriPatterns** (consumer) | Specify one ore more URI templates to be serviced by a restlet consumer endpoint using the notation to reference a List in the Camel Registry. If a URI pattern has been defined in the endpoint URI both the URI pattern defined in the endpoint and the restletUriPatterns option will be honored. | | List +| **disableStreamCache** (consumer) | Determines whether or not the raw input stream from Restlet 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 Restlet input stream to support reading it multiple times to ensure 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 persistent store. DefaultRestletBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. | false | boolean +| **exceptionHandler** (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **connectTimeout** (producer) | The Client will give up connection if the connection is timeout 0 for unlimited wait. | 30000 | int +| **cookieHandler** (producer) | Configure a cookie handler to maintain a HTTP session | | CookieHandler +| **socketTimeout** (producer) | The Client socket receive timeout 0 for unlimited wait. | 30000 | int +| **throwExceptionOnFailure** (producer) | Whether to throw exception on a producer failure. If this option is false then the http status code is set as a message header which can be checked if it has an error value. | true | boolean +| **autoCloseStream** (producer) | Whether to auto close the stream representation as response from calling a REST service using the restlet producer. If the response is streaming and the option streamRepresentation is enabled then you may want to auto close the InputStream from the streaming response to ensure the input stream is closed when the Camel Exchange is done being routed. However if you need to read the stream outside a Camel route you may need to not auto close the stream. | false | boolean +| **streamRepresentation** (producer) | Whether to support stream representation as response from calling a REST service using the restlet producer. If the response is streaming then this option can be enabled to use an java.io.InputStream as the message body on the Camel Message body. If using this option you may want to enable the autoCloseStream option as well to ensure the input stream is closed when the Camel Exchange is done being routed. However if you need to read the stream outside a Camel route you may need to not auto close the stream. | false | boolean +| **headerFilterStrategy** (advanced) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy +| **restletBinding** (advanced) | To use a custom RestletBinding to bind between Restlet and Camel message. | | RestletBinding +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **restletRealm** (security) | To configure the security realms of restlet as a map. | | Map +| **sslContextParameters** (security) | To configure security using SSLContextParameters. | | SSLContextParameters |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-rmi/src/main/docs/rmi-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-rmi/src/main/docs/rmi-component.adoc b/components/camel-rmi/src/main/docs/rmi-component.adoc index 15a4f52..a7f89d6 100644 --- a/components/camel-rmi/src/main/docs/rmi-component.adoc +++ b/components/camel-rmi/src/main/docs/rmi-component.adoc @@ -61,31 +61,25 @@ with the following path and query parameters: #### Path Parameters (3 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| hostname | localhost | String | Hostname of RMI server -| name | | String | *Required* Name to use when binding to RMI server -| port | 1099 | int | Port number of RMI server +| Name | Description | Default | Type +| **hostname** | Hostname of RMI server | localhost | String +| **name** | *Required* Name to use when binding to RMI server | | String +| **port** | Port number of RMI server | 1099 | int |======================================================================= #### Query Parameters (6 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| method | | String | You can set the name of the method to invoke. - -| remoteInterfaces | | List | To specific the remote interfaces. - 4+^s| consumer -| bridgeErrorHandler | 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 or ERROR level and ignored. - 4+^s| consumer (advanced) -| exceptionHandler | | 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 or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **method** (common) | You can set the name of the method to invoke. | | String +| **remoteInterfaces** (common) | To specific the remote interfaces. | | List +| **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 +| **exceptionHandler** (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-routebox/src/main/docs/routebox-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-routebox/src/main/docs/routebox-component.adoc b/components/camel-routebox/src/main/docs/routebox-component.adoc index 4919683..16bcaa5 100644 --- a/components/camel-routebox/src/main/docs/routebox-component.adoc +++ b/components/camel-routebox/src/main/docs/routebox-component.adoc @@ -113,51 +113,34 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| routeboxName | | String | *Required* Logical name for the routebox (eg like a queue name) +| Name | Description | Default | Type +| **routeboxName** | *Required* Logical name for the routebox (eg like a queue name) | | String |======================================================================= #### Query Parameters (17 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| dispatchMap | | Map | A string representing a key in the Camel Registry matching an object value of the type HashMap. The HashMap key should contain strings that can be matched against the value set for the exchange header ROUTE_DISPATCH_KEY. The HashMap value should contain inner route consumer URI's to which requests should be directed. - -| dispatchStrategy | | RouteboxDispatchStrategy | To use a custom RouteboxDispatchStrategy which allows to use custom dispatching instead of the default. - -| forkContext | true | boolean | Whether to fork and create a new inner CamelContext instead of reusing the same CamelContext. - -| innerProtocol | direct | String | The Protocol used internally by the Routebox component. Can be Direct or SEDA. The Routebox component currently offers protocols that are JVM bound. - -| queueSize | | int | Create a fixed size queue to receive requests. - 4+^s| consumer -| bridgeErrorHandler | 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 or ERROR level and ignored. - -| pollInterval | 1000 | long | The timeout used when polling from seda. When a timeout occurs the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. - -| threads | 20 | int | Number of threads to be used by the routebox to receive requests. - 4+^s| consumer (advanced) -| exceptionHandler | | 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 or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| producer -| connectionTimeout | 20000 | long | Timeout in millis used by the producer when sending a message. - -| sendToConsumer | true | boolean | Dictates whether a Producer endpoint sends a request to an external routebox consumer. If the setting is false the Producer creates an embedded inner context and processes requests internally. - 4+^s| advanced -| innerContext | | CamelContext | A string representing a key in the Camel Registry matching an object value of the type org.apache.camel.CamelContext. If a CamelContext is not provided by the user a CamelContext is automatically created for deployment of inner routes. - -| innerProducerTemplate | | ProducerTemplate | The ProducerTemplate to use by the internal embeded CamelContext - -| innerRegistry | | Registry | To use a custom registry for the internal embedded CamelContext. - -| routeBuilders | | String | A string representing a key in the Camel Registry matching an object value of the type List. If the user does not supply an innerContext pre-primed with inner routes the routeBuilders option must be provided as a non-empty list of RouteBuilders containing inner routes - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **dispatchMap** (common) | A string representing a key in the Camel Registry matching an object value of the type HashMap. The HashMap key should contain strings that can be matched against the value set for the exchange header ROUTE_DISPATCH_KEY. The HashMap value should contain inner route consumer URI's to which requests should be directed. | | Map +| **dispatchStrategy** (common) | To use a custom RouteboxDispatchStrategy which allows to use custom dispatching instead of the default. | | RouteboxDispatch Strategy +| **forkContext** (common) | Whether to fork and create a new inner CamelContext instead of reusing the same CamelContext. | true | boolean +| **innerProtocol** (common) | The Protocol used internally by the Routebox component. Can be Direct or SEDA. The Routebox component currently offers protocols that are JVM bound. | direct | String +| **queueSize** (common) | Create a fixed size queue to receive requests. | | int +| **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 +| **pollInterval** (consumer) | The timeout used when polling from seda. When a timeout occurs the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. | 1000 | long +| **threads** (consumer) | Number of threads to be used by the routebox to receive requests. | 20 | int +| **exceptionHandler** (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **connectionTimeout** (producer) | Timeout in millis used by the producer when sending a message. | 20000 | long +| **sendToConsumer** (producer) | Dictates whether a Producer endpoint sends a request to an external routebox consumer. If the setting is false the Producer creates an embedded inner context and processes requests internally. | true | boolean +| **innerContext** (advanced) | A string representing a key in the Camel Registry matching an object value of the type org.apache.camel.CamelContext. If a CamelContext is not provided by the user a CamelContext is automatically created for deployment of inner routes. | | CamelContext +| **innerProducerTemplate** (advanced) | The ProducerTemplate to use by the internal embeded CamelContext | | ProducerTemplate +| **innerRegistry** (advanced) | To use a custom registry for the internal embedded CamelContext. | | Registry +| **routeBuilders** (advanced) | A string representing a key in the Camel Registry matching an object value of the type List. If the user does not supply an innerContext pre-primed with inner routes the routeBuilders option must be provided as a non-empty list of RouteBuilders containing inner routes | | String +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-rss/src/main/docs/rss-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-rss/src/main/docs/rss-component.adoc b/components/camel-rss/src/main/docs/rss-component.adoc index 3c4b7ef..02b3387 100644 --- a/components/camel-rss/src/main/docs/rss-component.adoc +++ b/components/camel-rss/src/main/docs/rss-component.adoc @@ -56,71 +56,44 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| feedUri | | String | *Required* The URI to the feed to poll. +| Name | Description | Default | Type +| **feedUri** | *Required* The URI to the feed to poll. | | String |======================================================================= #### Query Parameters (27 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| bridgeErrorHandler | 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 or ERROR level and ignored. - -| feedHeader | true | boolean | Sets whether to add the feed object as a header - -| filter | true | boolean | Sets whether to use filtering or not of the entries. - -| lastUpdate | | Date | Sets the timestamp to be used for filtering entries from the atom feeds. This options is only in conjunction with the splitEntries. - -| password | | String | Sets the password to be used for basic authentication when polling from a HTTP feed - -| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. - -| sortEntries | false | boolean | Sets whether to sort entries by published date. Only works when splitEntries = true. - -| splitEntries | true | boolean | Sets whether or not entries should be sent individually or whether the entire feed should be sent as a single message - -| throttleEntries | true | boolean | Sets whether all entries identified in a single feed poll should be delivered immediately. If true only one entry is processed per consumer.delay. Only applicable when splitEntries = true. - -| username | | String | Sets the username to be used for basic authentication when polling from a HTTP feed - 4+^s| consumer (advanced) -| exceptionHandler | | 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 or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - -| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| scheduler -| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. - -| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. - -| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. - -| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). - -| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. - -| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). - -| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. - -| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. - -| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component - -| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. - -| startScheduler | true | boolean | Whether the scheduler should be auto started. - -| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. - -| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. +| 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 +| **feedHeader** (consumer) | Sets whether to add the feed object as a header | true | boolean +| **filter** (consumer) | Sets whether to use filtering or not of the entries. | true | boolean +| **lastUpdate** (consumer) | Sets the timestamp to be used for filtering entries from the atom feeds. This options is only in conjunction with the splitEntries. | | Date +| **password** (consumer) | Sets the password to be used for basic authentication when polling from a HTTP feed | | String +| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean +| **sortEntries** (consumer) | Sets whether to sort entries by published date. Only works when splitEntries = true. | false | boolean +| **splitEntries** (consumer) | Sets whether or not entries should be sent individually or whether the entire feed should be sent as a single message | true | boolean +| **throttleEntries** (consumer) | Sets whether all entries identified in a single feed poll should be delivered immediately. If true only one entry is processed per consumer.delay. Only applicable when splitEntries = true. | true | boolean +| **username** (consumer) | Sets the username to be used for basic authentication when polling from a HTTP feed | | String +| **exceptionHandler** (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int +| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int +| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int +| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long +| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean +| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long +| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel +| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service +| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler +| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map +| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean +| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit +| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean |======================================================================= // endpoint options: END
