com.gemalto.idp.mobile.otp.dsformatting

Interface DsFormattingDevice

public interface DsFormattingDevice

An interface representing a Dynamic Signature (DS) device.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
DsCapParameters	getCapParameters(SecureString challenge, Template.DomainType domain, DsCapParameters.DsCapMode capMode, DsTransactionData dsTransactionData) Get the CAP parameters for the given DS challenge and associated transaction data.
DsCapParameters	getCapParameters(Template.DomainType domain, DsCapParameters.DsCapMode capMode, DsTransactionData dsTransactionData) Get the CAP parameters for the given DS transaction data.
<T extends Primitive> T	getPrimitive(String name) Get a primitive for the given tag name.
Template	getTemplate(int templateId) Get a DS template by id.
Template	getTemplate(SecureString challenge) Get a DS template from a challenge.

Method Detail

getTemplate

Template getTemplate(SecureString challenge)
              throws InvalidDigitChecksumException

Get a DS template from a challenge. If the challenge does not map to a template then the returned template will have the empty list for primitives.

Parameters:

challenge - the challenge

Returns:

the template, null if no template was encoded in the challenge

Throws:

InvalidDigitChecksumException - when a computed check digit does not match the given check digit.

getTemplate

Template getTemplate(int templateId)

Get a DS template by id.

Parameters:

templateId - the id of the template

Returns:

the template, null if no template was found with that id

getPrimitive

<T extends Primitive> T getPrimitive(String name)

Get a primitive for the given tag name.

Parameters:

name - the name of the primitive as defined in the JSON configuration file.

Returns:

the primitive

getCapParameters

DsCapParameters getCapParameters(SecureString challenge,
                                 Template.DomainType domain,
                                 DsCapParameters.DsCapMode capMode,
                                 DsTransactionData dsTransactionData)
                          throws InvalidDigitChecksumException

Get the CAP parameters for the given DS challenge and associated transaction data.

Parameters:

challenge - the challenge or null if there is no challenge.

domain - the template domain. Can only be Template.DomainType.CONNECTED or Template.DomainType.SWYS if challenge is null.

capMode - the CAP mode to generate input data for

dsTransactionData - the template transaction data or null if there is no transaction data.

Returns:

the CAP input parameters

Throws:

IllegalArgumentException - when the challenge does not correspond to the transaction data (only applies if the challenge is non-null).

InvalidDigitChecksumException - when a computed check digit does not match the given check digit.

getCapParameters

DsCapParameters getCapParameters(Template.DomainType domain,
                                 DsCapParameters.DsCapMode capMode,
                                 DsTransactionData dsTransactionData)
                          throws InvalidDigitChecksumException

Get the CAP parameters for the given DS transaction data.

Parameters:

domain - the template domain. Can only be Template.DomainType.CONNECTED or Template.DomainType.SWYS.

capMode - the CAP mode to generate input data for

dsTransactionData - the template transaction data or null if there is no transaction data.

Returns:

the CAP input parameters

Throws:

InvalidDigitChecksumException - when a computed check digit does not match the given check digit.