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

Interface RestOpenApiEndpointBuilderFactory.AdvancedRestOpenApiEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
RestOpenApiEndpointBuilderFactory.AdvancedRestOpenApiEndpointBuilder
Enclosing interface:
RestOpenApiEndpointBuilderFactory
public static interface RestOpenApiEndpointBuilderFactory.AdvancedRestOpenApiEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Advanced builder for endpoint consumers for the REST OpenApi component.

  • Method Details

    • basic

      default RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointConsumerBuilder basic()

    • bridgeErrorHandler

      default RestOpenApiEndpointBuilderFactory.AdvancedRestOpenApiEndpointConsumerBuilder 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: boolean type. Default: false Group: consumer (advanced)
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default RestOpenApiEndpointBuilderFactory.AdvancedRestOpenApiEndpointConsumerBuilder 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 boolean type. Default: false Group: consumer (advanced)
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • consumerComponentName

      default RestOpenApiEndpointBuilderFactory.AdvancedRestOpenApiEndpointConsumerBuilder consumerComponentName(String consumerComponentName)
      Name of the Camel component that will service the requests. The component must be present in Camel registry and it must implement RestOpenApiConsumerFactory service provider interface. If not set CLASSPATH is searched for single component that implements RestOpenApiConsumerFactory SPI. Overrides component configuration. The option is a: java.lang.String type. Group: consumer (advanced)
      Parameters:
      consumerComponentName - the value to set
      Returns:
      the dsl builder

    • exceptionHandler

      default RestOpenApiEndpointBuilderFactory.AdvancedRestOpenApiEndpointConsumerBuilder 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: org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
      Parameters:
      exceptionHandler - the value to set
      Returns:
      the dsl builder

    • exceptionHandler

      default RestOpenApiEndpointBuilderFactory.AdvancedRestOpenApiEndpointConsumerBuilder 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 org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
      Parameters:
      exceptionHandler - the value to set
      Returns:
      the dsl builder

    • exchangePattern

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

    • exchangePattern

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

    • mockIncludePattern

      default RestOpenApiEndpointBuilderFactory.AdvancedRestOpenApiEndpointConsumerBuilder mockIncludePattern(String mockIncludePattern)
      Used for inclusive filtering of mock data from directories. The pattern is using Ant-path style pattern. Multiple patterns can be specified separated by comma. The option is a: java.lang.String type. Default: classpath:camel-mock/** Group: consumer (advanced)
      Parameters:
      mockIncludePattern - the value to set
      Returns:
      the dsl builder

    • restOpenapiProcessorStrategy

      default RestOpenApiEndpointBuilderFactory.AdvancedRestOpenApiEndpointConsumerBuilder restOpenapiProcessorStrategy(org.apache.camel.component.rest.openapi.RestOpenapiProcessorStrategy restOpenapiProcessorStrategy)
      To use a custom strategy for how to process Rest DSL requests. The option is a: org.apache.camel.component.rest.openapi.RestOpenapiProcessorStrategy type. Group: consumer (advanced)
      Parameters:
      restOpenapiProcessorStrategy - the value to set
      Returns:
      the dsl builder

    • restOpenapiProcessorStrategy

      default RestOpenApiEndpointBuilderFactory.AdvancedRestOpenApiEndpointConsumerBuilder restOpenapiProcessorStrategy(String restOpenapiProcessorStrategy)
      To use a custom strategy for how to process Rest DSL requests. The option will be converted to a org.apache.camel.component.rest.openapi.RestOpenapiProcessorStrategy type. Group: consumer (advanced)
      Parameters:
      restOpenapiProcessorStrategy - the value to set
      Returns:
      the dsl builder