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.NamedNode

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

To configure rest binding

Constructor Summary

Constructors

Constructor and Description
RestBindingDefinition()

Method Summary

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
String	getBindingMode()
String	getClientRequestValidation()
String	getComponent()
String	getConsumes()
Map<String,String>	getDefaultValues() Gets the registered default values for query parameters
String	getEnableCORS()
String	getLabel()
String	getOutType()
String	getProduces()
Boolean	getRequiredBody()
Set<String>	getRequiredHeaders()
Set<String>	getRequiredQueryParameters()
String	getShortName()
String	getSkipBindingOnErrorCode()
String	getType()
void	setBindingMode(String bindingMode) Sets the binding mode to use.
void	setClientRequestValidation(String 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(String 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(String 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, getParent, 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

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

getRequiredQueryParameters

public Set<String> getRequiredQueryParameters()

addRequiredHeader

public void addRequiredHeader(String headerName)

Adds a required HTTP header

Parameters:

headerName - HTTP header name

getRequiredHeaders

public Set<String> getRequiredHeaders()

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 String getBindingMode()

setBindingMode

public void setBindingMode(String 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 String getSkipBindingOnErrorCode()

setSkipBindingOnErrorCode

public void setSkipBindingOnErrorCode(String 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 String getClientRequestValidation()

setClientRequestValidation

public void setClientRequestValidation(String 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 String getEnableCORS()

setEnableCORS

public void setEnableCORS(String enableCORS)

Whether to enable CORS headers in the HTTP response.

The default value is false.

getShortName

public String getShortName()

getLabel

public String getLabel()