Servlet

Servlet

Description: Camel servlet transport support
Scheme: servlet
Syntax: servlet:contextPath
Maven: org.apache.camel/camel-servlet/2.16.1
Name Kind Group Required Default Type Enum Description
contextPath path consumer true java.lang.String The context-path to use
httpUri path producer true java.net.URI The url of the HTTP endpoint to call.
binding parameter consumer org.apache.camel.http.common.HttpBinding To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
chunked parameter consumer true boolean If this option is false Jetty servlet will disable the HTTP streaming and set the content-length header on the response
disableStreamCache parameter consumer boolean Determines whether or not the raw input stream from Jetty is cached or not (Camel will read the stream into a in memory/overflow to file, Stream caching) cache. By default Camel will cache the Jetty input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Jetty to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times.
eagerCheckContentAvailable parameter consumer boolean Whether to eager check whether the HTTP requests has content if the content-length header is 0 or not present. This can be turned on in case HTTP clients do not send streamed data.
headerFilterStrategy parameter consumer org.apache.camel.spi.HeaderFilterStrategy To use a custom HeaderFilterStrategy to filter header to and from Camel message.
httpMethodRestrict parameter consumer java.lang.String Used to only allow consuming if the HttpMethod matches, such as GET/POST/PUT etc. Multiple methods can be specified separated by comma.
matchOnUriPrefix parameter consumer boolean Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found.
responseBufferSize parameter consumer java.lang.Integer To use a custom buffer size on the javax.servlet.ServletResponse.
servletName parameter consumer CamelServlet java.lang.String Name of the servlet to use
traceEnabled parameter consumer boolean Specifies whether to enable HTTP TRACE for this Jetty consumer. By default TRACE is turned off.
transferException parameter consumer boolean If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is, instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.
authMethodPriority parameter producer java.lang.String Basic
Digest
NTLM
Authentication method for proxy, either as Basic, Digest or NTLM.
bridgeEndpoint parameter producer boolean If the option is true, HttpProducer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request. You may also set the option throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back.
copyHeaders parameter producer true boolean If this option is true then IN exchange headers will be copied to OUT exchange headers according to copy strategy. Setting this to false, allows to only include the headers from the HTTP response (not propagating IN headers).
ignoreResponseBody parameter producer boolean If this option is true, The http producer won't read response body and cache the input stream
okStatusCodeRange parameter producer 200-299 java.lang.String The status codes which is considered a success response. The values are inclusive. The range must be defined as from-to with the dash included.
proxyHost parameter producer java.lang.String The proxy host name
proxyPort parameter producer int The proxy port number
throwExceptionOnFailure parameter producer true boolean Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code.
exchangePattern parameter advanced InOnly org.apache.camel.ExchangePattern InOnly
RobustInOnly
InOut
InOptionalOut
OutOnly
RobustOutOnly
OutIn
OutOptionalIn
Sets the default exchange pattern when creating an exchange
synchronous parameter advanced false boolean Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

servlet consumer