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