Deprecate Json*Serializer

Yubico · Mar 29, 2022 · d2753cb · d2753cb
1 parent f68e7c0
commit d2753cb
Show file tree

Hide file tree

Showing 14 changed files with 74 additions and 37 deletions.
diff --git a/...n-server-core/src/main/java/com/yubico/webauthn/data/AttestationConveyancePreference.java b/...n-server-core/src/main/java/com/yubico/webauthn/data/AttestationConveyancePreference.java
@@ -32,6 +32,7 @@
 import java.util.stream.Stream;
 import lombok.AccessLevel;
 import lombok.AllArgsConstructor;
+import lombok.Getter;
 import lombok.NonNull;
 
 /**
@@ -77,25 +78,27 @@ public enum AttestationConveyancePreference implements JsonStringSerializable {
    */
   DIRECT("direct");
 
-  @NonNull private final String id;
+  @Getter @NonNull private final String value;
 
-  private static Optional<AttestationConveyancePreference> fromString(@NonNull String id) {
-    return Stream.of(values()).filter(v -> v.id.equals(id)).findAny();
+  private static Optional<AttestationConveyancePreference> fromString(@NonNull String value) {
+    return Stream.of(values()).filter(v -> v.value.equals(value)).findAny();
   }
 
   @JsonCreator
-  private static AttestationConveyancePreference fromJsonString(@NonNull String id) {
-    return fromString(id)
+  private static AttestationConveyancePreference fromJsonString(@NonNull String value) {
+    return fromString(value)
         .orElseThrow(
             () ->
                 new IllegalArgumentException(
                     String.format(
                         "Unknown %s value: %s",
-                        AttestationConveyancePreference.class.getSimpleName(), id)));
+                        AttestationConveyancePreference.class.getSimpleName(), value)));
   }
 
   @Override
+  @Deprecated
+  /** @deprecated Use {@link #getValue()} instead. */
   public String toJsonString() {
-    return id;
+    return value;
   }
 }
diff --git a/webauthn-server-core/src/main/java/com/yubico/webauthn/data/AuthenticatorAttachment.java b/webauthn-server-core/src/main/java/com/yubico/webauthn/data/AuthenticatorAttachment.java
@@ -31,6 +31,7 @@
 import java.util.Optional;
 import java.util.stream.Stream;
 import lombok.AllArgsConstructor;
+import lombok.Getter;
 import lombok.NonNull;
 
 /**
@@ -73,25 +74,27 @@ public enum AuthenticatorAttachment implements JsonStringSerializable {
    */
   PLATFORM("platform");
 
-  @NonNull private final String id;
+  @Getter @NonNull private final String value;
 
-  private static Optional<AuthenticatorAttachment> fromString(@NonNull String id) {
-    return Stream.of(values()).filter(v -> v.id.equals(id)).findAny();
+  private static Optional<AuthenticatorAttachment> fromString(@NonNull String value) {
+    return Stream.of(values()).filter(v -> v.value.equals(value)).findAny();
   }
 
   @JsonCreator
-  private static AuthenticatorAttachment fromJsonString(@NonNull String id) {
-    return fromString(id)
+  private static AuthenticatorAttachment fromJsonString(@NonNull String value) {
+    return fromString(value)
         .orElseThrow(
             () ->
                 new IllegalArgumentException(
                     String.format(
                         "Unknown %s value: %s",
-                        AuthenticatorAttachment.class.getSimpleName(), id)));
+                        AuthenticatorAttachment.class.getSimpleName(), value)));
   }
 
   @Override
+  @Deprecated
+  /** @deprecated Use {@link #getValue()} instead. */
   public String toJsonString() {
-    return id;
+    return value;
   }
 }
diff --git a/webauthn-server-core/src/main/java/com/yubico/webauthn/data/AuthenticatorTransport.java b/webauthn-server-core/src/main/java/com/yubico/webauthn/data/AuthenticatorTransport.java
@@ -152,6 +152,8 @@ public static AuthenticatorTransport fromU2fTransport(Transport transport) {
   }
 
   @Override
+  @Deprecated
+  /** @deprecated Use {@link #getId()} instead. */
   public String toJsonString() {
     return id;
   }

diff --git a/webauthn-server-core/src/main/java/com/yubico/webauthn/data/ByteArray.java b/webauthn-server-core/src/main/java/com/yubico/webauthn/data/ByteArray.java
@@ -133,8 +133,9 @@ public String getHex() {
     return BinaryUtil.toHex(bytes);
   }
 
-  /** Used by JSON serializer. */
   @Override
+  @Deprecated
+  /** @deprecated Use {@link #getBase64Url()} instead. */
   public String toJsonString() {
     return base64url;
   }

diff --git a/webauthn-server-core/src/main/java/com/yubico/webauthn/data/COSEAlgorithmIdentifier.java b/webauthn-server-core/src/main/java/com/yubico/webauthn/data/COSEAlgorithmIdentifier.java
@@ -66,6 +66,8 @@ private static COSEAlgorithmIdentifier fromJson(long id) {
   }
 
   @Override
+  @Deprecated
+  /** @deprecated Use {@link #getId()} instead. */
   public long toJsonNumber() {
     return id;
   }

diff --git a/webauthn-server-core/src/main/java/com/yubico/webauthn/data/PublicKeyCredentialType.java b/webauthn-server-core/src/main/java/com/yubico/webauthn/data/PublicKeyCredentialType.java
@@ -31,6 +31,7 @@
 import java.util.Optional;
 import java.util.stream.Stream;
 import lombok.AllArgsConstructor;
+import lombok.Getter;
 import lombok.NonNull;
 
 /**
@@ -51,7 +52,7 @@
 public enum PublicKeyCredentialType implements JsonStringSerializable {
   PUBLIC_KEY("public-key");
 
-  @NonNull private final String id;
+  @Getter @NonNull private final String id;
 
   private static Optional<PublicKeyCredentialType> fromString(@NonNull String id) {
     return Stream.of(values()).filter(v -> v.id.equals(id)).findAny();
@@ -69,6 +70,8 @@ private static PublicKeyCredentialType fromJsonString(@NonNull String id) {
   }
 
   @Override
+  @Deprecated
+  /** @deprecated Use {@link #getId()} instead. */
   public String toJsonString() {
     return id;
   }

diff --git a/webauthn-server-core/src/main/java/com/yubico/webauthn/data/ResidentKeyRequirement.java b/webauthn-server-core/src/main/java/com/yubico/webauthn/data/ResidentKeyRequirement.java
@@ -31,6 +31,7 @@
 import java.util.Optional;
 import java.util.stream.Stream;
 import lombok.AllArgsConstructor;
+import lombok.Getter;
 import lombok.NonNull;
 
 /**
@@ -96,24 +97,27 @@ public enum ResidentKeyRequirement implements JsonStringSerializable {
    */
   REQUIRED("required");
 
-  @NonNull private final String id;
+  @Getter @NonNull private final String value;
 
-  private static Optional<ResidentKeyRequirement> fromString(@NonNull String id) {
-    return Stream.of(values()).filter(v -> v.id.equals(id)).findAny();
+  private static Optional<ResidentKeyRequirement> fromString(@NonNull String value) {
+    return Stream.of(values()).filter(v -> v.value.equals(value)).findAny();
   }
 
   @JsonCreator
-  private static ResidentKeyRequirement fromJsonString(@NonNull String id) {
-    return fromString(id)
+  private static ResidentKeyRequirement fromJsonString(@NonNull String value) {
+    return fromString(value)
         .orElseThrow(
             () ->
                 new IllegalArgumentException(
                     String.format(
-                        "Unknown %s value: %s", ResidentKeyRequirement.class.getSimpleName(), id)));
+                        "Unknown %s value: %s",
+                        ResidentKeyRequirement.class.getSimpleName(), value)));
   }
 
   @Override
+  @Deprecated
+  /** @deprecated Use {@link #getValue()} instead. */
   public String toJsonString() {
-    return id;
+    return value;
   }
 }
diff --git a/webauthn-server-core/src/main/java/com/yubico/webauthn/data/TokenBindingStatus.java b/webauthn-server-core/src/main/java/com/yubico/webauthn/data/TokenBindingStatus.java
@@ -31,6 +31,7 @@
 import java.util.Arrays;
 import java.util.Optional;
 import lombok.AllArgsConstructor;
+import lombok.Getter;
 import lombok.NonNull;
 
 /**
@@ -58,24 +59,26 @@ public enum TokenBindingStatus implements JsonStringSerializable {
    */
   SUPPORTED("supported");
 
-  @NonNull private final String id;
+  @Getter @NonNull private final String value;
 
   private static Optional<TokenBindingStatus> fromString(@NonNull String value) {
-    return Arrays.stream(values()).filter(v -> v.id.equals(value)).findAny();
+    return Arrays.stream(values()).filter(v -> v.value.equals(value)).findAny();
   }
 
   @JsonCreator
-  public static TokenBindingStatus fromJsonString(@NonNull String id) {
-    return fromString(id)
+  public static TokenBindingStatus fromJsonString(@NonNull String value) {
+    return fromString(value)
         .orElseThrow(
             () ->
                 new IllegalArgumentException(
                     String.format(
-                        "Unknown %s value: %s", TokenBindingStatus.class.getSimpleName(), id)));
+                        "Unknown %s value: %s", TokenBindingStatus.class.getSimpleName(), value)));
   }
 
   @Override
+  @Deprecated
+  /** @deprecated Use {@link #getValue()} instead. */
   public String toJsonString() {
-    return id;
+    return value;
   }
 }
diff --git a/webauthn-server-core/src/main/java/com/yubico/webauthn/data/UserVerificationRequirement.java b/webauthn-server-core/src/main/java/com/yubico/webauthn/data/UserVerificationRequirement.java
@@ -31,6 +31,7 @@
 import java.util.Optional;
 import java.util.stream.Stream;
 import lombok.AllArgsConstructor;
+import lombok.Getter;
 import lombok.NonNull;
 
 /**
@@ -66,25 +67,27 @@ public enum UserVerificationRequirement implements JsonStringSerializable {
    */
   REQUIRED("required");
 
-  @NonNull private final String id;
+  @Getter @NonNull private final String value;
 
-  private static Optional<UserVerificationRequirement> fromString(@NonNull String id) {
-    return Stream.of(values()).filter(v -> v.id.equals(id)).findAny();
+  private static Optional<UserVerificationRequirement> fromString(@NonNull String value) {
+    return Stream.of(values()).filter(v -> v.value.equals(value)).findAny();
   }
 
   @JsonCreator
-  private static UserVerificationRequirement fromJsonString(@NonNull String id) {
-    return fromString(id)
+  private static UserVerificationRequirement fromJsonString(@NonNull String value) {
+    return fromString(value)
         .orElseThrow(
             () ->
                 new IllegalArgumentException(
                     String.format(
                         "Unknown %s value: %s",
-                        UserVerificationRequirement.class.getSimpleName(), id)));
+                        UserVerificationRequirement.class.getSimpleName(), value)));
   }
 
   @Override
+  @Deprecated
+  /** @deprecated Use {@link #getValue()} instead. */
   public String toJsonString() {
-    return id;
+    return value;
   }
 }
diff --git a/webauthn-server-core/src/main/java/com/yubico/webauthn/meta/DocumentStatus.java b/webauthn-server-core/src/main/java/com/yubico/webauthn/meta/DocumentStatus.java
@@ -57,8 +57,9 @@ static Optional<DocumentStatus> fromString(@NonNull String id) {
     return Stream.of(values()).filter(v -> v.id.equals(id)).findAny();
   }
 
-  /** Used by JSON serializer. */
   @Override
+  @Deprecated
+  /** @deprecated This will be removed in the next major version release. */
   public String toJsonString() {
     return id;
   }

diff --git a/yubico-util/src/main/java/com/yubico/internal/util/json/JsonLongSerializable.java b/yubico-util/src/main/java/com/yubico/internal/util/json/JsonLongSerializable.java
@@ -24,7 +24,11 @@
 
 package com.yubico.internal.util.json;
 
+@Deprecated
+/** @deprecated This will be removed in the next major version. */
 public interface JsonLongSerializable {
 
+  @Deprecated
+  /** @deprecated This will be removed in the next major version. */
   long toJsonNumber();
 }
diff --git a/yubico-util/src/main/java/com/yubico/internal/util/json/JsonLongSerializer.java b/yubico-util/src/main/java/com/yubico/internal/util/json/JsonLongSerializer.java
@@ -29,6 +29,8 @@
 import com.fasterxml.jackson.databind.SerializerProvider;
 import java.io.IOException;
 
+@Deprecated
+/** @deprecated This will be removed in the next major version. */
 public class JsonLongSerializer<T extends JsonLongSerializable> extends JsonSerializer<T> {
 
   @Override

diff --git a/yubico-util/src/main/java/com/yubico/internal/util/json/JsonStringSerializable.java b/yubico-util/src/main/java/com/yubico/internal/util/json/JsonStringSerializable.java
@@ -24,7 +24,11 @@
 
 package com.yubico.internal.util.json;
 
+@Deprecated
+/** @deprecated This will be removed in the next major version. */
 public interface JsonStringSerializable {
 
+  @Deprecated
+  /** @deprecated This will be removed in the next major version. */
   String toJsonString();
 }
diff --git a/yubico-util/src/main/java/com/yubico/internal/util/json/JsonStringSerializer.java b/yubico-util/src/main/java/com/yubico/internal/util/json/JsonStringSerializer.java
@@ -29,6 +29,8 @@
 import com.fasterxml.jackson.databind.SerializerProvider;
 import java.io.IOException;
 
+@Deprecated
+/** @deprecated This will be removed in the next major version. */
 public class JsonStringSerializer<T extends JsonStringSerializable> extends JsonSerializer<T> {
 
   @Override