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

Interface PlatformHttpEndpointBuilderFactory.PlatformHttpEndpointBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
Enclosing interface:
PlatformHttpEndpointBuilderFactory
public static interface PlatformHttpEndpointBuilderFactory.PlatformHttpEndpointBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint for the Platform HTTP component.

  • Method Details

    • advanced

      default PlatformHttpEndpointBuilderFactory.AdvancedPlatformHttpEndpointBuilder advanced()

    • consumes

      default PlatformHttpEndpointBuilderFactory.PlatformHttpEndpointBuilder consumes(String consumes)
      The content type this endpoint accepts as an input, such as application/xml or application/json. null or */* mean no restriction. The option is a: java.lang.String type. Group: consumer
      Parameters:
      consumes - the value to set
      Returns:
      the dsl builder

    • cookieDomain

      default PlatformHttpEndpointBuilderFactory.PlatformHttpEndpointBuilder cookieDomain(String cookieDomain)
      Sets which server can receive cookies. The option is a: java.lang.String type. Group: consumer
      Parameters:
      cookieDomain - the value to set
      Returns:
      the dsl builder

    • cookieHttpOnly

      default PlatformHttpEndpointBuilderFactory.PlatformHttpEndpointBuilder cookieHttpOnly(boolean cookieHttpOnly)
      Sets whether to prevent client side scripts from accessing created cookies. The option is a: boolean type. Default: false Group: consumer
      Parameters:
      cookieHttpOnly - the value to set
      Returns:
      the dsl builder

    • cookieHttpOnly

      default PlatformHttpEndpointBuilderFactory.PlatformHttpEndpointBuilder cookieHttpOnly(String cookieHttpOnly)
      Sets whether to prevent client side scripts from accessing created cookies. The option will be converted to a boolean type. Default: false Group: consumer
      Parameters:
      cookieHttpOnly - the value to set
      Returns:
      the dsl builder

    • cookieMaxAge

      default PlatformHttpEndpointBuilderFactory.PlatformHttpEndpointBuilder cookieMaxAge(Long cookieMaxAge)
      Sets the maximum cookie age in seconds. The option is a: java.lang.Long type. Group: consumer
      Parameters:
      cookieMaxAge - the value to set
      Returns:
      the dsl builder

    • cookieMaxAge

      default PlatformHttpEndpointBuilderFactory.PlatformHttpEndpointBuilder cookieMaxAge(String cookieMaxAge)
      Sets the maximum cookie age in seconds. The option will be converted to a java.lang.Long type. Group: consumer
      Parameters:
      cookieMaxAge - the value to set
      Returns:
      the dsl builder

    • cookiePath

      default PlatformHttpEndpointBuilderFactory.PlatformHttpEndpointBuilder cookiePath(String cookiePath)
      Sets the URL path that must exist in the requested URL in order to send the Cookie. The option is a: java.lang.String type. Default: / Group: consumer
      Parameters:
      cookiePath - the value to set
      Returns:
      the dsl builder

    • cookieSameSite

      default PlatformHttpEndpointBuilderFactory.PlatformHttpEndpointBuilder cookieSameSite(org.apache.camel.component.platform.http.cookie.CookieConfiguration.CookieSameSite cookieSameSite)
      Sets whether to prevent the browser from sending cookies along with cross-site requests. The option is a: org.apache.camel.component.platform.http.cookie.CookieConfiguration.CookieSameSite type. Default: Lax Group: consumer
      Parameters:
      cookieSameSite - the value to set
      Returns:
      the dsl builder

    • cookieSameSite

      default PlatformHttpEndpointBuilderFactory.PlatformHttpEndpointBuilder cookieSameSite(String cookieSameSite)
      Sets whether to prevent the browser from sending cookies along with cross-site requests. The option will be converted to a org.apache.camel.component.platform.http.cookie.CookieConfiguration.CookieSameSite type. Default: Lax Group: consumer
      Parameters:
      cookieSameSite - the value to set
      Returns:
      the dsl builder

    • cookieSecure

      default PlatformHttpEndpointBuilderFactory.PlatformHttpEndpointBuilder cookieSecure(boolean cookieSecure)
      Sets whether the cookie is only sent to the server with an encrypted request over HTTPS. The option is a: boolean type. Default: false Group: consumer
      Parameters:
      cookieSecure - the value to set
      Returns:
      the dsl builder

    • cookieSecure

      default PlatformHttpEndpointBuilderFactory.PlatformHttpEndpointBuilder cookieSecure(String cookieSecure)
      Sets whether the cookie is only sent to the server with an encrypted request over HTTPS. The option will be converted to a boolean type. Default: false Group: consumer
      Parameters:
      cookieSecure - the value to set
      Returns:
      the dsl builder

    • httpMethodRestrict

      default PlatformHttpEndpointBuilderFactory.PlatformHttpEndpointBuilder httpMethodRestrict(String httpMethodRestrict)
      A comma separated list of HTTP methods to serve, e.g. GET,POST . If no methods are specified, all methods will be served. The option is a: java.lang.String type. Group: consumer
      Parameters:
      httpMethodRestrict - the value to set
      Returns:
      the dsl builder

    • matchOnUriPrefix

      default PlatformHttpEndpointBuilderFactory.PlatformHttpEndpointBuilder 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: boolean type. Default: false Group: consumer
      Parameters:
      matchOnUriPrefix - the value to set
      Returns:
      the dsl builder

    • matchOnUriPrefix

      default PlatformHttpEndpointBuilderFactory.PlatformHttpEndpointBuilder 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 boolean type. Default: false Group: consumer
      Parameters:
      matchOnUriPrefix - the value to set
      Returns:
      the dsl builder

    • muteException

      default PlatformHttpEndpointBuilderFactory.PlatformHttpEndpointBuilder 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: boolean type. Default: true Group: consumer
      Parameters:
      muteException - the value to set
      Returns:
      the dsl builder

    • muteException

      default PlatformHttpEndpointBuilderFactory.PlatformHttpEndpointBuilder 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 boolean type. Default: true Group: consumer
      Parameters:
      muteException - the value to set
      Returns:
      the dsl builder

    • produces

      default PlatformHttpEndpointBuilderFactory.PlatformHttpEndpointBuilder produces(String produces)
      The content type this endpoint produces, such as application/xml or application/json. The option is a: java.lang.String type. Group: consumer
      Parameters:
      produces - the value to set
      Returns:
      the dsl builder