lang/java/reef-webserver/src/main/java/org/apache/reef/webserver/HttpHandler.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.reef.webserver;

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

/**
 * HttpHandler interface.
 */
public interface HttpHandler {
  /**
   * Return specification of the handler. e.g Reef
   *
   * @return
   */
  String getUriSpecification();

  /**
   * Set specification of the handler. e.g Reef
   */
  void setUriSpecification(String s);

  /**
   * Will be called when request comes.
   *
   * @param parsedHttpRequest
   * @param response
   */
  void onHttpRequest(ParsedHttpRequest parsedHttpRequest, HttpServletResponse response)
      throws IOException, ServletException;
}