com.opendxl.streaming.client.builder

Class ChannelBuilder

java.lang.Object

com.opendxl.streaming.client.builder.ChannelBuilder

public class ChannelBuilder
extends java.lang.Object

ChannelBuilder implements a build pattern for Channel to ease constructing instances of it.

Constructor Summary

Constructors

Constructor and Description
ChannelBuilder(java.lang.String base, ChannelAuth auth, java.lang.String consumerGroup) Constructor for ChannelBuilder

Method Summary

Modifier and Type	Method and Description
Channel	build() Build a Channel object using the previously set parameters.
ChannelBuilder	withCertificateBundle(java.lang.String verifyCertBundle) Set the certificate bundle chain to be used at build() when creating Channel instance.
ChannelBuilder	withConsumerPathPrefix(java.lang.String consumerPathPrefix) Set the consumerPathPrefix value to be used at build() when creating Channel instance
ChannelBuilder	withExtraConfigs(java.util.Properties extraConfigs) Set the extraConfigs value to be used at build() when creating Channel instance
ChannelBuilder	withHttpProxy(HttpProxySettings httpProxySettings) Set the httpProxySettings to be used at build() when creating Channel instance
ChannelBuilder	withPathPrefix(java.lang.String pathPrefix) Set the path value to be used at build() when creating Channel instance
ChannelBuilder	withProducerPathPrefix(java.lang.String producerPathPrefix) Set the producerPathPrefix value to be used at build() when creating Channel instance
ChannelBuilder	withRetryOnFail(boolean retryOnFail) Set the retryOnFail value to be used at build() when creating Channel instance

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChannelBuilder

public ChannelBuilder(java.lang.String base,
                      ChannelAuth auth,
                      java.lang.String consumerGroup)

Constructor for ChannelBuilder

Its parameters are mandatory parameters to create a Channel instance.

Parameters:

base - base URL at which the streaming service resides. This base URL applies to both, consume and produce requests.

auth - Authentication object to use for channel requests.

consumerGroup - Consumer group to subscribe the channel consumer to

Method Detail

withPathPrefix

public ChannelBuilder withPathPrefix(java.lang.String pathPrefix)

Set the path value to be used at build() when creating Channel instance

Parameters:

pathPrefix - Path to append to streaming service requests. If pathPrefix is set, then it will take precedence over consumerPathPrefix and producerPathPrefix. This means that it is this pathPrefix the one to be appended to consume and produce requests while consumerPathPrefix and producerPathPrefix will be ignored.

Returns:

this ChannelBuilder instance

withConsumerPathPrefix

public ChannelBuilder withConsumerPathPrefix(java.lang.String consumerPathPrefix)

Set the consumerPathPrefix value to be used at build() when creating Channel instance

Parameters:

consumerPathPrefix - Path to append to consumer-related requests made to the streaming service. Note that if the pathPrefix parameter is set to a non-empty value, the pathPrefix value will be appended to consumer-related requests instead of the consumerPathPrefix value.

Returns:

this ChannelBuilder instance

withProducerPathPrefix

public ChannelBuilder withProducerPathPrefix(java.lang.String producerPathPrefix)

Set the producerPathPrefix value to be used at build() when creating Channel instance

Parameters:

producerPathPrefix - Path to append to producer-related requests made to the streaming service. Note that if the pathPrefix parameter is set to a non-empty value, the pathPrefix value will be appended to producer-related requests instead of the producerPathPrefix value.

Returns:

this ChannelBuilder

withRetryOnFail

public ChannelBuilder withRetryOnFail(boolean retryOnFail)

Set the retryOnFail value to be used at build() when creating Channel instance

Parameters:

retryOnFail - Whether or not the channel will automatically retry a call which failed due to a temporary error.

Returns:

this ChannelBuilder instance

withCertificateBundle

public ChannelBuilder withCertificateBundle(java.lang.String verifyCertBundle)

Set the certificate bundle chain to be used at build() when creating Channel instance.

Parameters:

verifyCertBundle - CA Bundle chain certificates. This string shall be either the certificates themselves or a path to a CA bundle file containing those certificates. The CA bundle is used to validate that the certificate of the authentication server being connected to was signed by a valid authority. If set to an empty string, the server certificate will not be validated.

Returns:

this ChannelBuilder instance

withExtraConfigs

public ChannelBuilder withExtraConfigs(java.util.Properties extraConfigs)

Set the extraConfigs value to be used at build() when creating Channel instance

Parameters:

extraConfigs - Dictionary of key/value pairs containing any custom configuration settings which should be sent to the streaming service when a consumer is created. Examples of key/value pairs are: ("auto.offset.reset", "latest"); ("request.timeout.ms", 30000) and ("session.timeout.ms", 10000).

Returns:

this ChannelBuilder instance

withHttpProxy

public ChannelBuilder withHttpProxy(HttpProxySettings httpProxySettings)

Set the httpProxySettings to be used at build() when creating Channel instance

Parameters:

httpProxySettings - contains http proxy hostname, port, username and password.

Returns:

this ChannelBuilder instance

build

public Channel build()
              throws TemporaryError

Build a Channel object using the previously set parameters.

Returns:

a Channel object which can consume records from subscribed topics and also produce records to topics specified in the ProducerRecords

Throws:

TemporaryError - if Channel http client request object failed to be created.