Interface UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder

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

    public static interface UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder
    extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint producers for the Undertow component.
    • Method Detail

      • useStreaming

        default UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder 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.UndertowEndpointProducerBuilder 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
      • lazyStartProducer

        default UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder lazyStartProducer​(boolean lazyStartProducer)
        Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: boolean type. Default: false Group: producer
      • lazyStartProducer

        default UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder lazyStartProducer​(String lazyStartProducer)
        Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option will be converted to a boolean type. Default: false Group: producer
      • options

        default UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder options​(String key,
                                                                                       Object value)
        Sets additional channel options. The options that can be used are defined in org.xnio.Options. To configure from endpoint uri, then prefix each option with option., such as option.close-abort=true&option.send-buffer=8192. The option is a: java.util.Map<java.lang.String, java.lang.Object> type. The option is multivalued, and you can use the options(String, Object) method to add a value (call the method multiple times to set more values). Group: producer
      • options

        default UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder options​(Map values)
        Sets additional channel options. The options that can be used are defined in org.xnio.Options. To configure from endpoint uri, then prefix each option with option., such as option.close-abort=true&option.send-buffer=8192. The option is a: java.util.Map<java.lang.String, java.lang.Object> type. The option is multivalued, and you can use the options(String, Object) method to add a value (call the method multiple times to set more values). Group: producer
      • preserveHostHeader

        default UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder preserveHostHeader​(boolean preserveHostHeader)
        If the option is true, UndertowProducer will set the Host header to the value contained in the current exchange Host header, useful in reverse proxy applications where you want the Host header received by the downstream server to reflect the URL called by the upstream client, this allows applications which use the Host header to generate accurate URL's for a proxied service. The option is a: boolean type. Default: true Group: producer
      • preserveHostHeader

        default UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder preserveHostHeader​(String preserveHostHeader)
        If the option is true, UndertowProducer will set the Host header to the value contained in the current exchange Host header, useful in reverse proxy applications where you want the Host header received by the downstream server to reflect the URL called by the upstream client, this allows applications which use the Host header to generate accurate URL's for a proxied service. The option will be converted to a boolean type. Default: true Group: producer
      • throwExceptionOnFailure

        default UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder 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: java.lang.Boolean type. Default: true Group: producer
      • throwExceptionOnFailure

        default UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder 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 java.lang.Boolean type. Default: true Group: producer
      • transferException

        default UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder transferException​(Boolean transferException)
        If enabled and an Exchange failed processing on the consumer side and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. The option is a: java.lang.Boolean type. Default: false Group: producer
      • transferException

        default UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder transferException​(String transferException)
        If enabled and an Exchange failed processing on the consumer side and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. The option will be converted to a java.lang.Boolean type. Default: false Group: producer
      • securityConfiguration

        default UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder 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.UndertowEndpointProducerBuilder 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.UndertowEndpointProducerBuilder 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.UndertowEndpointProducerBuilder 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
      • sendToAll

        default UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder sendToAll​(String sendToAll)
        To send to all websocket subscribers. Can be used to configure on endpoint level, instead of having to use the UndertowConstants.SEND_TO_ALL header on the message. The option will be converted to a java.lang.Boolean type. Group: websocket