Interface ServletEndpointBuilderFactory.ServletEndpointBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- Enclosing interface:
- ServletEndpointBuilderFactory
public static interface ServletEndpointBuilderFactory.ServletEndpointBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint for the Servlet component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default ServletEndpointBuilderFactory.AdvancedServletEndpointBuilder
advanced()
default ServletEndpointBuilderFactory.ServletEndpointBuilder
async(boolean async)
Configure the consumer to work in async mode.default ServletEndpointBuilderFactory.ServletEndpointBuilder
async(String async)
Configure the consumer to work in async mode.default ServletEndpointBuilderFactory.ServletEndpointBuilder
chunked(boolean chunked)
If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response.default ServletEndpointBuilderFactory.ServletEndpointBuilder
chunked(String chunked)
If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response.default ServletEndpointBuilderFactory.ServletEndpointBuilder
disableStreamCache(boolean disableStreamCache)
Determines whether or not the raw input stream from Servlet is cached or not (Camel will read the stream into a in memory/overflow to file, Stream caching) cache.default ServletEndpointBuilderFactory.ServletEndpointBuilder
disableStreamCache(String disableStreamCache)
Determines whether or not the raw input stream from Servlet is cached or not (Camel will read the stream into a in memory/overflow to file, Stream caching) cache.default ServletEndpointBuilderFactory.ServletEndpointBuilder
headerFilterStrategy(String headerFilterStrategy)
To use a custom HeaderFilterStrategy to filter header to and from Camel message.default ServletEndpointBuilderFactory.ServletEndpointBuilder
headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
To use a custom HeaderFilterStrategy to filter header to and from Camel message.default ServletEndpointBuilderFactory.ServletEndpointBuilder
httpMethodRestrict(String httpMethodRestrict)
Used to only allow consuming if the HttpMethod matches, such as GET/POST/PUT etc.default ServletEndpointBuilderFactory.ServletEndpointBuilder
matchOnUriPrefix(boolean matchOnUriPrefix)
Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found.default ServletEndpointBuilderFactory.ServletEndpointBuilder
matchOnUriPrefix(String matchOnUriPrefix)
Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found.default ServletEndpointBuilderFactory.ServletEndpointBuilder
muteException(boolean muteException)
If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace.default ServletEndpointBuilderFactory.ServletEndpointBuilder
muteException(String muteException)
If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace.default ServletEndpointBuilderFactory.ServletEndpointBuilder
responseBufferSize(Integer responseBufferSize)
To use a custom buffer size on the javax.servlet.ServletResponse.default ServletEndpointBuilderFactory.ServletEndpointBuilder
responseBufferSize(String responseBufferSize)
To use a custom buffer size on the javax.servlet.ServletResponse.default ServletEndpointBuilderFactory.ServletEndpointBuilder
servletName(String servletName)
Name of the servlet to use.default ServletEndpointBuilderFactory.ServletEndpointBuilder
transferException(boolean transferException)
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.default ServletEndpointBuilderFactory.ServletEndpointBuilder
transferException(String transferException)
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.
-
-
-
Method Detail
-
advanced
default ServletEndpointBuilderFactory.AdvancedServletEndpointBuilder advanced()
-
chunked
default ServletEndpointBuilderFactory.ServletEndpointBuilder chunked(boolean chunked)
If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response. The option is a: <code>boolean</code> type. Default: true Group: consumer- Parameters:
chunked
- the value to set- Returns:
- the dsl builder
-
chunked
default ServletEndpointBuilderFactory.ServletEndpointBuilder chunked(String chunked)
If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer- Parameters:
chunked
- the value to set- Returns:
- the dsl builder
-
disableStreamCache
default ServletEndpointBuilderFactory.ServletEndpointBuilder disableStreamCache(boolean disableStreamCache)
Determines whether or not the raw input stream from Servlet 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 Servlet 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 Servlet 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. The http producer will by default cache the response body stream. If setting this option to true, then the producers will not cache the response body stream but use the response stream as-is as the message body. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
disableStreamCache
- the value to set- Returns:
- the dsl builder
-
disableStreamCache
default ServletEndpointBuilderFactory.ServletEndpointBuilder disableStreamCache(String disableStreamCache)
Determines whether or not the raw input stream from Servlet 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 Servlet 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 Servlet 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. The http producer will by default cache the response body stream. If setting this option to true, then the producers will not cache the response body stream but use the response stream as-is as the message body. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Parameters:
disableStreamCache
- the value to set- Returns:
- the dsl builder
-
headerFilterStrategy
default ServletEndpointBuilderFactory.ServletEndpointBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
To use a custom HeaderFilterStrategy to filter header to and from Camel message. The option is a: <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: common- Parameters:
headerFilterStrategy
- the value to set- Returns:
- the dsl builder
-
headerFilterStrategy
default ServletEndpointBuilderFactory.ServletEndpointBuilder headerFilterStrategy(String headerFilterStrategy)
To use a custom HeaderFilterStrategy to filter header to and from Camel message. The option will be converted to a <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: common- Parameters:
headerFilterStrategy
- the value to set- Returns:
- the dsl builder
-
async
default ServletEndpointBuilderFactory.ServletEndpointBuilder async(boolean async)
Configure the consumer to work in async mode. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
async
- the value to set- Returns:
- the dsl builder
-
async
default ServletEndpointBuilderFactory.ServletEndpointBuilder async(String async)
Configure the consumer to work in async mode. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer- Parameters:
async
- the value to set- Returns:
- the dsl builder
-
httpMethodRestrict
default ServletEndpointBuilderFactory.ServletEndpointBuilder httpMethodRestrict(String httpMethodRestrict)
Used to only allow consuming if the HttpMethod matches, such as GET/POST/PUT etc. Multiple methods can be specified separated by comma. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
httpMethodRestrict
- the value to set- Returns:
- the dsl builder
-
matchOnUriPrefix
default ServletEndpointBuilderFactory.ServletEndpointBuilder matchOnUriPrefix(boolean matchOnUriPrefix)
Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
matchOnUriPrefix
- the value to set- Returns:
- the dsl builder
-
matchOnUriPrefix
default ServletEndpointBuilderFactory.ServletEndpointBuilder matchOnUriPrefix(String matchOnUriPrefix)
Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer- Parameters:
matchOnUriPrefix
- the value to set- Returns:
- the dsl builder
-
muteException
default ServletEndpointBuilderFactory.ServletEndpointBuilder muteException(boolean muteException)
If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
muteException
- the value to set- Returns:
- the dsl builder
-
muteException
default ServletEndpointBuilderFactory.ServletEndpointBuilder muteException(String muteException)
If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer- Parameters:
muteException
- the value to set- Returns:
- the dsl builder
-
responseBufferSize
default ServletEndpointBuilderFactory.ServletEndpointBuilder responseBufferSize(Integer responseBufferSize)
To use a custom buffer size on the javax.servlet.ServletResponse. The option is a: <code>java.lang.Integer</code> type. Group: consumer- Parameters:
responseBufferSize
- the value to set- Returns:
- the dsl builder
-
responseBufferSize
default ServletEndpointBuilderFactory.ServletEndpointBuilder responseBufferSize(String responseBufferSize)
To use a custom buffer size on the javax.servlet.ServletResponse. The option will be converted to a <code>java.lang.Integer</code> type. Group: consumer- Parameters:
responseBufferSize
- the value to set- Returns:
- the dsl builder
-
servletName
default ServletEndpointBuilderFactory.ServletEndpointBuilder servletName(String servletName)
Name of the servlet to use. The option is a: <code>java.lang.String</code> type. Default: CamelServlet Group: consumer- Parameters:
servletName
- the value to set- Returns:
- the dsl builder
-
transferException
default ServletEndpointBuilderFactory.ServletEndpointBuilder transferException(boolean transferException)
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. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
transferException
- the value to set- Returns:
- the dsl builder
-
transferException
default ServletEndpointBuilderFactory.ServletEndpointBuilder transferException(String transferException)
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. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer- Parameters:
transferException
- the value to set- Returns:
- the dsl builder
-
-