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
021/**
022 * HttpServer interface.
023 */
024public interface HttpServer {
025
026  /**
027   * start the server.
028   *
029   * @throws Exception
030   */
031  void start() throws Exception;
032
033  /**
034   * stop the server.
035   *
036   * @throws Exception
037   */
038  void stop() throws Exception;
039
040  /**
041   * get port number of the server.
042   *
043   * @return
044   */
045  int getPort();
046
047  /**
048   * Add a httpHandler to the server.
049   *
050   * @param httpHandler
051   */
052  void addHttpHandler(final HttpHandler httpHandler);
053}