Package org.apache.camel.model.rest
Class RestBindingDefinition
java.lang.Object
org.apache.camel.model.OptionalIdentifiedDefinition<RestBindingDefinition>
org.apache.camel.model.rest.RestBindingDefinition
- All Implemented Interfaces:
org.apache.camel.CamelContextAware
,org.apache.camel.LineNumberAware
,org.apache.camel.NamedNode
,org.apache.camel.spi.HasCamelContext
,org.apache.camel.spi.HasId
,org.apache.camel.spi.IdAware
@Metadata(label="rest")
public class RestBindingDefinition
extends OptionalIdentifiedDefinition<RestBindingDefinition>
To configure rest binding
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addDefaultValue
(String paramName, String defaultValue) Adds a default value for the query parametervoid
addRequiredHeader
(String headerName) Adds a required HTTP headervoid
addRequiredQueryParameter
(String paramName) Adds a required query parameterGets the registered default values for query parametersgetLabel()
Class
<?> getType()
Class
<?> void
setBindingMode
(String bindingMode) Sets the binding mode to use.void
setClientRequestValidation
(String 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.void
setComponent
(String component) Sets the component name that this definition will apply tovoid
setConsumes
(String consumes) To define the content type what the REST service consumes (accept as input), such as application/xml or application/jsonvoid
setEnableCORS
(String enableCORS) Whether to enable CORS headers in the HTTP response.void
setEnableNoContentResponse
(String enableNoContentResponse) Whether to return HTTP 204 with an empty body when a response contains an empty JSON object or XML root object.void
setOutType
(String outType) Sets the class name to use for binding from POJO to output for the outgoing datavoid
setOutTypeClass
(Class<?> outTypeClass) Sets the class name to use for binding from POJO to output for the outgoing datavoid
setProduces
(String produces) To define the content type what the REST service produces (uses for output), such as application/xml or application/jsonvoid
setRequiredBody
(Boolean requiredBody) void
setSkipBindingOnErrorCode
(String skipBindingOnErrorCode) Whether to skip binding on output if there is a custom HTTP error code header.void
Sets the class name to use for binding from input to POJO for the incoming datavoid
setTypeClass
(Class<?> typeClass) Sets the class to use for binding from input to POJO for the incoming datatoString()
Methods inherited from class org.apache.camel.model.OptionalIdentifiedDefinition
description, getCamelContext, getCustomId, getDescription, getDescriptionText, getId, getLineNumber, getLocation, getNodePrefixId, getParent, hasCustomIdAssigned, id, idOrCreate, setCamelContext, setCustomId, setDescription, setGeneratedId, setId, setLineNumber, setLocation
-
Constructor Details
-
RestBindingDefinition
public RestBindingDefinition()
-
-
Method Details
-
toString
-
getConsumes
-
addDefaultValue
Adds a default value for the query parameter- Parameters:
paramName
- query parameter namedefaultValue
- the default value
-
addRequiredQueryParameter
Adds a required query parameter- Parameters:
paramName
- query parameter name
-
getRequiredQueryParameters
-
addRequiredHeader
Adds a required HTTP header- Parameters:
headerName
- HTTP header name
-
getRequiredHeaders
-
getRequiredBody
-
setRequiredBody
-
getDefaultValues
Gets the registered default values for query parameters -
setComponent
Sets the component name that this definition will apply to -
getComponent
-
setConsumes
To define the content type what the REST service consumes (accept as input), such as application/xml or application/json -
getProduces
-
setProduces
To define the content type what the REST service produces (uses for output), such as application/xml or application/json -
getBindingMode
-
setBindingMode
Sets the binding mode to use. The default value is off -
getType
-
setType
Sets the class name to use for binding from input to POJO for the incoming data The name of the class of the input data. Append a [] to the end of the name if you want the input to be an array type. -
getTypeClass
-
setTypeClass
Sets the class to use for binding from input to POJO for the incoming data -
getOutType
-
setOutType
Sets the class name to use for binding from POJO to output for the outgoing data The name of the class of the input data. Append a [] to the end of the name if you want the input to be an array type. -
getOutTypeClass
-
setOutTypeClass
Sets the class name to use for binding from POJO to output for the outgoing data -
getSkipBindingOnErrorCode
-
setSkipBindingOnErrorCode
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. -
getClientRequestValidation
-
setClientRequestValidation
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. -
getEnableCORS
-
setEnableCORS
Whether to enable CORS headers in the HTTP response. The default value is false. -
getEnableNoContentResponse
-
setEnableNoContentResponse
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. -
getShortName
-
getLabel
-