Package org.apache.juneau.bean.rfc7807

Class ProblemException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.apache.juneau.bean.rfc7807.ProblemException

All Implemented Interfaces:

Serializable

public class ProblemException
extends RuntimeException

A RuntimeException that carries an RFC 7807 Problem payload.

Lets handlers throw a custom problem without manually building a BasicHttpException:

throw new ProblemException( Problem.fromStatus(403, "Insufficient credit", "Balance 30 < cost 50") .set("balance", 30) );

The wrapped Problem is recovered via getProblem(). Lives in the bean module (no juneau-rest-server dep); the server-side processor recognises ProblemException and unwraps it for serialization.

See Also:

• Problem
• juneau-bean-rfc7807

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ProblemException(Problem problem)	Constructor.

Method Summary

Modifier and Type	Method	Description
Problem	getProblem()	Returns the wrapped Problem payload.
static ProblemException	of(Problem problem)	Convenience factory.

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

ProblemException

public ProblemException(Problem problem)

Constructor.

Parameters:

problem - The problem payload to carry. May be null, though callers should normally supply a populated Problem.

Method Details

of

public static ProblemException of(Problem problem)

Convenience factory.

Parameters:

problem - The problem payload to carry. May be null.

Returns:

A new ProblemException wrapping problem.

getProblem

public Problem getProblem()

Returns the wrapped Problem payload.

Returns:

The problem payload, or null if none was supplied at construction.