Package com.yubico.webauthn.data

Enum Class AuthenticatorAttachment

java.lang.Object

java.lang.Enum<AuthenticatorAttachment>

com.yubico.webauthn.data.AuthenticatorAttachment

All Implemented Interfaces:

Serializable, Comparable<AuthenticatorAttachment>, Constable

public enum AuthenticatorAttachment
extends Enum<AuthenticatorAttachment>

This enumeration’s values describe authenticators' attachment modalities. Relying Parties use this for two purposes:

• to express a preferred authenticator attachment modality when calling navigator.credentials.create() to create a credential, and
• to inform the client of the Relying Party's best belief about how to locate the managing authenticators of the credentials listed in PublicKeyCredentialRequestOptions.getAllowCredentials() when calling navigator.credentials.get().

See Also:

• §5.4.5. Authenticator Attachment Enumeration (enum AuthenticatorAttachment)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CROSS_PLATFORM	Indicates cross-platform attachment.
PLATFORM	Indicates platform attachment.

Method Summary

Modifier and Type	Method	Description
static Optional<AuthenticatorAttachment>	fromValue(@NonNull String value)	Attempt to parse a string as an AuthenticatorAttachment.
@NonNull String	getValue()
static AuthenticatorAttachment	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AuthenticatorAttachment[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CROSS_PLATFORM

public static final AuthenticatorAttachment CROSS_PLATFORM

Indicates cross-platform attachment.

Authenticators of this class are removable from, and can "roam" among, client platforms.

PLATFORM

public static final AuthenticatorAttachment PLATFORM

Indicates platform attachment.

Usually, authenticators of this class are not removable from the platform.

Method Details

values

public static AuthenticatorAttachment[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static AuthenticatorAttachment valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

fromValue

public static Optional<AuthenticatorAttachment> fromValue(@NonNull
 @NonNull String value)

Attempt to parse a string as an AuthenticatorAttachment.

Parameters:

value - a String equal to the value of a constant in AuthenticatorAttachment

Returns:

The AuthenticatorAttachment instance whose value equals value, if any.

See Also:

• §5.4.5. Authenticator Attachment Enumeration (enum AuthenticatorAttachment)

getValue

@NonNull
public @NonNull String getValue()