Package org.apache.camel.builder.endpoint.dsl

Interface JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
Enclosing interface:
JettyHttp12EndpointBuilderFactory
public static interface JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Advanced builder for endpoint for the Jetty component.

  • Method Details

    • basic

      default JettyHttp12EndpointBuilderFactory.JettyHttp12EndpointBuilder basic()

    • headerFilterStrategy

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder 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 (advanced)
      Parameters:
      headerFilterStrategy - the value to set
      Returns:
      the dsl builder

    • headerFilterStrategy

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder 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 (advanced)
      Parameters:
      headerFilterStrategy - the value to set
      Returns:
      the dsl builder

    • httpBinding

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder httpBinding(org.apache.camel.http.common.HttpBinding httpBinding)
      To use a custom HttpBinding to control the mapping between Camel message and HttpClient. The option is a: <code>org.apache.camel.http.common.HttpBinding</code> type. Group: common (advanced)
      Parameters:
      httpBinding - the value to set
      Returns:
      the dsl builder

    • httpBinding

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder httpBinding(String httpBinding)
      To use a custom HttpBinding to control the mapping between Camel message and HttpClient. The option will be converted to a <code>org.apache.camel.http.common.HttpBinding</code> type. Group: common (advanced)
      Parameters:
      httpBinding - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>boolean</code> type. Default: false Group: consumer (advanced)
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder bridgeErrorHandler(String bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer (advanced)
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • eagerCheckContentAvailable

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder eagerCheckContentAvailable(boolean eagerCheckContentAvailable)
      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. The option is a: <code>boolean</code> type. Default: false Group: consumer (advanced)
      Parameters:
      eagerCheckContentAvailable - the value to set
      Returns:
      the dsl builder

    • eagerCheckContentAvailable

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder eagerCheckContentAvailable(String eagerCheckContentAvailable)
      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. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer (advanced)
      Parameters:
      eagerCheckContentAvailable - the value to set
      Returns:
      the dsl builder

    • exceptionHandler

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler)
      To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)
      Parameters:
      exceptionHandler - the value to set
      Returns:
      the dsl builder

    • exceptionHandler

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder exceptionHandler(String exceptionHandler)
      To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)
      Parameters:
      exceptionHandler - the value to set
      Returns:
      the dsl builder

    • exchangePattern

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder exchangePattern(org.apache.camel.ExchangePattern exchangePattern)
      Sets the exchange pattern when the consumer creates an exchange. The option is a: <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)
      Parameters:
      exchangePattern - the value to set
      Returns:
      the dsl builder

    • exchangePattern

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder exchangePattern(String exchangePattern)
      Sets the exchange pattern when the consumer creates an exchange. The option will be converted to a <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)
      Parameters:
      exchangePattern - the value to set
      Returns:
      the dsl builder

    • fileSizeThreshold

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder fileSizeThreshold(Integer fileSizeThreshold)
      The size threshold after which files will be written to disk for multipart/form-data requests. By default the files are not written to disk. The option is a: <code>java.lang.Integer</code> type. Group: consumer (advanced)
      Parameters:
      fileSizeThreshold - the value to set
      Returns:
      the dsl builder

    • fileSizeThreshold

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder fileSizeThreshold(String fileSizeThreshold)
      The size threshold after which files will be written to disk for multipart/form-data requests. By default the files are not written to disk. The option will be converted to a <code>java.lang.Integer</code> type. Group: consumer (advanced)
      Parameters:
      fileSizeThreshold - the value to set
      Returns:
      the dsl builder

    • filesLocation

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder filesLocation(String filesLocation)
      The directory location where files will be store for multipart/form-data requests. By default the files are written in the system temporary folder. The option is a: <code>java.lang.String</code> type. Group: consumer (advanced)
      Parameters:
      filesLocation - the value to set
      Returns:
      the dsl builder

    • filterInitParameters

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder filterInitParameters(String key, Object value)
      Configuration of the filter init parameters. These parameters will be applied to the filter list before starting the jetty server. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.String&gt;</code> type. The option is multivalued, and you can use the filterInitParameters(String, Object) method to add a value (call the method multiple times to set more values). Group: consumer (advanced)
      Parameters:
      key - the option key
      value - the option value
      Returns:
      the dsl builder

    • filterInitParameters

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder filterInitParameters(Map values)
      Configuration of the filter init parameters. These parameters will be applied to the filter list before starting the jetty server. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.String&gt;</code> type. The option is multivalued, and you can use the filterInitParameters(String, Object) method to add a value (call the method multiple times to set more values). Group: consumer (advanced)
      Parameters:
      values - the values
      Returns:
      the dsl builder

    • filters

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder filters(List<jakarta.servlet.Filter> filters)
      Allows using a custom filters which is putted into a list and can be find in the Registry. Multiple values can be separated by comma. The option is a: <code>java.util.List&lt;jakarta.servlet.Filter&gt;</code> type. Group: consumer (advanced)
      Parameters:
      filters - the value to set
      Returns:
      the dsl builder

    • filters

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder filters(String filters)
      Allows using a custom filters which is putted into a list and can be find in the Registry. Multiple values can be separated by comma. The option will be converted to a <code>java.util.List&lt;jakarta.servlet.Filter&gt;</code> type. Group: consumer (advanced)
      Parameters:
      filters - the value to set
      Returns:
      the dsl builder

    • handlers

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder handlers(List<org.eclipse.jetty.server.Handler> handlers)
      Specifies a comma-delimited set of Handler instances to lookup in your Registry. These handlers are added to the Jetty servlet context (for example, to add security). Important: You can not use different handlers with different Jetty endpoints using the same port number. The handlers is associated to the port number. If you need different handlers, then use different port numbers. The option is a: <code>java.util.List&lt;org.eclipse.jetty.server.Handler&gt;</code> type. Group: consumer (advanced)
      Parameters:
      handlers - the value to set
      Returns:
      the dsl builder

    • handlers

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder handlers(String handlers)
      Specifies a comma-delimited set of Handler instances to lookup in your Registry. These handlers are added to the Jetty servlet context (for example, to add security). Important: You can not use different handlers with different Jetty endpoints using the same port number. The handlers is associated to the port number. If you need different handlers, then use different port numbers. The option will be converted to a <code>java.util.List&lt;org.eclipse.jetty.server.Handler&gt;</code> type. Group: consumer (advanced)
      Parameters:
      handlers - the value to set
      Returns:
      the dsl builder

    • idleTimeout

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder idleTimeout(long idleTimeout)
      The max idle time (in milli seconds) is applied to an HTTP request for IO operations and delayed dispatch. Idle time 0 implies an infinite timeout, -1 (default) implies no HTTP channel timeout and the connection timeout is used instead. The option is a: <code>long</code> type. Default: -1 Group: consumer (advanced)
      Parameters:
      idleTimeout - the value to set
      Returns:
      the dsl builder

    • idleTimeout

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder idleTimeout(String idleTimeout)
      The max idle time (in milli seconds) is applied to an HTTP request for IO operations and delayed dispatch. Idle time 0 implies an infinite timeout, -1 (default) implies no HTTP channel timeout and the connection timeout is used instead. The option will be converted to a <code>long</code> type. Default: -1 Group: consumer (advanced)
      Parameters:
      idleTimeout - the value to set
      Returns:
      the dsl builder

    • mapHttpMessageBody

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder mapHttpMessageBody(boolean mapHttpMessageBody)
      If this option is true then IN exchange Body of the exchange will be mapped to HTTP body. Setting this to false will avoid the HTTP mapping. The option is a: <code>boolean</code> type. Default: true Group: consumer (advanced)
      Parameters:
      mapHttpMessageBody - the value to set
      Returns:
      the dsl builder

    • mapHttpMessageBody

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder mapHttpMessageBody(String mapHttpMessageBody)
      If this option is true then IN exchange Body of the exchange will be mapped to HTTP body. Setting this to false will avoid the HTTP mapping. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer (advanced)
      Parameters:
      mapHttpMessageBody - the value to set
      Returns:
      the dsl builder

    • mapHttpMessageFormUrlEncodedBody

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder mapHttpMessageFormUrlEncodedBody(boolean mapHttpMessageFormUrlEncodedBody)
      If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP. Setting this to false will avoid the HTTP Form Encoded body mapping. The option is a: <code>boolean</code> type. Default: true Group: consumer (advanced)
      Parameters:
      mapHttpMessageFormUrlEncodedBody - the value to set
      Returns:
      the dsl builder

    • mapHttpMessageFormUrlEncodedBody

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder mapHttpMessageFormUrlEncodedBody(String mapHttpMessageFormUrlEncodedBody)
      If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP. Setting this to false will avoid the HTTP Form Encoded body mapping. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer (advanced)
      Parameters:
      mapHttpMessageFormUrlEncodedBody - the value to set
      Returns:
      the dsl builder

    • mapHttpMessageHeaders

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder mapHttpMessageHeaders(boolean mapHttpMessageHeaders)
      If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers. Setting this to false will avoid the HTTP Headers mapping. The option is a: <code>boolean</code> type. Default: true Group: consumer (advanced)
      Parameters:
      mapHttpMessageHeaders - the value to set
      Returns:
      the dsl builder

    • mapHttpMessageHeaders

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder mapHttpMessageHeaders(String mapHttpMessageHeaders)
      If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers. Setting this to false will avoid the HTTP Headers mapping. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer (advanced)
      Parameters:
      mapHttpMessageHeaders - the value to set
      Returns:
      the dsl builder

    • maxFileSize

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder maxFileSize(Long maxFileSize)
      The maximum size allowed for uploaded files. -1 means no limit. The option is a: <code>java.lang.Long</code> type. Group: consumer (advanced)
      Parameters:
      maxFileSize - the value to set
      Returns:
      the dsl builder

    • maxFileSize

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder maxFileSize(String maxFileSize)
      The maximum size allowed for uploaded files. -1 means no limit. The option will be converted to a <code>java.lang.Long</code> type. Group: consumer (advanced)
      Parameters:
      maxFileSize - the value to set
      Returns:
      the dsl builder

    • maxRequestSize

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder maxRequestSize(Long maxRequestSize)
      The maximum size allowed for multipart/form-data requests. -1 means no limit. The option is a: <code>java.lang.Long</code> type. Group: consumer (advanced)
      Parameters:
      maxRequestSize - the value to set
      Returns:
      the dsl builder

    • maxRequestSize

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder maxRequestSize(String maxRequestSize)
      The maximum size allowed for multipart/form-data requests. -1 means no limit. The option will be converted to a <code>java.lang.Long</code> type. Group: consumer (advanced)
      Parameters:
      maxRequestSize - the value to set
      Returns:
      the dsl builder

    • multipartFilter

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder multipartFilter(jakarta.servlet.Filter multipartFilter)
      Allows using a custom multipart filter. Note: setting multipartFilterRef forces the value of enableMultipartFilter to true. The option is a: <code>jakarta.servlet.Filter</code> type. Group: consumer (advanced)
      Parameters:
      multipartFilter - the value to set
      Returns:
      the dsl builder

    • multipartFilter

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder multipartFilter(String multipartFilter)
      Allows using a custom multipart filter. Note: setting multipartFilterRef forces the value of enableMultipartFilter to true. The option will be converted to a <code>jakarta.servlet.Filter</code> type. Group: consumer (advanced)
      Parameters:
      multipartFilter - the value to set
      Returns:
      the dsl builder

    • optionsEnabled

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder optionsEnabled(boolean optionsEnabled)
      Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off. The option is a: <code>boolean</code> type. Default: false Group: consumer (advanced)
      Parameters:
      optionsEnabled - the value to set
      Returns:
      the dsl builder

    • optionsEnabled

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder optionsEnabled(String optionsEnabled)
      Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer (advanced)
      Parameters:
      optionsEnabled - the value to set
      Returns:
      the dsl builder

    • traceEnabled

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder traceEnabled(boolean traceEnabled)
      Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off. The option is a: <code>boolean</code> type. Default: false Group: consumer (advanced)
      Parameters:
      traceEnabled - the value to set
      Returns:
      the dsl builder

    • traceEnabled

      default JettyHttp12EndpointBuilderFactory.AdvancedJettyHttp12EndpointBuilder traceEnabled(String traceEnabled)
      Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer (advanced)
      Parameters:
      traceEnabled - the value to set
      Returns:
      the dsl builder