org.multibit.hd.hardware.core

Class HardwareWalletSpecification

java.lang.Object

org.multibit.hd.hardware.core.HardwareWalletSpecification

public class HardwareWalletSpecification
extends Object

Specification to provide the following to HardwareWallets:

• required hardware wallet specific parameters for creating a client
• optional hardware wallet specific parameters for additional configuration

Constructor Summary

Constructors

Constructor and Description
HardwareWalletSpecification(Class hardwareWalletClass) Static binding
HardwareWalletSpecification(String className) Constructor for dynamic binding

Method Summary

Modifier and Type	Method and Description
String	getClassName()
String	getDescription()
String	getHost() Get the host name of the server providing socket access to the device (e.g.
String	getName()
Object	getParameter(String key)
int	getPort() Get the port number of the server providing direct socket data (e.g.
com.google.common.base.Optional<Integer>	getProductId()
com.google.common.base.Optional<String>	getSerialNumber()
com.google.common.base.Optional<Integer>	getVendorId()
boolean	isUsb()
static <T extends HardwareWallet> HardwareWalletSpecification	newSocketSpecification(Class<T> hardwareWalletClass, String host, int port) Builder for hardware wallets communicating over sockets using static binding
static HardwareWalletSpecification	newSocketSpecification(String className, String host, int port) Builder for hardware wallets communicating over sockets using dynamic binding
static <T extends HardwareWallet> HardwareWalletSpecification	newUsbSpecification(Class<T> hardwareWalletClass, com.google.common.base.Optional<Integer> vendorId, com.google.common.base.Optional<Integer> productId, com.google.common.base.Optional<String> serialNumber) Builder for hardware wallets communicating over USB HID using static binding
static HardwareWalletSpecification	newUsbSpecification(String className, com.google.common.base.Optional<Integer> vendorId, com.google.common.base.Optional<Integer> productId, com.google.common.base.Optional<String> serialNumber) Builder for hardware wallets communicating over USB HID using dynamic binding
void	setDescription(String description)
void	setHost(String host) Set the host name of the server providing socket access to the device
void	setName(String name)
void	setPort(int port) Set the port number of the server providing direct socket data (e.g.
void	setProductId(com.google.common.base.Optional<Integer> productId)
void	setSerialNumber(com.google.common.base.Optional<String> serialNumber)
void	setSpecificParameters(Map<String,Object> specificParameters)
void	setUsb(boolean isUsb)
void	setVendorId(com.google.common.base.Optional<Integer> vendorId)

Methods inherited from class java.lang.Object

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

Constructor Detail

HardwareWalletSpecification

public HardwareWalletSpecification(String className)

Constructor for dynamic binding

Parameters:

className - The hardware wallet class name (e.g. "org.example.hw.ExampleHardwareWallet")

HardwareWalletSpecification

public HardwareWalletSpecification(Class hardwareWalletClass)

Static binding

Parameters:

hardwareWalletClass - The hardware wallet class

Method Detail

newSocketSpecification

public static HardwareWalletSpecification newSocketSpecification(String className,
                                                                 String host,
                                                                 int port)

Builder for hardware wallets communicating over sockets using dynamic binding

Parameters:

className - The hardware wallet class name (e.g. "org.example.hw.ExampleSocketHardwareWallet")

host - The host name

port - The port number

Returns:

A new hardware wallet specification suitable for use with sockets

newSocketSpecification

public static <T extends HardwareWallet> HardwareWalletSpecification newSocketSpecification(Class<T> hardwareWalletClass,
                                                                                            String host,
                                                                                            int port)

Builder for hardware wallets communicating over sockets using static binding

Parameters:

hardwareWalletClass - The hardware wallet class

host - The host name

port - The port number

Returns:

A new hardware wallet specification suitable for use with sockets

newUsbSpecification

public static HardwareWalletSpecification newUsbSpecification(String className,
                                                              com.google.common.base.Optional<Integer> vendorId,
                                                              com.google.common.base.Optional<Integer> productId,
                                                              com.google.common.base.Optional<String> serialNumber)

Builder for hardware wallets communicating over USB HID using dynamic binding

Parameters:

className - The class name of the HardwareWallet implemention (e.g. "org.example.hw.ExampleUsbHardwareWallet")

vendorId - The vendor ID (uses default if absent)

productId - The product ID (uses default if absent)

serialNumber - The device serial number (accepts any if absent)

Returns:

A new hardware wallet specification suitable for use with sockets

newUsbSpecification

public static <T extends HardwareWallet> HardwareWalletSpecification newUsbSpecification(Class<T> hardwareWalletClass,
                                                                                         com.google.common.base.Optional<Integer> vendorId,
                                                                                         com.google.common.base.Optional<Integer> productId,
                                                                                         com.google.common.base.Optional<String> serialNumber)

Builder for hardware wallets communicating over USB HID using static binding

Parameters:

hardwareWalletClass - The hardware wallet class

vendorId - The vendor ID (uses default if absent)

productId - The product ID (uses default if absent)

serialNumber - The device serial number (accepts any if absent)

Returns:

A new hardware wallet specification suitable for use with sockets

getClassName

public String getClassName()

Returns:

The hardware wallet class name for loading at runtime

getParameter

public Object getParameter(String key)

Parameters:

key - The key into the parameter map (recommend using the provided standard static entries)

Returns:

Any additional hardware wallet specific parameters that the client may consume to configure the device

setSpecificParameters

public void setSpecificParameters(Map<String,Object> specificParameters)

Parameters:

specificParameters - The map of hardware wallet specific parameters

isUsb

public boolean isUsb()

Returns:

True if the physical link is via the USB human interface device hardware

setUsb

public void setUsb(boolean isUsb)

Parameters:

isUsb - True for USB hardware

getVendorId

public com.google.common.base.Optional<Integer> getVendorId()

Returns:

The optional USB vendor ID

setVendorId

public void setVendorId(com.google.common.base.Optional<Integer> vendorId)

Parameters:

vendorId - The USB vendor ID. If absent then the device-specific default is used.

getProductId

public com.google.common.base.Optional<Integer> getProductId()

Returns:

The optional USB product ID

setProductId

public void setProductId(com.google.common.base.Optional<Integer> productId)

Parameters:

productId - The USB product ID. If absent then the device-specific default is used.

getSerialNumber

public com.google.common.base.Optional<String> getSerialNumber()

Returns:

The optional USB device serial number

setSerialNumber

public void setSerialNumber(com.google.common.base.Optional<String> serialNumber)

Parameters:

serialNumber - The USB serial number. If absent then any serial number will be accepted.

getHost

public String getHost()

Get the host name of the server providing socket access to the device (e.g. "example.org", "localhost").

Returns:

The host name

setHost

public void setHost(String host)

Set the host name of the server providing socket access to the device

Parameters:

host - The host name

getPort

public int getPort()

Get the port number of the server providing direct socket data (e.g. "1337").

Returns:

The port number

setPort

public void setPort(int port)

Set the port number of the server providing direct socket data (e.g. "1337").

Parameters:

port - The port number

getName

public String getName()

Returns:

The hardware wallet name (e.g. "Trezor") for presentation to the user

setName

public void setName(String name)

Parameters:

name - The hardware wallet name (may be presented to the user)

getDescription

public String getDescription()

Returns:

The hardware wallet description (e.g. "BIP32 compliant hardware wallet") for presentation to the user

setDescription

public void setDescription(String description)

Parameters:

description - the hardwareWallet description