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 SocksResponse, providing common properties for
20 * {@link SocksInitResponse}, {@link SocksAuthResponse}, {@link SocksCmdResponse} and {@link UnknownSocksResponse}.
21 *
22 * @see SocksInitResponse
23 * @see SocksAuthResponse
24 * @see SocksCmdResponse
25 * @see UnknownSocksResponse
26 */
27 public abstract class SocksResponse extends SocksMessage {
28 private final SocksResponseType responseType;
29
30 protected SocksResponse(SocksResponseType responseType) {
31 super(SocksMessageType.RESPONSE);
32 if (responseType == null) {
33 throw new NullPointerException("responseType");
34 }
35 this.responseType = responseType;
36 }
37
38 /**
39 * Returns socks response type
40 *
41 * @return socks response type
42 */
43 public SocksResponseType responseType() {
44 return responseType;
45 }
46 }