Module org.shredzone.acme4j

Package org.shredzone.acme4j.exception

Class AcmeUserActionRequiredException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.shredzone.acme4j.exception.AcmeException

org.shredzone.acme4j.exception.AcmeServerException

org.shredzone.acme4j.exception.AcmeUserActionRequiredException

All Implemented Interfaces:

Serializable

public class AcmeUserActionRequiredException
extends AcmeServerException

The user is required to take manual action as indicated.

Usually this exception is thrown when the terms of service have changed, and the CA requires an agreement to the new terms before proceeding.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AcmeUserActionRequiredException(Problem problem, URI tosUri)	Creates a new AcmeUserActionRequiredException.

Method Summary

Modifier and Type	Method	Description
URL	getInstance()	Returns the URL of a document that gives instructions on the actions to be taken by a human.
Optional<URI>	getTermsOfServiceUri()	Returns the URI of the terms-of-service document to accept.
String	toString()

Methods inherited from class org.shredzone.acme4j.exception.AcmeServerException

getProblem, getType

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Details

AcmeUserActionRequiredException

public AcmeUserActionRequiredException(Problem problem,
 @Nullable
 URI tosUri)

Creates a new AcmeUserActionRequiredException.

Parameters:

problem - Problem that caused the exception

tosUri - URI of the terms-of-service document to accept, may be null

Method Details

getTermsOfServiceUri

public Optional<URI> getTermsOfServiceUri()

Returns the URI of the terms-of-service document to accept. Empty if the server did not provide a link to such a document.

getInstance

public URL getInstance()

Returns the URL of a document that gives instructions on the actions to be taken by a human.

toString

public String toString()

Overrides:

toString in class Throwable