Class OnapMsgRouterPublisher.Builder
- java.lang.Object
-
- io.continual.onap.services.mrCommon.CommonClientBuilder
-
- io.continual.onap.services.publisher.OnapMsgRouterPublisher.Builder
-
- Enclosing class:
- OnapMsgRouterPublisher
public static class OnapMsgRouterPublisher.Builder extends CommonClientBuilder
A builder for the publisher.
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OnapMsgRouterPublisher.BuilderasUser(String user, String pwd)Set HTTP basic auth credentials.OnapMsgRouterPublisherbuild()Build the publisher given this specification.OnapMsgRouterPublisher.BuilderdefaultHttp()If no protocol is provided on a host string, default to http://OnapMsgRouterPublisher.BuilderdefaultHttps()If no protocol is provided on a host string, default to https://OnapMsgRouterPublisher.BuilderdefaultHttps(boolean https)If no protocol is provided on a host string, default to https:// if true, http:// if false.OnapMsgRouterPublisher.BuilderforgetHosts()Clear any hosts the builder already knows about.OnapMsgRouterPublisher.BuilderlogTo(org.slf4j.Logger log)Specify the log to use.OnapMsgRouterPublisher.BuilderonTopic(String topic)Specify the topic to publish to.OnapMsgRouterPublisher.BuilderusingProxy(String proxy)Specify a proxy to use for the HTTP connection to Message Router.OnapMsgRouterPublisher.BuilderusingProxy(String host, int port)Specify a proxy to use for the HTTP connection to Message Router.OnapMsgRouterPublisher.BuilderwaitingAtMost(long ms)Specify the amount of time to wait on a socket connection, read, or write.OnapMsgRouterPublisher.BuilderwithApiKey(String apiKey, String apiSecret)Set an API key and secret.OnapMsgRouterPublisher.BuilderwithClock(Clock clock)Specify a clock to use within this implementation.OnapMsgRouterPublisher.BuilderwithHost(String host)Add a host to the set the publisher can use.OnapMsgRouterPublisher.BuilderwithHosts(String[] hosts)Add each host to the host list.OnapMsgRouterPublisher.BuilderwithHosts(Collection<String> hosts)Add each host to the host list.-
Methods inherited from class io.continual.onap.services.mrCommon.CommonClientBuilder
getClock, getCredentials, getDefaultHttps, getHosts, getLog, getProxy, getProxyHost, getProxyPort, getSocketWaitMs, getTopic, isProxied, socketWaitAtMost
-
-
-
-
Method Detail
-
withHost
public OnapMsgRouterPublisher.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:
withHostin classCommonClientBuilder- Parameters:
host- the host to add to the host set- Returns:
- this builder
-
withHosts
public OnapMsgRouterPublisher.Builder withHosts(Collection<String> hosts)
Add each host to the host list. See withHost ( String host ) for details.- Overrides:
withHostsin classCommonClientBuilder- Parameters:
hosts- a collection of hosts to add to the host set- Returns:
- this builder
-
withHosts
public OnapMsgRouterPublisher.Builder withHosts(String[] hosts)
Add each host to the host list. See withHost ( String host ) for details.- Overrides:
withHostsin classCommonClientBuilder- Parameters:
hosts- a collection of hosts to add to the host set- Returns:
- this builder
-
forgetHosts
public OnapMsgRouterPublisher.Builder forgetHosts()
Clear any hosts the builder already knows about.- Overrides:
forgetHostsin classCommonClientBuilder- Returns:
- this builder
-
onTopic
public OnapMsgRouterPublisher.Builder onTopic(String topic)
Specify the topic to publish to.- Overrides:
onTopicin classCommonClientBuilder- Parameters:
topic- the topic on which to post messages- Returns:
- this builder
-
waitingAtMost
public OnapMsgRouterPublisher.Builder waitingAtMost(long ms)
Specify the amount of time to wait on a socket connection, read, or write.- Overrides:
waitingAtMostin classCommonClientBuilder- Parameters:
ms- the number of milliseconds to wait for a socket operation (connect/read/write)- Returns:
- this builder
-
logTo
public OnapMsgRouterPublisher.Builder logTo(org.slf4j.Logger log)
Specify the log to use. If never called, the default logger, named for this class, is used.- Overrides:
logToin classCommonClientBuilder- Parameters:
log- the slf4j logger to use for this library. Do not pass null.- Returns:
- this builder
-
asUser
public OnapMsgRouterPublisher.Builder asUser(String user, String pwd)
Set HTTP basic auth credentials. If user is null, the auth info is removed from the builder.- Overrides:
asUserin classCommonClientBuilder- Parameters:
user- the username for basic auth credentialspwd- the password for basic auth credentials- Returns:
- this builder
-
withApiKey
public OnapMsgRouterPublisher.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:
withApiKeyin classCommonClientBuilder- Parameters:
apiKey- the API key for the userapiSecret- the API key's secret- Returns:
- this builder
-
defaultHttp
public OnapMsgRouterPublisher.Builder defaultHttp()
If no protocol is provided on a host string, default to http://- Overrides:
defaultHttpin classCommonClientBuilder- Returns:
- this builder
-
defaultHttps
public OnapMsgRouterPublisher.Builder defaultHttps()
If no protocol is provided on a host string, default to https://- Overrides:
defaultHttpsin classCommonClientBuilder- Returns:
- this builder
-
defaultHttps
public OnapMsgRouterPublisher.Builder defaultHttps(boolean https)
If no protocol is provided on a host string, default to https:// if true, http:// if false.- Overrides:
defaultHttpsin classCommonClientBuilder- Parameters:
https- if true, use https. if false, use http- Returns:
- this builder
-
withClock
public OnapMsgRouterPublisher.Builder withClock(Clock clock)
Specify a clock to use within this implementation.- Overrides:
withClockin classCommonClientBuilder- Parameters:
clock- the clock to use for timing- Returns:
- this builder
-
usingProxy
public OnapMsgRouterPublisher.Builder usingProxy(String proxy)
Specify a proxy to use for the HTTP connection to Message Router.- Overrides:
usingProxyin classCommonClientBuilder- Parameters:
proxy- a proxy string, which can optionally end in :port, e.g. proxy.example.com:8888- Returns:
- this builder
-
usingProxy
public OnapMsgRouterPublisher.Builder usingProxy(String host, int port)
Specify a proxy to use for the HTTP connection to Message Router.- Overrides:
usingProxyin classCommonClientBuilder- Parameters:
host- a proxy host nameport- a port number- Returns:
- this builder
-
build
public OnapMsgRouterPublisher build()
Build the publisher given this specification.- Returns:
- a new publisher
-
-