Uses of Class
org.apache.camel.main.RestConfigurationProperties
Packages that use RestConfigurationProperties
Package
Description
Application level classes that can be used to instantiate camel.
-
Uses of RestConfigurationProperties in org.apache.camel.main
Methods in org.apache.camel.main that return RestConfigurationPropertiesModifier and TypeMethodDescriptionMainConfigurationProperties.rest()To configure Rest DSLRestConfigurationProperties.withApiComponent(String apiComponent) The name of the Camel component to use as the REST API (such as swagger)RestConfigurationProperties.withApiContextPath(String apiContextPath) Sets a leading API context-path the REST API services will be using.RestConfigurationProperties.withApiContextRouteId(String apiContextRouteId) Sets the route id to use for the route that services the REST API.RestConfigurationProperties.withApiHost(String apiHost) To use a specific hostname for the API documentation (such as swagger or openapi)RestConfigurationProperties.withApiProperty(String key, Object value) Adds a api propertyRestConfigurationProperties.withApiVendorExtension(boolean apiVendorExtension) Whether vendor extension is enabled in the Rest APIs.RestConfigurationProperties.withBindingMode(String bindingMode) Sets the binding mode to use.RestConfigurationProperties.withBindingPackageScan(String bindingPackageScan) Package name to use as base (offset) for classpath scanning of POJO classes are located when using binding mode is enabled for JSon or XML.RestConfigurationProperties.withClientRequestValidation(boolean clientRequestValidation) Whether to enable validation of the client request to check: 1) Content-Type header matches what the Rest DSL consumes; returns HTTP Status 415 if validation error. 2) Accept header matches what the Rest DSL produces; returns HTTP Status 406 if validation error. 3) Missing required data (query parameters, HTTP headers, body); returns HTTP Status 400 if validation error. 4) Parsing error of the message body (JSon, XML or Auto binding mode must be enabled); returns HTTP Status 400 if validation error.RestConfigurationProperties.withClientResponseValidation(boolean clientResponseValidation) Whether to check what Camel is returning as response to the client: 1) Status-code and Content-Type matches Rest DSL response messages. 2) Check whether expected headers is included according to the Rest DSL repose message headers. 3) If the response body is JSon then check whether its valid JSon.RestConfigurationProperties.withComponent(String component) The Camel Rest component to use for the REST transport (consumer), such as netty-http, jetty, servlet, undertow.RestConfigurationProperties.withComponentProperty(String key, Object value) Adds a component propertyRestConfigurationProperties.withConsumerProperty(String key, Object value) Adds a consumer propertyRestConfigurationProperties.withContextPath(String contextPath) Sets a leading context-path the REST services will be using.RestConfigurationProperties.withCorsHeader(String key, String value) Adds a CORS header propertyRestConfigurationProperties.withDataFormatProperty(String key, Object value) Adds a data format propertyRestConfigurationProperties.withEnableCORS(boolean enableCORS) Whether to enable CORS headers in the HTTP response.RestConfigurationProperties.withEndpointProperty(String key, Object value) Adds a endpoint propertyThe hostname to use for exposing the REST service.RestConfigurationProperties.withHostNameResolver(String hostNameResolver) If no hostname has been explicit configured, then this resolver is used to compute the hostname the REST service will be using.RestConfigurationProperties.withInlineRoutes(boolean inlineRoutes) Inline routes in rest-dsl which are linked using direct endpoints.RestConfigurationProperties.withJsonDataFormat(String jsonDataFormat) Name of specific json data format to use.RestConfigurationProperties.withPort(int port) The port number to use for exposing the REST service.RestConfigurationProperties.withProducerApiDoc(String producerApiDoc) Sets the location of the api document (swagger api) the REST producer will use to validate the REST uri and query parameters are valid accordingly to the api document.RestConfigurationProperties.withProducerComponent(String producerComponent) Sets the name of the Camel component to use as the REST producerRestConfigurationProperties.withScheme(String scheme) The scheme to use for exposing the REST service.RestConfigurationProperties.withSkipBindingOnErrorCode(boolean skipBindingOnErrorCode) Whether to skip binding on output if there is a custom HTTP error code header.RestConfigurationProperties.withUseXForwardHeaders(boolean useXForwardHeaders) Whether to use X-Forward headers to set host etc. for OpenApi.RestConfigurationProperties.withValidationLevel(String key, String value) Adds a validation error propertyRestConfigurationProperties.withXmlDataFormat(String xmlDataFormat) Name of specific XML data format to use.