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

Interface AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointBuilder
Enclosing interface:
AtmosphereWebsocketEndpointBuilderFactory
public static interface AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Advanced builder for endpoint consumers for the Atmosphere Websocket component.

  • Method Details

    • basic

      default AtmosphereWebsocketEndpointBuilderFactory.AtmosphereWebsocketEndpointConsumerBuilder basic()

    • headerFilterStrategy

      default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
      To use a custom HeaderFilterStrategy to filter header to and from Camel message. The option is a: org.apache.camel.spi.HeaderFilterStrategy type. Group: common (advanced)
      Parameters:
      headerFilterStrategy - the value to set
      Returns:
      the dsl builder

    • headerFilterStrategy

      default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder headerFilterStrategy(String headerFilterStrategy)
      To use a custom HeaderFilterStrategy to filter header to and from Camel message. The option will be converted to a org.apache.camel.spi.HeaderFilterStrategy type. Group: common (advanced)
      Parameters:
      headerFilterStrategy - the value to set
      Returns:
      the dsl builder

    • httpBinding

      default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder 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: org.apache.camel.http.common.HttpBinding type. Group: common (advanced)
      Parameters:
      httpBinding - the value to set
      Returns:
      the dsl builder

    • httpBinding

      default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder httpBinding(String httpBinding)
      To use a custom HttpBinding to control the mapping between Camel message and HttpClient. The option will be converted to a org.apache.camel.http.common.HttpBinding type. Group: common (advanced)
      Parameters:
      httpBinding - the value to set
      Returns:
      the dsl builder

    • attachmentMultipartBinding

      default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder attachmentMultipartBinding(boolean attachmentMultipartBinding)
      Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. The options attachmentMultipartBinding=true and disableStreamCache=false cannot work together. Remove disableStreamCache to use AttachmentMultipartBinding. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet's. The option is a: boolean type. Default: false Group: consumer (advanced)
      Parameters:
      attachmentMultipartBinding - the value to set
      Returns:
      the dsl builder

    • attachmentMultipartBinding

      default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder attachmentMultipartBinding(String attachmentMultipartBinding)
      Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. The options attachmentMultipartBinding=true and disableStreamCache=false cannot work together. Remove disableStreamCache to use AttachmentMultipartBinding. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet's. The option will be converted to a boolean type. Default: false Group: consumer (advanced)
      Parameters:
      attachmentMultipartBinding - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder 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 AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder 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

    • eagerCheckContentAvailable

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

    • eagerCheckContentAvailable

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

    • exceptionHandler

      default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder 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 AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder 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 AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder 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 AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder 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

    • fileNameExtWhitelist

      default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder fileNameExtWhitelist(String fileNameExtWhitelist)
      Whitelist of accepted filename extensions for accepting uploaded files. Multiple extensions can be separated by comma, such as txt,xml. The option is a: java.lang.String type. Group: consumer (advanced)
      Parameters:
      fileNameExtWhitelist - the value to set
      Returns:
      the dsl builder

    • mapHttpMessageBody

      default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder 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: boolean type. Default: true Group: consumer (advanced)
      Parameters:
      mapHttpMessageBody - the value to set
      Returns:
      the dsl builder

    • mapHttpMessageBody

      default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder 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 boolean type. Default: true Group: consumer (advanced)
      Parameters:
      mapHttpMessageBody - the value to set
      Returns:
      the dsl builder

    • mapHttpMessageFormUrlEncodedBody

      default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder 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: boolean type. Default: true Group: consumer (advanced)
      Parameters:
      mapHttpMessageFormUrlEncodedBody - the value to set
      Returns:
      the dsl builder

    • mapHttpMessageFormUrlEncodedBody

      default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder 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 boolean type. Default: true Group: consumer (advanced)
      Parameters:
      mapHttpMessageFormUrlEncodedBody - the value to set
      Returns:
      the dsl builder

    • mapHttpMessageHeaders

      default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder 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: boolean type. Default: true Group: consumer (advanced)
      Parameters:
      mapHttpMessageHeaders - the value to set
      Returns:
      the dsl builder

    • mapHttpMessageHeaders

      default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder 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 boolean type. Default: true Group: consumer (advanced)
      Parameters:
      mapHttpMessageHeaders - the value to set
      Returns:
      the dsl builder

    • optionsEnabled

      default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder optionsEnabled(boolean optionsEnabled)
      Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off. The option is a: boolean type. Default: false Group: consumer (advanced)
      Parameters:
      optionsEnabled - the value to set
      Returns:
      the dsl builder

    • optionsEnabled

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

    • traceEnabled

      default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder traceEnabled(boolean traceEnabled)
      Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off. The option is a: boolean type. Default: false Group: consumer (advanced)
      Parameters:
      traceEnabled - the value to set
      Returns:
      the dsl builder

    • traceEnabled

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