xref: /unit/src/java/javax/websocket/server/HandshakeRequest.java (revision 1157:7ae152bda303)
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.websocket.server;
18 
19 import java.net.URI;
20 import java.security.Principal;
21 import java.util.List;
22 import java.util.Map;
23 
24 /**
25  * Represents the HTTP request that asked to be upgraded to WebSocket.
26  */
27 public interface HandshakeRequest {
28 
29     static final String SEC_WEBSOCKET_KEY = "Sec-WebSocket-Key";
30     static final String SEC_WEBSOCKET_PROTOCOL = "Sec-WebSocket-Protocol";
31     static final String SEC_WEBSOCKET_VERSION = "Sec-WebSocket-Version";
32     static final String SEC_WEBSOCKET_EXTENSIONS= "Sec-WebSocket-Extensions";
33 
getHeaders()34     Map<String,List<String>> getHeaders();
35 
getUserPrincipal()36     Principal getUserPrincipal();
37 
getRequestURI()38     URI getRequestURI();
39 
isUserInRole(String role)40     boolean isUserInRole(String role);
41 
42     /**
43      * Get the HTTP Session object associated with this request. Object is used
44      * to avoid a direct dependency on the Servlet API.
45      * @return The javax.servlet.http.HttpSession object associated with this
46      *         request, if any.
47      */
getHttpSession()48     Object getHttpSession();
49 
getParameterMap()50     Map<String, List<String>> getParameterMap();
51 
getQueryString()52     String getQueryString();
53 }
54