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