Package io.github.belgif.rest.problem

Class MissingScopeProblem

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.github.belgif.rest.problem.api.Problem

io.github.belgif.rest.problem.api.ClientProblem

io.github.belgif.rest.problem.MissingScopeProblem

All Implemented Interfaces:

FluentProblem<MissingScopeProblem>, HttpResponseHeaders, Serializable

public class MissingScopeProblem
extends ClientProblem
implements FluentProblem<MissingScopeProblem>, HttpResponseHeaders

HTTP 403: Missing Scope (https://www.belgif.be/specification/rest/api-guide/problems/missingScope.html)

See Also:

• https://www.belgif.be/specification/rest/api-guide/#missing-scope
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final URI	HREF	The href URI.
static final int	STATUS	The status.
static final String	TITLE	The title.
static final String	TYPE	The problem type.
static final URI	TYPE_URI	The problem type URI.

Fields inherited from interface io.github.belgif.rest.problem.api.HttpResponseHeaders

RETRY_AFTER, WWW_AUTHENTICATE

Constructor Summary

Constructors

Constructor	Description
MissingScopeProblem()
MissingScopeProblem(String... requiredScopes)

Method Summary

Modifier and Type	Method	Description
void	addRequiredScope(String requiredScope)
boolean	equals(Object o)
Map<String,Object>	getHttpResponseHeaders()	Return the HTTP response headers.
List<String>	getRequiredScopes()
int	hashCode()
MissingScopeProblem	realm(String realm)
void	setRequiredScopes(String... requiredScopes)
void	setRequiredScopes(List<String> requiredScopes)

Methods inherited from class io.github.belgif.rest.problem.api.Problem

getAdditionalProperties, getDetail, getHref, getInstance, getMessage, getStatus, getTitle, getType, setAdditionalProperty, setDetail, setHref, setInstance

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.github.belgif.rest.problem.api.FluentProblem

additionalProperty, detail, href, instance, setAdditionalProperty, setDetail, setHref, setInstance

Field Details

TYPE

public static final String TYPE

The problem type.

See Also:

• Constant Field Values

TYPE_URI

public static final URI TYPE_URI

The problem type URI.

HREF

public static final URI HREF

The href URI.

TITLE

public static final String TITLE

The title.

See Also:

• Constant Field Values

STATUS

public static final int STATUS

The status.

See Also:

• Constant Field Values

Constructor Details

MissingScopeProblem

public MissingScopeProblem()

MissingScopeProblem

public MissingScopeProblem(String... requiredScopes)

Method Details

realm

public MissingScopeProblem realm(String realm)

getRequiredScopes

public List<String> getRequiredScopes()

setRequiredScopes

public void setRequiredScopes(List<String> requiredScopes)

setRequiredScopes

public void setRequiredScopes(String... requiredScopes)

addRequiredScope

public void addRequiredScope(String requiredScope)

equals

public boolean equals(Object o)

Overrides:

equals in class Problem

hashCode

public int hashCode()

Overrides:

hashCode in class Problem

getHttpResponseHeaders

public Map<String,Object> getHttpResponseHeaders()

Description copied from interface: HttpResponseHeaders

Return the HTTP response headers.

Specified by:

getHttpResponseHeaders in interface HttpResponseHeaders

Returns:

the HTTP response headers