org.shredzone.acme4j.exception

Class AcmeAgreementRequiredException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.shredzone.acme4j.exception.AcmeException

org.shredzone.acme4j.exception.AcmeServerException

org.shredzone.acme4j.exception.AcmeAgreementRequiredException

All Implemented Interfaces:

Serializable

public class AcmeAgreementRequiredException
extends AcmeServerException

An exception that is thrown when the client needs to accept the terms of service in order to continue.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AcmeAgreementRequiredException(String type, String detail, URI agreementUri, URI instance) Creates a new AcmeAgreementRequiredException.

Method Summary

Modifier and Type	Method and Description
URI	getAgreementUri() Returns the URI of the agreement document to accept, or null if the server did not provide a link to such a document.
URI	getInstance() Returns the URI of a document showing a human how to agree to the terms and conditions, or null if the server did not provide such a link.

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

getAcmeErrorType, getType

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 Detail

AcmeAgreementRequiredException

public AcmeAgreementRequiredException(String type,
                                      String detail,
                                      URI agreementUri,
                                      URI instance)

Creates a new AcmeAgreementRequiredException.

Parameters:

type - System readable error type (here "urn:ietf:params:acme:error:agreementRequired")

detail - Human readable error message

agreementUri - URI of the agreement document to accept

instance - URI to be visited by a human, showing instructions for how to agree to the terms and conditions.

Method Detail

getAgreementUri

public URI getAgreementUri()

Returns the URI of the agreement document to accept, or null if the server did not provide a link to such a document.

getInstance

public URI getInstance()

Returns the URI of a document showing a human how to agree to the terms and conditions, or null if the server did not provide such a link.