Package com.yubico.yubikit.management

Class DeviceConfig

java.lang.Object

com.yubico.yubikit.management.DeviceConfig

public class DeviceConfig
extends java.lang.Object

Describes the configuration of a YubiKey which can be altered via the Management application.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DeviceConfig.Builder	Builder class for use with ManagementSession.updateDeviceConfig(com.yubico.yubikit.management.DeviceConfig, boolean, byte[], byte[]) when altering the device configuration.

Field Summary

Fields

Modifier and Type	Field	Description
static int	FLAG_EJECT	In pure CCID mode eject/inject the card with the button.
static int	FLAG_REMOTE_WAKEUP	Enables remote wakeup.

Method Summary

Modifier and Type	Method	Description
java.lang.Short	getAutoEjectTimeout()	Returns the timeout used when in CCID-only mode with FLAG_EJECT enabled.
java.lang.Byte	getChallengeResponseTimeout()	Returns the timeout value used by the YubiOTP application when waiting for a user presence check (physical touch).
java.lang.Integer	getDeviceFlags()	Returns the device flags that are set.
java.lang.Integer	getEnabledCapabilities(com.yubico.yubikit.core.Transport transport)	Get the currently enabled capabilities for a given Interface.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FLAG_EJECT

public static final int FLAG_EJECT

In pure CCID mode eject/inject the card with the button.

See Also:

Constant Field Values

FLAG_REMOTE_WAKEUP

public static final int FLAG_REMOTE_WAKEUP

Enables remote wakeup.

See Also:

Constant Field Values

Method Detail

getEnabledCapabilities

@Nullable
public java.lang.Integer getEnabledCapabilities(com.yubico.yubikit.core.Transport transport)

Get the currently enabled capabilities for a given Interface. NOTE: This method will return null if the Interface is not supported by the YubiKey, OR if the enabled capabilities state isn't readable. The YubiKey 4 series, for example, does not return enabled-status for USB applications.

Parameters:

transport - the physical transport to get enabled capabilities for

Returns:

the enabled capabilities, represented as Capability bits being set (1) or not (0)

getAutoEjectTimeout

@Nullable
public java.lang.Short getAutoEjectTimeout()

Returns the timeout used when in CCID-only mode with FLAG_EJECT enabled.

getChallengeResponseTimeout

@Nullable
public java.lang.Byte getChallengeResponseTimeout()

Returns the timeout value used by the YubiOTP application when waiting for a user presence check (physical touch).

getDeviceFlags

@Nullable
public java.lang.Integer getDeviceFlags()

Returns the device flags that are set.