From 9989832b56df1c37c1e9f53250d3590628907b50 Mon Sep 17 00:00:00 2001 From: Pravin Pushkar Date: Thu, 27 Jan 2022 16:30:49 +0530 Subject: [PATCH] Adding javadocs to some Domain classes (#673) * Adding javadocs to some Domain classes Signed-off-by: pravinpushkar * Fixing code coverage Signed-off-by: pravinpushkar * Incorporating review comments Signed-off-by: pravinpushkar --- .../io/dapr/client/domain/DeleteStateRequest.java | 6 ++++++ .../client/domain/ExecuteStateTransactionRequest.java | 8 ++++++++ .../io/dapr/client/domain/GetBulkSecretRequest.java | 5 +++++ .../io/dapr/client/domain/GetBulkStateRequest.java | 6 ++++++ .../dapr/client/domain/GetConfigurationRequest.java | 6 ++++++ .../java/io/dapr/client/domain/GetSecretRequest.java | 6 ++++++ .../java/io/dapr/client/domain/GetStateRequest.java | 6 ++++++ .../io/dapr/client/domain/InvokeBindingRequest.java | 6 ++++++ .../io/dapr/client/domain/InvokeMethodRequest.java | 6 ++++++ .../java/io/dapr/client/domain/SaveStateRequest.java | 5 +++++ .../main/java/io/dapr/client/domain/StateOptions.java | 9 +++++++++ .../client/domain/SubscribeConfigurationRequest.java | 6 ++++++ .../client/domain/TransactionalStateOperation.java | 7 +++++++ .../dapr/client/domain/TransactionalStateRequest.java | 4 ++++ .../io/dapr/client/DaprPreviewClientGrpcTest.java | 11 +++++++++++ 15 files changed, 97 insertions(+) diff --git a/sdk/src/main/java/io/dapr/client/domain/DeleteStateRequest.java b/sdk/src/main/java/io/dapr/client/domain/DeleteStateRequest.java index ffdacde29..ec623a3e6 100644 --- a/sdk/src/main/java/io/dapr/client/domain/DeleteStateRequest.java +++ b/sdk/src/main/java/io/dapr/client/domain/DeleteStateRequest.java @@ -31,6 +31,12 @@ public class DeleteStateRequest { private StateOptions stateOptions; + /** + * Constructor for DeleteStateRequest. + * + * @param storeName Name of the state store + * @param key Key present in the state store + */ public DeleteStateRequest(String storeName, String key) { this.stateStoreName = storeName; this.key = key; diff --git a/sdk/src/main/java/io/dapr/client/domain/ExecuteStateTransactionRequest.java b/sdk/src/main/java/io/dapr/client/domain/ExecuteStateTransactionRequest.java index 988f1d988..91615b26e 100644 --- a/sdk/src/main/java/io/dapr/client/domain/ExecuteStateTransactionRequest.java +++ b/sdk/src/main/java/io/dapr/client/domain/ExecuteStateTransactionRequest.java @@ -17,6 +17,9 @@ import java.util.Collections; import java.util.List; import java.util.Map; +/** + * A request for executing state transaction operations. + */ public class ExecuteStateTransactionRequest { /** @@ -34,6 +37,11 @@ public class ExecuteStateTransactionRequest { */ private Map metadata; + /** + * Constructor for ExecuteStateTransactionRequest. + * + * @param stateStoreName Name of the state store + */ public ExecuteStateTransactionRequest(String stateStoreName) { this.stateStoreName = stateStoreName; } diff --git a/sdk/src/main/java/io/dapr/client/domain/GetBulkSecretRequest.java b/sdk/src/main/java/io/dapr/client/domain/GetBulkSecretRequest.java index f950eb559..45289ff56 100644 --- a/sdk/src/main/java/io/dapr/client/domain/GetBulkSecretRequest.java +++ b/sdk/src/main/java/io/dapr/client/domain/GetBulkSecretRequest.java @@ -25,6 +25,11 @@ public class GetBulkSecretRequest { private Map metadata; + /** + * Constructor for GetBulkSecretRequest. + * + * @param storeName Name of the secret store + */ public GetBulkSecretRequest(String storeName) { this.storeName = storeName; } diff --git a/sdk/src/main/java/io/dapr/client/domain/GetBulkStateRequest.java b/sdk/src/main/java/io/dapr/client/domain/GetBulkStateRequest.java index fa65eaf4a..47a20e2e0 100644 --- a/sdk/src/main/java/io/dapr/client/domain/GetBulkStateRequest.java +++ b/sdk/src/main/java/io/dapr/client/domain/GetBulkStateRequest.java @@ -31,6 +31,12 @@ public class GetBulkStateRequest { private int parallelism = 1; + /** + * Constructor for GetBulkStateRequest. + * + * @param storeName Name of the state store + * @param keys keys for the state objects + */ public GetBulkStateRequest(String storeName, List keys) { this.storeName = storeName; this.keys = keys == null ? null : Collections.unmodifiableList(keys); diff --git a/sdk/src/main/java/io/dapr/client/domain/GetConfigurationRequest.java b/sdk/src/main/java/io/dapr/client/domain/GetConfigurationRequest.java index 7e0d13c54..a8de2bd61 100644 --- a/sdk/src/main/java/io/dapr/client/domain/GetConfigurationRequest.java +++ b/sdk/src/main/java/io/dapr/client/domain/GetConfigurationRequest.java @@ -25,6 +25,12 @@ public class GetConfigurationRequest { private final List keys; private Map metadata; + /** + * Constructor for GetConfigurationRequest. + * + * @param storeName Name of the configuration store + * @param keys Keys for the configuration objects + */ public GetConfigurationRequest(String storeName, List keys) { this.storeName = storeName; this.keys = keys == null ? Collections.EMPTY_LIST : Collections.unmodifiableList(keys); diff --git a/sdk/src/main/java/io/dapr/client/domain/GetSecretRequest.java b/sdk/src/main/java/io/dapr/client/domain/GetSecretRequest.java index fa1a22b10..d0e9629ea 100644 --- a/sdk/src/main/java/io/dapr/client/domain/GetSecretRequest.java +++ b/sdk/src/main/java/io/dapr/client/domain/GetSecretRequest.java @@ -25,6 +25,12 @@ public class GetSecretRequest { private final String key; + /** + * Constructor for GetSecretRequest. + * + * @param storeName Name of the Secret Store + * @param key Key for retrieving the secret + */ public GetSecretRequest(String storeName, String key) { this.storeName = storeName; this.key = key; diff --git a/sdk/src/main/java/io/dapr/client/domain/GetStateRequest.java b/sdk/src/main/java/io/dapr/client/domain/GetStateRequest.java index f80034539..fdd5797ef 100644 --- a/sdk/src/main/java/io/dapr/client/domain/GetStateRequest.java +++ b/sdk/src/main/java/io/dapr/client/domain/GetStateRequest.java @@ -29,6 +29,12 @@ public class GetStateRequest { private StateOptions stateOptions; + /** + * Constructor for GetStateRequest. + * + * @param storeName Name of the state store + * @param key Key of the state object + */ public GetStateRequest(String storeName, String key) { this.storeName = storeName; this.key = key; diff --git a/sdk/src/main/java/io/dapr/client/domain/InvokeBindingRequest.java b/sdk/src/main/java/io/dapr/client/domain/InvokeBindingRequest.java index c45e31264..33bc72eba 100644 --- a/sdk/src/main/java/io/dapr/client/domain/InvokeBindingRequest.java +++ b/sdk/src/main/java/io/dapr/client/domain/InvokeBindingRequest.java @@ -29,6 +29,12 @@ public class InvokeBindingRequest { private Map metadata; + /** + * Constructor for InvokeBindingRequest. + * + * @param bindingName Name of the binding + * @param operation Name of the binding operation + */ public InvokeBindingRequest(String bindingName, String operation) { this.name = bindingName; this.operation = operation; diff --git a/sdk/src/main/java/io/dapr/client/domain/InvokeMethodRequest.java b/sdk/src/main/java/io/dapr/client/domain/InvokeMethodRequest.java index c6391a23a..6058363bb 100644 --- a/sdk/src/main/java/io/dapr/client/domain/InvokeMethodRequest.java +++ b/sdk/src/main/java/io/dapr/client/domain/InvokeMethodRequest.java @@ -28,6 +28,12 @@ public class InvokeMethodRequest { private String contentType; + /** + * Constructor for InvokeMethodRequest. + * + * @param appId ID of the Dapr application + * @param method Name of the method to be invoked + */ public InvokeMethodRequest(String appId, String method) { this.appId = appId; this.method = method; diff --git a/sdk/src/main/java/io/dapr/client/domain/SaveStateRequest.java b/sdk/src/main/java/io/dapr/client/domain/SaveStateRequest.java index 67bcd7ee5..39c0da1a3 100644 --- a/sdk/src/main/java/io/dapr/client/domain/SaveStateRequest.java +++ b/sdk/src/main/java/io/dapr/client/domain/SaveStateRequest.java @@ -26,6 +26,11 @@ public class SaveStateRequest { private List> states; + /** + * Constructor for SaveStateRequest. + * + * @param storeName Name of the state store + */ public SaveStateRequest(String storeName) { this.storeName = storeName; } diff --git a/sdk/src/main/java/io/dapr/client/domain/StateOptions.java b/sdk/src/main/java/io/dapr/client/domain/StateOptions.java index 356eb0899..136e47f7e 100644 --- a/sdk/src/main/java/io/dapr/client/domain/StateOptions.java +++ b/sdk/src/main/java/io/dapr/client/domain/StateOptions.java @@ -32,6 +32,9 @@ import java.util.HashMap; import java.util.Map; import java.util.Optional; +/** + * A class representing the state options for Dapr state API. + */ public class StateOptions { private final Consistency consistency; private final Concurrency concurrency; @@ -70,6 +73,9 @@ public class StateOptions { return Collections.unmodifiableMap(Optional.ofNullable(mapOptions).orElse(Collections.EMPTY_MAP)); } + /** + * Options for Consistency. + */ public enum Consistency { EVENTUAL("eventual"), STRONG("strong"); @@ -91,6 +97,9 @@ public class StateOptions { } } + /** + * Options for Concurrency. + */ public enum Concurrency { FIRST_WRITE("first-write"), LAST_WRITE("last-write"); diff --git a/sdk/src/main/java/io/dapr/client/domain/SubscribeConfigurationRequest.java b/sdk/src/main/java/io/dapr/client/domain/SubscribeConfigurationRequest.java index 0684dce5e..25118c400 100644 --- a/sdk/src/main/java/io/dapr/client/domain/SubscribeConfigurationRequest.java +++ b/sdk/src/main/java/io/dapr/client/domain/SubscribeConfigurationRequest.java @@ -25,6 +25,12 @@ public class SubscribeConfigurationRequest { private final List keys; private Map metadata; + /** + * Constructor for SubscribeConfigurationRequest. + * + * @param storeName Name of the configuration store + * @param keys Keys of the configurations values to subscribe to + */ public SubscribeConfigurationRequest(String storeName, List keys) { this.storeName = storeName; this.keys = keys == null ? Collections.EMPTY_LIST : Collections.unmodifiableList(keys); diff --git a/sdk/src/main/java/io/dapr/client/domain/TransactionalStateOperation.java b/sdk/src/main/java/io/dapr/client/domain/TransactionalStateOperation.java index 8ec6a992a..1e613c746 100644 --- a/sdk/src/main/java/io/dapr/client/domain/TransactionalStateOperation.java +++ b/sdk/src/main/java/io/dapr/client/domain/TransactionalStateOperation.java @@ -17,6 +17,10 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** + * Class to represent transactional state operations. + * @param Type of the state value + */ public class TransactionalStateOperation { /** @@ -73,6 +77,9 @@ public class TransactionalStateOperation { + '}'; } + /** + * Options for type of operation. + */ public enum OperationType { @JsonProperty("upsert") UPSERT, @JsonProperty("delete") DELETE diff --git a/sdk/src/main/java/io/dapr/client/domain/TransactionalStateRequest.java b/sdk/src/main/java/io/dapr/client/domain/TransactionalStateRequest.java index a5fff1cf8..6eb5969fa 100644 --- a/sdk/src/main/java/io/dapr/client/domain/TransactionalStateRequest.java +++ b/sdk/src/main/java/io/dapr/client/domain/TransactionalStateRequest.java @@ -17,6 +17,10 @@ import java.util.Collections; import java.util.List; import java.util.Map; +/** + * A class to represent request for transactional state. + * @param Type of state value in TransactionalStateOperation + */ public class TransactionalStateRequest { /** diff --git a/sdk/src/test/java/io/dapr/client/DaprPreviewClientGrpcTest.java b/sdk/src/test/java/io/dapr/client/DaprPreviewClientGrpcTest.java index a5ce0a592..2252074e3 100644 --- a/sdk/src/test/java/io/dapr/client/DaprPreviewClientGrpcTest.java +++ b/sdk/src/test/java/io/dapr/client/DaprPreviewClientGrpcTest.java @@ -15,6 +15,8 @@ package io.dapr.client; import io.dapr.client.domain.ConfigurationItem; +import io.dapr.client.domain.GetConfigurationRequest; +import io.dapr.client.domain.SubscribeConfigurationRequest; import io.dapr.serializer.DefaultObjectSerializer; import io.dapr.v1.CommonProtos; import io.dapr.v1.DaprGrpc; @@ -73,6 +75,10 @@ public class DaprPreviewClientGrpcTest { assertThrows(IllegalArgumentException.class, () -> { previewClient.getConfiguration("", "key").block(); }); + GetConfigurationRequest req = new GetConfigurationRequest(CONFIG_STORE_NAME, null); + assertThrows(IllegalArgumentException.class, () -> { + previewClient.getConfiguration(req).block(); + }); } @Test @@ -223,6 +229,11 @@ public class DaprPreviewClientGrpcTest { assertThrows(IllegalArgumentException.class, () -> { previewClient.subscribeToConfiguration("", "key").blockFirst(); }); + + SubscribeConfigurationRequest req = new SubscribeConfigurationRequest(CONFIG_STORE_NAME, null); + assertThrows(IllegalArgumentException.class, () -> { + previewClient.subscribeToConfiguration(req).blockFirst(); + }); } private DaprProtos.GetConfigurationResponse getSingleMockResponse() {