Package com.nimbusds.jose

Class ActionRequiredForJWSCompletionException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.nimbusds.jose.JOSEException

com.nimbusds.jose.ActionRequiredForJWSCompletionException

All Implemented Interfaces:

Serializable

public class ActionRequiredForJWSCompletionException
extends JOSEException

Action required for JWS completion. Can be used to signal a user authentication requirement in Android to unlock a private signing key created with setUserAuthenticationRequired(true).

Version:

2024-04-20

Author:

Vladimir Dzhuvinov

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ActionRequiredForJWSCompletionException(String message, JWSSignerOption option, CompletableJWSObjectSigning completableSigning)	Creates a new action required for JWS completion exception.

Method Summary

Modifier and Type	Method	Description
CompletableJWSObjectSigning	getCompletableJWSObjectSigning()	Returns an interface to complete the JWS object signing after the required action is performed.
JWSSignerOption	getTriggeringOption()	Returns the JWS signer option that triggered this exception.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Details

ActionRequiredForJWSCompletionException

public ActionRequiredForJWSCompletionException(String message,
 JWSSignerOption option,
 CompletableJWSObjectSigning completableSigning)

Creates a new action required for JWS completion exception.

Parameters:

message - The exception message.

option - The JWS signer option that triggered the exception.

completableSigning - To complete the JWS object signing after the required action.

Method Details

getTriggeringOption

public JWSSignerOption getTriggeringOption()

Returns the JWS signer option that triggered this exception.

Returns:

The JWS signer option.

getCompletableJWSObjectSigning

public CompletableJWSObjectSigning getCompletableJWSObjectSigning()

Returns an interface to complete the JWS object signing after the required action is performed.

Returns:

The completable JWS object signing.