Package | Description |
---|---|
org.apache.camel.builder | |
org.apache.camel.model.rest |
The JAXB POJOs for the REST DSL
|
Modifier and Type | Method and Description |
---|---|
RestConfigurationDefinition |
RouteBuilder.restConfiguration()
Configures the REST services
|
RestConfigurationDefinition |
RouteBuilder.restConfiguration(String component)
Configures the REST service for the given component
|
Modifier and Type | Method and Description |
---|---|
Map<String,RestConfigurationDefinition> |
RouteBuilder.getRestConfigurations() |
Modifier and Type | Method and Description |
---|---|
RestConfigurationDefinition |
RestConfigurationDefinition.apiComponent(String componentId)
To use a specific Camel rest API component
|
RestConfigurationDefinition |
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 |
RestConfigurationDefinition.apiContextListing(boolean listing)
Sets whether listing of all available CamelContext's with REST services in the JVM is enabled.
|
RestConfigurationDefinition |
RestConfigurationDefinition.apiContextPath(String contextPath)
Sets a leading context-path the REST services will be using.
|
RestConfigurationDefinition |
RestConfigurationDefinition.apiContextRouteId(String routeId)
Sets the route id to use for the route that services the REST API.
|
RestConfigurationDefinition |
RestConfigurationDefinition.apiHost(String host)
To define a specific host to use for API documentation (eg swagger) instead
of using a generated API hostname that is relative to the REST service host.
|
RestConfigurationDefinition |
RestConfigurationDefinition.apiProperty(String key,
String value)
For configuring an api property, such as api.title, or api.version.
|
RestConfigurationDefinition |
RestConfigurationDefinition.apiVendorExtension(boolean vendorExtension)
Whether vendor extension is enabled in the Rest APIs.
|
RestConfigurationDefinition |
RestConfigurationDefinition.bindingMode(RestBindingMode bindingMode)
To specify the binding mode
|
RestConfigurationDefinition |
RestConfigurationDefinition.clientRequestValidation(boolean clientRequestValidation)
Whether to enable validation of the client request to check whether the Content-Type and Accept headers from
the client is supported by the Rest-DSL configuration of its consumes/produces settings.
|
RestConfigurationDefinition |
RestConfigurationDefinition.component(String componentId)
To use a specific Camel rest component (consumer)
|
RestConfigurationDefinition |
RestConfigurationDefinition.componentProperty(String key,
String value)
For additional configuration options on component level
The value can use # to refer to a bean to lookup in the registry.
|
RestConfigurationDefinition |
RestConfigurationDefinition.consumerProperty(String key,
String value)
For additional configuration options on consumer level
The value can use # to refer to a bean to lookup in the registry.
|
RestConfigurationDefinition |
RestConfigurationDefinition.contextPath(String contextPath)
Sets a leading context-path the REST services will be using.
|
RestConfigurationDefinition |
RestConfigurationDefinition.corsAllowCredentials(boolean corsAllowCredentials)
Shortcut for setting the
Access-Control-Allow-Credentials header. |
RestConfigurationDefinition |
RestConfigurationDefinition.corsHeaderProperty(String key,
String value)
For configuring CORS headers
|
RestConfigurationDefinition |
RestConfigurationDefinition.dataFormatProperty(String key,
String value)
For additional configuration options on data format level
The value can use # to refer to a bean to lookup in the registry.
|
RestConfigurationDefinition |
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 |
RestConfigurationDefinition.endpointProperty(String key,
String value)
For additional configuration options on endpoint level
The value can use # to refer to a bean to lookup in the registry.
|
RestConfigurationDefinition |
RestConfigurationDefinition.host(String host)
To define the host to use, such as 0.0.0.0 or localhost
|
RestConfigurationDefinition |
RestConfigurationDefinition.hostNameResolver(RestHostNameResolver hostNameResolver)
To specify the hostname resolver
|
RestConfigurationDefinition |
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 |
RestConfigurationDefinition.port(int port)
To specify the port number to use for the REST service
|
RestConfigurationDefinition |
RestConfigurationDefinition.port(String port)
To specify the port number to use for the REST service
|
RestConfigurationDefinition |
RestConfigurationDefinition.producerApiDoc(String apiDoc)
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.
|
RestConfigurationDefinition |
RestConfigurationDefinition.producerComponent(String componentId)
To use a specific Camel rest component (producer)
|
RestConfigurationDefinition |
RestConfigurationDefinition.scheme(String scheme)
To use a specific scheme such as http/https
|
RestConfigurationDefinition |
RestConfigurationDefinition.skipBindingOnErrorCode(boolean skipBindingOnErrorCode)
To specify whether to skip binding output if there is a custom HTTP error code
|
RestConfigurationDefinition |
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.
|
Apache Camel