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

Interface JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder

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

    • Method Detail

      • headerFilterStrategy

        default JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder bridgeErrorHandler​(boolean bridgeErrorHandler)
        Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder bridgeErrorHandler​(String bridgeErrorHandler)
        Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder filters​(List<javax.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;javax.servlet.Filter&gt;</code> type. Group: consumer (advanced)
        Parameters:
        filters - the value to set
        Returns:
        the dsl builder

      • filters

        default JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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;javax.servlet.Filter&gt;</code> type. Group: consumer (advanced)
        Parameters:
        filters - the value to set
        Returns:
        the dsl builder

      • handlers

        default JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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

      • mapHttpMessageBody

        default JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder multipartFilter​(javax.servlet.Filter multipartFilter)
        Allows using a custom multipart filter. Note: setting multipartFilterRef forces the value of enableMultipartFilter to true. The option is a: <code>javax.servlet.Filter</code> type. Group: consumer (advanced)
        Parameters:
        multipartFilter - the value to set
        Returns:
        the dsl builder

      • multipartFilter

        default JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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>javax.servlet.Filter</code> type. Group: consumer (advanced)
        Parameters:
        multipartFilter - the value to set
        Returns:
        the dsl builder

      • optionsEnabled

        default JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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 JettyHttpEndpointBuilderFactory.AdvancedJettyHttpEndpointBuilder 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