RestBindingDefinition (Camel :: Core 2.22.2 API)

java.lang.Object
- org.apache.camel.model.OptionalIdentifiedDefinition<RestBindingDefinition>
- - org.apache.camel.model.rest.RestBindingDefinition

All Implemented Interfaces:: NamedNode

@Metadata(label="rest")
public class RestBindingDefinition
extends OptionalIdentifiedDefinition<RestBindingDefinition>

To configure rest binding

Constructor Summary

Constructors
Constructor and Description

RestBindingDefinition()

Constructors
Constructor and Description
`RestBindingDefinition()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDefaultValue(String paramName, String defaultValue)` Adds a default value for the query parameter
`void`	`addRequiredHeader(String headerName)` Adds a required HTTP header
`void`	`addRequiredQueryParameter(String paramName)` Adds a required query parameter
`RestBindingAdvice`	`createRestBindingAdvice(RouteContext routeContext)`
`RestBindingMode`	`getBindingMode()`
`Boolean`	`getClientRequestValidation()`
`String`	`getComponent()`
`String`	`getConsumes()`
`Map<String,String>`	`getDefaultValues()` Gets the registered default values for query parameters
`Boolean`	`getEnableCORS()`
`String`	`getLabel()` Returns a label to describe this node such as the expression if some kind of expression node
`String`	`getOutType()`
`String`	`getProduces()`
`Boolean`	`getRequiredBody()`
`Boolean`	`getSkipBindingOnErrorCode()`
`String`	`getType()`
`void`	`setBindingMode(RestBindingMode bindingMode)` Sets the binding mode to use.
`void`	`setClientRequestValidation(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.
`void`	`setComponent(String component)` Sets the component name that this definition will apply to
`void`	`setConsumes(String consumes)` To define the content type what the REST service consumes (accept as input), such as application/xml or application/json
`void`	`setEnableCORS(Boolean enableCORS)` Whether to enable CORS headers in the HTTP response.
`void`	`setOutType(String outType)` Sets the class name to use for binding from POJO to output for the outgoing data The canonical name of the class of the input data.
`void`	`setProduces(String produces)` To define the content type what the REST service produces (uses for output), such as application/xml or application/json
`void`	`setRequiredBody(Boolean requiredBody)`
`void`	`setSkipBindingOnErrorCode(Boolean skipBindingOnErrorCode)` Whether to skip binding on output if there is a custom HTTP error code header.
`void`	`setType(String type)` Sets the class name to use for binding from input to POJO for the incoming data The canonical name of the class of the input data.
`String`	`toString()`

Methods inherited from class org.apache.camel.model.OptionalIdentifiedDefinition
description, description, getCustomId, getDescription, getDescriptionText, getId, getShortName, hasCustomIdAssigned, id, idOrCreate, setCustomId, setDescription, setId

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

- Constructor Detail
  - RestBindingDefinition
```
public RestBindingDefinition()
```
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - createRestBindingAdvice
```
public RestBindingAdvice createRestBindingAdvice(RouteContext routeContext)
                                          throws Exception
```
    Throws:
    
    Exception
  - getConsumes
```
public String getConsumes()
```
  - addDefaultValue
```
public void addDefaultValue(String paramName,
                            String defaultValue)
```
    Adds a default value for the query parameter
    
    Parameters:
    
    paramName - query parameter name
    
    defaultValue - the default value
  - addRequiredQueryParameter
```
public void addRequiredQueryParameter(String paramName)
```
    Adds a required query parameter
    
    Parameters:
    
    paramName - query parameter name
  - addRequiredHeader
```
public void addRequiredHeader(String headerName)
```
    Adds a required HTTP header
    
    Parameters:
    
    headerName - HTTP header name
  - getRequiredBody
```
public Boolean getRequiredBody()
```
  - setRequiredBody
```
public void setRequiredBody(Boolean requiredBody)
```
  - getDefaultValues
```
public Map<String,String> getDefaultValues()
```
    Gets the registered default values for query parameters
  - setComponent
```
public void setComponent(String component)
```
    Sets the component name that this definition will apply to
  - getComponent
```
public String getComponent()
```
  - setConsumes
```
public void setConsumes(String consumes)
```
    To define the content type what the REST service consumes (accept as input), such as application/xml or application/json
  - getProduces
```
public String getProduces()
```
  - setProduces
```
public void setProduces(String produces)
```
    To define the content type what the REST service produces (uses for output), such as application/xml or application/json
  - getBindingMode
```
public RestBindingMode getBindingMode()
```
  - setBindingMode
```
public void setBindingMode(RestBindingMode bindingMode)
```
    Sets the binding mode to use.
    The default value is off
  - getType
```
public String getType()
```
  - setType
```
public void setType(String type)
```
    Sets the class name to use for binding from input to POJO for the incoming data
    The canonical name of the class of the input data. Append a [] to the end of the canonical name if you want the input to be an array type.
  - getOutType
```
public String getOutType()
```
  - setOutType
```
public void setOutType(String outType)
```
    Sets the class name to use for binding from POJO to output for the outgoing data
    The canonical name of the class of the input data. Append a [] to the end of the canonical name if you want the input to be an array type.
  - 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.
  - getClientRequestValidation
```
public Boolean getClientRequestValidation()
```
  - setClientRequestValidation
```
public void setClientRequestValidation(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.
    This can be turned on, to enable this check. In case of validation error, then HTTP Status codes 415 or 406 is returned.
    The default value is false.
  - getEnableCORS
```
public Boolean getEnableCORS()
```
  - setEnableCORS
```
public void setEnableCORS(Boolean enableCORS)
```
    Whether to enable CORS headers in the HTTP response.
    The default value is false.
  - getLabel
```
public String getLabel()
```
    Description copied from interface: NamedNode
    
    Returns a label to describe this node such as the expression if some kind of expression node

Class RestBindingDefinition

Constructor Summary

Method Summary

Methods inherited from class org.apache.camel.model.OptionalIdentifiedDefinition

Methods inherited from class java.lang.Object

Constructor Detail

RestBindingDefinition

Method Detail

toString

createRestBindingAdvice

getConsumes

addDefaultValue

addRequiredQueryParameter

addRequiredHeader

getRequiredBody

setRequiredBody

getDefaultValues

setComponent

getComponent

setConsumes

getProduces

setProduces

getBindingMode

setBindingMode

getType

setType

getOutType

setOutType

getSkipBindingOnErrorCode

setSkipBindingOnErrorCode

getClientRequestValidation

setClientRequestValidation

getEnableCORS

setEnableCORS

getLabel