io.continual.onap.services.subscriber

Class OnapMsgRouterSubscriber.Builder

java.lang.Object

io.continual.onap.services.mrCommon.CommonClientBuilder

io.continual.onap.services.subscriber.OnapMsgRouterSubscriber.Builder

Enclosing class:

OnapMsgRouterSubscriber

public static class OnapMsgRouterSubscriber.Builder
extends CommonClientBuilder

A builder for the subscriber.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_RECV_LIMIT

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
OnapMsgRouterSubscriber.Builder	asUser(String user, String pwd) Set HTTP basic auth credentials.
OnapMsgRouterSubscriber	build() Build the subscriber given this specification.
OnapMsgRouterSubscriber.Builder	defaultHttp() If no protocol is provided on a host string, default to http://
OnapMsgRouterSubscriber.Builder	defaultHttps() If no protocol is provided on a host string, default to https://
OnapMsgRouterSubscriber.Builder	defaultHttps(boolean https) If no protocol is provided on a host string, default to https:// if true, http:// if false.
OnapMsgRouterSubscriber.Builder	forgetHosts() Clear any hosts the builder already knows about.
OnapMsgRouterSubscriber.Builder	inGroup(String group) Specify the subscriber group that this subscriber belongs to.
OnapMsgRouterSubscriber.Builder	logTo(org.slf4j.Logger log) Specify the log to use.
OnapMsgRouterSubscriber.Builder	noRecvLimit() Do not specify a maximum number of events to return on a fetch, allowing the server to determine the number to send.
OnapMsgRouterSubscriber.Builder	onTopic(String topic) Specify the topic to publish to.
OnapMsgRouterSubscriber.Builder	parseWith(JsonResponseParser p) Provide a response parser.
OnapMsgRouterSubscriber.Builder	recvAtMostEvents(int eventCount) Specify the maximum number of events to return on a fetch.
OnapMsgRouterSubscriber.Builder	socketWaitAtMost(long ms) Specify the amount of time to wait on a socket connection, read, or write.
OnapMsgRouterSubscriber.Builder	usingProxy(String proxy) Specify a proxy to use for the HTTP connection to Message Router.
OnapMsgRouterSubscriber.Builder	usingProxy(String host, int port) Specify a proxy to use for the HTTP connection to Message Router.
OnapMsgRouterSubscriber.Builder	waitAtServerAtMost(long ms) Specify the amount of time to wait at the server for messages.
OnapMsgRouterSubscriber.Builder	withApiKey(String apiKey, String apiSecret) Set an API key and secret.
OnapMsgRouterSubscriber.Builder	withClock(Clock clock) Specify a clock to use within this implementation.
OnapMsgRouterSubscriber.Builder	withHost(String host) Add a host to the set the publisher can use.
OnapMsgRouterSubscriber.Builder	withHosts(Collection<String> hosts) Add each host to the host list.
OnapMsgRouterSubscriber.Builder	withHosts(String[] hosts) Add each host to the host list.
OnapMsgRouterSubscriber.Builder	withSubscriberId(String id) Specify the subscriber id for this subscriber.

Methods inherited from class io.continual.onap.services.mrCommon.CommonClientBuilder

getClock, getCredentials, getDefaultHttps, getHosts, getLog, getProxy, getProxyHost, getProxyPort, getSocketWaitMs, getTopic, isProxied, waitingAtMost

Methods inherited from class java.lang.Object

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

Field Detail

NO_RECV_LIMIT

public static final int NO_RECV_LIMIT

See Also:

Constant Field Values

Constructor Detail

Builder

public Builder()

Method Detail

withHost

public OnapMsgRouterSubscriber.Builder withHost(String host)

Add a host to the set the publisher can use. If you do not provide a protocol, "http://" is assumed. You may specify "https://" or "http://". If you do not provide a port (e.g. "host:3904"), then 3904 is assumed for http, and 3905 for https. Thus "localhost" is treated as "http://localhost:3904".

Overrides:

withHost in class CommonClientBuilder

Parameters:

host - the host to add to the host set

Returns:

this builder

withHosts

public OnapMsgRouterSubscriber.Builder withHosts(Collection<String> hosts)

Add each host to the host list. See withHost ( String host ) for details.

Overrides:

withHosts in class CommonClientBuilder

Parameters:

hosts - a collection of hosts to add to the host set

Returns:

this builder

withHosts

public OnapMsgRouterSubscriber.Builder withHosts(String[] hosts)

Add each host to the host list. See withHost ( String host ) for details.

Overrides:

withHosts in class CommonClientBuilder

Parameters:

hosts - a collection of hosts to add to the host set

Returns:

this builder

forgetHosts

public OnapMsgRouterSubscriber.Builder forgetHosts()

Clear any hosts the builder already knows about.

Overrides:

forgetHosts in class CommonClientBuilder

Returns:

this builder

onTopic

public OnapMsgRouterSubscriber.Builder onTopic(String topic)

Specify the topic to publish to.

Overrides:

onTopic in class CommonClientBuilder

Parameters:

topic - the topic on which to post messages

Returns:

this builder

inGroup

public OnapMsgRouterSubscriber.Builder inGroup(String group)

Specify the subscriber group that this subscriber belongs to.

Parameters:

group - the subscriber group name

Returns:

this builder

withSubscriberId

public OnapMsgRouterSubscriber.Builder withSubscriberId(String id)

Specify the subscriber id for this subscriber. This must be unique across members of the group.

Parameters:

id - the unique subscriber ID in the group

Returns:

this builder

waitAtServerAtMost

public OnapMsgRouterSubscriber.Builder waitAtServerAtMost(long ms)

Specify the amount of time to wait at the server for messages. This is essentially a long-poll mechanism supported by the ONAP Message Router system.

Parameters:

ms - the number of milliseconds to wait at the server for messages.

Returns:

this builder

recvAtMostEvents

public OnapMsgRouterSubscriber.Builder recvAtMostEvents(int eventCount)

Specify the maximum number of events to return on a fetch.

Parameters:

eventCount - the number of events to return at most

Returns:

this builder

logTo

public OnapMsgRouterSubscriber.Builder logTo(org.slf4j.Logger log)

Specify the log to use. If never called, the default logger, named for this class, is used.

Overrides:

logTo in class CommonClientBuilder

Parameters:

log - the slf4j logger to use for this library. Do not pass null.

Returns:

this builder

noRecvLimit

public OnapMsgRouterSubscriber.Builder noRecvLimit()

Do not specify a maximum number of events to return on a fetch, allowing the server to determine the number to send.

Returns:

this builder

socketWaitAtMost

public OnapMsgRouterSubscriber.Builder socketWaitAtMost(long ms)

Specify the amount of time to wait on a socket connection, read, or write.

Overrides:

socketWaitAtMost in class CommonClientBuilder

Parameters:

ms - the number of milliseconds to wait for a socket operation (connect/read/write)

Returns:

this builder

asUser

public OnapMsgRouterSubscriber.Builder asUser(String user,
                                              String pwd)

Set HTTP basic auth credentials. If user is null, the auth info is removed from the builder.

Overrides:

asUser in class CommonClientBuilder

Parameters:

user - the username for basic auth credentials

pwd - the password for basic auth credentials

Returns:

this builder

withApiKey

public OnapMsgRouterSubscriber.Builder withApiKey(String apiKey,
                                                  String apiSecret)

Set an API key and secret. If the API key is null, the auth info is removed from the builder.

Overrides:

withApiKey in class CommonClientBuilder

Parameters:

apiKey - the API key for the user

apiSecret - the API key's secret

Returns:

this builder

defaultHttp

public OnapMsgRouterSubscriber.Builder defaultHttp()

If no protocol is provided on a host string, default to http://

Overrides:

defaultHttp in class CommonClientBuilder

Returns:

this builder

defaultHttps

public OnapMsgRouterSubscriber.Builder defaultHttps()

If no protocol is provided on a host string, default to https://

Overrides:

defaultHttps in class CommonClientBuilder

Returns:

this builder

defaultHttps

public OnapMsgRouterSubscriber.Builder defaultHttps(boolean https)

If no protocol is provided on a host string, default to https:// if true, http:// if false.

Overrides:

defaultHttps in class CommonClientBuilder

Parameters:

https - if true, use https. if false, use http

Returns:

this builder

withClock

public OnapMsgRouterSubscriber.Builder withClock(Clock clock)

Specify a clock to use within this implementation.

Overrides:

withClock in class CommonClientBuilder

Parameters:

clock - the clock to use for timing

Returns:

this builder

usingProxy

public OnapMsgRouterSubscriber.Builder usingProxy(String proxy)

Specify a proxy to use for the HTTP connection to Message Router.

Overrides:

usingProxy in class CommonClientBuilder

Parameters:

proxy - a proxy string, which can optionally end in :port, e.g. proxy.example.com:8888

Returns:

this builder

usingProxy

public OnapMsgRouterSubscriber.Builder usingProxy(String host,
                                                  int port)

Specify a proxy to use for the HTTP connection to Message Router.

Overrides:

usingProxy in class CommonClientBuilder

Parameters:

host - a proxy host name

port - a port number

Returns:

this builder

parseWith

public OnapMsgRouterSubscriber.Builder parseWith(JsonResponseParser p)

Provide a response parser.

Parameters:

p - the reponse parser

Returns:

this builder

build

public OnapMsgRouterSubscriber build()

Build the subscriber given this specification.

Returns:

a new subscriber