Changes for javadoc and logger #4552

sima-zhu · 2019-07-23T22:36:02Z

Addressed the missed feedback from last PR.
Removed extra README.

Last PR: #4383

* SAS implementation * Fixed some minor formatting issues * Fixed checkstyle problems and test issue

Removes RawClients from Storage Blobs

…to ContainerClient (Azure#4376) * Removed raw clients * Added deleteContainer to StorageClient * Added getAppendBlob with snapshot to ContainerClient

* Initial check in for storage queue

...age/client/queue/src/main/java/com/azure/storage/common/credentials/SharedKeyCredential.java

alzimmermsft

Check if the asError logs should be asWarning. asError is meant to be used when the application would not be able to recover.

storage/client/queue/src/main/java/com/azure/storage/queue/QueueAsyncClient.java

* Finished the restructure, refactor builder. Added sleep in record feature. Linting

Merges AppendBlobClientBuilder, BlobClientBuilder, BlockBlobClientBuilder, and PageBlobClientBuilder into a single builder class BlobClientBuilder. Additionally, JavaDoc comments for the other builder classes, ContainerClientBuilder and StorageAccountClientBuilder, were cleaned up and the way the endpoint is handled in builders was changed.

alzimmermsft

Let's block this PR until #4489 merges in, most of the changes done here will be removed once it happens.

…zure-sdk-for-java into storage_queue

alzimmermsft

This is the spec I am referring to: spec

alzimmermsft · 2019-07-31T23:26:34Z

...ure-storage-file/src/main/java/com/azure/storage/common/credentials/SharedKeyCredential.java

@@ -236,8 +234,8 @@ private String computeHMACSHA256(String stringToSign) {
            String signature = Base64.getEncoder().encodeToString(hmacSha256.doFinal(utf8Bytes));
            return String.format(AUTHORIZATION_HEADER_FORMAT, accountName, signature);
        } catch (NoSuchAlgorithmException | InvalidKeyException ex) {
-            logger.warning(ex.getMessage());
-            throw new Error(ex);
+            logger.logAndThrow(new RuntimeException(ex.getMessage()));


Pass in the exception itself into the constructor and change this to use IllegalStateException as that better aligns with the spec.

alzimmermsft · 2019-07-31T23:26:54Z

...re-storage-queue/src/main/java/com/azure/storage/common/credentials/SharedKeyCredential.java

@@ -232,8 +234,8 @@ private String computeHMACSHA256(String stringToSign) {
            String signature = Base64.getEncoder().encodeToString(hmacSha256.doFinal(utf8Bytes));
            return String.format(AUTHORIZATION_HEADER_FORMAT, accountName, signature);
        } catch (NoSuchAlgorithmException | InvalidKeyException ex) {
-            LOGGER.error(ex.getMessage());
-            throw new Error(ex);
+            logger.logAndThrow(new RuntimeException(ex.getMessage()));


Pass in the exception itself into the constructor and change this to use IllegalStateException as that better aligns with the spec.

alzimmermsft · 2019-07-31T23:27:20Z

...ure-storage-file/src/main/java/com/azure/storage/common/credentials/SharedKeyCredential.java

-            String errorMsg = "There is no such algorithm. Error Details: " + e.getMessage();
-            logger.warning(errorMsg);
-            throw new RuntimeException(errorMsg);
+            logger.logAndThrow(new RuntimeException("There is no such algorithm. Error Details: " + e.getMessage()));


Change this to IllegalStateException as it better aligns with the spec.

alzimmermsft · 2019-07-31T23:27:24Z

...ure-storage-file/src/main/java/com/azure/storage/common/credentials/SharedKeyCredential.java

-            String errorMsg = "Please double check the account key. Error details: " + e.getMessage();
-            logger.warning(errorMsg);
-            throw new RuntimeException(errorMsg);
+            logger.logAndThrow(new RuntimeException("Please double check the account key. Error details: " + e.getMessage()));


Change this to IllegalStateException as it better aligns with the spec.

alzimmermsft · 2019-07-31T23:27:30Z

...re-storage-queue/src/main/java/com/azure/storage/common/credentials/SharedKeyCredential.java

@@ -116,11 +118,11 @@ public String computeHmac256(final String stringToSign) {
            byte[] utf8Bytes = stringToSign.getBytes(StandardCharsets.UTF_8);
            return Base64.getEncoder().encodeToString(hmacSha256.doFinal(utf8Bytes));
        } catch (final NoSuchAlgorithmException e) {
-            LOGGER.error(e.getMessage());
-            throw new RuntimeException(e);
+            logger.logAndThrow(new RuntimeException(e));


Change this to IllegalStateException as it better aligns with the spec.

alzimmermsft · 2019-07-31T23:28:38Z

sdk/storage/azure-storage-queue/src/main/java/com/azure/storage/queue/QueueClientBuilder.java

@@ -138,8 +138,8 @@ public QueueAsyncClient buildAsyncClient() {
        Objects.requireNonNull(queueName);

        if (sasTokenCredential == null && sharedKeyCredential == null) {
-            LOGGER.error("Credentials are required for authorization");
-            throw new IllegalArgumentException("Credentials are required for authorization");
+            logger.logAndThrow(new IllegalArgumentException("Credentials are required for authorization"));


Change this to IllegalStateException as it better aligns with the spec.

alzimmermsft · 2019-07-31T23:29:20Z

sdk/storage/azure-storage-queue/src/main/java/com/azure/storage/queue/QueueClientBuilder.java

-            LOGGER.error("The Azure Storage Queue endpoint url is malformed. Endpoint: " + endpoint);
-            throw new IllegalArgumentException("The Azure Storage Queue endpoint url is malformed. Endpoint: " + endpoint);
+            logger.logAndThrow(new IllegalArgumentException("The Azure Storage Queue endpoint url is malformed. Endpoint: " + endpoint));
+            return null;


Don't need to return null here, only use that when the code analyzer thinks there is no return case when one is needed.

alzimmermsft · 2019-07-31T23:29:55Z

...orage/azure-storage-queue/src/main/java/com/azure/storage/queue/QueueServiceAsyncClient.java

@@ -71,8 +71,8 @@ public URL getQueueServiceUrl() {
        try {
            return new URL(client.getUrl());
        } catch (MalformedURLException ex) {
-            LOGGER.error("Queue Service URL is malformed");
-            throw new RuntimeException("Storage account URL is malformed");
+            logger.logAndThrow(new RuntimeException("Storage account URL is malformed"));


Change this IllegalStateException to better align with the spec.

alzimmermsft · 2019-07-31T23:30:22Z

...age/azure-storage-queue/src/main/java/com/azure/storage/queue/QueueServiceClientBuilder.java

@@ -112,8 +112,8 @@ public QueueServiceAsyncClient buildAsyncClient() {
        Objects.requireNonNull(endpoint);

        if (sasTokenCredential == null && sharedKeyCredential == null) {
-            LOGGER.error("Credentials are required for authorization");
-            throw new IllegalArgumentException("Credentials are required for authorization");
+            logger.logAndThrow(new IllegalArgumentException("Credentials are required for authorization"));


Change this IllegalStateException to better align with the spec.

alzimmermsft · 2019-07-31T23:30:38Z

...age/azure-storage-queue/src/main/java/com/azure/storage/queue/QueueServiceClientBuilder.java

-                + "Connection String: %s", connectionString);
-            throw new IllegalArgumentException(String.format("There is no valid account for the connection string. "
-                + "Connection String: %s", connectionString));
+            logger.logAndThrow(new IllegalArgumentException(String.format("There is no valid account for the connection string. "


Change this IllegalStateException to better align with the spec.

sima-zhu · 2019-08-20T22:59:09Z

Close this and will address in issue:
#5066

gapra-msft and others added 8 commits July 12, 2019 11:57

Storage SAS implementation (Azure#4404)

1ec9438

* SAS implementation * Fixed some minor formatting issues * Fixed checkstyle problems and test issue

Merge branch 'master' into storage-post-review1-dev

78db8d4

Merge branch 'master' into storage-post-review1-dev

69026ba

Remove RawClients from Blobs (Azure#4375)

be429c3

Removes RawClients from Storage Blobs

Add deleteContainer to StorageClient and getBlobClient with Snapshot …

b00cdc6

…to ContainerClient (Azure#4376) * Removed raw clients * Added deleteContainer to StorageClient * Added getAppendBlob with snapshot to ContainerClient

Merge branch 'master' into storage-post-review1-dev

da7ebb6

Storage queue linting, builder refactor, tests (Azure#4383)

78ea66b

* Initial check in for storage queue

Changes for javadoc and logger

84d562f

sima-zhu requested review from JonathanGiles and alzimmermsft July 23, 2019 22:36

JonathanGiles requested changes Jul 23, 2019

View reviewed changes

...age/client/queue/src/main/java/com/azure/storage/common/credentials/SharedKeyCredential.java Outdated Show resolved Hide resolved

sima-zhu requested a review from JonathanGiles July 23, 2019 22:43

alzimmermsft requested changes Jul 23, 2019

View reviewed changes

storage/client/queue/src/main/java/com/azure/storage/queue/QueueAsyncClient.java Outdated Show resolved Hide resolved

Changed asError to as Warning

8dfecc3

sima-zhu requested a review from alzimmermsft July 23, 2019 23:18

sima-zhu self-assigned this Jul 24, 2019

sima-zhu and others added 2 commits July 23, 2019 17:49

Initial checkin for Storage file (Azure#4414)

44fb56e

* Finished the restructure, refactor builder. Added sleep in record feature. Linting

alzimmermsft requested changes Jul 24, 2019

View reviewed changes

Merge branch 'storage-post-review1-dev' of https://github.com/Azure/a…

577f463

…zure-sdk-for-java into storage_queue

sima-zhu changed the base branch from storage-post-review1-dev to master July 26, 2019 21:22

merge from mainline

6b8d9d3

sima-zhu requested review from jaschrep-msft and rickle-msft as code owners July 29, 2019 22:20

sima-zhu requested a review from alzimmermsft July 29, 2019 22:20

sima-zhu mentioned this pull request Jul 30, 2019

Bump to the right version. Switch test account to team account. #4710

Merged

merge from mainline

0fe4ec2

alzimmermsft requested changes Jul 31, 2019

View reviewed changes

alzimmermsft added Client This issue points to a problem in the data-plane of the library. Storage Storage Service (Queues, Blobs, Files) labels Aug 19, 2019

sima-zhu closed this Aug 20, 2019

sima-zhu deleted the storage_queue branch February 23, 2021 19:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Changes for javadoc and logger #4552

Changes for javadoc and logger #4552

sima-zhu commented Jul 23, 2019 •

edited

Loading

alzimmermsft left a comment

alzimmermsft left a comment

alzimmermsft left a comment

alzimmermsft Jul 31, 2019

alzimmermsft Jul 31, 2019

alzimmermsft Jul 31, 2019

alzimmermsft Jul 31, 2019

alzimmermsft Jul 31, 2019

alzimmermsft Jul 31, 2019

alzimmermsft Jul 31, 2019

alzimmermsft Jul 31, 2019

alzimmermsft Jul 31, 2019

alzimmermsft Jul 31, 2019

sima-zhu commented Aug 20, 2019

Changes for javadoc and logger #4552

Changes for javadoc and logger #4552

Conversation

sima-zhu commented Jul 23, 2019 • edited Loading

alzimmermsft left a comment

Choose a reason for hiding this comment

alzimmermsft left a comment

Choose a reason for hiding this comment

alzimmermsft left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sima-zhu commented Aug 20, 2019

sima-zhu commented Jul 23, 2019 •

edited

Loading