org.apache.camel.builder.endpoint.dsl

Interface ElytronEndpointBuilderFactory.ElytronEndpointBuilder

All Superinterfaces:

ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder, ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder, org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

Enclosing interface:

ElytronEndpointBuilderFactory

public static interface ElytronEndpointBuilderFactory.ElytronEndpointBuilder
extends ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder, ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder

Builder for endpoint for the Elytron component.

Method Summary

Modifier and Type	Method and Description
default ElytronEndpointBuilderFactory.AdvancedElytronEndpointBuilder	advanced()
default ElytronEndpointBuilderFactory.ElytronEndpointBuilder	allowedRoles(String allowedRoles) List of allowed roles in String format.
default ElytronEndpointBuilderFactory.ElytronEndpointBuilder	securityConfiguration(Object securityConfiguration) OConfiguration used by UndertowSecurityProvider.
default ElytronEndpointBuilderFactory.ElytronEndpointBuilder	securityConfiguration(String securityConfiguration) OConfiguration used by UndertowSecurityProvider.
default ElytronEndpointBuilderFactory.ElytronEndpointBuilder	securityProvider(Object securityProvider) Security provider allows plug in the provider, which will be used to secure requests.
default ElytronEndpointBuilderFactory.ElytronEndpointBuilder	securityProvider(String securityProvider) Security provider allows plug in the provider, which will be used to secure requests.
default ElytronEndpointBuilderFactory.ElytronEndpointBuilder	sslContextParameters(Object sslContextParameters) To configure security using SSLContextParameters.
default ElytronEndpointBuilderFactory.ElytronEndpointBuilder	sslContextParameters(String sslContextParameters) To configure security using SSLContextParameters.
default ElytronEndpointBuilderFactory.ElytronEndpointBuilder	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.
default ElytronEndpointBuilderFactory.ElytronEndpointBuilder	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.

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder

accessLog, accessLog, bridgeErrorHandler, bridgeErrorHandler, fireWebSocketChannelEvents, fireWebSocketChannelEvents, httpMethodRestrict, matchOnUriPrefix, matchOnUriPrefix, muteException, muteException, optionsEnabled, optionsEnabled

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder

cookieHandler, cookieHandler, keepAlive, keepAlive, lazyStartProducer, lazyStartProducer, options, options, preserveHostHeader, preserveHostHeader, reuseAddresses, reuseAddresses, sendTimeout, sendTimeout, sendToAll, sendToAll, tcpNoDelay, tcpNoDelay, throwExceptionOnFailure, throwExceptionOnFailure, transferException, transferException

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve

Method Detail

advanced

default ElytronEndpointBuilderFactory.AdvancedElytronEndpointBuilder advanced()

Specified by:

advanced in interface ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder

Specified by:

advanced in interface ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder

useStreaming

default ElytronEndpointBuilderFactory.ElytronEndpointBuilder 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

Specified by:

useStreaming in interface ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder

Specified by:

useStreaming in interface ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder

useStreaming

default ElytronEndpointBuilderFactory.ElytronEndpointBuilder 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

Specified by:

useStreaming in interface ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder

Specified by:

useStreaming in interface ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder

allowedRoles

default ElytronEndpointBuilderFactory.ElytronEndpointBuilder allowedRoles(String allowedRoles)

List of allowed roles in String format. The option is a: java.lang.String type. Group: security

Specified by:

allowedRoles in interface ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder

Specified by:

allowedRoles in interface ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder

securityConfiguration

default ElytronEndpointBuilderFactory.ElytronEndpointBuilder 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

Specified by:

securityConfiguration in interface ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder

Specified by:

securityConfiguration in interface ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder

securityConfiguration

default ElytronEndpointBuilderFactory.ElytronEndpointBuilder 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

Specified by:

securityConfiguration in interface ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder

Specified by:

securityConfiguration in interface ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder

securityProvider

default ElytronEndpointBuilderFactory.ElytronEndpointBuilder 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

Specified by:

securityProvider in interface ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder

Specified by:

securityProvider in interface ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder

securityProvider

default ElytronEndpointBuilderFactory.ElytronEndpointBuilder 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

Specified by:

securityProvider in interface ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder

Specified by:

securityProvider in interface ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder

sslContextParameters

default ElytronEndpointBuilderFactory.ElytronEndpointBuilder sslContextParameters(Object sslContextParameters)

To configure security using SSLContextParameters. The option is a: org.apache.camel.support.jsse.SSLContextParameters type. Group: security

Specified by:

sslContextParameters in interface ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder

Specified by:

sslContextParameters in interface ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder

sslContextParameters

default ElytronEndpointBuilderFactory.ElytronEndpointBuilder sslContextParameters(String sslContextParameters)

To configure security using SSLContextParameters. The option will be converted to a org.apache.camel.support.jsse.SSLContextParameters type. Group: security

Specified by:

sslContextParameters in interface ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder

Specified by:

sslContextParameters in interface ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder