PublicKeyCredential.Builder

Page Summary

• PublicKeyCredential.Builder is a builder class used to construct PublicKeyCredential objects.

• It includes methods to set various properties of the PublicKeyCredential, such as authenticator attachment, credential identifier (in string or raw byte format), authenticator response, and client outputs for authentication extensions.

• The build() method is used to finalize and create the PublicKeyCredential object once all desired properties have been set.

public static class PublicKeyCredential.Builder extends Object

Builder for PublicKeyCredential.

Public Constructor Summary

Builder() The constructor of PublicKeyCredential.Builder.

Public Method Summary

PublicKeyCredential	build() Builds the PublicKeyCredential object.
PublicKeyCredential.Builder	setAuthenticationExtensionsClientOutputs(AuthenticationExtensionsClientOutputs extensionsClientOutputs) Sets the output produced by the client's processing of the extensions requested by the relying party.
PublicKeyCredential.Builder	setAuthenticatorAttachment(String authenticatorAttachment) Sets the authenticator attachment of the credential.
PublicKeyCredential.Builder	setId(String id) Sets the base64url encoding of the credential identifier.
PublicKeyCredential.Builder	setRawId(byte[] rawId) Sets the raw value of the credential identifier.
PublicKeyCredential.Builder	setRawId(ByteString rawId) Sets the raw value of the credential identifier.
PublicKeyCredential.Builder	setResponse(AuthenticatorResponse response) Sets the authenticator's response to the clients register or sign request.

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Public Constructors

public Builder ()

The constructor of PublicKeyCredential.Builder.

Public Methods

public PublicKeyCredential build ()

Builds the PublicKeyCredential object.

public PublicKeyCredential.Builder setAuthenticationExtensionsClientOutputs (AuthenticationExtensionsClientOutputs extensionsClientOutputs)

Sets the output produced by the client's processing of the extensions requested by the relying party.

public PublicKeyCredential.Builder setAuthenticatorAttachment (String authenticatorAttachment)

Sets the authenticator attachment of the credential.

public PublicKeyCredential.Builder setId (String id)

Sets the base64url encoding of the credential identifier.

public PublicKeyCredential.Builder setRawId (byte[] rawId)

Sets the raw value of the credential identifier.

public PublicKeyCredential.Builder setRawId (ByteString rawId)

Sets the raw value of the credential identifier.

public PublicKeyCredential.Builder setResponse (AuthenticatorResponse response)

Sets the authenticator's response to the clients register or sign request.

This attribute contains the authenticator's response to the client’s request to either create a public key credential, or generate an authentication assertion. If the PublicKeyCredential is created in response a register request, this attribute’s value will be an AuthenticatorAttestationResponse, otherwise, the PublicKeyCredential was created in response to a sign request, and this attribute’s value will be an AuthenticatorAssertionResponse.