1 /*
2 * Copyright 2012 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.socks;
17
18 import io.netty.util.internal.ObjectUtil;
19
20 /**
21 * An abstract class that defines a SocksRequest, providing common properties for
22 * {@link SocksInitRequest}, {@link SocksAuthRequest}, {@link SocksCmdRequest} and {@link UnknownSocksRequest}.
23 *
24 * @see SocksInitRequest
25 * @see SocksAuthRequest
26 * @see SocksCmdRequest
27 * @see UnknownSocksRequest
28 */
29 public abstract class SocksRequest extends SocksMessage {
30 private final SocksRequestType requestType;
31
32 protected SocksRequest(SocksRequestType requestType) {
33 super(SocksMessageType.REQUEST);
34 this.requestType = ObjectUtil.checkNotNull(requestType, "requestType");
35 }
36
37 /**
38 * Returns socks request type
39 *
40 * @return socks request type
41 */
42 public SocksRequestType requestType() {
43 return requestType;
44 }
45 }