View Javadoc
1   /*
2    * Copyright 2014 The Netty Project
3    *
4    * The Netty Project licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    *   http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  package io.netty.handler.codec.http.websocketx.extensions;
17  
18  import java.util.Collections;
19  import java.util.Map;
20  
21  /**
22   * A WebSocket Extension data from the <tt>Sec-WebSocket-Extensions</tt> header.
23   *
24   * See <tt>io.netty.handler.codec.http.HttpHeaders.Names.SEC_WEBSOCKET_EXTENSIONS</tt>.
25   */
26  public final class WebSocketExtensionData {
27  
28      private final String name;
29      private final Map<String, String> parameters;
30  
31      public WebSocketExtensionData(String name, Map<String, String> parameters) {
32          if (name == null) {
33              throw new NullPointerException("name");
34          }
35          if (parameters == null) {
36              throw new NullPointerException("parameters");
37          }
38          this.name = name;
39          this.parameters = Collections.unmodifiableMap(parameters);
40      }
41  
42      /**
43       * @return the extension name.
44       */
45      public String name() {
46          return name;
47      }
48  
49      /**
50       * @return the extension optional parameters.
51       */
52      public Map<String, String> parameters() {
53          return parameters;
54      }
55  }