yakworks.problem

Interface IProblem

All Superinterfaces:

yakworks.i18n.MsgKey, yakworks.i18n.MsgKeyDecorator, Result

All Known Subinterfaces:

IProblem.Fluent<E>

public interface IProblem
extends Result

Simple interface for problem getters

See Also:

RFC 7807: Problem Details for HTTP APIs

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IProblem.Fluent<E extends IProblem.Fluent>

Method Summary

Modifier and Type	Method and Description
default java.lang.String	getDetail() A human readable explanation specific to this occurrence of the problem.
default java.net.URI	getInstanceURI() An absolute URI that identifies the specific occurrence of the problem.
default yakworks.i18n.MsgKey	getMsg()
default java.lang.Boolean	getOk() success or fail? if ok is true then it still may mean that there are warnings and needs to be looked into
default java.net.URI	getType() An absolute URI that identifies the problem type.
default java.util.List<Violation>	getViolations() The list of constraint violations or any others
default void	setDetail(java.lang.String v)
default void	setType(java.net.URI v)
default void	setViolations(java.util.List<Violation> v)

Methods inherited from interface yakworks.api.Result

get, getDefaultCode, getPayload, getStatus, getTitle, getValue, of, of, ofCode, OK, setPayload, setStatus, setTitle

Methods inherited from interface yakworks.i18n.MsgKeyDecorator

getArgs, getCode, setArgs, setCode, setMsg

Methods inherited from interface yakworks.i18n.MsgKey

getFallbackMessage, setArgs, setFallbackMessage

Method Detail

getOk

default java.lang.Boolean getOk()

Description copied from interface: Result

success or fail? if ok is true then it still may mean that there are warnings and needs to be looked into

Specified by:

getOk in interface Result

getMsg

default yakworks.i18n.MsgKey getMsg()

Specified by:

getMsg in interface yakworks.i18n.MsgKeyDecorator

getType

default java.net.URI getType()

An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type (e.g., using HTML). When this member is not present, its value is assumed to be "about:blank".

Returns:

an absolute URI that identifies this problem's type

setType

default void setType(java.net.URI v)

getDetail

default java.lang.String getDetail()

A human readable explanation specific to this occurrence of the problem.

Returns:

A human readable explaination of this problem

setDetail

default void setDetail(java.lang.String v)

getViolations

default java.util.List<Violation> getViolations()

The list of constraint violations or any others

setViolations

default void setViolations(java.util.List<Violation> v)

getInstanceURI

default java.net.URI getInstanceURI()

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.