Package io.micronaut.security.authentication

Class AuthorizationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.micronaut.security.authentication.AuthorizationException

All Implemented Interfaces:

Serializable

public class AuthorizationException
extends RuntimeException

Exception thrown when access to a protected resource is denied.

Since:

1.4.0

Author:

James Kleeh

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AuthorizationException(@Nullable Authentication authentication)

Method Summary

Modifier and Type	Method	Description
@Nullable Authentication	getAuthentication()
boolean	isForbidden()

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

AuthorizationException

public AuthorizationException(@Nullable
 @Nullable Authentication authentication)

Parameters:

authentication - The authentication that was denied, null if unauthorized

Method Details

isForbidden

public boolean isForbidden()

Returns:

True if the request was authenticated

getAuthentication

@Nullable
public @Nullable Authentication getAuthentication()

Returns:

The authentication used in the request