RestConfigurationDefinition (Camel

java.lang.Object
- org.apache.camel.model.rest.RestConfigurationDefinition

@Metadata(label="rest")
public class RestConfigurationDefinition
extends Object

To configure rest

Constructor Summary

Constructors
Constructor and Description

RestConfigurationDefinition()

Constructors
Constructor and Description
`RestConfigurationDefinition()`

Method Summary

Methods
Modifier and Type	Method and Description
`RestConfigurationDefinition`	`apiComponent(String componentId)` To use a specific Camel rest API component
`RestConfigurationDefinition`	`apiContextIdPattern(String pattern)` Sets an CamelContext id pattern to only allow Rest APIs from rest services within CamelContext's which name matches the pattern.
`RestConfigurationDefinition`	`apiContextListing(boolean listing)` Sets whether listing of all available CamelContext's with REST services in the JVM is enabled.
`RestConfigurationDefinition`	`apiContextPath(String contextPath)` Sets a leading context-path the REST services will be using.
`RestConfigurationDefinition`	`apiContextRouteId(String routeId)` Sets the route id to use for the route that services the REST API.
`RestConfigurationDefinition`	`apiProperty(String key, String value)` For configuring an api property, such as `api.title`, or `api.version`.
`RestConfiguration`	`asRestConfiguration(CamelContext context)` Creates a `RestConfiguration` instance based on the definition
`RestConfigurationDefinition`	`bindingMode(RestBindingMode bindingMode)` To specify the binding mode
`RestConfigurationDefinition`	`component(String componentId)` To use a specific Camel rest component
`RestConfigurationDefinition`	`componentProperty(String key, String value)` For additional configuration options on component level
`RestConfigurationDefinition`	`consumerProperty(String key, String value)` For additional configuration options on consumer level
`RestConfigurationDefinition`	`contextPath(String contextPath)` Sets a leading context-path the REST services will be using.
`RestConfigurationDefinition`	`corsHeaderProperty(String key, String value)` For configuring CORS headers
`RestConfigurationDefinition`	`dataFormatProperty(String key, String value)` For additional configuration options on data format level
`RestConfigurationDefinition`	`enableCORS(boolean enableCORS)` To specify whether to enable CORS which means Camel will automatic include CORS in the HTTP headers in the response.
`RestConfigurationDefinition`	`endpointProperty(String key, String value)` For additional configuration options on endpoint level
`String`	`getApiComponent()`
`String`	`getApiContextIdPattern()`
`Boolean`	`getApiContextListing()`
`String`	`getApiContextPath()`
`String`	`getApiContextRouteId()`
`List<RestPropertyDefinition>`	`getApiProperties()`
`RestBindingMode`	`getBindingMode()`
`String`	`getComponent()`
`List<RestPropertyDefinition>`	`getComponentProperties()`
`List<RestPropertyDefinition>`	`getConsumerProperties()`
`String`	`getContextPath()`
`List<RestPropertyDefinition>`	`getCorsHeaders()`
`List<RestPropertyDefinition>`	`getDataFormatProperties()`
`Boolean`	`getEnableCORS()`
`List<RestPropertyDefinition>`	`getEndpointProperties()`
`String`	`getHost()`
`RestHostNameResolver`	`getHostNameResolver()`
`String`	`getJsonDataFormat()`
`String`	`getPort()`
`String`	`getScheme()`
`Boolean`	`getSkipBindingOnErrorCode()`
`String`	`getXmlDataFormat()`
`RestConfigurationDefinition`	`host(String host)` To define the host to use, such as 0.0.0.0 or localhost
`RestConfigurationDefinition`	`hostNameResolver(RestHostNameResolver hostNameResolver)` To specify the hostname resolver
`RestConfigurationDefinition`	`jsonDataFormat(String name)` To use a specific 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.
`RestConfigurationDefinition`	`port(int port)` To specify the port number to use for the REST service
`RestConfigurationDefinition`	`port(String port)` To specify the port number to use for the REST service
`RestConfigurationDefinition`	`scheme(String scheme)` To use a specific scheme such as http/https
`void`	`setApiComponent(String apiComponent)` The name of the Camel component to use as the REST API (such as swagger)
`void`	`setApiContextIdPattern(String apiContextIdPattern)` Sets an CamelContext id pattern to only allow Rest APIs from rest services within CamelContext's which name matches the pattern.
`void`	`setApiContextListing(Boolean apiContextListing)` Sets whether listing of all available CamelContext's with REST services in the JVM is enabled.
`void`	`setApiContextPath(String contextPath)` Sets a leading API context-path the REST API services will be using.
`void`	`setApiContextRouteId(String apiContextRouteId)` Sets the route id to use for the route that services the REST API.
`void`	`setApiProperties(List<RestPropertyDefinition> apiProperties)` Allows to configure as many additional properties for the api documentation (swagger).
`void`	`setBindingMode(RestBindingMode bindingMode)` Sets the binding mode to use.
`void`	`setComponent(String component)` The Camel Rest component to use for the REST transport, such as restlet, spark-rest.
`void`	`setComponentProperties(List<RestPropertyDefinition> componentProperties)` Allows to configure as many additional properties for the rest component in use.
`void`	`setConsumerProperties(List<RestPropertyDefinition> consumerProperties)` Allows to configure as many additional properties for the rest consumer in use.
`void`	`setContextPath(String contextPath)` Sets a leading context-path the REST services will be using.
`void`	`setCorsHeaders(List<RestPropertyDefinition> corsHeaders)` Allows to configure custom CORS headers.
`void`	`setDataFormatProperties(List<RestPropertyDefinition> dataFormatProperties)` Allows to configure as many additional properties for the data formats in use.
`void`	`setEnableCORS(Boolean enableCORS)` Whether to enable CORS headers in the HTTP response.
`void`	`setEndpointProperties(List<RestPropertyDefinition> endpointProperties)` Allows to configure as many additional properties for the rest endpoint in use.
`void`	`setHost(String host)` The hostname to use for exposing the REST service.
`void`	`setHostNameResolver(RestHostNameResolver hostNameResolver)` If no hostname has been explicit configured, then this resolver is used to compute the hostname the REST service will be using.
`void`	`setJsonDataFormat(String jsonDataFormat)` Name of specific json data format to use.
`void`	`setPort(String port)` The port number to use for exposing the REST service.
`void`	`setScheme(String scheme)` The scheme to use for exposing the REST service.
`void`	`setSkipBindingOnErrorCode(Boolean skipBindingOnErrorCode)` Whether to skip binding on output if there is a custom HTTP error code header.
`void`	`setXmlDataFormat(String xmlDataFormat)` Name of specific XML data format to use.
`RestConfigurationDefinition`	`skipBindingOnErrorCode(boolean skipBindingOnErrorCode)` To specify whether to skip binding output if there is a custom HTTP error code
`RestConfigurationDefinition`	`xmlDataFormat(String name)` To use a specific 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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RestConfigurationDefinition
```
public RestConfigurationDefinition()
```
- Method Detail
  - getComponent
```
public String getComponent()
```
  - setComponent
```
public void setComponent(String component)
```
    The Camel Rest component to use for the REST transport, such as restlet, spark-rest. If no component has been explicit configured, then Camel will lookup if there is a Camel component that integrates with the Rest DSL, or if a org.apache.camel.spi.RestConsumerFactory is registered in the registry. If either one is found, then that is being used.
  - getApiComponent
```
public String getApiComponent()
```
  - setApiComponent
```
public void setApiComponent(String apiComponent)
```
    The name of the Camel component to use as the REST API (such as swagger)
  - getScheme
```
public String getScheme()
```
  - setScheme
```
public void setScheme(String scheme)
```
    The scheme to use for exposing the REST service. Usually http or https is supported.
    The default value is http
  - getHost
```
public String getHost()
```
  - setHost
```
public void setHost(String host)
```
    The hostname to use for exposing the REST service.
  - getPort
```
public String getPort()
```
  - setPort
```
public void setPort(String port)
```
    The port number to use for exposing the REST service. Notice if you use servlet component then the port number configured here does not apply, as the port number in use is the actual port number the servlet component is using. eg if using Apache Tomcat its the tomcat http port, if using Apache Karaf its the HTTP service in Karaf that uses port 8181 by default etc. Though in those situations setting the port number here, allows tooling and JMX to know the port number, so its recommended to set the port number to the number that the servlet engine uses.
  - getContextPath
```
public String getContextPath()
```
  - 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-netty4-http that includes a HTTP server.
  - getApiContextPath
```
public String getApiContextPath()
```
  - 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 String getApiContextRouteId()
```
  - 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
  - getApiContextIdPattern
```
public String getApiContextIdPattern()
```
  - setApiContextIdPattern
```
public void setApiContextIdPattern(String apiContextIdPattern)
```
    Sets an CamelContext id pattern to only allow Rest APIs from rest services within CamelContext's which name matches the pattern.
    The pattern #name# refers to the CamelContext name, to match on the current CamelContext only. For any other value, the pattern uses the rules from EndpointHelper.matchPattern(String, String)
    
    Parameters:
    apiContextIdPattern - the pattern
  - getApiContextListing
```
public Boolean getApiContextListing()
```
  - setApiContextListing
```
public void setApiContextListing(Boolean apiContextListing)
```
    Sets whether listing of all available CamelContext's with REST services in the JVM is enabled. If enabled it allows to discover these contexts, if false then only the current CamelContext is in use.
  - getHostNameResolver
```
public RestHostNameResolver getHostNameResolver()
```
  - setHostNameResolver
```
public void setHostNameResolver(RestHostNameResolver hostNameResolver)
```
    If no hostname has been explicit configured, then this resolver is used to compute the hostname the REST service will be using.
  - getBindingMode
```
public RestBindingMode getBindingMode()
```
  - setBindingMode
```
public void setBindingMode(RestBindingMode bindingMode)
```
    Sets the binding mode to use.
    The default value is auto
  - getSkipBindingOnErrorCode
```
public Boolean getSkipBindingOnErrorCode()
```
  - setSkipBindingOnErrorCode
```
public void setSkipBindingOnErrorCode(Boolean skipBindingOnErrorCode)
```
    Whether to skip binding on output if there is a custom HTTP error code header. This allows to build custom error messages that do not bind to json / xml etc, as success messages otherwise will do.
  - getEnableCORS
```
public Boolean getEnableCORS()
```
  - setEnableCORS
```
public void setEnableCORS(Boolean enableCORS)
```
    Whether to enable CORS headers in the HTTP response.
    The default value is false.
  - getJsonDataFormat
```
public String getJsonDataFormat()
```
  - setJsonDataFormat
```
public void setJsonDataFormat(String jsonDataFormat)
```
    Name of specific json data format to use. By default json-jackson will 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.
  - getXmlDataFormat
```
public String getXmlDataFormat()
```
  - setXmlDataFormat
```
public void setXmlDataFormat(String xmlDataFormat)
```
    Name of specific XML data format to use. By default jaxb will 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.
  - getComponentProperties
```
public List<RestPropertyDefinition> getComponentProperties()
```
  - setComponentProperties
```
public void setComponentProperties(List<RestPropertyDefinition> componentProperties)
```
    Allows to configure as many additional properties for the rest component in use.
  - getEndpointProperties
```
public List<RestPropertyDefinition> getEndpointProperties()
```
  - setEndpointProperties
```
public void setEndpointProperties(List<RestPropertyDefinition> endpointProperties)
```
    Allows to configure as many additional properties for the rest endpoint in use.
  - getConsumerProperties
```
public List<RestPropertyDefinition> getConsumerProperties()
```
  - setConsumerProperties
```
public void setConsumerProperties(List<RestPropertyDefinition> consumerProperties)
```
    Allows to configure as many additional properties for the rest consumer in use.
  - getDataFormatProperties
```
public List<RestPropertyDefinition> getDataFormatProperties()
```
  - setDataFormatProperties
```
public void setDataFormatProperties(List<RestPropertyDefinition> dataFormatProperties)
```
    Allows to configure as many additional properties for the data formats in use. For example set property prettyPrint to true to have json outputted in pretty mode. The properties can be prefixed to denote the option is only for either JSON or XML and for either the IN or the OUT. The prefixes are:
    - json.in.
    - json.out.
    - xml.in.
    - xml.out.
    For example a key with value "xml.out.mustBeJAXBElement" is only for the XML data format for the outgoing. A key without a prefix is a common key for all situations.
  - getApiProperties
```
public List<RestPropertyDefinition> getApiProperties()
```
  - setApiProperties
```
public void setApiProperties(List<RestPropertyDefinition> apiProperties)
```
    Allows to configure as many additional properties for the api documentation (swagger). For example set property api.title to my cool stuff
  - getCorsHeaders
```
public List<RestPropertyDefinition> getCorsHeaders()
```
  - setCorsHeaders
```
public void setCorsHeaders(List<RestPropertyDefinition> corsHeaders)
```
    Allows to configure custom CORS headers.
  - component
```
public RestConfigurationDefinition component(String componentId)
```
    To use a specific Camel rest component
  - apiComponent
```
public RestConfigurationDefinition apiComponent(String componentId)
```
    To use a specific Camel rest API component
  - scheme
```
public RestConfigurationDefinition scheme(String scheme)
```
    To use a specific scheme such as http/https
  - host
```
public RestConfigurationDefinition host(String host)
```
    To define the host to use, such as 0.0.0.0 or localhost
  - port
```
public RestConfigurationDefinition port(int port)
```
    To specify the port number to use for the REST service
  - port
```
public RestConfigurationDefinition port(String port)
```
    To specify the port number to use for the REST service
  - apiContextPath
```
public RestConfigurationDefinition apiContextPath(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-netty4-http that includes a HTTP server.
  - apiContextRouteId
```
public RestConfigurationDefinition apiContextRouteId(String routeId)
```
    Sets the route id to use for the route that services the REST API.
  - apiContextIdPattern
```
public RestConfigurationDefinition apiContextIdPattern(String pattern)
```
    Sets an CamelContext id pattern to only allow Rest APIs from rest services within CamelContext's which name matches the pattern.
    The pattern uses the rules from EndpointHelper.matchPattern(String, String)
  - apiContextListing
```
public RestConfigurationDefinition apiContextListing(boolean listing)
```
    Sets whether listing of all available CamelContext's with REST services in the JVM is enabled. If enabled it allows to discover these contexts, if false then only the current CamelContext is in use.
  - contextPath
```
public RestConfigurationDefinition contextPath(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.
  - hostNameResolver
```
public RestConfigurationDefinition hostNameResolver(RestHostNameResolver hostNameResolver)
```
    To specify the hostname resolver
  - bindingMode
```
public RestConfigurationDefinition bindingMode(RestBindingMode bindingMode)
```
    To specify the binding mode
  - skipBindingOnErrorCode
```
public RestConfigurationDefinition skipBindingOnErrorCode(boolean skipBindingOnErrorCode)
```
    To specify whether to skip binding output if there is a custom HTTP error code
  - enableCORS
```
public RestConfigurationDefinition enableCORS(boolean enableCORS)
```
    To specify whether to enable CORS which means Camel will automatic include CORS in the HTTP headers in the response.
  - jsonDataFormat
```
public RestConfigurationDefinition jsonDataFormat(String name)
```
    To use a specific 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.
    
    Parameters:
    name - name of the data format to resolve
  - xmlDataFormat
```
public RestConfigurationDefinition xmlDataFormat(String name)
```
    To use a specific 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.
    
    Parameters:
    name - name of the data format to resolve
  - componentProperty
```
public RestConfigurationDefinition componentProperty(String key,
                                            String value)
```
    For additional configuration options on component level
  - endpointProperty
```
public RestConfigurationDefinition endpointProperty(String key,
                                           String value)
```
    For additional configuration options on endpoint level
  - consumerProperty
```
public RestConfigurationDefinition consumerProperty(String key,
                                           String value)
```
    For additional configuration options on consumer level
  - dataFormatProperty
```
public RestConfigurationDefinition dataFormatProperty(String key,
                                             String value)
```
    For additional configuration options on data format level
  - apiProperty
```
public RestConfigurationDefinition apiProperty(String key,
                                      String value)
```
    For configuring an api property, such as api.title, or api.version.
  - corsHeaderProperty
```
public RestConfigurationDefinition corsHeaderProperty(String key,
                                             String value)
```
    For configuring CORS headers
  - asRestConfiguration
```
public RestConfiguration asRestConfiguration(CamelContext context)
                                      throws Exception
```
    Creates a RestConfiguration instance based on the definition
    
    Parameters:
    context - the camel context
    
    Returns:
    the configuration
    
    Throws:
    
    Exception - is thrown if error creating the configuration

Class RestConfigurationDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RestConfigurationDefinition

Method Detail

getComponent

setComponent

getApiComponent

setApiComponent

getScheme

setScheme

getHost

setHost

getPort

setPort

getContextPath

setContextPath

getApiContextPath

setApiContextPath

getApiContextRouteId

setApiContextRouteId

getApiContextIdPattern

setApiContextIdPattern

getApiContextListing

setApiContextListing

getHostNameResolver

setHostNameResolver

getBindingMode

setBindingMode

getSkipBindingOnErrorCode

setSkipBindingOnErrorCode

getEnableCORS

setEnableCORS

getJsonDataFormat

setJsonDataFormat

getXmlDataFormat

setXmlDataFormat

getComponentProperties

setComponentProperties

getEndpointProperties

setEndpointProperties

getConsumerProperties

setConsumerProperties

getDataFormatProperties

setDataFormatProperties

getApiProperties

setApiProperties

getCorsHeaders

setCorsHeaders

component

apiComponent

scheme

host

port

port

apiContextPath

apiContextRouteId

apiContextIdPattern

apiContextListing

contextPath

hostNameResolver

bindingMode

skipBindingOnErrorCode

enableCORS

jsonDataFormat

xmlDataFormat

componentProperty

endpointProperty

consumerProperty

dataFormatProperty

apiProperty

corsHeaderProperty

asRestConfiguration