-
Notifications
You must be signed in to change notification settings - Fork 53
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add ApiErrorResponseAccessDeniedHandler so users can configure this t…
…o have a consistent error response if a user does not have the correct role for a resource Fixes #88
- Loading branch information
1 parent
6f8cdab
commit 146ff78
Showing
3 changed files
with
116 additions
and
4 deletions.
There are no files selected for viewing
82 changes: 82 additions & 0 deletions
82
...ithub/wimdeblauwe/errorhandlingspringbootstarter/ApiErrorResponseAccessDeniedHandler.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
package io.github.wimdeblauwe.errorhandlingspringbootstarter; | ||
|
||
import com.fasterxml.jackson.databind.ObjectMapper; | ||
import io.github.wimdeblauwe.errorhandlingspringbootstarter.mapper.ErrorCodeMapper; | ||
import io.github.wimdeblauwe.errorhandlingspringbootstarter.mapper.ErrorMessageMapper; | ||
import io.github.wimdeblauwe.errorhandlingspringbootstarter.mapper.HttpStatusMapper; | ||
import jakarta.servlet.ServletException; | ||
import jakarta.servlet.http.HttpServletRequest; | ||
import jakarta.servlet.http.HttpServletResponse; | ||
import org.springframework.http.HttpStatus; | ||
import org.springframework.http.HttpStatusCode; | ||
import org.springframework.http.MediaType; | ||
import org.springframework.security.access.AccessDeniedException; | ||
import org.springframework.security.web.access.AccessDeniedHandler; | ||
|
||
import java.io.IOException; | ||
import java.nio.charset.StandardCharsets; | ||
|
||
/** | ||
* Use this {@link AccessDeniedHandler} implementation if you want to have a consistent response | ||
* with how this library works when the user is not allowed to access a resource. | ||
* <p> | ||
* It is impossible for the library to provide auto-configuration for this. So you need to manually add | ||
* this to your security configuration. For example: | ||
* | ||
* <pre> | ||
* public class WebSecurityConfiguration extends WebSecurityConfigurerAdapter {* | ||
* @Bean | ||
* public AccessDeniedHandler accessDeniedHandler(HttpStatusMapper httpStatusMapper, ErrorCodeMapper errorCodeMapper, ErrorMessageMapper errorMessageMapper, ObjectMapper objectMapper) { | ||
* return new ApiErrorResponseAccessDeniedHandler(objectMapper, httpStatusMapper, errorCodeMapper, errorMessageMapper); | ||
* } | ||
* | ||
* @Bean | ||
* public SecurityFilterChain securityFilterChain(HttpSecurity http, | ||
* AccessDeniedHandler accessDeniedHandler) throws Exception { | ||
* http.httpBasic().disable(); | ||
* | ||
* http.authorizeHttpRequests().anyRequest().authenticated(); | ||
* | ||
* http.exceptionHandling().accessDeniedHandler(accessDeniedHandler); | ||
* | ||
* return http.build(); | ||
* } | ||
* } | ||
* </pre> | ||
* | ||
* @see UnauthorizedEntryPoint | ||
*/ | ||
public class ApiErrorResponseAccessDeniedHandler implements AccessDeniedHandler { | ||
private final ObjectMapper objectMapper; | ||
private final HttpStatusMapper httpStatusMapper; | ||
private final ErrorCodeMapper errorCodeMapper; | ||
private final ErrorMessageMapper errorMessageMapper; | ||
|
||
public ApiErrorResponseAccessDeniedHandler(ObjectMapper objectMapper, HttpStatusMapper httpStatusMapper, ErrorCodeMapper errorCodeMapper, | ||
ErrorMessageMapper errorMessageMapper) { | ||
this.objectMapper = objectMapper; | ||
this.httpStatusMapper = httpStatusMapper; | ||
this.errorCodeMapper = errorCodeMapper; | ||
this.errorMessageMapper = errorMessageMapper; | ||
} | ||
|
||
@Override | ||
public void handle(HttpServletRequest request, HttpServletResponse response, AccessDeniedException accessDeniedException) | ||
throws IOException, ServletException { | ||
ApiErrorResponse errorResponse = createResponse(accessDeniedException); | ||
|
||
response.setStatus(errorResponse.getHttpStatus().value()); | ||
response.setContentType(MediaType.APPLICATION_JSON_VALUE); | ||
response.setCharacterEncoding(StandardCharsets.UTF_8.toString()); | ||
response.getWriter().write(objectMapper.writeValueAsString(errorResponse)); | ||
} | ||
|
||
public ApiErrorResponse createResponse(AccessDeniedException exception) { | ||
HttpStatusCode httpStatus = httpStatusMapper.getHttpStatus(exception, HttpStatus.FORBIDDEN); | ||
String code = errorCodeMapper.getErrorCode(exception); | ||
String message = errorMessageMapper.getErrorMessage(exception); | ||
|
||
return new ApiErrorResponse(httpStatus, code, message); | ||
} | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters