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

Interface JettyHttpEndpointBuilderFactory.JettyHttpEndpointBuilder

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

    • Method Detail

      • chunked

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

      • continuationTimeout

        default JettyHttpEndpointBuilderFactory.JettyHttpEndpointBuilder continuationTimeout​(Long continuationTimeout)
        Allows to set a timeout in millis when using Jetty as consumer (server). By default Jetty uses 30000. You can use a value of = 0 to never expire. If a timeout occurs then the request will be expired and Jetty will return back a http error 503 to the client. This option is only in use when using Jetty with the Asynchronous Routing Engine. The option is a: <code>java.lang.Long</code> type. Default: 30000 Group: consumer
        Parameters:
        continuationTimeout - the value to set
        Returns:
        the dsl builder

      • continuationTimeout

        default JettyHttpEndpointBuilderFactory.JettyHttpEndpointBuilder continuationTimeout​(String continuationTimeout)
        Allows to set a timeout in millis when using Jetty as consumer (server). By default Jetty uses 30000. You can use a value of = 0 to never expire. If a timeout occurs then the request will be expired and Jetty will return back a http error 503 to the client. This option is only in use when using Jetty with the Asynchronous Routing Engine. The option will be converted to a <code>java.lang.Long</code> type. Default: 30000 Group: consumer
        Parameters:
        continuationTimeout - the value to set
        Returns:
        the dsl builder

      • enableCORS

        default JettyHttpEndpointBuilderFactory.JettyHttpEndpointBuilder enableCORS​(boolean enableCORS)
        If the option is true, Jetty server will setup the CrossOriginFilter which supports the CORS out of box. The option is a: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        enableCORS - the value to set
        Returns:
        the dsl builder

      • enableCORS

        default JettyHttpEndpointBuilderFactory.JettyHttpEndpointBuilder enableCORS​(String enableCORS)
        If the option is true, Jetty server will setup the CrossOriginFilter which supports the CORS out of box. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        enableCORS - the value to set
        Returns:
        the dsl builder

      • enableJmx

        default JettyHttpEndpointBuilderFactory.JettyHttpEndpointBuilder enableJmx​(boolean enableJmx)
        If this option is true, Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details. The option is a: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        enableJmx - the value to set
        Returns:
        the dsl builder

      • enableJmx

        default JettyHttpEndpointBuilderFactory.JettyHttpEndpointBuilder enableJmx​(String enableJmx)
        If this option is true, Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        enableJmx - the value to set
        Returns:
        the dsl builder

      • enableMultipartFilter

        default JettyHttpEndpointBuilderFactory.JettyHttpEndpointBuilder enableMultipartFilter​(boolean enableMultipartFilter)
        Whether org.apache.camel.component.jetty.MultiPartFilter is enabled or not. You should set this value to false when bridging endpoints, to ensure multipart requests is proxied/bridged as well. The option is a: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        enableMultipartFilter - the value to set
        Returns:
        the dsl builder

      • enableMultipartFilter

        default JettyHttpEndpointBuilderFactory.JettyHttpEndpointBuilder enableMultipartFilter​(String enableMultipartFilter)
        Whether org.apache.camel.component.jetty.MultiPartFilter is enabled or not. You should set this value to false when bridging endpoints, to ensure multipart requests is proxied/bridged as well. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        enableMultipartFilter - the value to set
        Returns:
        the dsl builder

      • httpMethodRestrict

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

      • sendDateHeader

        default JettyHttpEndpointBuilderFactory.JettyHttpEndpointBuilder sendDateHeader​(boolean sendDateHeader)
        If the option is true, jetty server will send the date header to the client which sends the request. NOTE please make sure there is no any other camel-jetty endpoint is share the same port, otherwise this option may not work as expected. The option is a: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        sendDateHeader - the value to set
        Returns:
        the dsl builder

      • sendDateHeader

        default JettyHttpEndpointBuilderFactory.JettyHttpEndpointBuilder sendDateHeader​(String sendDateHeader)
        If the option is true, jetty server will send the date header to the client which sends the request. NOTE please make sure there is no any other camel-jetty endpoint is share the same port, otherwise this option may not work as expected. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        sendDateHeader - the value to set
        Returns:
        the dsl builder

      • sendServerVersion

        default JettyHttpEndpointBuilderFactory.JettyHttpEndpointBuilder sendServerVersion​(boolean sendServerVersion)
        If the option is true, jetty will send the server header with the jetty version information to the client which sends the request. NOTE please make sure there is no any other camel-jetty endpoint is share the same port, otherwise this option may not work as expected. The option is a: <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        sendServerVersion - the value to set
        Returns:
        the dsl builder

      • sendServerVersion

        default JettyHttpEndpointBuilderFactory.JettyHttpEndpointBuilder sendServerVersion​(String sendServerVersion)
        If the option is true, jetty will send the server header with the jetty version information to the client which sends the request. NOTE please make sure there is no any other camel-jetty endpoint is share the same port, otherwise this option may not work as expected. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        sendServerVersion - the value to set
        Returns:
        the dsl builder

      • sessionSupport

        default JettyHttpEndpointBuilderFactory.JettyHttpEndpointBuilder sessionSupport​(boolean sessionSupport)
        Specifies whether to enable the session manager on the server side of Jetty. The option is a: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        sessionSupport - the value to set
        Returns:
        the dsl builder

      • sessionSupport

        default JettyHttpEndpointBuilderFactory.JettyHttpEndpointBuilder sessionSupport​(String sessionSupport)
        Specifies whether to enable the session manager on the server side of Jetty. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        sessionSupport - the value to set
        Returns:
        the dsl builder

      • transferException

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

      • useContinuation

        default JettyHttpEndpointBuilderFactory.JettyHttpEndpointBuilder useContinuation​(Boolean useContinuation)
        Whether or not to use Jetty continuations for the Jetty Server. The option is a: <code>java.lang.Boolean</code> type. Group: consumer
        Parameters:
        useContinuation - the value to set
        Returns:
        the dsl builder

      • useContinuation

        default JettyHttpEndpointBuilderFactory.JettyHttpEndpointBuilder useContinuation​(String useContinuation)
        Whether or not to use Jetty continuations for the Jetty Server. The option will be converted to a <code>java.lang.Boolean</code> type. Group: consumer
        Parameters:
        useContinuation - the value to set
        Returns:
        the dsl builder

      • sslContextParameters

        default JettyHttpEndpointBuilderFactory.JettyHttpEndpointBuilder sslContextParameters​(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
        To configure security using SSLContextParameters. The option is a: <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security
        Parameters:
        sslContextParameters - the value to set
        Returns:
        the dsl builder

      • sslContextParameters

        default JettyHttpEndpointBuilderFactory.JettyHttpEndpointBuilder sslContextParameters​(String sslContextParameters)
        To configure security using SSLContextParameters. The option will be converted to a <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security
        Parameters:
        sslContextParameters - the value to set
        Returns:
        the dsl builder