com.opendxl.streaming.client.builder

Class ConsumerBuilder

java.lang.Object

com.opendxl.streaming.client.builder.ConsumerBuilder

public class ConsumerBuilder
extends java.lang.Object

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsumerBuilder

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

Constructor for ConsumerBuilder

Parameters:

base - base URL at which the streaming service resides.

auth - Authentication object to use for channel requests.

consumerGroup - Consumer group to subscribe the channel consumer to

Method Detail

withConsumerPathPrefix

public ConsumerBuilder withConsumerPathPrefix(java.lang.String consumerPathPrefix)

Set the consumerPathPrefix value to be used at build() when creating Consumer 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 ConsumerBuilder instance

withRetryOnFail

public ConsumerBuilder withRetryOnFail(boolean retryOnFail)

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

Parameters:

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

Returns:

this ConsumerBuilder instance

withCertificateBundle

public ConsumerBuilder withCertificateBundle(java.lang.String verifyCertBundle)

Set the certificate bundle chain to be used at build() when creating Consumer 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 ConsumerBuilder instance

withExtraConfigs

public ConsumerBuilder withExtraConfigs(java.util.Properties extraConfigs)

Set the extraConfigs value to be used at build() when creating Consumer 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 ConsumerBuilder instance

withHttpProxy

public ConsumerBuilder withHttpProxy(HttpProxySettings httpProxySettings)

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

Parameters:

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

Returns:

this ConsumerBuilder instance

build

public Consumer build()
               throws TemporaryError

Build a Channel object using the previously set parameters and expose it as a Consumer object.

Returns:

a Consumer object which only exposes the Channel consume related methods, e.g.: Channel.create(), Channel.subscribe(List), Channel.subscriptions(), Channel.consume(), Channel.commit(), Channel.run(ConsumerRecordProcessor, List, int), Channel.delete(), Channel.stop() and Channel.close()

Throws:

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