Source code

001/**
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.reef.webserver;
020
021import org.apache.reef.tang.annotations.DefaultImplementation;
022
023/**
024 * HttpServer interface
025 */
026public interface HttpServer {
027
028  /**
029   * start the server
030   *
031   * @throws Exception
032   */
033  public void start() throws Exception;
034
035  /**
036   * stop the server
037   *
038   * @throws Exception
039   */
040  public void stop() throws Exception;
041
042  /**
043   * get port number of the server
044   *
045   * @return
046   */
047  public int getPort();
048
049  /**
050   * Add a httpHandler to the server
051   *
052   * @param httpHandler
053   */
054  public void addHttpHandler(final HttpHandler httpHandler);
055}