EnvironmentBuilder (RabbitMQ Stream Java Client 0.2.0 API)

All Known Implementing Classes:

StreamEnvironmentBuilder
```
public interface EnvironmentBuilder
```
API to configure and create an Environment.

See Also:

EnvironmentBuilder

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface EnvironmentBuilder.TlsConfiguration
Helper to configure TLS.

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`EnvironmentBuilder.TlsConfiguration` Helper to configure TLS.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`EnvironmentBuilder`	`addressResolver(AddressResolver addressResolver)` An `AddressResolver` to potentially change resolved node address to connect to.
`Environment`	`build()` Create the `Environment` instance.
`EnvironmentBuilder`	`byteBufAllocator(io.netty.buffer.ByteBufAllocator byteBufAllocator)`
`EnvironmentBuilder`	`channelCustomizer(ChannelCustomizer channelCustomizer)` An extension point to customize Netty's `Channel`s used for connection.
`EnvironmentBuilder`	`chunkChecksum(ChunkChecksum chunkChecksum)` The checksum strategy used for chunk checksum.
`EnvironmentBuilder`	`clientProperties(Map<String,String> clientProperties)` Custom client properties to add to default client properties.
`EnvironmentBuilder`	`clientProperty(String key, String value)` Add a custom client properties to default client properties.
`EnvironmentBuilder`	`codec(Codec codec)` The AMQP 1.0 codec used to encode and decode AMQP 1.0 messages.
`EnvironmentBuilder`	`compressionCodecFactory(CompressionCodecFactory compressionCodecFactory)`
`EnvironmentBuilder`	`credentialsProvider(CredentialsProvider credentialsProvider)` The `CredentialsProvider` to use.
`EnvironmentBuilder`	`eventLoopGroup(io.netty.channel.EventLoopGroup eventLoopGroup)` The Netty `EventLoopGroup` instance to use.
`EnvironmentBuilder`	`host(String host)` The host to connect to.
`EnvironmentBuilder`	`lazyInitialization(boolean lazy)` To delay the connection opening until necessary.
`EnvironmentBuilder`	`maxConsumersByConnection(int maxConsumersByConnection)` The maximum number of consumers allocated to a single connection.
`EnvironmentBuilder`	`maxProducersByConnection(int maxProducersByConnection)` The maximum number of producers allocated to a single connection.
`EnvironmentBuilder`	`maxTrackingConsumersByConnection(int maxTrackingConsumersByConnection)` The maximum number of tracking consumers allocated to a single connection.
`EnvironmentBuilder`	`metricsCollector(MetricsCollector metricsCollector)` Set up a `MetricsCollector`.
`EnvironmentBuilder`	`password(String password)` The password to use.
`EnvironmentBuilder`	`port(int port)` The port to use to connect.
`EnvironmentBuilder`	`recoveryBackOffDelayPolicy(BackOffDelayPolicy recoveryBackOffDelayPolicy)` The `BackOffDelayPolicy` to use for connection recovery.
`EnvironmentBuilder`	`requestedHeartbeat(Duration requestedHeartbeat)` The hearbeat to request.
`EnvironmentBuilder`	`requestedMaxFrameSize(int requestedMaxFrameSize)` The maximum frame size to request.
`EnvironmentBuilder`	`rpcTimeout(Duration timeout)` Timeout for RPC calls.
`EnvironmentBuilder`	`saslConfiguration(SaslConfiguration saslConfiguration)` The SASL configuration to use.
`EnvironmentBuilder`	`scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)` Set the `ScheduledExecutorService` used to: Schedule producers batch sending Handle connection recovery Handle topology update
`EnvironmentBuilder.TlsConfiguration`	`tls()` Enable and configure TLS.
`EnvironmentBuilder`	`topologyUpdateBackOffDelayPolicy(BackOffDelayPolicy topologyUpdateBackOffDelayPolicy)` The `BackOffDelayPolicy` to use for topology recovery.
`EnvironmentBuilder`	`uri(String uri)` The URI of a node to connect to.
`EnvironmentBuilder`	`uris(List<String> uris)` A list of URIs of nodes of the same cluster to use to connect to.
`EnvironmentBuilder`	`username(String username)` The username to use.
`EnvironmentBuilder`	`virtualHost(String virtualHost)` The virtual host to connect to.

- Method Detail
  - uri
```
EnvironmentBuilder uri(String uri)
```
    The URI of a node to connect to.
    URI must be of the form rabbitmq-stream://guest:guest@localhost:5552/%2f.
    
    Parameters:
    
    uri -
    
    Returns:
    
    this builder instance
  - uris
```
EnvironmentBuilder uris(List<String> uris)
```
    A list of URIs of nodes of the same cluster to use to connect to.
    URIs must be of the form rabbitmq-stream://guest:guest@localhost:5552/%2f.
    
    Parameters:
    
    uris -
    
    Returns:
    
    this builder instance
  - addressResolver
```
EnvironmentBuilder addressResolver(AddressResolver addressResolver)
```
    An AddressResolver to potentially change resolved node address to connect to.
    Applications can use this abstraction to make sure connection attempts ignore metadata hints and always go to a single point like a load balancer.
    
    Parameters:
    
    addressResolver -
    
    Returns:
    
    this builder instance
  - host
```
EnvironmentBuilder host(String host)
```
    The host to connect to.
    
    Parameters:
    
    host -
    
    Returns:
    
    this builder instance
  - port
```
EnvironmentBuilder port(int port)
```
    The port to use to connect.
    
    Parameters:
    
    port -
    
    Returns:
    
    this builder instance
  - codec
```
EnvironmentBuilder codec(Codec codec)
```
    The AMQP 1.0 codec used to encode and decode AMQP 1.0 messages.
    
    Parameters:
    
    codec -
    
    Returns:
    
    this builder instance
  - eventLoopGroup
```
EnvironmentBuilder eventLoopGroup(io.netty.channel.EventLoopGroup eventLoopGroup)
```
    The Netty EventLoopGroup instance to use.
    The environment uses its own instance by default. It is the developer's responsibility to close the EventLoopGroup they provide.
    
    Parameters:
    
    eventLoopGroup -
    
    Returns:
    
    this builder instance
  - byteBufAllocator
```
EnvironmentBuilder byteBufAllocator(io.netty.buffer.ByteBufAllocator byteBufAllocator)
```
  - compressionCodecFactory
```
EnvironmentBuilder compressionCodecFactory(CompressionCodecFactory compressionCodecFactory)
```
  - rpcTimeout
```
EnvironmentBuilder rpcTimeout(Duration timeout)
```
    Timeout for RPC calls.
    Default is 10 seconds.
    
    Parameters:
    
    timeout -
    
    Returns:
    
    this builder instance
  - saslConfiguration
```
EnvironmentBuilder saslConfiguration(SaslConfiguration saslConfiguration)
```
    The SASL configuration to use.
    
    Parameters:
    
    saslConfiguration -
    
    Returns:
    
    this builder instance
    
    See Also:
    
    credentialsProvider(CredentialsProvider)
  - credentialsProvider
```
EnvironmentBuilder credentialsProvider(CredentialsProvider credentialsProvider)
```
    The CredentialsProvider to use.
    
    Parameters:
    
    credentialsProvider -
    
    Returns:
    
    this builder instance
    
    See Also:
    
    saslConfiguration(SaslConfiguration)
  - username
```
EnvironmentBuilder username(String username)
```
    The username to use.
    
    Parameters:
    
    username -
    
    Returns:
    
    this builder instance
  - password
```
EnvironmentBuilder password(String password)
```
    The password to use.
    
    Parameters:
    
    password -
    
    Returns:
    
    this builder instance
  - virtualHost
```
EnvironmentBuilder virtualHost(String virtualHost)
```
    The virtual host to connect to.
    
    Parameters:
    
    virtualHost -
    
    Returns:
    
    this builder instance
  - requestedHeartbeat
```
EnvironmentBuilder requestedHeartbeat(Duration requestedHeartbeat)
```
    The hearbeat to request.
    Default is 60 seconds.
    
    Parameters:
    
    requestedHeartbeat -
    
    Returns:
    
    this builder instance
  - requestedMaxFrameSize
```
EnvironmentBuilder requestedMaxFrameSize(int requestedMaxFrameSize)
```
    The maximum frame size to request.
    Default is 1048576.
    
    Parameters:
    
    requestedMaxFrameSize -
    
    Returns:
    
    this builder instance
  - channelCustomizer
```
EnvironmentBuilder channelCustomizer(ChannelCustomizer channelCustomizer)
```
    An extension point to customize Netty's Channels used for connection.
    
    Parameters:
    
    channelCustomizer -
    
    Returns:
    
    this builder instance
  - chunkChecksum
```
EnvironmentBuilder chunkChecksum(ChunkChecksum chunkChecksum)
```
    The checksum strategy used for chunk checksum.
    The default is CRC32 based on JDK implementation.
    
    Parameters:
    
    chunkChecksum -
    
    Returns:
    
    this builder instance
  - clientProperties
```
EnvironmentBuilder clientProperties(Map<String,String> clientProperties)
```
    Custom client properties to add to default client properties.
    
    Parameters:
    
    clientProperties -
    
    Returns:
    
    this builder instance
  - clientProperty
```
EnvironmentBuilder clientProperty(String key,
                                  String value)
```
    Add a custom client properties to default client properties.
    
    Parameters:
    
    key -
    
    value -
    
    Returns:
    
    this builder instance
  - metricsCollector
```
EnvironmentBuilder metricsCollector(MetricsCollector metricsCollector)
```
    Set up a MetricsCollector.
    
    Parameters:
    
    metricsCollector -
    
    Returns:
    
    this builder instance
  - maxProducersByConnection
```
EnvironmentBuilder maxProducersByConnection(int maxProducersByConnection)
```
    The maximum number of producers allocated to a single connection.
    Default is 256, which is the maximum value.
    
    Parameters:
    
    maxProducersByConnection -
    
    Returns:
    
    this builder instance
  - maxTrackingConsumersByConnection
```
EnvironmentBuilder maxTrackingConsumersByConnection(int maxTrackingConsumersByConnection)
```
    The maximum number of tracking consumers allocated to a single connection.
    Default is 50, which is the maximum value.
    
    Parameters:
    
    maxTrackingConsumersByConnection -
    
    Returns:
    
    this builder instance
  - maxConsumersByConnection
```
EnvironmentBuilder maxConsumersByConnection(int maxConsumersByConnection)
```
    The maximum number of consumers allocated to a single connection.
    Default is 256, which is the maximum value.
    
    Parameters:
    
    maxConsumersByConnection -
    
    Returns:
    
    this builder instance
  - scheduledExecutorService
```
EnvironmentBuilder scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)
```
    Set the ScheduledExecutorService used to:
    - Schedule producers batch sending
    - Handle connection recovery
    - Handle topology update
    Parameters:
    
    scheduledExecutorService - the service to use
    
    Returns:
    
    this builder instance
  - recoveryBackOffDelayPolicy
```
EnvironmentBuilder recoveryBackOffDelayPolicy(BackOffDelayPolicy recoveryBackOffDelayPolicy)
```
    The BackOffDelayPolicy to use for connection recovery.
    The default is a fixed delay of 5 seconds.
    
    Parameters:
    
    recoveryBackOffDelayPolicy -
    
    Returns:
    
    this builder instance
  - topologyUpdateBackOffDelayPolicy
```
EnvironmentBuilder topologyUpdateBackOffDelayPolicy(BackOffDelayPolicy topologyUpdateBackOffDelayPolicy)
```
    The BackOffDelayPolicy to use for topology recovery.
    Topology recovery can kick in when streams leaders and replicas move from nodes to nodes in the cluster.
    The default is a fixed delay of 5 seconds.
    
    Parameters:
    
    topologyUpdateBackOffDelayPolicy -
    
    Returns:
    
    this builder instance
  - lazyInitialization
```
EnvironmentBuilder lazyInitialization(boolean lazy)
```
    To delay the connection opening until necessary.
    No connection will be open before it is necessary (for stream management or producer/consumer creation).
    Default is false.
    
    Parameters:
    
    lazy -
    
    Returns:
    
    this builder instance
  - build
```
Environment build()
```
    Create the Environment instance.
    
    Returns:
    
    the configured environment
  - tls
```
EnvironmentBuilder.TlsConfiguration tls()
```
    Enable and configure TLS.
    
    Returns:
    
    the TLS configuration helper

Interface EnvironmentBuilder

Nested Class Summary

Method Summary

Method Detail

uri

uris

addressResolver

host

port

codec

eventLoopGroup

byteBufAllocator

compressionCodecFactory

rpcTimeout

saslConfiguration

credentialsProvider

username

password

virtualHost

requestedHeartbeat

requestedMaxFrameSize

channelCustomizer

chunkChecksum

clientProperties

clientProperty

metricsCollector

maxProducersByConnection

maxTrackingConsumersByConnection

maxConsumersByConnection

scheduledExecutorService

recoveryBackOffDelayPolicy

topologyUpdateBackOffDelayPolicy

lazyInitialization

build

tls