lib/servlet-api/javax/servlet/http/HttpUpgradeHandler.java

   1 /*
   2  * Licensed to the Apache Software Foundation (ASF) under one or more
   3  * contributor license agreements.  See the NOTICE file distributed with
   4  * this work for additional information regarding copyright ownership.
   5  * The ASF licenses this file to You under the Apache License, Version 2.0
   6  * (the "License"); you may not use this file except in compliance with
   7  * the License.  You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17 package javax.servlet.http;
  18
  19 /**
  20  * Interface between the HTTP upgrade process and the new protocol.
  21  *
  22  * @since Servlet 3.1
  23  */
  24 public interface HttpUpgradeHandler {
  25
  26     /**
  27      * This method is called once the request/response pair where
  28      * {@link HttpServletRequest#upgrade(Class)} is called has completed
  29      * processing and is the point where control of the connection passes from
  30      * the container to the {@link HttpUpgradeHandler}.
  31      *
  32      * @param connection    The connection that has been upgraded
  33      *
  34      * @since Servlet 3.1
  35      */
  36     void init(WebConnection connection);
  37
  38     /**
  39      * This method is called after the upgraded connection has been closed.
  40      */
  41     void destroy();
  42 }