Package com.yubico.webauthn.data

Class PublicKeyCredentialDescriptor

java.lang.Object

com.yubico.webauthn.data.PublicKeyCredentialDescriptor

All Implemented Interfaces:

ToPublicKeyCredentialDescriptor, Comparable<PublicKeyCredentialDescriptor>

public final class PublicKeyCredentialDescriptor
extends Object
implements Comparable<PublicKeyCredentialDescriptor>, ToPublicKeyCredentialDescriptor

The attributes that are specified by a caller when referring to a public key credential as an input parameter to the navigator.credentials.create() or navigator.credentials.get() methods. It mirrors the fields of the PublicKeyCredential object returned by the latter methods.

See Also:

• §5.10.3. Credential Descriptor (dictionary PublicKeyCredentialDescriptor)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PublicKeyCredentialDescriptor.PublicKeyCredentialDescriptorBuilder

Method Summary

Modifier and Type	Method	Description
static PublicKeyCredentialDescriptor.PublicKeyCredentialDescriptorBuilder.MandatoryStages	builder()
int	compareTo(PublicKeyCredentialDescriptor other)
boolean	equals(Object o)
@NonNull ByteArray	getId()	The credential ID of the public key credential the caller is referring to.
Optional<SortedSet<AuthenticatorTransport>>	getTransports()
@NonNull PublicKeyCredentialType	getType()	The type of the credential the caller is referring to.
int	hashCode()
PublicKeyCredentialDescriptor.PublicKeyCredentialDescriptorBuilder	toBuilder()
PublicKeyCredentialDescriptor	toPublicKeyCredentialDescriptor()	This implementation of ToPublicKeyCredentialDescriptor.toPublicKeyCredentialDescriptor() is a no-op which returns this unchanged.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

compareTo

public int compareTo(PublicKeyCredentialDescriptor other)

Specified by:

compareTo in interface Comparable<PublicKeyCredentialDescriptor>

builder

public static PublicKeyCredentialDescriptor.PublicKeyCredentialDescriptorBuilder.MandatoryStages builder()

toPublicKeyCredentialDescriptor

public PublicKeyCredentialDescriptor toPublicKeyCredentialDescriptor()

This implementation of ToPublicKeyCredentialDescriptor.toPublicKeyCredentialDescriptor() is a no-op which returns this unchanged.

Specified by:

toPublicKeyCredentialDescriptor in interface ToPublicKeyCredentialDescriptor

Returns:

this.

See Also:

• PublicKeyCredentialDescriptor
• §5.10.3. Credential Descriptor (dictionary PublicKeyCredentialDescriptor)
• CredentialRecord

getTransports

public Optional<SortedSet<AuthenticatorTransport>> getTransports()

toBuilder

public PublicKeyCredentialDescriptor.PublicKeyCredentialDescriptorBuilder toBuilder()

getType

@NonNull
public @NonNull PublicKeyCredentialType getType()

The type of the credential the caller is referring to.

getId

@NonNull
public @NonNull ByteArray getId()

The credential ID of the public key credential the caller is referring to.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object