| // spring-boot-auto-configure options: START |
| :page-partial: |
| :doctitle: Camel Spring Boot Starter for resteasy |
| |
| == Spring Boot Auto-Configuration |
| |
| When using resteasy with Spring Boot make sure to use the following Maven dependency to have support for auto configuration: |
| |
| [source,xml] |
| ---- |
| <dependency> |
| <groupId>org.apache.camel.springboot</groupId> |
| <artifactId>camel-resteasy-starter</artifactId> |
| <version>x.x.x</version> |
| <!-- use the same version as your Camel core version --> |
| </dependency> |
| ---- |
| |
| |
| The component supports 18 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Type |
| | *camel.component.resteasy.allow-java-serialized-object* | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. | false | Boolean |
| | *camel.component.resteasy.auth-caching-disabled* | Disables authentication scheme caching | false | Boolean |
| | *camel.component.resteasy.automatic-retries-disabled* | Disables automatic request recovery and re-execution | false | Boolean |
| | *camel.component.resteasy.autowired-enabled* | 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 |
| | *camel.component.resteasy.bridge-error-handler* | 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 |
| | *camel.component.resteasy.connection-state-disabled* | Disables connection state tracking | false | Boolean |
| | *camel.component.resteasy.content-compression-disabled* | Disables automatic content decompression | false | Boolean |
| | *camel.component.resteasy.cookie-management-disabled* | Disables state (cookie) management | false | Boolean |
| | *camel.component.resteasy.copy-headers* | If this option is true then IN exchange headers will be copied to OUT exchange headers according to copy strategy. Setting this to false, allows to only include the headers from the HTTP response (not propagating IN headers). | true | Boolean |
| | *camel.component.resteasy.default-user-agent-disabled* | Disables the default user agent set by this builder if none has been provided by the user | false | Boolean |
| | *camel.component.resteasy.enabled* | Whether to enable auto configuration of the resteasy component. This is enabled by default. | | Boolean |
| | *camel.component.resteasy.header-filter-strategy* | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. The option is a org.apache.camel.spi.HeaderFilterStrategy type. | | HeaderFilterStrategy |
| | *camel.component.resteasy.lazy-start-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 starting the producer may take a little time and prolong the total processing time of the processing. | false | Boolean |
| | *camel.component.resteasy.proxy-consumers-classes* | Proxy classes for consumer endpoints. Multiple classes can be separated by comma. | | String |
| | *camel.component.resteasy.redirect-handling-disabled* | Disables automatic redirect handling | false | Boolean |
| | *camel.component.resteasy.response-payload-streaming-threshold* | This threshold in bytes controls whether the response payload should be stored in memory as a byte array or be streaming based. Set this to -1 to always use streaming mode. | 8192 | Integer |
| | *camel.component.resteasy.skip-request-headers* | Whether to skip mapping all the Camel headers as HTTP request headers. If there are no data from Camel headers needed to be included in the HTTP request then this can avoid parsing overhead with many object allocations for the JVM garbage collector. | false | Boolean |
| | *camel.component.resteasy.skip-response-headers* | Whether to skip mapping all the HTTP response headers to Camel headers. If there are no data needed from HTTP headers then this can avoid parsing overhead with many object allocations for the JVM garbage collector. | false | Boolean |
| |=== |
| // spring-boot-auto-configure options: END |
