org.apache.camel.spi

Class RestConfiguration

java.lang.Object

org.apache.camel.spi.RestConfiguration

public class RestConfiguration
extends Object

Configuration use by RestConsumerFactory and RestApiConsumerFactory for Camel components to support the Camel rest DSL.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestConfiguration.RestBindingMode
static class	RestConfiguration.RestHostNameResolver

Field Summary

Fields

Modifier and Type	Field and Description
static String	CORS_ACCESS_CONTROL_ALLOW_HEADERS
static String	CORS_ACCESS_CONTROL_ALLOW_METHODS
static String	CORS_ACCESS_CONTROL_ALLOW_ORIGIN
static String	CORS_ACCESS_CONTROL_MAX_AGE

Constructor Summary

Constructors

Constructor and Description
RestConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
String	getApiComponent() Gets the name of the Camel component to use as the REST API (such as swagger)
String	getApiContextIdPattern()
String	getApiContextPath()
String	getApiContextRouteId()
Map<String,Object>	getApiProperties()
RestConfiguration.RestBindingMode	getBindingMode() Gets the binding mode used by the REST consumer
String	getComponent() Gets the name of the Camel component to use as the REST consumer
Map<String,Object>	getComponentProperties() Gets additional options on component level
Map<String,Object>	getConsumerProperties() Gets additional options on consumer level
String	getContextPath() Gets the configured context-path
Map<String,String>	getCorsHeaders() Gets the CORS headers to use if CORS has been enabled.
Map<String,Object>	getDataFormatProperties() Gets additional options on data format level
Map<String,Object>	getEndpointProperties() Gets additional options on endpoint level
String	getHost() Gets the hostname to use by the REST consumer
String	getJsonDataFormat() Gets the name of the json data format.
int	getPort() Gets the port to use by the REST consumer
RestConfiguration.RestHostNameResolver	getRestHostNameResolver() Gets the resolver to use for resolving hostname
String	getScheme() Gets the scheme to use by the REST consumer
String	getXmlDataFormat() Gets the name of the xml data format.
boolean	isApiContextListing()
boolean	isEnableCORS() To specify whether to enable CORS which means Camel will automatic include CORS in the HTTP headers in the response.
boolean	isSkipBindingOnErrorCode() Whether to skip binding output if there is a custom HTTP error code, and instead use the response body as-is.
void	setApiComponent(String apiComponent) Sets the name of the Camel component to use as the REST API (such as swagger)
void	setApiContextIdPattern(String apiContextIdPattern) Optional 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(Map<String,Object> apiProperties) Sets additional options on api level
void	setBindingMode(RestConfiguration.RestBindingMode bindingMode) Sets the binding mode to be used by the REST consumer
void	setBindingMode(String bindingMode) Sets the binding mode to be used by the REST consumer
void	setComponent(String componentName) Sets the name of the Camel component to use as the REST consumer
void	setComponentProperties(Map<String,Object> componentProperties) Sets additional options on component level
void	setConsumerProperties(Map<String,Object> consumerProperties) Sets additional options on consumer level
void	setContextPath(String contextPath) Sets a leading context-path the REST services will be using.
void	setCorsHeaders(Map<String,String> corsHeaders) Sets the CORS headers to use if CORS has been enabled.
void	setDataFormatProperties(Map<String,Object> dataFormatProperties) Sets additional options on data format level
void	setEnableCORS(boolean enableCORS) To specify whether to enable CORS which means Camel will automatic include CORS in the HTTP headers in the response.
void	setEndpointProperties(Map<String,Object> endpointProperties) Sets additional options on endpoint level
void	setHost(String host) Sets the hostname to use by the REST consumer
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.
void	setPort(int port) Sets the port to use by the REST consumer
void	setRestHostNameResolver(RestConfiguration.RestHostNameResolver restHostNameResolver) Sets the resolver to use for resolving hostname
void	setRestHostNameResolver(String restHostNameResolver) Sets the resolver to use for resolving hostname
void	setScheme(String scheme) Sets the scheme to use by the REST consumer
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.
void	setXmlDataFormat(String name) Sets a custom xml data format to be used.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CORS_ACCESS_CONTROL_ALLOW_ORIGIN

public static final String CORS_ACCESS_CONTROL_ALLOW_ORIGIN

See Also:

Constant Field Values

CORS_ACCESS_CONTROL_ALLOW_METHODS

public static final String CORS_ACCESS_CONTROL_ALLOW_METHODS

See Also:

Constant Field Values

CORS_ACCESS_CONTROL_MAX_AGE

public static final String CORS_ACCESS_CONTROL_MAX_AGE

See Also:

Constant Field Values

CORS_ACCESS_CONTROL_ALLOW_HEADERS

public static final String CORS_ACCESS_CONTROL_ALLOW_HEADERS

See Also:

Constant Field Values

Constructor Detail

RestConfiguration

public RestConfiguration()

Method Detail

getComponent

public 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 restlet, spark-rest, etc.)

getApiComponent

public String getApiComponent()

Gets the name of the Camel component to use as the REST API (such as swagger)

Returns:

the component name, or null to let Camel use the default name swagger

setApiComponent

public void setApiComponent(String apiComponent)

Sets the name of the Camel component to use as the REST API (such as swagger)

Parameters:

apiComponent - the name of the component (such as swagger)

getHost

public 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

getScheme

public 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 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-netty4-http that includes a HTTP server.

Parameters:

contextPath - the context path

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)

Optional 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

isApiContextListing

public boolean isApiContextListing()

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.

getRestHostNameResolver

public RestConfiguration.RestHostNameResolver getRestHostNameResolver()

Gets the resolver to use for resolving hostname

Returns:

the resolver

setRestHostNameResolver

public void setRestHostNameResolver(RestConfiguration.RestHostNameResolver restHostNameResolver)

Sets the resolver to use for resolving hostname

Parameters:

restHostNameResolver - the resolver

setRestHostNameResolver

public void setRestHostNameResolver(String restHostNameResolver)

Sets the resolver to use for resolving hostname

Parameters:

restHostNameResolver - 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

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

isEnableCORS

public boolean isEnableCORS()

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

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

getJsonDataFormat

public 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 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 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 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 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 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 Map<String,Object> getApiProperties()

setApiProperties

public void setApiProperties(Map<String,Object> apiProperties)

Sets additional options on api level

Parameters:

apiProperties - the options

getCorsHeaders

public 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