Package org.jopensignature.sign

Interface SigningDevice

All Known Implementing Classes:

NativeColorDevice, NativeDevice, NativeG12Device, NativeG13Device, NativeMonochromeDevice, SoHeadlessSigningDevice, SoSigningDevice

public interface SigningDevice

Representation of a typically physical signing device.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SigningDevice.UnsupportedMessageException	Indicates a unsupported message sent using send(BaseMessage).

Method Summary

Modifier and Type	Method	Description
void	close()
SigningDeviceCapabilities	getCapabilities()	Returns the device capabilities.
java.lang.String	getIdentifier()	Returns a unique identifier of the SigningDevice.
SigningDeviceInfo	getInfo(java.util.Locale locale)
void	send(BaseMessage message)	Send the given BaseMessage instance to the device.

Method Detail

getCapabilities

SigningDeviceCapabilities getCapabilities()

Returns the device capabilities.

Returns:

getIdentifier

java.lang.String getIdentifier()

Returns a unique identifier of the SigningDevice. The SignatureServiceProvider implementation has to ensure that all the SigningDevices it returns have a unique identifier. Identifiers for SigningDevices coming from different SignatureServiceProviders might have overlapping identifiers.

Returns:

getInfo

SigningDeviceInfo getInfo(java.util.Locale locale)

Parameters:

locale - the locale in which the SigningDeviceInfo shall be returned. If locale is null, Locale.getDefault() shall be used. If there is no matching translation is available, the implementation shall use the closest substitute. How a substitute is selected is up to the implementation. We encourage to follow the guidelines of ResourceBundle.

send

void send(BaseMessage message)
   throws SigningDevice.UnsupportedMessageException

Send the given BaseMessage instance to the device. Some messages might require replies. Receiving replies may be achieved by sending messages extending ReplyableMessage.

Parameters:

message - the message to be sent

Throws:

java.lang.IllegalArgumentException - if message is null.

SigningDevice.UnsupportedMessageException - if the message is unsupported. Whether a message is supported or not, may be checked using getCapabilities(). isMessageSupported(Class)

close

void close()