com.yubico.webauthn.data

Enum AuthenticatorTransport

java.lang.Object

java.lang.Enum<AuthenticatorTransport>

com.yubico.webauthn.data.AuthenticatorTransport

All Implemented Interfaces:

com.yubico.internal.util.json.JsonStringSerializable, java.io.Serializable, java.lang.Comparable<AuthenticatorTransport>

public enum AuthenticatorTransport
extends java.lang.Enum<AuthenticatorTransport>
implements com.yubico.internal.util.json.JsonStringSerializable

Authenticators may communicate with Clients using a variety of transports. This enumeration defines a hint as to how Clients might communicate with a particular Authenticator in order to obtain an assertion for a specific credential. Note that these hints represent the Relying Party's best belief as to how an Authenticator may be reached. A Relying Party may obtain a list of transports hints from some attestation statement formats or via some out-of-band mechanism; it is outside the scope of this specification to define that mechanism.

Authenticators may implement various transports for communicating with clients. This enumeration defines hints as to how clients might communicate with a particular authenticator in order to obtain an assertion for a specific credential. Note that these hints represent the WebAuthn Relying Party's best belief as to how an authenticator may be reached. A Relying Party may obtain a list of transports hints from some attestation statement formats or via some out-of-band mechanism; it is outside the scope of the Web Authentication specification to define that mechanism.

See Also:

§5.10.4. Authenticator Transport Enumeration (enum AuthenticatorTransport)

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLE Indicates the respective authenticator can be contacted over Bluetooth Smart (Bluetooth Low Energy / BLE).
INTERNAL Indicates the respective authenticator is contacted using a client device-specific transport.
NFC Indicates the respective authenticator can be contacted over Near Field Communication (NFC).
USB Indicates the respective authenticator can be contacted over removable USB.

Method Summary

Modifier and Type	Method and Description
java.lang.String	toJsonString()
static AuthenticatorTransport	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AuthenticatorTransport[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

USB

public static final AuthenticatorTransport USB

Indicates the respective authenticator can be contacted over removable USB.

NFC

public static final AuthenticatorTransport NFC

Indicates the respective authenticator can be contacted over Near Field Communication (NFC).

BLE

public static final AuthenticatorTransport BLE

Indicates the respective authenticator can be contacted over Bluetooth Smart (Bluetooth Low Energy / BLE).

INTERNAL

public static final AuthenticatorTransport INTERNAL

Indicates the respective authenticator is contacted using a client device-specific transport. These authenticators are not removable from the client device.

Method Detail

values

public static AuthenticatorTransport[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AuthenticatorTransport c : AuthenticatorTransport.values())
    System.out.println(c);

Returns:

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

valueOf

public static AuthenticatorTransport valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toJsonString

public java.lang.String toJsonString()

Specified by:

toJsonString in interface com.yubico.internal.util.json.JsonStringSerializable