001/* 002 * Copyright 2012-2017 the original author or authors. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 */ 016 017package org.springframework.boot.web.server; 018 019/** 020 * Simple interface that represents a fully configured web server (for example Tomcat, 021 * Jetty, Netty). Allows the server to be {@link #start() started} and {@link #stop() 022 * stopped}. 023 * 024 * @author Phillip Webb 025 * @author Dave Syer 026 * @since 2.0.0 027 */ 028public interface WebServer { 029 030 /** 031 * Starts the web server. Calling this method on an already started server has no 032 * effect. 033 * @throws WebServerException if the server cannot be started 034 */ 035 void start() throws WebServerException; 036 037 /** 038 * Stops the web server. Calling this method on an already stopped server has no 039 * effect. 040 * @throws WebServerException if the server cannot be stopped 041 */ 042 void stop() throws WebServerException; 043 044 /** 045 * Return the port this server is listening on. 046 * @return the port (or -1 if none) 047 */ 048 int getPort(); 049 050}