From 2ffc3657168852af76e97d4f7b7cd6f9284c7f81 Mon Sep 17 00:00:00 2001 From: Scott Leberknight <174812+sleberknight@users.noreply.github.com> Date: Mon, 3 Jun 2024 16:41:18 -0400 Subject: [PATCH] Deprecate usage of the "options" constants for removal (#360) We don't yet have the replacements as of 1.3.3. Those will be added in 1.4.0. Closes #356 --- src/main/java/org/kiwiproject/consul/Consul.java | 2 +- .../org/kiwiproject/consul/option/DeleteOptions.java | 9 +++++++++ .../java/org/kiwiproject/consul/option/EventOptions.java | 4 ++++ .../java/org/kiwiproject/consul/option/PutOptions.java | 4 ++++ .../java/org/kiwiproject/consul/option/QueryOptions.java | 4 ++++ .../kiwiproject/consul/option/QueryParameterOptions.java | 4 ++++ .../java/org/kiwiproject/consul/option/RoleOptions.java | 4 ++++ .../org/kiwiproject/consul/option/TokenQueryOptions.java | 4 ++++ .../kiwiproject/consul/option/TransactionOptions.java | 4 ++++ 9 files changed, 38 insertions(+), 1 deletion(-) diff --git a/src/main/java/org/kiwiproject/consul/Consul.java b/src/main/java/org/kiwiproject/consul/Consul.java index d6d33b2..b51cd95 100644 --- a/src/main/java/org/kiwiproject/consul/Consul.java +++ b/src/main/java/org/kiwiproject/consul/Consul.java @@ -977,7 +977,7 @@ static void addSslSocketFactory(@Nullable SSLContext sslContext, private static void addTimeouts(OkHttpClient.Builder builder, NetworkTimeoutConfig networkTimeoutConfig) { - + if (networkTimeoutConfig.getClientConnectTimeoutMillis() >= 0) { builder.connectTimeout(networkTimeoutConfig.getClientConnectTimeoutMillis(), TimeUnit.MILLISECONDS); } diff --git a/src/main/java/org/kiwiproject/consul/option/DeleteOptions.java b/src/main/java/org/kiwiproject/consul/option/DeleteOptions.java index 91e9c1d..eef7d91 100644 --- a/src/main/java/org/kiwiproject/consul/option/DeleteOptions.java +++ b/src/main/java/org/kiwiproject/consul/option/DeleteOptions.java @@ -10,7 +10,16 @@ @Value.Style(jakarta = true) public abstract class DeleteOptions implements ParamAdder { + /** + * @deprecated for removal in 2.0.0 (replacement will be in 1.4.0) + */ + @Deprecated(since = "1.3.3", forRemoval = true) public static final DeleteOptions BLANK = ImmutableDeleteOptions.builder().build(); + + /** + * @deprecated for removal in 2.0.0 (replacement will be in 1.4.0) + */ + @Deprecated(since = "1.3.3", forRemoval = true) public static final DeleteOptions RECURSE = ImmutableDeleteOptions.builder().recurse(true).build(); public abstract Optional getCas(); diff --git a/src/main/java/org/kiwiproject/consul/option/EventOptions.java b/src/main/java/org/kiwiproject/consul/option/EventOptions.java index d242b76..44ff692 100644 --- a/src/main/java/org/kiwiproject/consul/option/EventOptions.java +++ b/src/main/java/org/kiwiproject/consul/option/EventOptions.java @@ -12,6 +12,10 @@ @Value.Style(jakarta = true) public abstract class EventOptions implements ParamAdder { + /** + * @deprecated for removal in 2.0.0 (replacement will be in 1.4.0) + */ + @Deprecated(since = "1.3.3", forRemoval = true) public static final EventOptions BLANK = ImmutableEventOptions.builder().build(); public abstract Optional getDatacenter(); diff --git a/src/main/java/org/kiwiproject/consul/option/PutOptions.java b/src/main/java/org/kiwiproject/consul/option/PutOptions.java index 6e57cb6..2c6e099 100644 --- a/src/main/java/org/kiwiproject/consul/option/PutOptions.java +++ b/src/main/java/org/kiwiproject/consul/option/PutOptions.java @@ -10,6 +10,10 @@ @Value.Style(jakarta = true) public abstract class PutOptions implements ParamAdder { + /** + * @deprecated for removal in 2.0.0 (replacement will be in 1.4.0) + */ + @Deprecated(since = "1.3.3", forRemoval = true) public static final PutOptions BLANK = ImmutablePutOptions.builder().build(); public abstract Optional getCas(); diff --git a/src/main/java/org/kiwiproject/consul/option/QueryOptions.java b/src/main/java/org/kiwiproject/consul/option/QueryOptions.java index 86be86f..4711330 100644 --- a/src/main/java/org/kiwiproject/consul/option/QueryOptions.java +++ b/src/main/java/org/kiwiproject/consul/option/QueryOptions.java @@ -17,6 +17,10 @@ @Value.Style(jakarta = true) public abstract class QueryOptions implements ParamAdder { + /** + * @deprecated for removal in 2.0.0 (replacement will be in 1.4.0) + */ + @Deprecated(since = "1.3.3", forRemoval = true) public static final QueryOptions BLANK = ImmutableQueryOptions.builder().build(); public abstract Optional getWait(); diff --git a/src/main/java/org/kiwiproject/consul/option/QueryParameterOptions.java b/src/main/java/org/kiwiproject/consul/option/QueryParameterOptions.java index 2b60449..f00a84c 100644 --- a/src/main/java/org/kiwiproject/consul/option/QueryParameterOptions.java +++ b/src/main/java/org/kiwiproject/consul/option/QueryParameterOptions.java @@ -15,6 +15,10 @@ @Value.Style(jakarta = true) public abstract class QueryParameterOptions implements ParamAdder { + /** + * @deprecated for removal in 2.0.0 (replacement will be in 1.4.0) + */ + @Deprecated(since = "1.3.3", forRemoval = true) public static final QueryParameterOptions BLANK = ImmutableQueryParameterOptions.builder().build(); public abstract Optional getReplaceExistingChecks(); diff --git a/src/main/java/org/kiwiproject/consul/option/RoleOptions.java b/src/main/java/org/kiwiproject/consul/option/RoleOptions.java index 05e0127..2057bbf 100644 --- a/src/main/java/org/kiwiproject/consul/option/RoleOptions.java +++ b/src/main/java/org/kiwiproject/consul/option/RoleOptions.java @@ -13,6 +13,10 @@ @Value.Style(jakarta = true) public abstract class RoleOptions implements ParamAdder { + /** + * @deprecated for removal in 2.0.0 (replacement will be in 1.4.0) + */ + @Deprecated(since = "1.3.3", forRemoval = true) public static final RoleOptions BLANK = ImmutableRoleOptions.builder().build(); public abstract Optional getPolicy(); diff --git a/src/main/java/org/kiwiproject/consul/option/TokenQueryOptions.java b/src/main/java/org/kiwiproject/consul/option/TokenQueryOptions.java index c00a5d7..260fed0 100644 --- a/src/main/java/org/kiwiproject/consul/option/TokenQueryOptions.java +++ b/src/main/java/org/kiwiproject/consul/option/TokenQueryOptions.java @@ -13,6 +13,10 @@ @Value.Style(jakarta = true) public abstract class TokenQueryOptions implements ParamAdder { + /** + * @deprecated for removal in 2.0.0 (replacement will be in 1.4.0) + */ + @Deprecated(since = "1.3.3", forRemoval = true) public static final TokenQueryOptions BLANK = ImmutableTokenQueryOptions.builder().build(); public abstract Optional getPolicy(); diff --git a/src/main/java/org/kiwiproject/consul/option/TransactionOptions.java b/src/main/java/org/kiwiproject/consul/option/TransactionOptions.java index ca81757..10a588d 100644 --- a/src/main/java/org/kiwiproject/consul/option/TransactionOptions.java +++ b/src/main/java/org/kiwiproject/consul/option/TransactionOptions.java @@ -13,6 +13,10 @@ @Value.Style(jakarta = true) public abstract class TransactionOptions implements ParamAdder { + /** + * @deprecated for removal in 2.0.0 (replacement will be in 1.4.0) + */ + @Deprecated(since = "1.3.3", forRemoval = true) public static final TransactionOptions BLANK = ImmutableTransactionOptions.builder().build(); public abstract Optional getDatacenter();