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 * https://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 io.netty.util.internal.ObjectUtil;
19
20 import java.util.Collections;
21 import java.util.Map;
22
23 /**
24 * A WebSocket Extension data from the <tt>Sec-WebSocket-Extensions</tt> header.
25 *
26 * See <tt>io.netty.handler.codec.http.HttpHeaders.Names.SEC_WEBSOCKET_EXTENSIONS</tt>.
27 */
28 public final class WebSocketExtensionData {
29
30 private final String name;
31 private final Map<String, String> parameters;
32
33 public WebSocketExtensionData(String name, Map<String, String> parameters) {
34 this.name = ObjectUtil.checkNotNull(name, "name");
35 this.parameters = Collections.unmodifiableMap(
36 ObjectUtil.checkNotNull(parameters, "parameters"));
37 }
38
39 /**
40 * @return the extension name.
41 */
42 public String name() {
43 return name;
44 }
45
46 /**
47 * @return the extension optional parameters.
48 */
49 public Map<String, String> parameters() {
50 return parameters;
51 }
52 }