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

Interface HttpEndpointBuilderFactory.HttpEndpointBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
Enclosing interface:
HttpEndpointBuilderFactory
public static interface HttpEndpointBuilderFactory.HttpEndpointBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint for the HTTP component.

  • Method Details

    • advanced

      default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder advanced()

    • disableStreamCache

      default HttpEndpointBuilderFactory.HttpEndpointBuilder disableStreamCache(boolean disableStreamCache)
      Determines whether or not the raw input stream is cached or not. The Camel consumer (camel-servlet, camel-jetty etc.) will by default cache the 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 producer (camel-http) 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 (the stream can only be read once) as the message body. The option is a: boolean type. Default: false Group: common
      Parameters:
      disableStreamCache - the value to set
      Returns:
      the dsl builder

    • disableStreamCache

      default HttpEndpointBuilderFactory.HttpEndpointBuilder disableStreamCache(String disableStreamCache)
      Determines whether or not the raw input stream is cached or not. The Camel consumer (camel-servlet, camel-jetty etc.) will by default cache the 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 producer (camel-http) 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 (the stream can only be read once) as the message body. The option will be converted to a boolean type. Default: false Group: common
      Parameters:
      disableStreamCache - the value to set
      Returns:
      the dsl builder

    • bridgeEndpoint

      default HttpEndpointBuilderFactory.HttpEndpointBuilder bridgeEndpoint(boolean bridgeEndpoint)
      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. The option is a: boolean type. Default: false Group: producer
      Parameters:
      bridgeEndpoint - the value to set
      Returns:
      the dsl builder

    • bridgeEndpoint

      default HttpEndpointBuilderFactory.HttpEndpointBuilder bridgeEndpoint(String bridgeEndpoint)
      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. The option will be converted to a boolean type. Default: false Group: producer
      Parameters:
      bridgeEndpoint - the value to set
      Returns:
      the dsl builder

    • connectionClose

      default HttpEndpointBuilderFactory.HttpEndpointBuilder connectionClose(boolean connectionClose)
      Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false. The option is a: boolean type. Default: false Group: producer
      Parameters:
      connectionClose - the value to set
      Returns:
      the dsl builder

    • connectionClose

      default HttpEndpointBuilderFactory.HttpEndpointBuilder connectionClose(String connectionClose)
      Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false. The option will be converted to a boolean type. Default: false Group: producer
      Parameters:
      connectionClose - the value to set
      Returns:
      the dsl builder

    • httpMethod

      default HttpEndpointBuilderFactory.HttpEndpointBuilder httpMethod(org.apache.camel.http.common.HttpMethods httpMethod)
      Configure the HTTP method to use. The HttpMethod header cannot override this option if set. The option is a: org.apache.camel.http.common.HttpMethods type. Group: producer
      Parameters:
      httpMethod - the value to set
      Returns:
      the dsl builder

    • httpMethod

      default HttpEndpointBuilderFactory.HttpEndpointBuilder httpMethod(String httpMethod)
      Configure the HTTP method to use. The HttpMethod header cannot override this option if set. The option will be converted to a org.apache.camel.http.common.HttpMethods type. Group: producer
      Parameters:
      httpMethod - the value to set
      Returns:
      the dsl builder

    • logHttpActivity

      default HttpEndpointBuilderFactory.HttpEndpointBuilder logHttpActivity(boolean logHttpActivity)
      To enable logging HTTP request and response. You can use a custom LoggingHttpActivityListener as httpActivityListener to control logging options. The option is a: boolean type. Default: false Group: producer
      Parameters:
      logHttpActivity - the value to set
      Returns:
      the dsl builder

    • logHttpActivity

      default HttpEndpointBuilderFactory.HttpEndpointBuilder logHttpActivity(String logHttpActivity)
      To enable logging HTTP request and response. You can use a custom LoggingHttpActivityListener as httpActivityListener to control logging options. The option will be converted to a boolean type. Default: false Group: producer
      Parameters:
      logHttpActivity - the value to set
      Returns:
      the dsl builder

    • multipartUpload

      default HttpEndpointBuilderFactory.HttpEndpointBuilder multipartUpload(boolean multipartUpload)
      Whether to force using multipart/form-data for easy file uploads. This is only to be used for uploading the message body as a single entity form-data. For uploading multiple entries then use org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder to build the form. The option is a: boolean type. Default: false Group: producer
      Parameters:
      multipartUpload - the value to set
      Returns:
      the dsl builder

    • multipartUpload

      default HttpEndpointBuilderFactory.HttpEndpointBuilder multipartUpload(String multipartUpload)
      Whether to force using multipart/form-data for easy file uploads. This is only to be used for uploading the message body as a single entity form-data. For uploading multiple entries then use org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder to build the form. The option will be converted to a boolean type. Default: false Group: producer
      Parameters:
      multipartUpload - the value to set
      Returns:
      the dsl builder

    • multipartUploadName

      default HttpEndpointBuilderFactory.HttpEndpointBuilder multipartUploadName(String multipartUploadName)
      The name of the multipart/form-data when multipartUpload is enabled. The option is a: java.lang.String type. Default: data Group: producer
      Parameters:
      multipartUploadName - the value to set
      Returns:
      the dsl builder

    • skipControlHeaders

      default HttpEndpointBuilderFactory.HttpEndpointBuilder skipControlHeaders(boolean skipControlHeaders)
      Whether to skip Camel control headers (CamelHttp... headers) to influence this endpoint. Control headers from previous HTTP components can influence how this Camel component behaves such as CamelHttpPath, CamelHttpQuery, etc. The option is a: boolean type. Default: false Group: producer
      Parameters:
      skipControlHeaders - the value to set
      Returns:
      the dsl builder

    • skipControlHeaders

      default HttpEndpointBuilderFactory.HttpEndpointBuilder skipControlHeaders(String skipControlHeaders)
      Whether to skip Camel control headers (CamelHttp... headers) to influence this endpoint. Control headers from previous HTTP components can influence how this Camel component behaves such as CamelHttpPath, CamelHttpQuery, etc. The option will be converted to a boolean type. Default: false Group: producer
      Parameters:
      skipControlHeaders - the value to set
      Returns:
      the dsl builder

    • skipRequestHeaders

      default HttpEndpointBuilderFactory.HttpEndpointBuilder skipRequestHeaders(boolean skipRequestHeaders)
      Whether to skip mapping the Camel headers as HTTP request headers. This is useful when you know that calling the HTTP service should not include any custom headers. The option is a: boolean type. Default: false Group: producer
      Parameters:
      skipRequestHeaders - the value to set
      Returns:
      the dsl builder

    • skipRequestHeaders

      default HttpEndpointBuilderFactory.HttpEndpointBuilder skipRequestHeaders(String skipRequestHeaders)
      Whether to skip mapping the Camel headers as HTTP request headers. This is useful when you know that calling the HTTP service should not include any custom headers. The option will be converted to a boolean type. Default: false Group: producer
      Parameters:
      skipRequestHeaders - the value to set
      Returns:
      the dsl builder

    • skipResponseHeaders

      default HttpEndpointBuilderFactory.HttpEndpointBuilder skipResponseHeaders(boolean skipResponseHeaders)
      Whether to skip mapping all the HTTP response headers to Camel headers. The option is a: boolean type. Default: false Group: producer
      Parameters:
      skipResponseHeaders - the value to set
      Returns:
      the dsl builder

    • skipResponseHeaders

      default HttpEndpointBuilderFactory.HttpEndpointBuilder skipResponseHeaders(String skipResponseHeaders)
      Whether to skip mapping all the HTTP response headers to Camel headers. The option will be converted to a boolean type. Default: false Group: producer
      Parameters:
      skipResponseHeaders - the value to set
      Returns:
      the dsl builder

    • throwExceptionOnFailure

      default HttpEndpointBuilderFactory.HttpEndpointBuilder throwExceptionOnFailure(boolean throwExceptionOnFailure)
      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. The option is a: boolean type. Default: true Group: producer
      Parameters:
      throwExceptionOnFailure - the value to set
      Returns:
      the dsl builder

    • throwExceptionOnFailure

      default HttpEndpointBuilderFactory.HttpEndpointBuilder throwExceptionOnFailure(String throwExceptionOnFailure)
      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. The option will be converted to a boolean type. Default: true Group: producer
      Parameters:
      throwExceptionOnFailure - the value to set
      Returns:
      the dsl builder

    • nonProxyHosts

      default HttpEndpointBuilderFactory.HttpEndpointBuilder nonProxyHosts(String nonProxyHosts)
      Comma-separated list of hosts that should bypass the proxy. Supports wildcards, e.g., localhost,.example.com,192.168.. The option is a: java.lang.String type. Group: proxy
      Parameters:
      nonProxyHosts - the value to set
      Returns:
      the dsl builder

    • proxyAuthDomain

      @Deprecated default HttpEndpointBuilderFactory.HttpEndpointBuilder proxyAuthDomain(String proxyAuthDomain)
      Deprecated.
      Proxy authentication domain to use with NTLM. The option is a: java.lang.String type. Group: proxy
      Parameters:
      proxyAuthDomain - the value to set
      Returns:
      the dsl builder

    • proxyAuthHost

      @Deprecated default HttpEndpointBuilderFactory.HttpEndpointBuilder proxyAuthHost(String proxyAuthHost)
      Deprecated.
      Proxy server host. The option is a: java.lang.String type. Group: proxy
      Parameters:
      proxyAuthHost - the value to set
      Returns:
      the dsl builder

    • proxyAuthMethod

      default HttpEndpointBuilderFactory.HttpEndpointBuilder proxyAuthMethod(String proxyAuthMethod)
      Proxy authentication method to use (NTLM is deprecated). The option is a: java.lang.String type. Group: proxy
      Parameters:
      proxyAuthMethod - the value to set
      Returns:
      the dsl builder

    • proxyAuthNtHost

      @Deprecated default HttpEndpointBuilderFactory.HttpEndpointBuilder proxyAuthNtHost(String proxyAuthNtHost)
      Deprecated.
      Proxy authentication domain (workstation name) to use with NTLM. The option is a: java.lang.String type. Group: proxy
      Parameters:
      proxyAuthNtHost - the value to set
      Returns:
      the dsl builder

    • proxyAuthPassword

      default HttpEndpointBuilderFactory.HttpEndpointBuilder proxyAuthPassword(String proxyAuthPassword)
      Proxy server password. The option is a: java.lang.String type. Group: proxy
      Parameters:
      proxyAuthPassword - the value to set
      Returns:
      the dsl builder

    • proxyAuthPort

      @Deprecated default HttpEndpointBuilderFactory.HttpEndpointBuilder proxyAuthPort(int proxyAuthPort)
      Deprecated.
      Proxy server port. The option is a: int type. Group: proxy
      Parameters:
      proxyAuthPort - the value to set
      Returns:
      the dsl builder

    • proxyAuthPort

      @Deprecated default HttpEndpointBuilderFactory.HttpEndpointBuilder proxyAuthPort(String proxyAuthPort)
      Deprecated.
      Proxy server port. The option will be converted to a int type. Group: proxy
      Parameters:
      proxyAuthPort - the value to set
      Returns:
      the dsl builder

    • proxyAuthScheme

      default HttpEndpointBuilderFactory.HttpEndpointBuilder proxyAuthScheme(String proxyAuthScheme)
      Proxy server authentication protocol scheme to use. The option is a: java.lang.String type. Group: proxy
      Parameters:
      proxyAuthScheme - the value to set
      Returns:
      the dsl builder

    • proxyAuthUsername

      default HttpEndpointBuilderFactory.HttpEndpointBuilder proxyAuthUsername(String proxyAuthUsername)
      Proxy server username. The option is a: java.lang.String type. Group: proxy
      Parameters:
      proxyAuthUsername - the value to set
      Returns:
      the dsl builder

    • proxyHost

      default HttpEndpointBuilderFactory.HttpEndpointBuilder proxyHost(String proxyHost)
      Proxy server host. The option is a: java.lang.String type. Group: proxy
      Parameters:
      proxyHost - the value to set
      Returns:
      the dsl builder

    • proxyPort

      default HttpEndpointBuilderFactory.HttpEndpointBuilder proxyPort(int proxyPort)
      Proxy server port. The option is a: int type. Group: proxy
      Parameters:
      proxyPort - the value to set
      Returns:
      the dsl builder

    • proxyPort

      default HttpEndpointBuilderFactory.HttpEndpointBuilder proxyPort(String proxyPort)
      Proxy server port. The option will be converted to a int type. Group: proxy
      Parameters:
      proxyPort - the value to set
      Returns:
      the dsl builder

    • authBearerToken

      default HttpEndpointBuilderFactory.HttpEndpointBuilder authBearerToken(String authBearerToken)
      Authentication bearer token. The option is a: java.lang.String type. Group: security
      Parameters:
      authBearerToken - the value to set
      Returns:
      the dsl builder

    • authDomain

      @Deprecated default HttpEndpointBuilderFactory.HttpEndpointBuilder authDomain(String authDomain)
      Deprecated.
      Authentication domain to use with NTLM. The option is a: java.lang.String type. Group: security
      Parameters:
      authDomain - the value to set
      Returns:
      the dsl builder

    • authenticationPreemptive

      default HttpEndpointBuilderFactory.HttpEndpointBuilder authenticationPreemptive(boolean authenticationPreemptive)
      If this option is true, camel-http sends preemptive basic authentication to the server. The option is a: boolean type. Default: false Group: security
      Parameters:
      authenticationPreemptive - the value to set
      Returns:
      the dsl builder

    • authenticationPreemptive

      default HttpEndpointBuilderFactory.HttpEndpointBuilder authenticationPreemptive(String authenticationPreemptive)
      If this option is true, camel-http sends preemptive basic authentication to the server. The option will be converted to a boolean type. Default: false Group: security
      Parameters:
      authenticationPreemptive - the value to set
      Returns:
      the dsl builder

    • authHost

      @Deprecated default HttpEndpointBuilderFactory.HttpEndpointBuilder authHost(String authHost)
      Deprecated.
      Authentication host to use with NTLM. The option is a: java.lang.String type. Group: security
      Parameters:
      authHost - the value to set
      Returns:
      the dsl builder

    • authMethod

      default HttpEndpointBuilderFactory.HttpEndpointBuilder authMethod(String authMethod)
      Authentication methods allowed to use as a comma separated list of values Basic, Bearer, or NTLM. (NTLM is deprecated). The option is a: java.lang.String type. Group: security
      Parameters:
      authMethod - the value to set
      Returns:
      the dsl builder

    • authPassword

      default HttpEndpointBuilderFactory.HttpEndpointBuilder authPassword(String authPassword)
      Authentication password. The option is a: java.lang.String type. Group: security
      Parameters:
      authPassword - the value to set
      Returns:
      the dsl builder

    • authUsername

      default HttpEndpointBuilderFactory.HttpEndpointBuilder authUsername(String authUsername)
      Authentication username. The option is a: java.lang.String type. Group: security
      Parameters:
      authUsername - the value to set
      Returns:
      the dsl builder

    • oauth2BodyAuthentication

      default HttpEndpointBuilderFactory.HttpEndpointBuilder oauth2BodyAuthentication(boolean oauth2BodyAuthentication)
      Whether to use OAuth2 body authentication. The option is a: boolean type. Default: false Group: security
      Parameters:
      oauth2BodyAuthentication - the value to set
      Returns:
      the dsl builder

    • oauth2BodyAuthentication

      default HttpEndpointBuilderFactory.HttpEndpointBuilder oauth2BodyAuthentication(String oauth2BodyAuthentication)
      Whether to use OAuth2 body authentication. The option will be converted to a boolean type. Default: false Group: security
      Parameters:
      oauth2BodyAuthentication - the value to set
      Returns:
      the dsl builder

    • oauth2CachedTokensDefaultExpirySeconds

      default HttpEndpointBuilderFactory.HttpEndpointBuilder oauth2CachedTokensDefaultExpirySeconds(long oauth2CachedTokensDefaultExpirySeconds)
      Default expiration time for cached OAuth2 tokens, in seconds. Used if token response does not contain 'expires_in' field. The option is a: long type. Default: 3600 Group: security
      Parameters:
      oauth2CachedTokensDefaultExpirySeconds - the value to set
      Returns:
      the dsl builder

    • oauth2CachedTokensDefaultExpirySeconds

      default HttpEndpointBuilderFactory.HttpEndpointBuilder oauth2CachedTokensDefaultExpirySeconds(String oauth2CachedTokensDefaultExpirySeconds)
      Default expiration time for cached OAuth2 tokens, in seconds. Used if token response does not contain 'expires_in' field. The option will be converted to a long type. Default: 3600 Group: security
      Parameters:
      oauth2CachedTokensDefaultExpirySeconds - the value to set
      Returns:
      the dsl builder

    • oauth2CachedTokensExpirationMarginSeconds

      default HttpEndpointBuilderFactory.HttpEndpointBuilder oauth2CachedTokensExpirationMarginSeconds(long oauth2CachedTokensExpirationMarginSeconds)
      Amount of time which is deducted from OAuth2 tokens expiry time to compensate for the time it takes OAuth2 Token Endpoint to send the token over http, in seconds. Set this parameter to high value if you OAuth2 Token Endpoint answers slowly or you tokens expire quickly. If you set this parameter to too small value, you can get 4xx http errors because camel will think that the received token is still valid, while in reality the token is expired for the Authentication server. The option is a: long type. Default: 5 Group: security
      Parameters:
      oauth2CachedTokensExpirationMarginSeconds - the value to set
      Returns:
      the dsl builder

    • oauth2CachedTokensExpirationMarginSeconds

      default HttpEndpointBuilderFactory.HttpEndpointBuilder oauth2CachedTokensExpirationMarginSeconds(String oauth2CachedTokensExpirationMarginSeconds)
      Amount of time which is deducted from OAuth2 tokens expiry time to compensate for the time it takes OAuth2 Token Endpoint to send the token over http, in seconds. Set this parameter to high value if you OAuth2 Token Endpoint answers slowly or you tokens expire quickly. If you set this parameter to too small value, you can get 4xx http errors because camel will think that the received token is still valid, while in reality the token is expired for the Authentication server. The option will be converted to a long type. Default: 5 Group: security
      Parameters:
      oauth2CachedTokensExpirationMarginSeconds - the value to set
      Returns:
      the dsl builder

    • oauth2CacheTokens

      default HttpEndpointBuilderFactory.HttpEndpointBuilder oauth2CacheTokens(boolean oauth2CacheTokens)
      Whether to cache OAuth2 client tokens. The option is a: boolean type. Default: false Group: security
      Parameters:
      oauth2CacheTokens - the value to set
      Returns:
      the dsl builder

    • oauth2CacheTokens

      default HttpEndpointBuilderFactory.HttpEndpointBuilder oauth2CacheTokens(String oauth2CacheTokens)
      Whether to cache OAuth2 client tokens. The option will be converted to a boolean type. Default: false Group: security
      Parameters:
      oauth2CacheTokens - the value to set
      Returns:
      the dsl builder

    • oauth2ClientId

      default HttpEndpointBuilderFactory.HttpEndpointBuilder oauth2ClientId(String oauth2ClientId)
      OAuth2 client id. The option is a: java.lang.String type. Group: security
      Parameters:
      oauth2ClientId - the value to set
      Returns:
      the dsl builder

    • oauth2ClientSecret

      default HttpEndpointBuilderFactory.HttpEndpointBuilder oauth2ClientSecret(String oauth2ClientSecret)
      OAuth2 client secret. The option is a: java.lang.String type. Group: security
      Parameters:
      oauth2ClientSecret - the value to set
      Returns:
      the dsl builder

    • oauth2ResourceIndicator

      default HttpEndpointBuilderFactory.HttpEndpointBuilder oauth2ResourceIndicator(String oauth2ResourceIndicator)
      OAuth2 Token endpoint. The option is a: java.lang.String type. Group: security
      Parameters:
      oauth2ResourceIndicator - the value to set
      Returns:
      the dsl builder

    • oauth2Scope

      default HttpEndpointBuilderFactory.HttpEndpointBuilder oauth2Scope(String oauth2Scope)
      OAuth2 scope. The option is a: java.lang.String type. Group: security
      Parameters:
      oauth2Scope - the value to set
      Returns:
      the dsl builder

    • oauth2TokenEndpoint

      default HttpEndpointBuilderFactory.HttpEndpointBuilder oauth2TokenEndpoint(String oauth2TokenEndpoint)
      OAuth2 Resource Indicator. The option is a: java.lang.String type. Group: security
      Parameters:
      oauth2TokenEndpoint - the value to set
      Returns:
      the dsl builder

    • sslContextParameters

      default HttpEndpointBuilderFactory.HttpEndpointBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
      To configure security using SSLContextParameters. Important: Only one instance of org.apache.camel.util.jsse.SSLContextParameters is supported per HttpComponent. If you need to use 2 or more different instances, you need to define a new HttpComponent per instance you need. The option is a: org.apache.camel.support.jsse.SSLContextParameters type. Group: security
      Parameters:
      sslContextParameters - the value to set
      Returns:
      the dsl builder

    • sslContextParameters

      default HttpEndpointBuilderFactory.HttpEndpointBuilder sslContextParameters(String sslContextParameters)
      To configure security using SSLContextParameters. Important: Only one instance of org.apache.camel.util.jsse.SSLContextParameters is supported per HttpComponent. If you need to use 2 or more different instances, you need to define a new HttpComponent per instance you need. The option will be converted to a org.apache.camel.support.jsse.SSLContextParameters type. Group: security
      Parameters:
      sslContextParameters - the value to set
      Returns:
      the dsl builder

    • x509HostnameVerifier

      default HttpEndpointBuilderFactory.HttpEndpointBuilder x509HostnameVerifier(HostnameVerifier x509HostnameVerifier)
      To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or NoopHostnameVerifier. The option is a: javax.net.ssl.HostnameVerifier type. Group: security
      Parameters:
      x509HostnameVerifier - the value to set
      Returns:
      the dsl builder

    • x509HostnameVerifier

      default HttpEndpointBuilderFactory.HttpEndpointBuilder x509HostnameVerifier(String x509HostnameVerifier)
      To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or NoopHostnameVerifier. The option will be converted to a javax.net.ssl.HostnameVerifier type. Group: security
      Parameters:
      x509HostnameVerifier - the value to set
      Returns:
      the dsl builder