Package com.pdftools.crypto.providers.swisscomsigsrv

Class StepUp

java.lang.Object

com.pdftools.internal.NativeBase

com.pdftools.internal.NativeObject

com.pdftools.crypto.providers.swisscomsigsrv.StepUp

public class StepUp
extends NativeObject

The options for step-up authorization using Mobile ID

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	StepUp.ConsentRequired	Event containing the URL for step-up authentication using password and SMS challenge (OTP).
static interface	StepUp.ConsentRequiredListener	Listener interface for the StepUp.ConsentRequired event.

Constructor Summary

Constructors

Constructor	Description
StepUp(java.lang.String msisdn, java.lang.String message, java.lang.String language)

Method Summary

Modifier and Type	Method	Description
void	addConsentRequiredListener(StepUp.ConsentRequiredListener listener)	Add a listener for the StepUp.ConsentRequired event.
java.lang.String	getLanguage()	The language of the message (Getter)
java.lang.String	getMessage()	The message to be displayed on the mobile phone (Getter)
java.lang.String	getMSISDN()	The mobile phone number (Getter)
void	removeConsentRequiredListener(StepUp.ConsentRequiredListener listener)	Remove registered listener for the StepUp.ConsentRequired event.
void	setLanguage(java.lang.String value)	The language of the message (Setter)
void	setMessage(java.lang.String value)	The message to be displayed on the mobile phone (Setter)
void	setMSISDN(java.lang.String value)	The mobile phone number (Setter)

Methods inherited from class com.pdftools.internal.NativeObject

equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StepUp

public StepUp(java.lang.String msisdn,
              java.lang.String message,
              java.lang.String language)

Parameters:

msisdn - The mobile phone number

message - The message to be displayed on the mobile phone

language - The language of the message

Throws:

java.lang.IllegalArgumentException - if msisdn is null

java.lang.IllegalArgumentException - if message is null

java.lang.IllegalArgumentException - if language is null

Method Detail

addConsentRequiredListener

public void addConsentRequiredListener(StepUp.ConsentRequiredListener listener)

Add a listener for the StepUp.ConsentRequired event.

Parameters:

listener - Listener for the StepUp.ConsentRequired event. If a listener is added that is already registered, it is ignored.

removeConsentRequiredListener

public void removeConsentRequiredListener(StepUp.ConsentRequiredListener listener)

Remove registered listener for the StepUp.ConsentRequired event.

Parameters:

listener - Listener for the StepUp.ConsentRequired event that should be removed. If the listener is not registered, it is ignored.

getMSISDN

public java.lang.String getMSISDN()

The mobile phone number (Getter)

Example: "+41798765432"

setMSISDN

public void setMSISDN(java.lang.String value)

The mobile phone number (Setter)

Example: "+41798765432"

Throws:

java.lang.IllegalArgumentException - if value is null

getMessage

public java.lang.String getMessage()

The message to be displayed on the mobile phone (Getter)

Example: "Do you authorize your signature on Contract.pdf?"

setMessage

public void setMessage(java.lang.String value)

The message to be displayed on the mobile phone (Setter)

Example: "Do you authorize your signature on Contract.pdf?"

Throws:

java.lang.IllegalArgumentException - if value is null

getLanguage

public java.lang.String getLanguage()

The language of the message (Getter)

Example: "DE"

setLanguage

public void setLanguage(java.lang.String value)

The language of the message (Setter)

Example: "DE"

Throws:

java.lang.IllegalArgumentException - if value is null