API Review Changes (Azure#26638)

* API Review Changes

* Prepare for 1.0.0 API release for Attestation SDK

* Api Review feedback - converted times to OffsetDateTime from Instant.

* README markdown style check improvements

* Attestation APIs return an AttestationResponse which contains a token, not a Response

* Sync admin client returns attestationresponse

Author: LarryOsterman

eng/code-quality-reports/src/main/resources/checkstyle/checkstyle-suppressions.xml

@@ -429,6 +429,12 @@ the main ServiceBusClientBuilder. -->
   <suppress checks="IllegalImport" files=".*[/\\]src[/\\]test[/\\]java[/\\]com[/\\]azure[/\\]security[/\\]attestation[/\\]AttestationClientTestBase.java"/>
   <suppress checks="IllegalImport" files=".*[/\\]src[/\\]test[/\\]java[/\\]com[/\\]azure[/\\]security[/\\]attestation[/\\]AttestationTest.java"/>
 
+  <!-- Attestation Client returns AttestationResponse_T_ instead of Response_T_ -->
+  <suppress checks="ServiceClient" files=".*[/\\]src[/\\]main[/\\]java[/\\]com[/\\]azure[/\\]security[/\\]attestation[/\\]AttestationClient.java"/>
+  <suppress checks="ServiceClient" files=".*[/\\]src[/\\]main[/\\]java[/\\]com[/\\]azure[/\\]security[/\\]attestation[/\\]AttestationAsyncClient.java"/>
+  <suppress checks="ServiceClient" files=".*[/\\]src[/\\]main[/\\]java[/\\]com[/\\]azure[/\\]security[/\\]attestation[/\\]AttestationAdministrationClient.java"/>
+  <suppress checks="ServiceClient" files=".*[/\\]src[/\\]main[/\\]java[/\\]com[/\\]azure[/\\]security[/\\]attestation[/\\]AttestationAdministrationAsyncClient.java"/>
+
   <!-- Suppress checks on AutoRest generated Attestation service code -->
  <suppress checks="WhitespaceAround|ThrowFromClientLogger"
             files="com.azure.security.attestation.implementation.models.*\.java"/>

eng/versioning/version_client.txt

@@ -116,7 +116,7 @@ com.azure:azure-perf-test-parent;1.0.0-beta.1;1.0.0-beta.1
 com.azure:azure-quantum-jobs;1.0.0-beta.1;1.0.0-beta.2
 com.azure:azure-search-documents;11.4.6;11.5.0-beta.6
 com.azure:azure-search-perf;1.0.0-beta.1;1.0.0-beta.1
-com.azure:azure-security-attestation;1.0.0-beta.1;1.0.0-beta.2
+com.azure:azure-security-attestation;1.0.0-beta.1;1.0.0
 com.azure:azure-security-confidentialledger;1.0.0-beta.2;1.0.0-beta.3
 com.azure:azure-security-keyvault-administration;4.0.6;4.1.0-beta.5
 com.azure:azure-security-keyvault-certificates;4.2.6;4.3.0-beta.5

sdk/attestation/azure-security-attestation/CHANGELOG.md

@@ -1,8 +1,6 @@
 # Release History
 
-## 1.0.0-beta.2 (Unreleased)
-### Features Added
-
+## 1.0.0 (2022-02-08)
 ### Breaking Changes
  * Removed `buildSigningCertificatesClient` and `buildSigningCertificatesAsyncClient` replaced
    with `getAttestationSigners` and `getAttestationSignersWithResponse` on `AttestationClient` 
@@ -26,7 +24,7 @@
 factory method:
 ```java
 AttestSgxEnclaveOptions options = AttestSgxEnclaveOptions
-    .fromQuote(decodedOpenEnclaveReport)
+    .fromQuote(decodedSgxEnclaveReport)
     .setRunTimeData(new byte[] { 1, 2, 3, 4, 5});
 ```
 or
@@ -49,12 +47,11 @@ with the  `listPolicyManagementCertificates`, `addPolicyManagementCertificate` a
  * Removed `JsonWebKey`, `JsonWebKeySet`, `PolicyCertificatesModificationResult`, `PolicyCertificatesModifyResponse`, and `CertificatesResponse` objects 
 because they are no longer a part of the public API surface.
  * Refactored `AttestationSigningKey` class to require certificate and signing key parameters in constructor.
+ * listAttestationSigners now returns an `AttestationSignersCollection` object instead of a raw `List<AttestationSigner>`
 
 ### Bugs Fixed
 * Attestation tests now all pass when run in Live mode.
 
-### Other Changes
-
 ## 1.0.0-beta.1 (2021-01-28)
 
 - Initial release. Please see the README and wiki for information on the new design.

sdk/attestation/azure-security-attestation/README.md

@@ -11,7 +11,7 @@
 
   <groupId>com.azure</groupId>
   <artifactId>azure-security-attestation</artifactId>
-  <version>1.0.0-beta.2</version> <!-- {x-version-update;com.azure:azure-security-attestation;current} -->
+  <version>1.0.0</version> <!-- {x-version-update;com.azure:azure-security-attestation;current} -->
 
   <name>Microsoft Azure SDK for Attestation</name>
   <description>This package contains Microsoft Azure SDK for the Microsoft Azure Attestation service.</description>
@@ -72,11 +72,13 @@
       <groupId>com.azure</groupId>
       <artifactId>azure-core-tracing-opentelemetry</artifactId>
       <version>1.0.0-beta.19</version> <!-- {x-version-update;com.azure:azure-core-tracing-opentelemetry;dependency} -->
+      <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>io.opentelemetry</groupId>
       <artifactId>opentelemetry-api</artifactId>
       <version>1.0.0</version> <!-- {x-version-update;io.opentelemetry:opentelemetry-api;external_dependency} -->
+      <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>io.opentelemetry</groupId>

sdk/attestation/azure-security-attestation/pom.xml

@@ -12,16 +12,14 @@
 import com.azure.core.util.Context;
 import com.azure.security.attestation.models.AttestationPolicySetOptions;
 import com.azure.security.attestation.models.AttestationResponse;
-import com.azure.security.attestation.models.AttestationSigner;
+import com.azure.security.attestation.models.AttestationSignerCollection;
 import com.azure.security.attestation.models.AttestationSigningKey;
 import com.azure.security.attestation.models.AttestationTokenValidationOptions;
 import com.azure.security.attestation.models.AttestationType;
 import com.azure.security.attestation.models.PolicyCertificatesModificationResult;
 import com.azure.security.attestation.models.PolicyManagementCertificateOptions;
 import com.azure.security.attestation.models.PolicyResult;
 
-import java.util.List;
-
 /**
  *
  * The AttestationAdministrationClient provides access to the administrative policy APIs
@@ -178,7 +176,7 @@ public String getAttestationPolicy(AttestationType attestationType, AttestationT
      * @return the attestation policy expressed as a string.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public Response<String> getAttestationPolicyWithResponse(AttestationType attestationType, AttestationTokenValidationOptions validationOptions, Context context) {
+    public AttestationResponse<String> getAttestationPolicyWithResponse(AttestationType attestationType, AttestationTokenValidationOptions validationOptions, Context context) {
         return asyncClient.getAttestationPolicyWithResponse(attestationType, validationOptions, context).block();
     }
 
@@ -272,7 +270,7 @@ public PolicyResult setAttestationPolicy(AttestationType attestationType, Attest
      * @return {@link PolicyResult} expressing the result of the attestation operation.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public Response<PolicyResult> setAttestationPolicyWithResponse(AttestationType attestationType, AttestationPolicySetOptions options, Context context) {
+    public AttestationResponse<PolicyResult> setAttestationPolicyWithResponse(AttestationType attestationType, AttestationPolicySetOptions options, Context context) {
         return asyncClient.setAttestationPolicyWithResponse(attestationType, options, context).block();
     }
 
@@ -391,7 +389,7 @@ public PolicyResult resetAttestationPolicy(AttestationType attestationType, Atte
      * @return {@link PolicyResult} expressing the result of the attestation operation.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public Response<PolicyResult> resetAttestationPolicyWithResponse(AttestationType attestationType, AttestationPolicySetOptions options, Context context) {
+    public AttestationResponse<PolicyResult> resetAttestationPolicyWithResponse(AttestationType attestationType, AttestationPolicySetOptions options, Context context) {
         return asyncClient.resetAttestationPolicyWithResponse(attestationType, options, context).block();
     }
 
@@ -413,8 +411,8 @@ public Response<PolicyResult> resetAttestationPolicyWithResponse(AttestationType
      * <p><strong>Retrieve the set of policy management certificates for this instance.</strong></p>
      * <!-- src_embed com.azure.security.attestation.AttestationAdministrationClient.listPolicyManagementCertificatesSimple -->
      * <pre>
-     * List&lt;AttestationSigner&gt; signers = client.listPolicyManagementCertificates&#40;&#41;;
-     * System.out.printf&#40;&quot;There are %d signers on the instance&#92;n&quot;, signers.size&#40;&#41;&#41;;
+     * AttestationSignerCollection signers = client.listPolicyManagementCertificates&#40;&#41;;
+     * System.out.printf&#40;&quot;There are %d signers on the instance&#92;n&quot;, signers.getAttestationSigners&#40;&#41;.size&#40;&#41;&#41;;
      * </pre>
      * <!-- end com.azure.security.attestation.AttestationAdministrationClient.listPolicyManagementCertificatesSimple -->
      *
@@ -424,7 +422,7 @@ public Response<PolicyResult> resetAttestationPolicyWithResponse(AttestationType
      * @return the response to an attestation policy operation.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public List<AttestationSigner> listPolicyManagementCertificates() {
+    public AttestationSignerCollection listPolicyManagementCertificates() {
         return asyncClient.listPolicyManagementCertificates().block();
     }
 
@@ -446,9 +444,11 @@ public List<AttestationSigner> listPolicyManagementCertificates() {
      * <p><strong>Retrieve the set of policy management certificates for this instance.</strong></p>
      * <!-- src_embed com.azure.security.attestation.AttestationAdministrationClient.listPolicyManagementCertificatesWithResponse -->
      * <pre>
-     * Response&lt;List&lt;AttestationSigner&gt;&gt; signersResponse = client.listPolicyManagementCertificatesWithResponse&#40;
-     *     new AttestationTokenValidationOptions&#40;&#41;.setValidationSlack&#40;Duration.ofSeconds&#40;10&#41;&#41;, Context.NONE&#41;;
-     * System.out.printf&#40;&quot;There are %d signers on the instance&#92;n&quot;, signersResponse.getValue&#40;&#41;.size&#40;&#41;&#41;;
+     * AttestationResponse&lt;AttestationSignerCollection&gt; signersResponse =
+     *     client.listPolicyManagementCertificatesWithResponse&#40;
+     *         new AttestationTokenValidationOptions&#40;&#41;.setValidationSlack&#40;Duration.ofSeconds&#40;10&#41;&#41;, Context.NONE&#41;;
+     * System.out.printf&#40;&quot;There are %d signers on the instance&#92;n&quot;,
+     *     signersResponse.getValue&#40;&#41;.getAttestationSigners&#40;&#41;.size&#40;&#41;&#41;;
      * </pre>
      * <!-- end com.azure.security.attestation.AttestationAdministrationClient.listPolicyManagementCertificatesWithResponse -->
      *
@@ -460,7 +460,7 @@ public List<AttestationSigner> listPolicyManagementCertificates() {
      * @return the attestation policy expressed as a string.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public Response<List<AttestationSigner>> listPolicyManagementCertificatesWithResponse(AttestationTokenValidationOptions tokenValidationOptions, Context context) {
+    public AttestationResponse<AttestationSignerCollection> listPolicyManagementCertificatesWithResponse(AttestationTokenValidationOptions tokenValidationOptions, Context context) {
         return asyncClient.listPolicyManagementCertificatesWithResponse(tokenValidationOptions, context).block();
     }
 
@@ -537,12 +537,12 @@ public PolicyCertificatesModificationResult addPolicyManagementCertificate(Polic
      * @return the response to an attestation policy operation.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public Response<PolicyCertificatesModificationResult> addPolicyManagementCertificateWithResponse(PolicyManagementCertificateOptions options, Context context) {
+    public AttestationResponse<PolicyCertificatesModificationResult> addPolicyManagementCertificateWithResponse(PolicyManagementCertificateOptions options, Context context) {
         return asyncClient.addPolicyManagementCertificateWithResponse(options, context).block();
     }
 
     /**
-     * Removes a policy management certificate from the set of policy management certificates.
+     * Deletes a policy management certificate from the set of policy management certificates.
      * <p>
      * Each Isolated mode attestation service instance maintains a set of certificates which can be used to authorize
      * policy modification operations (in Isolated mode, each policy modification request needs to be signed with
@@ -559,7 +559,7 @@ public Response<PolicyCertificatesModificationResult> addPolicyManagementCertifi
      * <p><strong>Add a new certificate to the set of policy management certificates for this instance.</strong></p>
      * <!-- src_embed com.azure.security.attestation.AttestationAdministrationClient.removePolicyManagementCertificate -->
      * <pre>
-     * PolicyCertificatesModificationResult removeResult = client.removePolicyManagementCertificate&#40;
+     * PolicyCertificatesModificationResult removeResult = client.deletePolicyManagementCertificate&#40;
      *     new PolicyManagementCertificateOptions&#40;certificateToAdd, new AttestationSigningKey&#40;certificate, privateKey&#41;&#41;&#41;;
      * System.out.printf&#40;&quot; Result: %s&#92;n&quot;, removeResult.getCertificateResolution&#40;&#41;.toString&#40;&#41;&#41;;
      * </pre>
@@ -577,8 +577,8 @@ public Response<PolicyCertificatesModificationResult> addPolicyManagementCertifi
      * @return the response to an attestation policy operation.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public PolicyCertificatesModificationResult removePolicyManagementCertificate(PolicyManagementCertificateOptions options) {
-        return asyncClient.removePolicyManagementCertificate(options).block();
+    public PolicyCertificatesModificationResult deletePolicyManagementCertificate(PolicyManagementCertificateOptions options) {
+        return asyncClient.deletePolicyManagementCertificate(options).block();
     }
 
     /**
@@ -619,7 +619,7 @@ public PolicyCertificatesModificationResult removePolicyManagementCertificate(Po
      * @return the response to an attestation policy operation.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public Response<PolicyCertificatesModificationResult> removePolicyManagementCertificateWithResponse(PolicyManagementCertificateOptions options, Context context) {
-        return asyncClient.removePolicyManagementCertificateWithResponse(options, context).block();
+    public AttestationResponse<PolicyCertificatesModificationResult> deletePolicyManagementCertificateWithResponse(PolicyManagementCertificateOptions options, Context context) {
+        return asyncClient.deletePolicyManagementCertificateWithResponse(options, context).block();
     }
 }

sdk/attestation/azure-security-attestation/src/main/java/com/azure/security/attestation/AttestationAdministrationAsyncClient.java

@@ -27,7 +27,6 @@
 import com.azure.core.util.CoreUtils;
 import com.azure.core.util.logging.ClientLogger;
 import com.azure.core.util.serializer.JacksonAdapter;
-import com.azure.core.util.serializer.SerializerAdapter;
 import com.azure.security.attestation.implementation.AttestationClientImpl;
 import com.azure.security.attestation.models.AttestationPolicySetOptions;
 import com.azure.security.attestation.models.AttestationTokenValidationOptions;
@@ -138,7 +137,6 @@ public final class AttestationAdministrationClientBuilder {
     private Configuration configuration;
     private AttestationServiceVersion serviceVersion;
     private AttestationTokenValidationOptions tokenValidationOptions;
-    private SerializerAdapter serializerAdapter;
     private TokenCredential tokenCredential = null;
     private static final String CLIENT_NAME;
     private static final String CLIENT_VERSION;
@@ -184,10 +182,10 @@ public AttestationAdministrationClient buildClient() {
      * <br>
      * <!-- src_embed com.azure.security.attestation.AttestationAdministrationClientBuilder.buildAsyncClient -->
      * <pre>
-     * AttestationAdministrationAsyncClient asyncClient = new AttestationAdministrationClientBuilder&#40;&#41;
+     * AttestationAdministrationClient client = new AttestationAdministrationClientBuilder&#40;&#41;
      *     .endpoint&#40;endpoint&#41;
      *     .credential&#40;new DefaultAzureCredentialBuilder&#40;&#41;.build&#40;&#41;&#41;
-     *     .buildAsyncClient&#40;&#41;;
+     *     .buildClient&#40;&#41;;
      * </pre>
      * <!-- end com.azure.security.attestation.AttestationAdministrationClientBuilder.buildAsyncClient -->
      * @return an instance of {@link AttestationClient}.
@@ -246,17 +244,6 @@ public AttestationAdministrationClientBuilder pipeline(HttpPipeline pipeline) {
         return this;
     }
 
-    /**
-     * Sets The serializer to serialize an object into a string.
-     *
-     * @param serializerAdapter the serializerAdapter value.
-     * @return the AttestationClientBuilder.
-     */
-    public AttestationAdministrationClientBuilder serializerAdapter(SerializerAdapter serializerAdapter) {
-        this.serializerAdapter = serializerAdapter;
-        return this;
-    }
-
     /**
      * Sets The HTTP client used to send the request.
      *
@@ -430,11 +417,6 @@ private AttestationClientImpl buildInnerClient() {
                 .build();
         }
 
-        SerializerAdapter serializerAdapter = this.serializerAdapter;
-        if (serializerAdapter == null) {
-            serializerAdapter = JacksonAdapter.createDefaultSerializerAdapter();
-        }
-
-        return new AttestationClientImpl(pipeline, serializerAdapter, endpoint, version.getVersion());
+        return new AttestationClientImpl(pipeline, JacksonAdapter.createDefaultSerializerAdapter(), endpoint, version.getVersion());
     }
 }