com.yubico.webauthn.data

Class PublicKeyCredentialDescriptor

java.lang.Object

com.yubico.webauthn.data.PublicKeyCredentialDescriptor

All Implemented Interfaces:

java.lang.Comparable<PublicKeyCredentialDescriptor>

public final class PublicKeyCredentialDescriptor
extends java.lang.Object
implements java.lang.Comparable<PublicKeyCredentialDescriptor>

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 and Description
static class	PublicKeyCredentialDescriptor.PublicKeyCredentialDescriptorBuilder

Method Summary

Modifier and Type	Method and Description
static PublicKeyCredentialDescriptor.PublicKeyCredentialDescriptorBuilder.MandatoryStages	builder()
int	compareTo(PublicKeyCredentialDescriptor other)
boolean	equals(java.lang.Object o)
@NonNull ByteArray	getId() The credential ID of the public key credential the caller is referring to.
@NonNull java.util.Optional<java.util.Set<AuthenticatorTransport>>	getTransports() An OPTIONAL hint as to how the client might communicate with the managing authenticator of the public key credential the caller is referring to.
@NonNull PublicKeyCredentialType	getType() The type of the credential the caller is referring to.
int	hashCode()
PublicKeyCredentialDescriptor.PublicKeyCredentialDescriptorBuilder	toBuilder()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

compareTo

public int compareTo(PublicKeyCredentialDescriptor other)

Specified by:

compareTo in interface java.lang.Comparable<PublicKeyCredentialDescriptor>

builder

public static PublicKeyCredentialDescriptor.PublicKeyCredentialDescriptorBuilder.MandatoryStages builder()

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.

getTransports

@NonNull
public @NonNull java.util.Optional<java.util.Set<AuthenticatorTransport>> getTransports()

An OPTIONAL hint as to how the client might communicate with the managing authenticator of the public key credential the caller is referring to.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object