HttpAuthProvider.java

/*
 * Copyright (C) 2013 Google Inc.
 *
 * 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 interactivespaces.service.web.server;

/**
 * A handler for authorizing HTTP requests (generated by dbarnard)
 */
public interface HttpAuthProvider {

  /**
   * Check whether request is authorized or not.
   *
   * @param request
   *          The request to authorize
   *
   * @return An auth response which well contain information on the user who
   *         made this request, whether or not the request is authorized and the
   *         ridirect url to send the user to if they need to log in.
   *
   *         <p>
   *         Implementations of this function should be thread safe.
   *
   */
  HttpAuthResponse authorizeRequest(HttpRequest request);

}