net.krotscheck.kangaroo.authz.admin.v1.auth.exception

Class WWWChallengeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

javax.ws.rs.WebApplicationException

net.krotscheck.kangaroo.common.exception.KangarooException

net.krotscheck.kangaroo.authz.admin.v1.auth.exception.WWWChallengeException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

OAuth2ForbiddenException, OAuth2NotAuthorizedException

public abstract class WWWChallengeException
extends KangarooException

Private, common implementation of all exceptions that need to return a WWW-Authenticate challenge.

Author:

Michael Krotscheck

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class net.krotscheck.kangaroo.common.exception.KangarooException

KangarooException.ErrorCode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WWWChallengeException(KangarooException.ErrorCode code, javax.ws.rs.core.UriInfo requestInfo, String[] requiredScopes) Create a new exception with the specified error code.

Method Summary

Modifier and Type	Method and Description
URI	getRealm() The URI Realm.
String[]	getRequiredScopes() Get the required scopes.

Methods inherited from class net.krotscheck.kangaroo.common.exception.KangarooException

getCode

Methods inherited from class javax.ws.rs.WebApplicationException

getResponse

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

WWWChallengeException

protected WWWChallengeException(KangarooException.ErrorCode code,
                                javax.ws.rs.core.UriInfo requestInfo,
                                String[] requiredScopes)

Create a new exception with the specified error code.

Parameters:

code - The error code enum type.

requestInfo - The original URI request, from which we're going to derive our realm.

requiredScopes - A list of required scopes.

Method Detail

getRequiredScopes

public final String[] getRequiredScopes()

Get the required scopes.

Returns:

List of required scopes.

getRealm

public final URI getRealm()

The URI Realm.

Returns:

URI of the authorization realm.