Class RestConfiguration

java.lang.Object
org.apache.camel.spi.RestConfiguration
public class RestConfiguration extends Object
Central configuration bean for the Camel REST DSL, shared by RestConsumerFactory, RestProducerFactory, and RestApiConsumerFactory implementations.

An instance of this class is held on CamelContext and controls every aspect of REST service hosting and client invocation: the HTTP component to use (e.g. platform-http, jetty, netty-http, servlet), the server host and port, the binding mode (RestConfiguration.RestBindingMode.off, RestConfiguration.RestBindingMode.json, RestConfiguration.RestBindingMode.xml, or RestConfiguration.RestBindingMode.json_xml), CORS headers, JSON and XML data-format class names, and additional Map<String, Object> property overrides for the component, consumer, and producer tiers. The configuration is typically expressed via the restConfiguration() builder in the Java DSL, or the rest-configuration element in XML and YAML DSLs.

See Rest DSL in the Camel user manual.

See Also:

  • Field Details

  • Constructor Details

    • RestConfiguration

      public RestConfiguration()

  • Method Details

    • getComponent

      public @Nullable String getComponent()
      Gets the name of the Camel component to use as the REST consumer
      Returns:
      the component name, or null to let Camel search the Registry to find suitable implementation

    • setComponent

      public void setComponent(String componentName)
      Sets the name of the Camel component to use as the REST consumer
      Parameters:
      componentName - the name of the component (such as netty-http, jetty, servlet, undertow, etc.)

    • getApiComponent

      public @Nullable String getApiComponent()
      Gets the name of the Camel component to use as the REST API (such as swagger or openapi).
      Returns:
      the component name

    • setApiComponent

      public void setApiComponent(String apiComponent)
      Sets the name of the Camel component to use as the REST API (such as swagger or openapi)
      Parameters:
      apiComponent - the name of the component (such as swagger or openapi)

    • getProducerComponent

      public @Nullable String getProducerComponent()
      Gets the name of the Camel component to use as the REST producer
      Returns:
      the component name, or null to let Camel search the Registry to find suitable implementation

    • setProducerComponent

      public void setProducerComponent(String componentName)
      Sets the name of the Camel component to use as the REST producer
      Parameters:
      componentName - the name of the component (such as http, netty-http, undertow, etc.)

    • getProducerApiDoc

      public @Nullable String getProducerApiDoc()
      Gets 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.

    • setProducerApiDoc

      public void setProducerApiDoc(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. This requires adding camel-openapi-java to the classpath, and any miss configuration will let Camel fail on startup and report the error(s).

      The location of the api document is loaded from classpath by default, but you can use file: or http: to refer to resources to load from file or http url.

    • getHost

      public @Nullable String getHost()
      Gets the hostname to use by the REST consumer
      Returns:
      the hostname, or null to use default hostname

    • setHost

      public void setHost(String host)
      Sets the hostname to use by the REST consumer
      Parameters:
      host - the hostname

    • isUseXForwardHeaders

      public boolean isUseXForwardHeaders()
      Whether to use X-Forward headers to set host etc. for OpenApi. This may be needed in special cases involving reverse-proxy and networking going from HTTP to HTTPS etc. Then the proxy can send X-Forward headers (X-Forwarded-Proto) that influences the host names in the OpenAPI schema that camel-openapi-java generates from Rest DSL routes.

    • setUseXForwardHeaders

      public void setUseXForwardHeaders(boolean useXForwardHeaders)
      Whether to use X-Forward headers to set host etc. for OpenApi. This may be needed in special cases involving reverse-proxy and networking going from HTTP to HTTPS etc. Then the proxy can send X-Forward headers (X-Forwarded-Proto) that influences the host names in the OpenAPI schema that camel-openapi-java generates from Rest DSL routes.

    • getApiHost

      public @Nullable String getApiHost()
      Gets the hostname to use for the API documentation (such as swagger or openapi).
      Returns:
      the API host, or null to use the default host

    • setApiHost

      public void setApiHost(String apiHost)
      To use a specific hostname for the API documentation (such as swagger or openapi)

      This can be used to override the generated host with this configured hostname

    • getScheme

      public @Nullable String getScheme()
      Gets the scheme to use by the REST consumer
      Returns:
      the scheme, or null to use default scheme

    • setScheme

      public void setScheme(String scheme)
      Sets the scheme to use by the REST consumer
      Parameters:
      scheme - the scheme

    • getPort

      public int getPort()
      Gets the port to use by the REST consumer
      Returns:
      the port, or 0 or -1 to use default port

    • setPort

      public void setPort(int port)
      Sets the port to use by the REST consumer
      Parameters:
      port - the port number

    • getContextPath

      public @Nullable String getContextPath()
      Gets the configured context-path
      Returns:
      the context path, or null if none configured.

    • setContextPath

      public void setContextPath(String contextPath)
      Sets a leading context-path the REST services will be using.

      This can be used when using components such as camel-servlet where the deployed web application is deployed using a context-path. Or for components such as camel-jetty or camel-netty-http that includes a HTTP server.

      Parameters:
      contextPath - the context path

    • getApiContextPath

      public @Nullable String getApiContextPath()
      Gets the leading API context-path the REST API services will be using.
      Returns:
      the API context path, or null if none configured.

    • setApiContextPath

      public void setApiContextPath(String contextPath)
      Sets a leading API context-path the REST API services will be using.

      This can be used when using components such as camel-servlet where the deployed web application is deployed using a context-path.

      Parameters:
      contextPath - the API context path

    • getApiContextRouteId

      public @Nullable String getApiContextRouteId()
      Gets the route id used for the route that services the REST API.
      Returns:
      the route id, or null if using an auto-assigned id

    • setApiContextRouteId

      public void setApiContextRouteId(String apiContextRouteId)
      Sets the route id to use for the route that services the REST API.

      The route will by default use an auto assigned route id.

      Parameters:
      apiContextRouteId - the route id

    • isApiVendorExtension

      public boolean isApiVendorExtension()
      Whether vendor extension is enabled in the REST APIs.
      Returns:
      true if vendor extensions are included in the API docs

    • setApiVendorExtension

      public void setApiVendorExtension(boolean apiVendorExtension)
      Whether vendor extension is enabled in the Rest APIs. If enabled then Camel will include additional information as vendor extension (eg keys starting with x-) such as route ids, class names etc. Not all 3rd party API gateways and tools supports vendor-extensions when importing your API docs.

    • getHostNameResolver

      public RestConfiguration.RestHostNameResolver getHostNameResolver()
      Gets the resolver to use for resolving hostname
      Returns:
      the resolver

    • setHostNameResolver

      public void setHostNameResolver(RestConfiguration.RestHostNameResolver hostNameResolver)
      Sets the resolver to use for resolving hostname
      Parameters:
      hostNameResolver - the resolver

    • setHostNameResolver

      public void setHostNameResolver(String hostNameResolver)
      Sets the resolver to use for resolving hostname
      Parameters:
      hostNameResolver - the resolver

    • getBindingMode

      public RestConfiguration.RestBindingMode getBindingMode()
      Gets the binding mode used by the REST consumer
      Returns:
      the binding mode

    • setBindingMode

      public void setBindingMode(RestConfiguration.RestBindingMode bindingMode)
      Sets the binding mode to be used by the REST consumer
      Parameters:
      bindingMode - the binding mode

    • setBindingMode

      public void setBindingMode(String bindingMode)
      Sets the binding mode to be used by the REST consumer
      Parameters:
      bindingMode - the binding mode

    • getBindingPackageScan

      public @Nullable String getBindingPackageScan()
      Gets the package name used as base for classpath scanning of POJO classes when binding mode is enabled.
      Returns:
      the package name, or null if not configured

    • setBindingPackageScan

      public void setBindingPackageScan(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. Multiple package names can be separated by comma.

    • isSkipBindingOnErrorCode

      public boolean isSkipBindingOnErrorCode()
      Whether to skip binding output if there is a custom HTTP error code, and instead use the response body as-is.

      This option is default true.

      Returns:
      whether to skip binding on error code

    • setSkipBindingOnErrorCode

      public void setSkipBindingOnErrorCode(boolean skipBindingOnErrorCode)
      Whether to skip binding output if there is a custom HTTP error code, and instead use the response body as-is.

      This option is default true.

      Parameters:
      skipBindingOnErrorCode - whether to skip binding on error code

    • isClientRequestValidation

      public boolean isClientRequestValidation()
      Whether client request validation is enabled.
      Returns:
      true if client request validation is enabled

    • setClientRequestValidation

      public void setClientRequestValidation(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.

    • isClientResponseValidation

      public boolean isClientResponseValidation()
      Whether client response validation is enabled.
      Returns:
      true if client response validation is enabled

    • setClientResponseValidation

      public void setClientResponseValidation(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. Returns 500 if validation error detected.

    • isEnableCORS

      public boolean isEnableCORS()
      To specify whether to enable CORS which means Camel will automatically include CORS in the HTTP headers in the response.

      This option is default false

      Returns:
      whether CORS is enabled or not

    • setEnableCORS

      public void setEnableCORS(boolean enableCORS)
      To specify whether to enable CORS which means Camel will automatic include CORS in the HTTP headers in the response.

      This option is default false

      Parameters:
      enableCORS - true to enable CORS

    • isEnableNoContentResponse

      public boolean isEnableNoContentResponse()
      Whether HTTP 204 No Content responses are enabled for empty JSON or XML responses.
      Returns:
      true if HTTP 204 responses are enabled

    • setEnableNoContentResponse

      public void setEnableNoContentResponse(boolean enableNoContentResponse)
      Whether to return HTTP 204 with an empty body when a response contains an empty JSON object or XML root object.

      The default value is false.

      Parameters:
      enableNoContentResponse - true to enable HTTP 204 response codes

    • isInlineRoutes

      public boolean isInlineRoutes()
      Whether routes in rest-dsl linked via direct endpoints are inlined as a single route.
      Returns:
      true if rest-dsl routes are inlined

    • setInlineRoutes

      public void setInlineRoutes(boolean inlineRoutes)
      Inline routes in rest-dsl which are linked using direct endpoints. Each service in Rest DSL is an individual route, meaning that you would have at least two routes per service (rest-dsl, and the route linked from rest-dsl). By inlining (default) allows Camel to optimize and inline this as a single route, however this requires to use direct endpoints, which must be unique per service. If a route is not using direct endpoint then the rest-dsl is not inlined, and will become an individual route. This option is default true.

    • getJsonDataFormat

      public @Nullable String getJsonDataFormat()
      Gets the name of the json data format.

      Important: This option is only for setting a custom name of the data format, not to refer to an existing data format instance.

      Returns:
      the name, or null to use default

    • setJsonDataFormat

      public void setJsonDataFormat(String name)
      Sets a custom json data format to be used

      Important: This option is only for setting a custom name of the data format, not to refer to an existing data format instance.

      Parameters:
      name - name of the data format

    • getXmlDataFormat

      public @Nullable String getXmlDataFormat()
      Gets the name of the xml data format.

      Important: This option is only for setting a custom name of the data format, not to refer to an existing data format instance.

      Returns:
      the name, or null to use default

    • setXmlDataFormat

      public void setXmlDataFormat(String name)
      Sets a custom xml data format to be used.

      Important: This option is only for setting a custom name of the data format, not to refer to an existing data format instance.

      Parameters:
      name - name of the data format

    • getComponentProperties

      public @Nullable Map<String,Object> getComponentProperties()
      Gets additional options on component level
      Returns:
      additional options

    • setComponentProperties

      public void setComponentProperties(Map<String,Object> componentProperties)
      Sets additional options on component level
      Parameters:
      componentProperties - the options

    • getEndpointProperties

      public @Nullable Map<String,Object> getEndpointProperties()
      Gets additional options on endpoint level
      Returns:
      additional options

    • setEndpointProperties

      public void setEndpointProperties(Map<String,Object> endpointProperties)
      Sets additional options on endpoint level
      Parameters:
      endpointProperties - the options

    • getConsumerProperties

      public @Nullable Map<String,Object> getConsumerProperties()
      Gets additional options on consumer level
      Returns:
      additional options

    • setConsumerProperties

      public void setConsumerProperties(Map<String,Object> consumerProperties)
      Sets additional options on consumer level
      Parameters:
      consumerProperties - the options

    • getDataFormatProperties

      public @Nullable Map<String,Object> getDataFormatProperties()
      Gets additional options on data format level
      Returns:
      additional options

    • setDataFormatProperties

      public void setDataFormatProperties(Map<String,Object> dataFormatProperties)
      Sets additional options on data format level
      Parameters:
      dataFormatProperties - the options

    • getApiProperties

      public @Nullable Map<String,Object> getApiProperties()
      Gets additional options on API level.
      Returns:
      additional options

    • setApiProperties

      public void setApiProperties(Map<String,Object> apiProperties)
      Sets additional options on api level
      Parameters:
      apiProperties - the options

    • getCorsHeaders

      public @Nullable Map<String,String> getCorsHeaders()
      Gets the CORS headers to use if CORS has been enabled.
      Returns:
      the CORS headers

    • setCorsHeaders

      public void setCorsHeaders(Map<String,String> corsHeaders)
      Sets the CORS headers to use if CORS has been enabled.
      Parameters:
      corsHeaders - the CORS headers

    • getValidationLevels

      public @Nullable Map<String,String> getValidationLevels()
      Gets the client request validation levels when using camel-openapi-validator.
      Returns:
      the validation levels

    • setValidationLevels

      public void setValidationLevels(@Nullable Map<String,String> validationLevels)
      Sets the client request validation levels when using camel-openapi-validator.