Skip to content

Commit d2753cb

Browse files
emlunemlun
committed
Deprecate Json*Serializer
1 parent f68e7c0 commit d2753cb

14 files changed

+74
-37
lines changed

‎webauthn-server-core/src/main/java/com/yubico/webauthn/data/AttestationConveyancePreference.java

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
import java.util.stream.Stream;
3333
import lombok.AccessLevel;
3434
import lombok.AllArgsConstructor;
35+
import lombok.Getter;
3536
import lombok.NonNull;
3637

3738
/**
@@ -77,25 +78,27 @@ public enum AttestationConveyancePreference implements JsonStringSerializable {
7778
*/
7879
DIRECT("direct");
7980

80-
@NonNull private final String id;
81+
@Getter @NonNull private final String value;
8182

82-
private static Optional<AttestationConveyancePreference> fromString(@NonNull String id) {
83-
return Stream.of(values()).filter(v -> v.id.equals(id)).findAny();
83+
private static Optional<AttestationConveyancePreference> fromString(@NonNull String value) {
84+
return Stream.of(values()).filter(v -> v.value.equals(value)).findAny();
8485
}
8586

8687
@JsonCreator
87-
private static AttestationConveyancePreference fromJsonString(@NonNull String id) {
88-
return fromString(id)
88+
private static AttestationConveyancePreference fromJsonString(@NonNull String value) {
89+
return fromString(value)
8990
.orElseThrow(
9091
() ->
9192
new IllegalArgumentException(
9293
String.format(
9394
"Unknown %s value: %s",
94-
AttestationConveyancePreference.class.getSimpleName(), id)));
95+
AttestationConveyancePreference.class.getSimpleName(), value)));
9596
}
9697

9798
@Override
99+
@Deprecated
100+
/** @deprecated Use {@link #getValue()} instead. */
98101
public String toJsonString() {
99-
return id;
102+
return value;
100103
}
101104
}

‎webauthn-server-core/src/main/java/com/yubico/webauthn/data/AuthenticatorAttachment.java

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
import java.util.Optional;
3232
import java.util.stream.Stream;
3333
import lombok.AllArgsConstructor;
34+
import lombok.Getter;
3435
import lombok.NonNull;
3536

3637
/**
@@ -73,25 +74,27 @@ public enum AuthenticatorAttachment implements JsonStringSerializable {
7374
*/
7475
PLATFORM("platform");
7576

76-
@NonNull private final String id;
77+
@Getter @NonNull private final String value;
7778

78-
private static Optional<AuthenticatorAttachment> fromString(@NonNull String id) {
79-
return Stream.of(values()).filter(v -> v.id.equals(id)).findAny();
79+
private static Optional<AuthenticatorAttachment> fromString(@NonNull String value) {
80+
return Stream.of(values()).filter(v -> v.value.equals(value)).findAny();
8081
}
8182

8283
@JsonCreator
83-
private static AuthenticatorAttachment fromJsonString(@NonNull String id) {
84-
return fromString(id)
84+
private static AuthenticatorAttachment fromJsonString(@NonNull String value) {
85+
return fromString(value)
8586
.orElseThrow(
8687
() ->
8788
new IllegalArgumentException(
8889
String.format(
8990
"Unknown %s value: %s",
90-
AuthenticatorAttachment.class.getSimpleName(), id)));
91+
AuthenticatorAttachment.class.getSimpleName(), value)));
9192
}
9293

9394
@Override
95+
@Deprecated
96+
/** @deprecated Use {@link #getValue()} instead. */
9497
public String toJsonString() {
95-
return id;
98+
return value;
9699
}
97100
}

‎webauthn-server-core/src/main/java/com/yubico/webauthn/data/AuthenticatorTransport.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,8 @@ public static AuthenticatorTransport fromU2fTransport(Transport transport) {
152152
}
153153

154154
@Override
155+
@Deprecated
156+
/** @deprecated Use {@link #getId()} instead. */
155157
public String toJsonString() {
156158
return id;
157159
}

‎webauthn-server-core/src/main/java/com/yubico/webauthn/data/ByteArray.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,9 @@ public String getHex() {
133133
return BinaryUtil.toHex(bytes);
134134
}
135135

136-
/** Used by JSON serializer. */
137136
@Override
137+
@Deprecated
138+
/** @deprecated Use {@link #getBase64Url()} instead. */
138139
public String toJsonString() {
139140
return base64url;
140141
}

‎webauthn-server-core/src/main/java/com/yubico/webauthn/data/COSEAlgorithmIdentifier.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,8 @@ private static COSEAlgorithmIdentifier fromJson(long id) {
6666
}
6767

6868
@Override
69+
@Deprecated
70+
/** @deprecated Use {@link #getId()} instead. */
6971
public long toJsonNumber() {
7072
return id;
7173
}

‎webauthn-server-core/src/main/java/com/yubico/webauthn/data/PublicKeyCredentialType.java

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
import java.util.Optional;
3232
import java.util.stream.Stream;
3333
import lombok.AllArgsConstructor;
34+
import lombok.Getter;
3435
import lombok.NonNull;
3536

3637
/**
@@ -51,7 +52,7 @@
5152
public enum PublicKeyCredentialType implements JsonStringSerializable {
5253
PUBLIC_KEY("public-key");
5354

54-
@NonNull private final String id;
55+
@Getter @NonNull private final String id;
5556

5657
private static Optional<PublicKeyCredentialType> fromString(@NonNull String id) {
5758
return Stream.of(values()).filter(v -> v.id.equals(id)).findAny();
@@ -69,6 +70,8 @@ private static PublicKeyCredentialType fromJsonString(@NonNull String id) {
6970
}
7071

7172
@Override
73+
@Deprecated
74+
/** @deprecated Use {@link #getId()} instead. */
7275
public String toJsonString() {
7376
return id;
7477
}

‎webauthn-server-core/src/main/java/com/yubico/webauthn/data/ResidentKeyRequirement.java

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
import java.util.Optional;
3232
import java.util.stream.Stream;
3333
import lombok.AllArgsConstructor;
34+
import lombok.Getter;
3435
import lombok.NonNull;
3536

3637
/**
@@ -96,24 +97,27 @@ public enum ResidentKeyRequirement implements JsonStringSerializable {
9697
*/
9798
REQUIRED("required");
9899

99-
@NonNull private final String id;
100+
@Getter @NonNull private final String value;
100101

101-
private static Optional<ResidentKeyRequirement> fromString(@NonNull String id) {
102-
return Stream.of(values()).filter(v -> v.id.equals(id)).findAny();
102+
private static Optional<ResidentKeyRequirement> fromString(@NonNull String value) {
103+
return Stream.of(values()).filter(v -> v.value.equals(value)).findAny();
103104
}
104105

105106
@JsonCreator
106-
private static ResidentKeyRequirement fromJsonString(@NonNull String id) {
107-
return fromString(id)
107+
private static ResidentKeyRequirement fromJsonString(@NonNull String value) {
108+
return fromString(value)
108109
.orElseThrow(
109110
() ->
110111
new IllegalArgumentException(
111112
String.format(
112-
"Unknown %s value: %s", ResidentKeyRequirement.class.getSimpleName(), id)));
113+
"Unknown %s value: %s",
114+
ResidentKeyRequirement.class.getSimpleName(), value)));
113115
}
114116

115117
@Override
118+
@Deprecated
119+
/** @deprecated Use {@link #getValue()} instead. */
116120
public String toJsonString() {
117-
return id;
121+
return value;
118122
}
119123
}

‎webauthn-server-core/src/main/java/com/yubico/webauthn/data/TokenBindingStatus.java

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
import java.util.Arrays;
3232
import java.util.Optional;
3333
import lombok.AllArgsConstructor;
34+
import lombok.Getter;
3435
import lombok.NonNull;
3536

3637
/**
@@ -58,24 +59,26 @@ public enum TokenBindingStatus implements JsonStringSerializable {
5859
*/
5960
SUPPORTED("supported");
6061

61-
@NonNull private final String id;
62+
@Getter @NonNull private final String value;
6263

6364
private static Optional<TokenBindingStatus> fromString(@NonNull String value) {
64-
return Arrays.stream(values()).filter(v -> v.id.equals(value)).findAny();
65+
return Arrays.stream(values()).filter(v -> v.value.equals(value)).findAny();
6566
}
6667

6768
@JsonCreator
68-
public static TokenBindingStatus fromJsonString(@NonNull String id) {
69-
return fromString(id)
69+
public static TokenBindingStatus fromJsonString(@NonNull String value) {
70+
return fromString(value)
7071
.orElseThrow(
7172
() ->
7273
new IllegalArgumentException(
7374
String.format(
74-
"Unknown %s value: %s", TokenBindingStatus.class.getSimpleName(), id)));
75+
"Unknown %s value: %s", TokenBindingStatus.class.getSimpleName(), value)));
7576
}
7677

7778
@Override
79+
@Deprecated
80+
/** @deprecated Use {@link #getValue()} instead. */
7881
public String toJsonString() {
79-
return id;
82+
return value;
8083
}
8184
}

‎webauthn-server-core/src/main/java/com/yubico/webauthn/data/UserVerificationRequirement.java

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
import java.util.Optional;
3232
import java.util.stream.Stream;
3333
import lombok.AllArgsConstructor;
34+
import lombok.Getter;
3435
import lombok.NonNull;
3536

3637
/**
@@ -66,25 +67,27 @@ public enum UserVerificationRequirement implements JsonStringSerializable {
6667
*/
6768
REQUIRED("required");
6869

69-
@NonNull private final String id;
70+
@Getter @NonNull private final String value;
7071

71-
private static Optional<UserVerificationRequirement> fromString(@NonNull String id) {
72-
return Stream.of(values()).filter(v -> v.id.equals(id)).findAny();
72+
private static Optional<UserVerificationRequirement> fromString(@NonNull String value) {
73+
return Stream.of(values()).filter(v -> v.value.equals(value)).findAny();
7374
}
7475

7576
@JsonCreator
76-
private static UserVerificationRequirement fromJsonString(@NonNull String id) {
77-
return fromString(id)
77+
private static UserVerificationRequirement fromJsonString(@NonNull String value) {
78+
return fromString(value)
7879
.orElseThrow(
7980
() ->
8081
new IllegalArgumentException(
8182
String.format(
8283
"Unknown %s value: %s",
83-
UserVerificationRequirement.class.getSimpleName(), id)));
84+
UserVerificationRequirement.class.getSimpleName(), value)));
8485
}
8586

8687
@Override
88+
@Deprecated
89+
/** @deprecated Use {@link #getValue()} instead. */
8790
public String toJsonString() {
88-
return id;
91+
return value;
8992
}
9093
}

‎webauthn-server-core/src/main/java/com/yubico/webauthn/meta/DocumentStatus.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,9 @@ static Optional<DocumentStatus> fromString(@NonNull String id) {
5757
return Stream.of(values()).filter(v -> v.id.equals(id)).findAny();
5858
}
5959

60-
/** Used by JSON serializer. */
6160
@Override
61+
@Deprecated
62+
/** @deprecated This will be removed in the next major version release. */
6263
public String toJsonString() {
6364
return id;
6465
}

0 commit comments

Comments
 (0)