com.yubico.yubikit.management

Class ManagementApplication

java.lang.Object

com.yubico.yubikit.management.ManagementApplication

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class ManagementApplication
extends java.lang.Object
implements java.io.Closeable

Implements management API to YubiKey interface https://developers.yubico.com/yubikey-manager/Config_Reference.html

Constructor Summary

Constructors

Constructor and Description
ManagementApplication(YubiKeySession session) Create new instance of ManagementApplication

Method Summary

Modifier and Type	Method and Description
void	close()
Version	getVersion() Firmware version
DeviceConfiguration	readConfiguration() Reads configurations from device
void	setMode(DeviceConfiguration config) Enables/disables USB capability on the key
void	writeConfiguration(DeviceConfiguration config, boolean reboot) Writes updates

Methods inherited from class java.lang.Object

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

Constructor Detail

ManagementApplication

public ManagementApplication(YubiKeySession session)
                      throws java.io.IOException,
                             ApplicationNotFound

Create new instance of ManagementApplication

Parameters:

session - session with YubiKey

Throws:

java.io.IOException - in case of connection error

ApduException - in case of communication error

ApplicationNotFound

Method Detail

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

getVersion

public Version getVersion()

Firmware version

Returns:

Yubikey firmware version

readConfiguration

public DeviceConfiguration readConfiguration()
                                      throws java.io.IOException,
                                             ApduException,
                                             NotSupportedOperation

Reads configurations from device

Returns:

configurations

Throws:

java.io.IOException - in case of connection error

ApduException - in case of communication or not supported operation error

NotSupportedOperation

writeConfiguration

public void writeConfiguration(DeviceConfiguration config,
                               boolean reboot)
                        throws java.io.IOException,
                               ApduException,
                               NotSupportedOperation

Writes updates

Parameters:

config - updated configurations

reboot - require reboot

Throws:

java.io.IOException - in case of connection error

ApduException - in case of communication or not supported operation error

NotSupportedOperation

setMode

public void setMode(DeviceConfiguration config)
             throws java.io.IOException,
                    ApduException,
                    NotSupportedOperation

Enables/disables USB capability on the key

Parameters:

config - updated configurations

Throws:

java.io.IOException - in case of connection error

ApduException - in case of communication or not supported operation error

NotSupportedOperation