com.opendxl.streaming.client.builder

Class ProducerBuilder

java.lang.Object

com.opendxl.streaming.client.builder.ProducerBuilder

public class ProducerBuilder
extends java.lang.Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Producer	build() Build a Channel object using the previously set parameters and expose it as a Producer object.
ProducerBuilder	withCertificateBundle(java.lang.String verifyCertBundle) Set the certificate bundle chain to be used at build() when creating Producer instance
ProducerBuilder	withHttpProxy(HttpProxySettings httpProxySettings) Set the httpProxySettings to be used at build() when creating Producer instance
ProducerBuilder	withProducerPathPrefix(java.lang.String producerPathPrefix) Set the producerPathPrefix to be used at build() when creating Producer instance

Methods inherited from class java.lang.Object

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

Constructor Detail

ProducerBuilder

public ProducerBuilder(java.lang.String base,
                       ChannelAuth auth)

Constructor for ProducerBuilder

Parameters:

base - base URL at which the streaming service resides.

auth - Authentication object to use for channel requests.

Method Detail

withProducerPathPrefix

public ProducerBuilder withProducerPathPrefix(java.lang.String producerPathPrefix)

Set the producerPathPrefix to be used at build() when creating Producer 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 ProducerBuilder instance

withCertificateBundle

public ProducerBuilder withCertificateBundle(java.lang.String verifyCertBundle)

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

withHttpProxy

public ProducerBuilder withHttpProxy(HttpProxySettings httpProxySettings)

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

Parameters:

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

Returns:

this ProducerBuilder instance

build

public Producer build()
               throws TemporaryError

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

Returns:

a Producer object which only exposes the Channel.produce(ProducerRecords), Channel.produce(String) and Channel.close() methods

Throws:

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