Package io.micronaut.security.authentication

Class DefaultAuthorizationExceptionHandler

java.lang.Object

io.micronaut.security.authentication.DefaultAuthorizationExceptionHandler

All Implemented Interfaces:

io.micronaut.http.server.exceptions.ExceptionHandler<AuthorizationException,io.micronaut.http.MutableHttpResponse<?>>

@Requires(classes=io.micronaut.http.server.exceptions.ExceptionHandler.class)
@Singleton
public class DefaultAuthorizationExceptionHandler
extends Object
implements io.micronaut.http.server.exceptions.ExceptionHandler<AuthorizationException,io.micronaut.http.MutableHttpResponse<?>>

Provides the default behavior for responding to an AuthorizationException.

Since:

1.4.0

Author:

James Kleeh

Constructor Summary

Constructors

Constructor	Description
DefaultAuthorizationExceptionHandler(io.micronaut.http.server.exceptions.response.ErrorResponseProcessor<?> errorResponseProcessor, RedirectConfiguration redirectConfiguration, RedirectService redirectService, @Nullable PriorToLoginPersistence priorToLoginPersistence)	Deprecated, for removal: This API element is subject to removal in a future version. Use DefaultAuthorizationExceptionHandler(io.micronaut.http.server.exceptions.response.ErrorResponseProcessor<?>,io.micronaut.security.config.RedirectConfiguration,io.micronaut.security.config.RedirectService,java.util.List<io.micronaut.security.authentication.WwwAuthenticateChallengeProvider<io.micronaut.http.HttpRequest<?>>>,@io.micronaut.core.annotation.Nullable io.micronaut.security.errors.PriorToLoginPersistence) instead.
DefaultAuthorizationExceptionHandler(io.micronaut.http.server.exceptions.response.ErrorResponseProcessor<?> errorResponseProcessor, RedirectConfiguration redirectConfiguration, RedirectService redirectService, List<WwwAuthenticateChallengeProvider<io.micronaut.http.HttpRequest<?>>> wwwAuthenticateChallengeProviders, @Nullable PriorToLoginPersistence priorToLoginPersistence)

Method Summary

Modifier and Type	Method	Description
protected String	getRedirectUri(io.micronaut.http.HttpRequest<?> request, AuthorizationException exception)
io.micronaut.http.MutableHttpResponse<?>	handle(io.micronaut.http.HttpRequest request, AuthorizationException exception)
protected io.micronaut.http.MutableHttpResponse<?>	httpResponseWithStatus(io.micronaut.http.HttpRequest<?> request, AuthorizationException exception)
protected io.micronaut.http.MutableHttpResponse<?>	httpResponseWithStatus(URI location)	Builds a HTTP Response redirection to the supplied location.
protected boolean	shouldRedirect(io.micronaut.http.HttpRequest<?> request, AuthorizationException exception)	Decides whether the request should be handled with a redirect.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultAuthorizationExceptionHandler

@Inject
public DefaultAuthorizationExceptionHandler(io.micronaut.http.server.exceptions.response.ErrorResponseProcessor<?> errorResponseProcessor,
 RedirectConfiguration redirectConfiguration,
 RedirectService redirectService,
 List<WwwAuthenticateChallengeProvider<io.micronaut.http.HttpRequest<?>>> wwwAuthenticateChallengeProviders,
 @Nullable
 @Nullable PriorToLoginPersistence priorToLoginPersistence)

Parameters:

errorResponseProcessor - ErrorResponse processor API

redirectConfiguration - Redirect configuration

redirectService - Redirection Service

wwwAuthenticateChallengeProviders - WWW-Authenticate Challenges

priorToLoginPersistence - Persistence mechanism to redirect to prior login url

DefaultAuthorizationExceptionHandler

@Deprecated(forRemoval=true,
            since="4.14.0")
public DefaultAuthorizationExceptionHandler(io.micronaut.http.server.exceptions.response.ErrorResponseProcessor<?> errorResponseProcessor,
 RedirectConfiguration redirectConfiguration,
 RedirectService redirectService,
 @Nullable
 @Nullable PriorToLoginPersistence priorToLoginPersistence)

Deprecated, for removal: This API element is subject to removal in a future version.

Use DefaultAuthorizationExceptionHandler(io.micronaut.http.server.exceptions.response.ErrorResponseProcessor<?>,io.micronaut.security.config.RedirectConfiguration,io.micronaut.security.config.RedirectService,java.util.List<io.micronaut.security.authentication.WwwAuthenticateChallengeProvider<io.micronaut.http.HttpRequest<?>>>,@io.micronaut.core.annotation.Nullable io.micronaut.security.errors.PriorToLoginPersistence) instead.

Parameters:

errorResponseProcessor - ErrorResponse processor API

redirectConfiguration - Redirect configuration

redirectService - Redirection Service

priorToLoginPersistence - Persistence mechanism to redirect to prior login url

Method Details

handle

public io.micronaut.http.MutableHttpResponse<?> handle(io.micronaut.http.HttpRequest request,
 AuthorizationException exception)

Specified by:

handle in interface io.micronaut.http.server.exceptions.ExceptionHandler<AuthorizationException,io.micronaut.http.MutableHttpResponse<?>>

httpResponseWithStatus

protected io.micronaut.http.MutableHttpResponse<?> httpResponseWithStatus(io.micronaut.http.HttpRequest<?> request,
 AuthorizationException exception)

Parameters:

request - The request

exception - The exception

Returns:

The response to be used when a redirect is not appropriate

shouldRedirect

protected boolean shouldRedirect(io.micronaut.http.HttpRequest<?> request,
 AuthorizationException exception)

Decides whether the request should be handled with a redirect.

Parameters:

request - The HTTP Request

exception - The authorization exception

Returns:

true if the request accepts text/html

getRedirectUri

protected String getRedirectUri(io.micronaut.http.HttpRequest<?> request,
 AuthorizationException exception)

Parameters:

request - The request

exception - The exception

Returns:

The URI to redirect to

httpResponseWithStatus

protected io.micronaut.http.MutableHttpResponse<?> httpResponseWithStatus(URI location)

Builds a HTTP Response redirection to the supplied location.

Parameters:

location - The Uri to redirect to

Returns:

an HTTP response with the Uri as location