Skip to content

Commit d8e2d60

Browse files
emlunemlun
committed
Add/improve javadoc on required builder methods
1 parent 0763da9 commit d8e2d60

16 files changed

+162
-4
lines changed

‎NEWS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ Fixes:
4848

4949
* Added missing JavaDoc for `id` and `name` methods of initial
5050
`RelyingPartyIdentityBuilder` stages.
51+
* Added and improved JavaDoc for required builder methods.
5152

5253

5354
== Version 1.10.1 ==

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,9 @@ public static class MandatoryStages {
148148
* {@link
149149
* AssertionRequestBuilder#publicKeyCredentialRequestOptions(PublicKeyCredentialRequestOptions)
150150
* publicKeyCredentialRequestOptions} is a required parameter.
151+
*
152+
* @see
153+
* AssertionRequestBuilder#publicKeyCredentialRequestOptions(PublicKeyCredentialRequestOptions)
151154
*/
152155
public AssertionRequestBuilder publicKeyCredentialRequestOptions(
153156
PublicKeyCredentialRequestOptions publicKeyCredentialRequestOptions) {

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,12 +79,24 @@ public static class FinishAssertionOptionsBuilder {
7979
public static class MandatoryStages {
8080
private final FinishAssertionOptionsBuilder builder = new FinishAssertionOptionsBuilder();
8181

82+
/**
83+
* {@link FinishAssertionOptionsBuilder#request(AssertionRequest) request} is a required
84+
* parameter.
85+
*
86+
* @see FinishAssertionOptionsBuilder#request(AssertionRequest)
87+
*/
8288
public Step2 request(AssertionRequest request) {
8389
builder.request(request);
8490
return new Step2();
8591
}
8692

8793
public class Step2 {
94+
/**
95+
* {@link FinishAssertionOptionsBuilder#response(PublicKeyCredential) response} is a
96+
* required parameter.
97+
*
98+
* @see FinishAssertionOptionsBuilder#response(PublicKeyCredential)
99+
*/
88100
public FinishAssertionOptionsBuilder response(
89101
PublicKeyCredential<AuthenticatorAssertionResponse, ClientAssertionExtensionOutputs>
90102
response) {

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,12 +82,24 @@ public static class MandatoryStages {
8282
private final FinishRegistrationOptionsBuilder builder =
8383
new FinishRegistrationOptionsBuilder();
8484

85+
/**
86+
* {@link FinishRegistrationOptionsBuilder#request(PublicKeyCredentialCreationOptions)
87+
* request} is a required parameter.
88+
*
89+
* @see FinishRegistrationOptionsBuilder#request(PublicKeyCredentialCreationOptions)
90+
*/
8591
public Step2 request(PublicKeyCredentialCreationOptions request) {
8692
builder.request(request);
8793
return new Step2();
8894
}
8995

9096
public class Step2 {
97+
/**
98+
* {@link FinishRegistrationOptionsBuilder#response(PublicKeyCredential) response} is a
99+
* required parameter.
100+
*
101+
* @see FinishRegistrationOptionsBuilder#response(PublicKeyCredential)
102+
*/
91103
public FinishRegistrationOptionsBuilder response(
92104
PublicKeyCredential<
93105
AuthenticatorAttestationResponse, ClientRegistrationExtensionOutputs>

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,19 +114,37 @@ public static class RegisteredCredentialBuilder {
114114
public static class MandatoryStages {
115115
private RegisteredCredentialBuilder builder = new RegisteredCredentialBuilder();
116116

117+
/**
118+
* {@link RegisteredCredentialBuilder#credentialId(ByteArray) credentialId} is a required
119+
* parameter.
120+
*
121+
* @see RegisteredCredentialBuilder#credentialId(ByteArray)
122+
*/
117123
public Step2 credentialId(ByteArray credentialId) {
118124
builder.credentialId(credentialId);
119125
return new Step2();
120126
}
121127

122128
public class Step2 {
129+
/**
130+
* {@link RegisteredCredentialBuilder#userHandle(ByteArray) userHandle} is a required
131+
* parameter.
132+
*
133+
* @see RegisteredCredentialBuilder#userHandle(ByteArray)
134+
*/
123135
public Step3 userHandle(ByteArray userHandle) {
124136
builder.userHandle(userHandle);
125137
return new Step3();
126138
}
127139
}
128140

129141
public class Step3 {
142+
/**
143+
* {@link RegisteredCredentialBuilder#publicKeyCose(ByteArray) publicKeyCose} is a required
144+
* parameter.
145+
*
146+
* @see RegisteredCredentialBuilder#publicKeyCose(ByteArray)
147+
*/
130148
public RegisteredCredentialBuilder publicKeyCose(ByteArray publicKeyCose) {
131149
return builder.publicKeyCose(publicKeyCose);
132150
}

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,11 @@ public static class StartRegistrationOptionsBuilder {
9595
public static class MandatoryStages {
9696
private final StartRegistrationOptionsBuilder builder = new StartRegistrationOptionsBuilder();
9797

98+
/**
99+
* {@link StartRegistrationOptionsBuilder#user(UserIdentity) user} is a required parameter.
100+
*
101+
* @see StartRegistrationOptionsBuilder#user(UserIdentity)
102+
*/
98103
public StartRegistrationOptionsBuilder user(UserIdentity user) {
99104
return builder.user(user);
100105
}

‎webauthn-server-core/src/main/java/com/yubico/webauthn/attestation/Attestation.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,11 @@ public static class AttestationBuilder {
112112
public static class MandatoryStages {
113113
private final AttestationBuilder builder = new AttestationBuilder();
114114

115+
/**
116+
* {@link AttestationBuilder#trusted(boolean) trusted} is a required parameter.
117+
*
118+
* @see AttestationBuilder#trusted(boolean)
119+
*/
115120
public AttestationBuilder trusted(boolean trusted) {
116121
return builder.trusted(trusted);
117122
}

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,19 +112,37 @@ public static class MandatoryStages {
112112
private final AuthenticatorAssertionResponseBuilder builder =
113113
new AuthenticatorAssertionResponseBuilder();
114114

115+
/**
116+
* {@link AuthenticatorAssertionResponseBuilder#authenticatorData(ByteArray)
117+
* authenticatorData} is a required parameter.
118+
*
119+
* @see AuthenticatorAssertionResponseBuilder#authenticatorData(ByteArray)
120+
*/
115121
public Step2 authenticatorData(ByteArray authenticatorData) {
116122
builder.authenticatorData(authenticatorData);
117123
return new Step2();
118124
}
119125

120126
public class Step2 {
127+
/**
128+
* {@link AuthenticatorAssertionResponseBuilder#clientDataJSON(ByteArray) clientDataJSON} is
129+
* a required parameter.
130+
*
131+
* @see AuthenticatorAssertionResponseBuilder#clientDataJSON(ByteArray)
132+
*/
121133
public Step3 clientDataJSON(ByteArray clientDataJSON) {
122134
builder.clientDataJSON(clientDataJSON);
123135
return new Step3();
124136
}
125137
}
126138

127139
public class Step3 {
140+
/**
141+
* {@link AuthenticatorAssertionResponseBuilder#signature(ByteArray) signature} is a
142+
* required parameter.
143+
*
144+
* @see AuthenticatorAssertionResponseBuilder#signature(ByteArray)
145+
*/
128146
public AuthenticatorAssertionResponseBuilder signature(ByteArray signature) {
129147
return builder.signature(signature);
130148
}

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,12 +122,24 @@ public static class MandatoryStages {
122122
private final AuthenticatorAttestationResponseBuilder builder =
123123
new AuthenticatorAttestationResponseBuilder();
124124

125+
/**
126+
* {@link AuthenticatorAttestationResponseBuilder#attestationObject(ByteArray)
127+
* attestationObject} is a required parameter.
128+
*
129+
* @see AuthenticatorAttestationResponseBuilder#attestationObject(ByteArray)
130+
*/
125131
public Step2 attestationObject(ByteArray attestationObject) {
126132
builder.attestationObject(attestationObject);
127133
return new Step2();
128134
}
129135

130136
public class Step2 {
137+
/**
138+
* {@link AuthenticatorAttestationResponseBuilder#clientDataJSON(ByteArray) clientDataJSON}
139+
* is a required parameter.
140+
*
141+
* @see AuthenticatorAttestationResponseBuilder#clientDataJSON(ByteArray)
142+
*/
131143
public AuthenticatorAttestationResponseBuilder clientDataJSON(ByteArray clientDataJSON) {
132144
return builder.clientDataJSON(clientDataJSON);
133145
}

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,19 +120,36 @@ private MandatoryStages start() {
120120
public class MandatoryStages {
121121
private final PublicKeyCredentialBuilder<A, B> builder;
122122

123+
/**
124+
* {@link PublicKeyCredentialBuilder#id(ByteArray) id} is a required parameter.
125+
*
126+
* @see PublicKeyCredentialBuilder#id(ByteArray)
127+
*/
123128
public Step2 id(ByteArray id) {
124129
builder.id(id);
125130
return new Step2();
126131
}
127132

128133
public class Step2 {
134+
/**
135+
* {@link PublicKeyCredentialBuilder#response(AuthenticatorResponse) response} is a required
136+
* parameter.
137+
*
138+
* @see PublicKeyCredentialBuilder#response(AuthenticatorResponse)
139+
*/
129140
public Step3 response(A response) {
130141
builder.response(response);
131142
return new Step3();
132143
}
133144
}
134145

135146
public class Step3 {
147+
/**
148+
* {@link PublicKeyCredentialBuilder#clientExtensionResults(ClientExtensionOutputs)
149+
* clientExtensionResults} is a required parameter.
150+
*
151+
* @see PublicKeyCredentialBuilder#clientExtensionResults(ClientExtensionOutputs)
152+
*/
136153
public PublicKeyCredentialBuilder<A, B> clientExtensionResults(B clientExtensionResults) {
137154
return builder.clientExtensionResults(clientExtensionResults);
138155
}

0 commit comments

Comments
 (0)