com.pdd.pop.ext.glassfish.tyrus.spi.ServerContainer Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2012-2016 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.pdd.pop.ext.glassfish.tyrus.spi;
import java.io.IOException;
import javax.websocket.DeploymentException;
/**
* HTTP server abstraction.
*
* TODO rename the class to avoid findbugs
*
* @author Martin Matula (martin.matula at oracle.com)
*/
public interface ServerContainer extends javax.websocket.server.ServerContainer {
/**
* Start the server.
*
* Creates a new embedded HTTP server (if supported) listening to incoming connections at a given root path
* and port.
*
* @param rootPath context root
* @param port TCP port
* @throws IOException if something goes wrong.
* @throws javax.websocket.DeploymentException when there is any issue with endpoints or other, non-specific
* issues.
*/
void start(String rootPath, int port) throws IOException, DeploymentException;
/**
* Stop the server.
*/
void stop();
/**
* Return WebSocketEngine to upgrade requests and setting up the connection.
*
* @return websocket engine
*/
WebSocketEngine getWebSocketEngine();
}