Open Source Repository

Home /spring/spring-web-servlet-3.0.5 | Repository Home



org/springframework/web/servlet/handler/UserRoleAuthorizationInterceptor.java
/*
 * Copyright 2002-2008 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.web.servlet.handler;

import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * Interceptor that checks the authorization of the current user via the
 * user's roles, as evaluated by HttpServletRequest's isUserInRole method.
 *
 @author Juergen Hoeller
 @since 20.06.2003
 @see javax.servlet.http.HttpServletRequest#isUserInRole
 */
public class UserRoleAuthorizationInterceptor extends HandlerInterceptorAdapter {

  private String[] authorizedRoles;


  /**
   * Set the roles that this interceptor should treat as authorized.
   @param authorizedRoles array of role names
   */
  public final void setAuthorizedRoles(String[] authorizedRoles) {
    this.authorizedRoles = authorizedRoles;
  }


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

    if (this.authorizedRoles != null) {
      for (String role : this.authorizedRoles) {
        if (request.isUserInRole(role)) {
          return true;
        }
      }
    }
    handleNotAuthorized(request, response, handler);
    return false;
  }

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

    response.sendError(HttpServletResponse.SC_FORBIDDEN);
  }

}