A B C D E F G H I L M O P R S T V W

A

add(ProducerRecords.ProducerRecord) - Method in class com.opendxl.streaming.client.entity.ProducerRecords

Add a ProducerRecords.ProducerRecord object to the ProducerRecords internal list

authenticate(HttpRequest) - Method in class com.opendxl.streaming.client.auth.ChannelAuthToken

Adds the http header with the Authorization token to the given http request

authenticate(HttpRequest) - Method in class com.opendxl.streaming.client.auth.ChannelAuthUserPass

Adds the http header with the Authorization token to the given http request

authenticate(HttpRequest) - Method in interface com.opendxl.streaming.client.ChannelAuth

Adds the http header with the Authorization token to the given http request

B

build() - Method in class com.opendxl.streaming.client.builder.ChannelBuilder

Build a Channel object using the previously set parameters.

build() - Method in class com.opendxl.streaming.client.builder.ConsumerBuilder

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

build() - Method in class com.opendxl.streaming.client.builder.ProducerBuilder

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

build() - Method in class com.opendxl.streaming.client.entity.ProducerRecords.ProducerRecord.Builder

Create a brand new ProducerRecords.ProducerRecord object which attributes are set to the values given for ProducerRecords.ProducerRecord.Builder.topic, ProducerRecords.ProducerRecord.Builder.base64EncodedPayload, ProducerRecords.ProducerRecord.Builder.shardingKey and ProducerRecords.ProducerRecord.Builder.headers

Builder(String, String) - Constructor for class com.opendxl.streaming.client.entity.ProducerRecords.ProducerRecord.Builder

ProducerRecords.ProducerRecord.Builder constructor asks for the ProducerRecords.ProducerRecord mandatory attributes which are topic and payload.

C

Channel - Class in com.opendxl.streaming.client

The Channel class is responsible for all communication with the streaming service.

Channel(String, ChannelAuth, String, String, String, boolean, String, Properties, HttpProxySettings) - Constructor for class com.opendxl.streaming.client.Channel

Channel(String, ChannelAuth, String, String, String, String, boolean, String, Properties, HttpProxySettings) - Constructor for class com.opendxl.streaming.client.Channel

ChannelAuth - Interface in com.opendxl.streaming.client

Interface to be implemented by Authentication classes responsible for adding the Authorization header to channel requests.

ChannelAuthToken - Class in com.opendxl.streaming.client.auth

Authentication class where a given fixed token is used in Authorization headers of channel requests.

ChannelAuthToken(String) - Constructor for class com.opendxl.streaming.client.auth.ChannelAuthToken

ChannelAuthUserPass - Class in com.opendxl.streaming.client.auth

Authentication class where a token is retrieved from a base URL for the given user and password and such token is later used in Authorization headers of channel requests.

ChannelAuthUserPass(String, String, String, String, String, HttpProxySettings) - Constructor for class com.opendxl.streaming.client.auth.ChannelAuthUserPass

ChannelBuilder - Class in com.opendxl.streaming.client.builder

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

ChannelBuilder(String, ChannelAuth, String) - Constructor for class com.opendxl.streaming.client.builder.ChannelBuilder

Constructor for ChannelBuilder

ClientError - Exception in com.opendxl.streaming.client.exception

ClientError(String, Throwable) - Constructor for exception com.opendxl.streaming.client.exception.ClientError

CliUtils - Class in com.opendxl.streaming.cli

Facilities for command line options

close() - Method in class com.opendxl.streaming.client.Channel

Closes the channel.

close() - Method in interface com.opendxl.streaming.client.Consumer

Closes the channel.

close() - Method in class com.opendxl.streaming.client.HttpConnection

Closes the request object and its supporting HttpClient.

close() - Method in interface com.opendxl.streaming.client.Producer

Closes the Producer channel.

close() - Method in class com.opendxl.streaming.client.Request

Closes the request object and its supporting HttpConnection.

com.opendxl.streaming.cli - package com.opendxl.streaming.cli

com.opendxl.streaming.cli.entity - package com.opendxl.streaming.cli.entity

com.opendxl.streaming.cli.operation - package com.opendxl.streaming.cli.operation

com.opendxl.streaming.client - package com.opendxl.streaming.client

com.opendxl.streaming.client.auth - package com.opendxl.streaming.client.auth

com.opendxl.streaming.client.builder - package com.opendxl.streaming.client.builder

com.opendxl.streaming.client.entity - package com.opendxl.streaming.client.entity

com.opendxl.streaming.client.exception - package com.opendxl.streaming.client.exception

CommandLineInterface - Class in com.opendxl.streaming.cli

Main class for the OpenDXL Streaming Java Client CLI.

CommandLineInterface(String[]) - Constructor for class com.opendxl.streaming.cli.CommandLineInterface

Constructor

CommandLineOperation - Interface in com.opendxl.streaming.cli.operation

Interface for all --operation arguments

commit() - Method in class com.opendxl.streaming.client.Channel

Commits the record offsets to the channel.

commit() - Method in interface com.opendxl.streaming.client.Consumer

Commits the record offsets to the channel.

CommitOperation - Class in com.opendxl.streaming.cli.operation

It represents the "commit" argument for a --operation option

CommitOperation(Map<Options, ArgumentAcceptingOptionSpec<String>>, OptionSet) - Constructor for class com.opendxl.streaming.cli.operation.CommitOperation

Constructor

configToMap(String) - Static method in class com.opendxl.streaming.cli.CliUtils

Get properties from comma-separated config String

consume() - Method in class com.opendxl.streaming.client.Channel

Consumes records from all the subscribed topics

consume(int) - Method in class com.opendxl.streaming.client.Channel

Consumes records from all the subscribed topics

consume() - Method in interface com.opendxl.streaming.client.Consumer

Consumes records from all the subscribed topics

consume(int) - Method in interface com.opendxl.streaming.client.Consumer

Consumes records from all the subscribed topics

ConsumeOperation - Class in com.opendxl.streaming.cli.operation

It represents a --consume operation command line

ConsumeOperation(Map<Options, ArgumentAcceptingOptionSpec<String>>, OptionSet) - Constructor for class com.opendxl.streaming.cli.operation.ConsumeOperation

Constructor

Consumer - Interface in com.opendxl.streaming.client

The Consumer interface only exposes the Channel methods to consume records.

ConsumerBuilder - Class in com.opendxl.streaming.client.builder

ConsumerBuilder(String, ChannelAuth, String) - Constructor for class com.opendxl.streaming.client.builder.ConsumerBuilder

Constructor for ConsumerBuilder

ConsumerError - Exception in com.opendxl.streaming.client.exception

Error raised when a channel operation fails due to the associated consumer not being recognized by the streaming service.

ConsumerError(String, Throwable, int, HttpRequest) - Constructor for exception com.opendxl.streaming.client.exception.ConsumerError

ConsumerError(String, int, HttpRequest) - Constructor for exception com.opendxl.streaming.client.exception.ConsumerError

ConsumerError(String, Throwable) - Constructor for exception com.opendxl.streaming.client.exception.ConsumerError

ConsumerError(String) - Constructor for exception com.opendxl.streaming.client.exception.ConsumerError

ConsumerRecord() - Constructor for class com.opendxl.streaming.client.entity.ConsumerRecords.ConsumerRecord

ConsumerRecordMessage() - Constructor for class com.opendxl.streaming.client.entity.ConsumerRecords.ConsumerRecordMessage

ConsumerRecordProcessor - Interface in com.opendxl.streaming.client

ConsumerRecordProcessor is an interface that must be implemented by the process which receives the consumed records.

ConsumerRecordRoutingData() - Constructor for class com.opendxl.streaming.client.entity.ConsumerRecords.ConsumerRecordRoutingData

ConsumerRecords - Class in com.opendxl.streaming.client.entity

Helper class use to deserialize the ConsumerService responses of consume() requests.

ConsumerRecords() - Constructor for class com.opendxl.streaming.client.entity.ConsumerRecords

ConsumerRecords.ConsumerRecord - Class in com.opendxl.streaming.client.entity

Helper class containing all attributes of a consumed record.

ConsumerRecords.ConsumerRecordMessage - Class in com.opendxl.streaming.client.entity

Headers and payload of the consumed record.

ConsumerRecords.ConsumerRecordRoutingData - Class in com.opendxl.streaming.client.entity

Topic name and sharding key of the consumed record.

ConsumerServiceError - Class in com.opendxl.streaming.client.entity

ConsumerServiceError is a helper class used to parse the JSON object returned by Consumer Service when an error has occurred.

ConsumerServiceError(String) - Constructor for class com.opendxl.streaming.client.entity.ConsumerServiceError

create() - Method in class com.opendxl.streaming.client.Channel

Creates a new consumer on the consumer group

create() - Method in interface com.opendxl.streaming.client.Consumer

Creates a new consumer on the consumer group specified by ConsumerBuilder.ConsumerBuilder(String, ChannelAuth, String)} at construction time.

CreateOperation - Class in com.opendxl.streaming.cli.operation

This class represents the "create" argument for a --operation option

CreateOperation(Map<Options, ArgumentAcceptingOptionSpec<String>>, OptionSet) - Constructor for class com.opendxl.streaming.cli.operation.CreateOperation

Constructor

D

delete() - Method in class com.opendxl.streaming.client.Channel

Deletes the consumer from the consumer group

delete() - Method in interface com.opendxl.streaming.client.Consumer

Deletes the consumer from the consumer group

delete(String, Map<Integer, ErrorType>) - Method in class com.opendxl.streaming.client.Request

Send a DELETE request

DeleteOperation - Class in com.opendxl.streaming.cli.operation

DeleteOperation(Map<Options, ArgumentAcceptingOptionSpec<String>>, OptionSet) - Constructor for class com.opendxl.streaming.cli.operation.DeleteOperation

Constructor

E

ErrorType - Enum in com.opendxl.streaming.client.exception

Identifiers corresponding to the different errors that Channel can throw, e.g.: ConsumerError, TemporaryError, PermanentError and StopError

execute() - Method in class com.opendxl.streaming.cli.CommandLineInterface

execute() - Method in interface com.opendxl.streaming.cli.operation.CommandLineOperation

Execute the operation

execute() - Method in class com.opendxl.streaming.cli.operation.CommitOperation

Execute the operation

execute() - Method in class com.opendxl.streaming.cli.operation.ConsumeOperation

Execute the operation

execute() - Method in class com.opendxl.streaming.cli.operation.CreateOperation

Execute the operation

execute() - Method in class com.opendxl.streaming.cli.operation.DeleteOperation

Execute the operation

execute() - Method in class com.opendxl.streaming.cli.operation.LoginOperation

execute() - Method in class com.opendxl.streaming.cli.operation.ProduceOperation

Execute the operation

execute() - Method in class com.opendxl.streaming.cli.operation.SubscribeOperation

Execute the operation

execute() - Method in class com.opendxl.streaming.cli.operation.SubscriptionsOperation

Execute the operation

execute(HttpRequestBase) - Method in class com.opendxl.streaming.client.HttpConnection

Execute the HTTP Request

ExecutionResult - Class in com.opendxl.streaming.cli.entity

Represent the result of a operation command line

ExecutionResult(String, Object, Map<String, List<?>>) - Constructor for class com.opendxl.streaming.cli.entity.ExecutionResult

Result of a command line operation.

F

fromString(String) - Static method in enum com.opendxl.streaming.cli.operation.OperationArguments

Return a OperationArgument enumerated based on a string

G

get(String, Map<Integer, ErrorType>) - Method in class com.opendxl.streaming.client.Request

Send a GET request

getApi() - Method in exception com.opendxl.streaming.client.exception.ClientError

Gets the Channel method name in which the ConsumerError occurred.

getApi() - Method in exception com.opendxl.streaming.client.exception.StopError

Gets the Channel method name in which the StopError occurred.

getBaseURL(URL) - Static method in class com.opendxl.streaming.cli.CliUtils

Get url based String based on URL instance

getCertificate(String) - Static method in class com.opendxl.streaming.cli.CliUtils

Checks whether the certificate parameter value is an existing filename.

getCode() - Method in class com.opendxl.streaming.cli.entity.ExecutionResult

getCode() - Method in enum com.opendxl.streaming.client.HttpStatusCodes

Get the integer value corresponding to the HTTP Status Code

getCommandLine(OptionSet, Map<Options, ArgumentAcceptingOptionSpec<String>>) - Static method in class com.opendxl.streaming.cli.CliUtils

It gets a list of options used for a specific operation command line

getCookie(Channel) - Static method in class com.opendxl.streaming.cli.CliUtils

Get stickiness cookie from channel

getDecodedPayload() - Method in class com.opendxl.streaming.client.entity.ConsumerRecords.ConsumerRecord

Decodes a Base64 encoded record payload.

getDomain() - Method in class com.opendxl.streaming.cli.entity.StickinessCookie

Get the cookie domain attribute

getHeaders() - Method in class com.opendxl.streaming.client.entity.ConsumerRecords.ConsumerRecord

Gets the record headers.

getHeaders() - Method in class com.opendxl.streaming.client.entity.ConsumerRecords.ConsumerRecordMessage

Gets the record headers.

getHttpProxySettings(String) - Static method in class com.opendxl.streaming.cli.CliUtils

Build an HttpProxySettings object from CLI arguments

getHttpRequest() - Method in exception com.opendxl.streaming.client.exception.ConsumerError

Gets the HttpRequest in which the ConsumerError occurred.

getHttpRequest() - Method in exception com.opendxl.streaming.client.exception.PermanentError

Gets the HttpRequest in which the PermanentError occurred.

getHttpRequest() - Method in exception com.opendxl.streaming.client.exception.TemporaryError

Gets the HttpRequest in which the TemporaryError occurred.

getHttpStatus(int) - Static method in enum com.opendxl.streaming.client.HttpStatusCodes

Get the HttpStatus object for a HTTP Status Code

getMandatoryOptions() - Method in interface com.opendxl.streaming.cli.operation.CommandLineOperation

getMandatoryOptions() - Method in class com.opendxl.streaming.cli.operation.CommitOperation

getMandatoryOptions() - Method in class com.opendxl.streaming.cli.operation.ConsumeOperation

getMandatoryOptions() - Method in class com.opendxl.streaming.cli.operation.CreateOperation

getMandatoryOptions() - Method in class com.opendxl.streaming.cli.operation.DeleteOperation

getMandatoryOptions() - Method in class com.opendxl.streaming.cli.operation.LoginOperation

getMandatoryOptions() - Method in class com.opendxl.streaming.cli.operation.ProduceOperation

getMandatoryOptions() - Method in class com.opendxl.streaming.cli.operation.SubscribeOperation

getMandatoryOptions() - Method in class com.opendxl.streaming.cli.operation.SubscriptionsOperation

getMessage() - Method in class com.opendxl.streaming.client.entity.ConsumerRecords.ConsumerRecord

Gets the record message

getMessage() - Method in class com.opendxl.streaming.client.entity.ConsumerServiceError

getOffset() - Method in class com.opendxl.streaming.client.entity.ConsumerRecords.ConsumerRecord

Gets the record offset.

getOperation(ArgumentAcceptingOptionSpec<String>) - Method in class com.opendxl.streaming.cli.operation.OperationFactory

getOperationName() - Method in interface com.opendxl.streaming.cli.operation.CommandLineOperation

getOperationName() - Method in class com.opendxl.streaming.cli.operation.CommitOperation

getOperationName() - Method in class com.opendxl.streaming.cli.operation.ConsumeOperation

getOperationName() - Method in class com.opendxl.streaming.cli.operation.CreateOperation

getOperationName() - Method in class com.opendxl.streaming.cli.operation.DeleteOperation

getOperationName() - Method in class com.opendxl.streaming.cli.operation.LoginOperation

getOperationName() - Method in class com.opendxl.streaming.cli.operation.ProduceOperation

getOperationName() - Method in class com.opendxl.streaming.cli.operation.SubscribeOperation

getOperationName() - Method in class com.opendxl.streaming.cli.operation.SubscriptionsOperation

getOptions() - Method in class com.opendxl.streaming.cli.entity.ExecutionResult

getPartition() - Method in class com.opendxl.streaming.client.entity.ConsumerRecords.ConsumerRecord

Gets the partition from which the record is consumed.

getPassword() - Method in class com.opendxl.streaming.client.HttpProxySettings

Get the password required to access the Http Proxy

getPayload() - Method in class com.opendxl.streaming.client.entity.ConsumerRecords.ConsumerRecord

Gets the record payload.

getPayload() - Method in class com.opendxl.streaming.client.entity.ConsumerRecords.ConsumerRecordMessage

Gets the record payload.

getPort() - Method in class com.opendxl.streaming.client.HttpProxySettings

Get the Http Proxy TCP port number

getProducerRecords() - Method in class com.opendxl.streaming.cli.entity.SimplifiedProducerRecords

Create a ProducerRecords object from the SimplifiedProducerRecords JSON objects specified by user in the --records CLI parameter.

getRecords() - Method in class com.opendxl.streaming.client.entity.ConsumerRecords

getRecords() - Method in class com.opendxl.streaming.client.entity.ProducerRecords

Get the List of ProducerRecords.ProducerRecord

getResult() - Method in class com.opendxl.streaming.cli.entity.ExecutionResult

getRoutingData() - Method in class com.opendxl.streaming.client.entity.ConsumerRecords.ConsumerRecord

Gets the record routing data

getShardingKey() - Method in class com.opendxl.streaming.client.entity.ConsumerRecords.ConsumerRecord

Gets the sharding key of the consumed record.

getShardingKey() - Method in class com.opendxl.streaming.client.entity.ConsumerRecords.ConsumerRecordRoutingData

Gets the record sharding key.

getStatusCode() - Method in exception com.opendxl.streaming.client.exception.ClientError

Get the HTTP Status Code that caused the error.

getStatusCode() - Method in exception com.opendxl.streaming.client.exception.ConsumerError

Get the HTTP Status Code that caused the ConsumerError.

getStatusCode() - Method in exception com.opendxl.streaming.client.exception.PermanentError

Get the HTTP Status Code that caused the PermanentError.

getStatusCode() - Method in exception com.opendxl.streaming.client.exception.TemporaryError

Get the HTTP Status Code that caused the TemporaryError.

getTopic() - Method in class com.opendxl.streaming.client.entity.ConsumerRecords.ConsumerRecord

Gets the topic name from which the record is consumed.

getTopic() - Method in class com.opendxl.streaming.client.entity.ConsumerRecords.ConsumerRecordRoutingData

Gets the record topic.

getUrl() - Method in class com.opendxl.streaming.client.HttpProxySettings

Get the Http Proxy URL

getUsername() - Method in class com.opendxl.streaming.client.HttpProxySettings

Get the username required to access the Http Proxy

getValue() - Method in class com.opendxl.streaming.cli.entity.StickinessCookie

Get the cookie value attribute

H

HttpConnection - Class in com.opendxl.streaming.client

The HttpConnection class provides an SSL communication layer for Channel requests.

HttpConnection(String, boolean, HttpProxySettings) - Constructor for class com.opendxl.streaming.client.HttpConnection

HttpProxySettings - Class in com.opendxl.streaming.client

The HttpProxySettings class collects all http proxy settings in a single object.

HttpProxySettings(boolean, String, int, String, String) - Constructor for class com.opendxl.streaming.client.HttpProxySettings

HttpStatusCodes - Enum in com.opendxl.streaming.client

HttpStatusCodes defines the HTTP codes which the Databus Consumer Service can return.

I

isEnabled() - Method in class com.opendxl.streaming.client.HttpProxySettings

Indicate whether Http Proxy is enabled or disabled

isSuccess(int) - Static method in enum com.opendxl.streaming.client.HttpStatusCodes

Checks whether a status code is successful one

L

LoginOperation - Class in com.opendxl.streaming.cli.operation

This class represents the "login" argument for a --operation option

LoginOperation(Map<Options, ArgumentAcceptingOptionSpec<String>>, OptionSet) - Constructor for class com.opendxl.streaming.cli.operation.LoginOperation

Constructor

M

main(String[]) - Static method in class com.opendxl.streaming.cli.CommandLineInterface

Entry point

Message(Map<String, String>, String) - Constructor for class com.opendxl.streaming.client.entity.ProducerRecords.ProducerRecord.Message

O

OperationArguments - Enum in com.opendxl.streaming.cli.operation

Arguments of --operation command line option

OperationFactory - Class in com.opendxl.streaming.cli.operation

This factory class creates instances of --operations arguments .

OperationFactory(Map<Options, ArgumentAcceptingOptionSpec<String>>, OptionSet) - Constructor for class com.opendxl.streaming.cli.operation.OperationFactory

Options - Enum in com.opendxl.streaming.cli

Each enumerated represents a command line option.

P

parser - Static variable in class com.opendxl.streaming.cli.CommandLineInterface

Parses command line arguments

PermanentError - Exception in com.opendxl.streaming.client.exception

Exception raised for an operation which would not be expected to succeed even if the operation were retried.

PermanentError(String, Throwable, int, HttpRequest) - Constructor for exception com.opendxl.streaming.client.exception.PermanentError

PermanentError(String, int, HttpRequest) - Constructor for exception com.opendxl.streaming.client.exception.PermanentError

PermanentError(String, Throwable) - Constructor for exception com.opendxl.streaming.client.exception.PermanentError

PermanentError(String) - Constructor for exception com.opendxl.streaming.client.exception.PermanentError

post(String, byte[], Map<Integer, ErrorType>) - Method in class com.opendxl.streaming.client.Request

Send a POST request

printUsageAndFinish(OptionParser, String) - Static method in class com.opendxl.streaming.cli.CliUtils

This method is invoked when the command line made up by options and argument are ill formed or do not meet options spec.

printUsageAndFinish(OptionParser, String, Exception) - Static method in class com.opendxl.streaming.cli.CliUtils

This method is invoked when the command line made up by options and argument are ill formed or do not meet options spec.

printUsageAndFinish(String) - Static method in class com.opendxl.streaming.cli.CliUtils

Prints usage and exits without system error

processCallback(ConsumerRecords, String) - Method in interface com.opendxl.streaming.client.ConsumerRecordProcessor

Method to be implemented by the receiver of the consumed records.

produce(ProducerRecords) - Method in class com.opendxl.streaming.client.Channel

Produce records to the channel.

produce(String) - Method in class com.opendxl.streaming.client.Channel

Produce records to the channel.

produce(ProducerRecords) - Method in interface com.opendxl.streaming.client.Producer

Produce records to the channel.

produce(String) - Method in interface com.opendxl.streaming.client.Producer

Produce records to the channel.

ProduceOperation - Class in com.opendxl.streaming.cli.operation

This class represents the "produce" argument for a --operation option

ProduceOperation(Map<Options, ArgumentAcceptingOptionSpec<String>>, OptionSet) - Constructor for class com.opendxl.streaming.cli.operation.ProduceOperation

Constructor

Producer - Interface in com.opendxl.streaming.client

The Producer interface only exposes the Channel methods to produce records.

ProducerBuilder - Class in com.opendxl.streaming.client.builder

ProducerBuilder(String, ChannelAuth) - Constructor for class com.opendxl.streaming.client.builder.ProducerBuilder

Constructor for ProducerBuilder

ProducerRecords - Class in com.opendxl.streaming.client.entity

ProducerRecords is the parameter type used in Channel.produce(ProducerRecords).

ProducerRecords() - Constructor for class com.opendxl.streaming.client.entity.ProducerRecords

ProducerRecords.ProducerRecord - Class in com.opendxl.streaming.client.entity

Helper class containing all attributes and inner classes of a produce record.

ProducerRecords.ProducerRecord.Builder - Class in com.opendxl.streaming.client.entity

ProducerRecords.ProducerRecord.Builder is a helper class implementing the builder pattern to easily create ProducerRecords.ProducerRecord objects.

ProducerRecords.ProducerRecord.Message - Class in com.opendxl.streaming.client.entity

Message is a class that contains the payload to produce (mandatory attribute) and a map of headers (optional attribute)

ProducerRecords.ProducerRecord.RoutingData - Class in com.opendxl.streaming.client.entity

RoutingData is a class that contains the topic to produce to (mandatory value) and the shardingKey (optional attribute)

R

Request - Class in com.opendxl.streaming.client

Request class is used to set up and send HTTP Post, Get and Delete requests to a given URI.

Request(String, ChannelAuth, String, boolean, HttpProxySettings) - Constructor for class com.opendxl.streaming.client.Request

reset() - Method in class com.opendxl.streaming.client.auth.ChannelAuthToken

This method does no operation in ChannelAuthToken class.

reset() - Method in class com.opendxl.streaming.client.auth.ChannelAuthUserPass

Purge any credentials cached from a previous authentication.

reset() - Method in interface com.opendxl.streaming.client.ChannelAuth

Purge any credentials cached from a previous authentication.

resetAuthorization() - Method in class com.opendxl.streaming.client.Request

Clean up authorization data which is sent in all requests, e.g.: delete authorization token

resetCookies() - Method in class com.opendxl.streaming.client.HttpConnection

Clean up session data which are sent in all requests, e.g.: delete cookies from HttpClientContext CookieStore

resetCookies() - Method in class com.opendxl.streaming.client.Request

Clean up session data which are sent in all requests, e.g.: delete cookies from HttpClientContext CookieStore

RoutingData(String, String) - Constructor for class com.opendxl.streaming.client.entity.ProducerRecords.ProducerRecord.RoutingData

run(ConsumerRecordProcessor, List<String>) - Method in class com.opendxl.streaming.client.Channel

Repeatedly consume records from the subscribed topics.

run(ConsumerRecordProcessor, List<String>, int) - Method in class com.opendxl.streaming.client.Channel

Repeatedly consume records from the subscribed topics.

run(ConsumerRecordProcessor, String) - Method in class com.opendxl.streaming.client.Channel

Repeatedly consume records from the subscribed topic.

run(ConsumerRecordProcessor, String, int) - Method in class com.opendxl.streaming.client.Channel

Repeatedly consume records from the subscribed topic.

run(ConsumerRecordProcessor, List<String>) - Method in interface com.opendxl.streaming.client.Consumer

Repeatedly consume records from the subscribed topics.

run(ConsumerRecordProcessor, List<String>, int) - Method in interface com.opendxl.streaming.client.Consumer

Repeatedly consume records from the subscribed topics.

run(ConsumerRecordProcessor, String) - Method in interface com.opendxl.streaming.client.Consumer

Repeatedly consume records from the subscribed topic.

run(ConsumerRecordProcessor, String, int) - Method in interface com.opendxl.streaming.client.Consumer

Repeatedly consume records from the subscribed topic.

S

setApi(String) - Method in exception com.opendxl.streaming.client.exception.ClientError

Sets the Channel method name in which the ConsumerError occurred.

setApi(String) - Method in exception com.opendxl.streaming.client.exception.StopError

Sets the Channel method name in which the StopError occurred.

setCookie(Channel, StickinessCookie) - Static method in class com.opendxl.streaming.cli.CliUtils

Set stickiness cookie to channel

SimplifiedProducerRecords - Class in com.opendxl.streaming.cli.entity

SimplifiedProducerRecords is collection of SimplifiedProducerRecord object.

SimplifiedProducerRecords(String) - Constructor for class com.opendxl.streaming.cli.entity.SimplifiedProducerRecords

SimplifiedProducerRecords is a public constructor which takes a single String argument as required by joptsimple requirement.

StickinessCookie - Class in com.opendxl.streaming.cli.entity

Represent the Stickiness cookie used by ALB to route and forward request to the right Consumer Service

StickinessCookie(String, String) - Constructor for class com.opendxl.streaming.cli.entity.StickinessCookie

Convenient object to store the two main attributes of a Cookie, its value and its domain.

stop() - Method in class com.opendxl.streaming.client.Channel

Stop an active execution of the Channel.run(ConsumerRecordProcessor, List) call.

stop() - Method in interface com.opendxl.streaming.client.Consumer

Stop an active execution of the Channel.run(ConsumerRecordProcessor, List) call.

StopError - Exception in com.opendxl.streaming.client.exception

Exception raised for an operation which is interrupted due to the channel being stopped.

StopError(String, Throwable) - Constructor for exception com.opendxl.streaming.client.exception.StopError

StopError(String) - Constructor for exception com.opendxl.streaming.client.exception.StopError

subscribe(List<String>) - Method in class com.opendxl.streaming.client.Channel

Subscribes the consumer to a list of topics

subscribe(List<String>) - Method in interface com.opendxl.streaming.client.Consumer

Subscribes the consumer to a list of topics

SubscribeOperation - Class in com.opendxl.streaming.cli.operation

This class represents the "subscriptions" argument for a --operation option

SubscribeOperation(Map<Options, ArgumentAcceptingOptionSpec<String>>, OptionSet) - Constructor for class com.opendxl.streaming.cli.operation.SubscribeOperation

Constructor

subscriptions() - Method in class com.opendxl.streaming.client.Channel

List the topic names to which the consumer is subscribed.

subscriptions() - Method in interface com.opendxl.streaming.client.Consumer

List the topic names to which the consumer is subscribed

SubscriptionsOperation - Class in com.opendxl.streaming.cli.operation

It represents the "commit" argument for a --operation option

SubscriptionsOperation(Map<Options, ArgumentAcceptingOptionSpec<String>>, OptionSet) - Constructor for class com.opendxl.streaming.cli.operation.SubscriptionsOperation

T

TemporaryError - Exception in com.opendxl.streaming.client.exception

Exception raised when an unexpected/unknown (but possibly recoverable) error occurs.

TemporaryError(String, Throwable, int, HttpRequest, String) - Constructor for exception com.opendxl.streaming.client.exception.TemporaryError

TemporaryError(String, int, HttpRequest) - Constructor for exception com.opendxl.streaming.client.exception.TemporaryError

TemporaryError(String, Throwable) - Constructor for exception com.opendxl.streaming.client.exception.TemporaryError

TemporaryError(String, Throwable, String) - Constructor for exception com.opendxl.streaming.client.exception.TemporaryError

TemporaryError(String) - Constructor for exception com.opendxl.streaming.client.exception.TemporaryError

Topics - Class in com.opendxl.streaming.client.entity

Helper class used to serialize and deserialize a list of topic names

Topics(List<String>) - Constructor for class com.opendxl.streaming.client.entity.Topics

topicsToList(String) - Static method in class com.opendxl.streaming.cli.CliUtils

Get a List of topics from a command-separated topic String

V

validateMandatoryOperationArgs(CommandLineOperation, OptionParser, OptionSet) - Static method in class com.opendxl.streaming.cli.CliUtils

This method validate the mandatory arguments for a specific operation

valueOf(String) - Static method in enum com.opendxl.streaming.cli.operation.OperationArguments

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.opendxl.streaming.cli.Options

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.opendxl.streaming.client.exception.ErrorType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.opendxl.streaming.client.HttpStatusCodes

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.opendxl.streaming.cli.operation.OperationArguments

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.opendxl.streaming.cli.Options

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.opendxl.streaming.client.exception.ErrorType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.opendxl.streaming.client.HttpStatusCodes

Returns an array containing the constants of this enum type, in the order they are declared.

W

withCertificateBundle(String) - Method in class com.opendxl.streaming.client.builder.ChannelBuilder

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

withCertificateBundle(String) - Method in class com.opendxl.streaming.client.builder.ConsumerBuilder

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

withCertificateBundle(String) - Method in class com.opendxl.streaming.client.builder.ProducerBuilder

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

withConsumerPathPrefix(String) - Method in class com.opendxl.streaming.client.builder.ChannelBuilder

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

withConsumerPathPrefix(String) - Method in class com.opendxl.streaming.client.builder.ConsumerBuilder

Set the consumerPathPrefix value to be used at ConsumerBuilder.build() when creating Consumer instance

withExtraConfigs(Properties) - Method in class com.opendxl.streaming.client.builder.ChannelBuilder

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

withExtraConfigs(Properties) - Method in class com.opendxl.streaming.client.builder.ConsumerBuilder

Set the extraConfigs value to be used at ConsumerBuilder.build() when creating Consumer instance

withHeaders(Map<String, String>) - Method in class com.opendxl.streaming.client.entity.ProducerRecords.ProducerRecord.Builder

Set the headers value to be set in the upcoming ProducerRecords.ProducerRecord object.

withHttpProxy(HttpProxySettings) - Method in class com.opendxl.streaming.client.builder.ChannelBuilder

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

withHttpProxy(HttpProxySettings) - Method in class com.opendxl.streaming.client.builder.ConsumerBuilder

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

withHttpProxy(HttpProxySettings) - Method in class com.opendxl.streaming.client.builder.ProducerBuilder

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

withPathPrefix(String) - Method in class com.opendxl.streaming.client.builder.ChannelBuilder

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

withProducerPathPrefix(String) - Method in class com.opendxl.streaming.client.builder.ChannelBuilder

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

withProducerPathPrefix(String) - Method in class com.opendxl.streaming.client.builder.ProducerBuilder

Set the producerPathPrefix to be used at ProducerBuilder.build() when creating Producer instance

withRetryOnFail(boolean) - Method in class com.opendxl.streaming.client.builder.ChannelBuilder

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

withRetryOnFail(boolean) - Method in class com.opendxl.streaming.client.builder.ConsumerBuilder

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

withShardingKey(String) - Method in class com.opendxl.streaming.client.entity.ProducerRecords.ProducerRecord.Builder

Set the shardingKey attribute value to be set in the upcoming ProducerRecords.ProducerRecord object.

A B C D E F G H I L M O P R S T V W