Interface UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    UndertowEndpointBuilderFactory.UndertowEndpointBuilder
    Enclosing interface:
    UndertowEndpointBuilderFactory

    public static interface UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder
    extends org.apache.camel.builder.EndpointConsumerBuilder
    Builder for endpoint consumers for the Undertow component.
    • Method Detail

      • useStreaming

        default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder useStreaming​(boolean useStreaming)
        For HTTP endpoint: if true, text and binary messages will be wrapped as java.io.InputStream before they are passed to an Exchange; otherwise they will be passed as byte. For WebSocket endpoint: if true, text and binary messages will be wrapped as java.io.Reader and java.io.InputStream respectively before they are passed to an Exchange; otherwise they will be passed as String and byte respectively. The option is a: boolean type. Default: false Group: common
      • useStreaming

        default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder useStreaming​(String useStreaming)
        For HTTP endpoint: if true, text and binary messages will be wrapped as java.io.InputStream before they are passed to an Exchange; otherwise they will be passed as byte. For WebSocket endpoint: if true, text and binary messages will be wrapped as java.io.Reader and java.io.InputStream respectively before they are passed to an Exchange; otherwise they will be passed as String and byte respectively. The option will be converted to a boolean type. Default: false Group: common
      • bridgeErrorHandler

        default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder bridgeErrorHandler​(boolean bridgeErrorHandler)
        Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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
      • bridgeErrorHandler

        default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder bridgeErrorHandler​(String bridgeErrorHandler)
        Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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
      • matchOnUriPrefix

        default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder 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 java.lang.Boolean type. Default: false Group: consumer
      • muteException

        default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder 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: false Group: consumer
      • securityConfiguration

        default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder securityConfiguration​(Object securityConfiguration)
        OConfiguration used by UndertowSecurityProvider. Security configuration object for use from UndertowSecurityProvider. Configuration is UndertowSecurityProvider specific. Each provider decides whether accepts configuration. The option is a: java.lang.Object type. Group: security
      • securityConfiguration

        default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder securityConfiguration​(String securityConfiguration)
        OConfiguration used by UndertowSecurityProvider. Security configuration object for use from UndertowSecurityProvider. Configuration is UndertowSecurityProvider specific. Each provider decides whether accepts configuration. The option will be converted to a java.lang.Object type. Group: security
      • securityProvider

        default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder securityProvider​(Object securityProvider)
        Security provider allows plug in the provider, which will be used to secure requests. SPI approach could be used too (endpoint then finds security provider using SPI). The option is a: org.apache.camel.component.undertow.spi.UndertowSecurityProvider type. Group: security
      • securityProvider

        default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder securityProvider​(String securityProvider)
        Security provider allows plug in the provider, which will be used to secure requests. SPI approach could be used too (endpoint then finds security provider using SPI). The option will be converted to a org.apache.camel.component.undertow.spi.UndertowSecurityProvider type. Group: security
      • fireWebSocketChannelEvents

        default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder fireWebSocketChannelEvents​(boolean fireWebSocketChannelEvents)
        if true, the consumer will post notifications to the route when a new WebSocket peer connects, disconnects, etc. See UndertowConstants.EVENT_TYPE and EventType. The option is a: boolean type. Default: false Group: websocket
      • fireWebSocketChannelEvents

        default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder fireWebSocketChannelEvents​(String fireWebSocketChannelEvents)
        if true, the consumer will post notifications to the route when a new WebSocket peer connects, disconnects, etc. See UndertowConstants.EVENT_TYPE and EventType. The option will be converted to a boolean type. Default: false Group: websocket