Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Options Builder constructor that takes existing Options #875

Merged
merged 1 commit into from
Mar 30, 2023
Merged

Options Builder constructor that takes existing Options #875

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 78 additions & 33 deletions src/main/java/io/nats/client/Options.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ public class Options {
// BUILD CONSTRUCTOR PROPS * update build props constructor to read new props
// BUILDER METHODS * add a chainable method in builder for new variable
// BUILD IMPL * update build() implementation if needed
// BUILDER COPY CONSTRUCTOR * update builder constructor to ensure new variables are set
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for not forgetting this.

// CONSTRUCTOR * update constructor to ensure new variables are set from builder
// GETTERS * update getter to be able to retrieve class variable value
// ----------------------------------------------------------------------------------------------------
Expand Down Expand Up @@ -204,7 +205,6 @@ public class Options {
* This value is used internally to limit the number of messages sent in a single network I/O.
* The value returned by {@link #getBufferSize() getBufferSize()} is used first, but if the buffer
* size is large and the message sizes are small, this limit comes into play.
*
* The choice of 1000 is arbitrary and based on testing across several operating systems. Use buffer
* size for tuning.
*/
Expand All @@ -213,11 +213,9 @@ public class Options {
/**
* This value is used internally to limit the number of messages allowed in the outgoing queue. When
* this limit is reached, publish requests will be blocked until the queue can clear.
*
* Because this value is in messages, the memory size associated with this value depends on the actual
* size of messages. If 0 byte messages are used, then DEFAULT_MAX_MESSAGES_IN_OUTGOING_QUEUE will take up the minimal
* space. If 1024 byte messages are used then approximately 5Mb is used for the queue (plus overhead for subjects, etc..)
*
* We are using messages, not bytes, to allow a simplification in the underlying library, and use LinkedBlockingQueue as
* the core element in the queue.
*/
Expand Down Expand Up @@ -356,7 +354,6 @@ public class Options {
/**
* Property used to configure a builder from a Properties object. {@value},
* see {@link Builder#sslContext(SSLContext) sslContext}.
*
* This property is a boolean flag, but it tells the options parser to use the
* default SSL context. Set the default context before creating the options.
*/
Expand All @@ -365,8 +362,7 @@ public class Options {
/**
* Property used to configure a builder from a Properties object.
* {@value}, see {@link Builder#sslContext(SSLContext) sslContext}.
*
* This property is a boolean flag, but it tells the options parser to use the
* This property is a boolean flag, but it tells the options parser to use
* an SSL context that takes any server TLS certificate and does not provide
* its own. The server must have tls_verify turned OFF for this option to work.
*/
Expand Down Expand Up @@ -500,7 +496,6 @@ public class Options {
/**
* Property used to set class name for ServerPool implementation
* {@link Builder#serverPool(ServerPool) serverPool}.
*
* IMPORTANT! ServerPool IS CURRENTLY EXPERIMENTAL AND SUBJECT TO CHANGE.
*/
public static final String PROP_SERVERS_POOL_IMPLEMENTATION_CLASS = "servers_pool_implementation_class";
Expand Down Expand Up @@ -601,7 +596,7 @@ public static class Builder {
// ----------------------------------------------------------------------------------------------------
// BUILDER VARIABLES
// ----------------------------------------------------------------------------------------------------
private final List<NatsUri> natsUris = new ArrayList<>();
private final List<NatsUri> natsServerUris = new ArrayList<>();
private final List<String> unprocessedServers = new ArrayList<>();
private boolean noRandomize = false;
private boolean noResolveHostnames = false;
Expand Down Expand Up @@ -664,8 +659,7 @@ public Builder() {
* Constructs a new {@code Builder} from a {@link Properties} object.
*
* <p>If {@link Options#PROP_SECURE PROP_SECURE} is set, the builder will
* try to to get the default context{@link SSLContext#getDefault() getDefault()}.
*
* try to get the default context{@link SSLContext#getDefault() getDefault()}.
* If a context can't be found, no context is set and an IllegalArgumentException is thrown.
*
* <p>Methods called on the builder after construction can override the properties.
Expand Down Expand Up @@ -900,8 +894,8 @@ public Builder servers(String[] servers) {
try {
String unprocessed = s.trim();
NatsUri nuri = new NatsUri(unprocessed);
if (!natsUris.contains(nuri)) {
natsUris.add(nuri);
if (!natsServerUris.contains(nuri)) {
natsServerUris.add(nuri);
unprocessedServers.add(unprocessed);
}
}
Expand Down Expand Up @@ -1054,8 +1048,8 @@ public Builder turnOnAdvancedStats() {
}

/**
* Enable connection trace messages. Messages are printed to standard out. This options is for very fine
* grained debugging of connection issues.
* Enable connection trace messages. Messages are printed to standard out. This option is for very
* fine-grained debugging of connection issues.
* @return the Builder for chaining
*/
public Builder traceConnection() {
Expand Down Expand Up @@ -1204,7 +1198,6 @@ public Builder connectionTimeout(Duration time) {
* and capped by {@link #maxPingsOut(int) maxPingsOut()}. As of 2.4.4 the library
* may way up to 2 * time to send a ping. Incoming traffic from the server can postpone
* the next ping to avoid pings taking up bandwidth during busy messaging.
*
* Keep in mind that a ping requires a round trip to the server. Setting this value to a small
* number can result in quick failures due to maxPingsOut being reached, these failures will
* force a disconnect/reconnect which can result in messages being held back or failed. In general,
Expand Down Expand Up @@ -1259,7 +1252,6 @@ public Builder bufferSize(int size) {
* Set the maximum number of bytes to buffer in the client when trying to
* reconnect. When this value is exceeded the client will start to drop messages.
* The count of dropped messages can be read from the {@link Statistics#getDroppedCount() Statistics}.
*
* A value of zero will disable the reconnect buffer, a value less than zero means unlimited. Caution
* should be used for negative numbers as they can result in an unreliable network connection plus a
* high message rate leading to an out of memory error.
Expand All @@ -1274,13 +1266,11 @@ public Builder reconnectBufferSize(long size) {

/**
* Set the username and password for basic authentication.
*
* If the user and password are set in the server URL, they will override these values. However, in a clustering situation,
* these values can be used as a fallback.
*
* use the char[] version instead for better security
*
* @param userName a non-empty user name
* @param userName a non-empty userName
* @param password the password, in plain text
* @return the Builder for chaining
*/
Expand All @@ -1292,11 +1282,10 @@ public Builder userInfo(String userName, String password) {

/**
* Set the username and password for basic authentication.
*
* If the user and password are set in the server URL, they will override these values. However, in a clustering situation,
* these values can be used as a fallback.
*
* @param userName a non-empty user name
* @param userName a non-empty userName
* @param password the password, in plain text
* @return the Builder for chaining
*/
Expand All @@ -1308,7 +1297,6 @@ public Builder userInfo(char[] userName, char[] password) {

/**
* Set the token for token-based authentication.
*
* If a token is provided in a server URI it overrides this value.
*
* @param token The token
Expand All @@ -1323,7 +1311,6 @@ public Builder token(String token) {

/**
* Set the token for token-based authentication.
*
* If a token is provided in a server URI it overrides this value.
*
* @param token The token
Expand Down Expand Up @@ -1385,10 +1372,9 @@ public Builder connectionListener(ConnectionListener listener) {
* Set the {@link ExecutorService ExecutorService} used to run threaded tasks. The default is a
* cached thread pool that names threads after the connection name (or a default). This executor
* is used for reading and writing the underlying sockets as well as for each Dispatcher.
*
* The default executor uses a short keepalive time, 500ms, to insure quick shutdowns. This is reasonable
* since most threads from the executor are long lived. If you customize, be sure to keep the shutdown
* effect in mind, exectors can block for their keepalive time. The default executor also marks threads
* since most threads from the executor are long-lived. If you customize, be sure to keep the shutdown
* effect in mind, executors can block for their keepalive time. The default executor also marks threads
* with priority normal and as non-daemon.
*
* @param executor The ExecutorService to use for connections built with these options.
Expand Down Expand Up @@ -1514,12 +1500,12 @@ public Options build() throws IllegalStateException {
throw new IllegalStateException("Options can't have token and username");
}

if (natsUris.size() == 0) {
if (natsServerUris.size() == 0) {
server(DEFAULT_URL);
}
else if (sslContext == null) { // see if we need to provide one
for (int i = 0; sslContext == null && i < natsUris.size(); i++) {
NatsUri natsUri = natsUris.get(i);
for (int i = 0; sslContext == null && i < natsServerUris.size(); i++) {
NatsUri natsUri = natsServerUris.get(i);
switch (natsUri.getScheme()) {
case TLS_PROTOCOL:
case SECURE_WEBSOCKET_PROTOCOL:
Expand All @@ -1545,16 +1531,75 @@ else if (sslContext == null) { // see if we need to provide one
}
return new Options(this);
}

// ----------------------------------------------------------------------------------------------------
// BUILDER COPY CONSTRUCTOR
// ----------------------------------------------------------------------------------------------------
public Builder(Options o) {
if (o == null) {
throw new IllegalArgumentException("Options cannot be null");
}

this.natsServerUris.addAll(o.natsServerUris);
this.unprocessedServers.addAll(o.unprocessedServers);
this.noRandomize = o.noRandomize;
this.noResolveHostnames = o.noResolveHostnames;
this.connectionName = o.connectionName;
this.verbose = o.verbose;
this.pedantic = o.pedantic;
this.sslContext = o.sslContext;
this.maxReconnect = o.maxReconnect;
this.reconnectWait = o.reconnectWait;
this.reconnectJitter = o.reconnectJitter;
this.reconnectJitterTls = o.reconnectJitterTls;
this.connectionTimeout = o.connectionTimeout;
this.pingInterval = o.pingInterval;
this.requestCleanupInterval = o.requestCleanupInterval;
this.maxPingsOut = o.maxPingsOut;
this.reconnectBufferSize = o.reconnectBufferSize;
this.username = o.username;
this.password = o.password;
this.token = o.token;
this.useOldRequestStyle = o.useOldRequestStyle;
this.maxControlLine = o.maxControlLine;
this.bufferSize = o.bufferSize;
this.noEcho = o.noEcho;
this.noHeaders = o.noHeaders;
this.noNoResponders = o.noNoResponders;
this.clientSideLimitChecks = o.clientSideLimitChecks;
this.utf8Support = o.utf8Support;
this.inboxPrefix = o.inboxPrefix;
this.traceConnection = o.traceConnection;
this.maxMessagesInOutgoingQueue = o.maxMessagesInOutgoingQueue;
this.discardMessagesWhenOutgoingQueueFull = o.discardMessagesWhenOutgoingQueueFull;

this.authHandler = o.authHandler;
this.reconnectDelayHandler = o.reconnectDelayHandler;

this.errorListener = o.errorListener;
this.connectionListener = o.connectionListener;
this.dataPortType = o.dataPortType;
this.trackAdvancedStats = o.trackAdvancedStats;
this.executor = o.executor;
this.httpRequestInterceptors = o.httpRequestInterceptors;
this.proxy = o.proxy;

this.ignoreDiscoveredServers = o.ignoreDiscoveredServers;

this.serverPool = o.serverPool;
}
}

// ----------------------------------------------------------------------------------------------------
// CONSTRUCTOR
// ----------------------------------------------------------------------------------------------------
private Options(Builder b) {
if (b.natsUris.size() == 0) {
b.natsUris.add(DEFAULT_NATS_URI);
if (b.natsServerUris.size() == 0) {
this.natsServerUris = Collections.singletonList(DEFAULT_NATS_URI);
}
else {
this.natsServerUris = Collections.unmodifiableList(b.natsServerUris);
}
this.natsServerUris = Collections.unmodifiableList(b.natsUris);
this.unprocessedServers = b.unprocessedServers; // exactly how the user gave them
this.noRandomize = b.noRandomize;
this.noResolveHostnames = b.noResolveHostnames;
Expand Down Expand Up @@ -1755,7 +1800,7 @@ public boolean isNoNoResponders() {
}

/**
* @return clientSideLimitChecks flag, see {@link Builder#clientSideLimitChecks() clientSideLimitChecks()} in the builder doc
* @return clientSideLimitChecks flag
*/
public boolean clientSideLimitChecks() {
return clientSideLimitChecks;
Expand Down
Loading