Package io.micronaut.security.oauth2.endpoint.authorization.response

Class AuthorizationErrorResponseExceptionHandler

java.lang.Object

io.micronaut.security.oauth2.endpoint.authorization.response.AuthorizationErrorResponseExceptionHandler

All Implemented Interfaces:

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

@Singleton
public class AuthorizationErrorResponseExceptionHandler
extends java.lang.Object
implements io.micronaut.http.server.exceptions.ExceptionHandler<AuthorizationErrorResponseException,io.micronaut.http.MutableHttpResponse<?>>

An exception handler for AuthorizationErrorResponseException.

Since:

1.2.0

Constructor Summary

Constructors

Constructor	Description
AuthorizationErrorResponseExceptionHandler()	Deprecated. This will be removed in the next major version, so that this class uses the ErrorProcessor API
AuthorizationErrorResponseExceptionHandler(io.micronaut.security.config.RedirectConfiguration redirectConfiguration, io.micronaut.security.config.RedirectService redirectService, io.micronaut.http.server.exceptions.response.ErrorResponseProcessor<?> errorResponseProcessor)

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	getRedirectUri(io.micronaut.http.HttpRequest<?> request, AuthorizationErrorResponseException exception)
io.micronaut.http.MutableHttpResponse<?>	handle(io.micronaut.http.HttpRequest request, AuthorizationErrorResponseException exception)
protected io.micronaut.http.MutableHttpResponse<?>	httpResponseWithStatus(io.micronaut.http.HttpRequest<?> request, AuthorizationErrorResponseException exception)
protected io.micronaut.http.MutableHttpResponse<?>	httpResponseWithStatus(java.net.URI location)	Builds a HTTP Response redirection to the supplied location.
protected boolean	shouldRedirect(io.micronaut.http.HttpRequest<?> request, AuthorizationErrorResponseException 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 Detail

AuthorizationErrorResponseExceptionHandler

@Inject
public AuthorizationErrorResponseExceptionHandler(@Nullable
                                                  io.micronaut.security.config.RedirectConfiguration redirectConfiguration,
                                                  @Nullable
                                                  io.micronaut.security.config.RedirectService redirectService,
                                                  @Nullable
                                                  io.micronaut.http.server.exceptions.response.ErrorResponseProcessor<?> errorResponseProcessor)

Parameters:

redirectConfiguration - Redirect Configuration

redirectService - Redirect Service

errorResponseProcessor - Error Response Processor

AuthorizationErrorResponseExceptionHandler

@Deprecated
public AuthorizationErrorResponseExceptionHandler()

Deprecated.

This will be removed in the next major version, so that this class uses the ErrorProcessor API

Default constructor.

Method Detail

handle

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

Specified by:

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

httpResponseWithStatus

@NonNull
protected io.micronaut.http.MutableHttpResponse<?> httpResponseWithStatus(@NonNull
                                                                          java.net.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

httpResponseWithStatus

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

Parameters:

request - The request

exception - The exception

Returns:

The response to be used when a redirect is not appropriate

getRedirectUri

@NonNull
protected java.lang.String getRedirectUri(@NonNull
                                          io.micronaut.http.HttpRequest<?> request,
                                          @NonNull
                                          AuthorizationErrorResponseException exception)

Parameters:

request - The request

exception - The exception

Returns:

The URI to redirect to

shouldRedirect

protected boolean shouldRedirect(@NonNull
                                 io.micronaut.http.HttpRequest<?> request,
                                 @NonNull
                                 AuthorizationErrorResponseException 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