Spring Framework 6.1.4 · org.springframework.web.servlet.handler.UserRoleAuthorizationInterceptor

Modifier and Type	Field and Description
private String[]	authorizedRoles

Access	Constructor and Description
public	UserRoleAuthorizationInterceptor()

Method Summary

Modifier and Type	Method and Description
protected void	handleNotAuthorized(HttpServletRequest current HTTP request request, HttpServletResponse current HTTP response response, Object chosen handler to execute, for type and/or instance evaluation handler) Handle a request that is not authorized according to this interceptor.
public final boolean	preHandle(HttpServletRequest current HTTP request request, HttpServletResponse current HTTP response response, Object chosen handler to execute, for type and/or instance evaluation handler) Overrides default org.springframework.web.servlet.HandlerInterceptor.preHandle. Interception point before the execution of a handler.
public final void	setAuthorizedRoles(String... array of role names authorizedRoles) Set the roles that this interceptor should treat as authorized.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

authorizedRoles	back to summary
private String[] authorizedRoles Annotations @Nullable

UserRoleAuthorizationInterceptor	back to summary
public UserRoleAuthorizationInterceptor()

Method Detail

handleNotAuthorized	back to summary
protected void handleNotAuthorized(HttpServletRequest request, HttpServletResponse response, Object handler) throws ServletException, IOException Handle a request that is not authorized according to this interceptor. Default implementation sends HTTP status code 403 ("forbidden"). This method can be overridden to write a custom message, forward or redirect to some error page or login page, or throw a ServletException. Parameters request:HttpServletRequest current HTTP request response:HttpServletResponse current HTTP response handler:Object chosen handler to execute, for type and/or instance evaluation Exceptions ServletException: if there is an internal error IOException: in case of an I/O error when writing the response

handleNotAuthorized

back to summary

protected void handleNotAuthorized(HttpServletRequest request, HttpServletResponse response, Object handler) throws ServletException, IOException

Handle a request that is not authorized according to this interceptor. Default implementation sends HTTP status code 403 ("forbidden").

This method can be overridden to write a custom message, forward or redirect to some error page or login page, or throw a ServletException.

Parameters

request:HttpServletRequest: current HTTP request
response:HttpServletResponse: current HTTP response
handler:Object: chosen handler to execute, for type and/or instance evaluation

Exceptions

ServletException:: if there is an internal error
IOException:: in case of an I/O error when writing the response

preHandle back to summary

preHandle	back to summary
public final boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws ServletException, IOException Overrides default org.springframework.web.servlet.HandlerInterceptor.preHandle. Doc from org.springframework.web.servlet.HandlerInterceptor.preHandle. Interception point before the execution of a handler. Called after HandlerMapping determined an appropriate handler object, but before HandlerAdapter invokes the handler. DispatcherServlet processes a handler in an execution chain, consisting of any number of interceptors, with the handler itself at the end. With this method, each interceptor can decide to abort the execution chain, typically sending an HTTP error or writing a custom response. Note special considerations apply for asynchronous request processing. For more details see `org.springframework.web.servlet.AsyncHandlerInterceptor`. The default implementation returns `true`. Parameters request:HttpServletRequest current HTTP request response:HttpServletResponse current HTTP response handler:Object chosen handler to execute, for type and/or instance evaluation Returns:boolean `true` if the execution chain should proceed with the next interceptor or the handler itself. Else, DispatcherServlet assumes that this interceptor has already dealt with the response itself. Annotations @Override

public final boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws ServletException, IOException

Overrides default org.springframework.web.servlet.HandlerInterceptor.preHandle.

Doc from org.springframework.web.servlet.HandlerInterceptor.preHandle.

Interception point before the execution of a handler. Called after HandlerMapping determined an appropriate handler object, but before HandlerAdapter invokes the handler.

DispatcherServlet processes a handler in an execution chain, consisting of any number of interceptors, with the handler itself at the end. With this method, each interceptor can decide to abort the execution chain, typically sending an HTTP error or writing a custom response.

Note

special considerations apply for asynchronous request processing. For more details see org.springframework.web.servlet.AsyncHandlerInterceptor.

The default implementation returns true.

Parameters

request:HttpServletRequest: current HTTP request
response:HttpServletResponse: current HTTP response
handler:Object: chosen handler to execute, for type and/or instance evaluation

Returns:boolean

true if the execution chain should proceed with the next interceptor or the handler itself. Else, DispatcherServlet assumes that this interceptor has already dealt with the response itself.

Annotations

@Override

setAuthorizedRoles	back to summary
public final void setAuthorizedRoles(String... authorizedRoles) Set the roles that this interceptor should treat as authorized. Parameters authorizedRoles:String[] array of role names

setAuthorizedRoles

back to summary

public final void setAuthorizedRoles(String... authorizedRoles)

Set the roles that this interceptor should treat as authorized.

Parameters

authorizedRoles:String[]: array of role names

public Class UserRoleAuthorizationInterceptor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail