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 import io.netty.buffer.ByteBuf;
19
20 /**
21 * An abstract class that defines a SocksMessage, providing common properties for
22 * {@link SocksRequest} and {@link SocksResponse}.
23 *
24 * @see SocksRequest
25 * @see SocksResponse
26 */
27
28 public abstract class SocksMessage {
29 private final SocksMessageType type;
30 private final SocksProtocolVersion protocolVersion = SocksProtocolVersion.SOCKS5;
31
32 protected SocksMessage(SocksMessageType type) {
33 if (type == null) {
34 throw new NullPointerException("type");
35 }
36 this.type = type;
37 }
38
39 /**
40 * Returns the {@link SocksMessageType} of this {@link SocksMessage}
41 *
42 * @return The {@link SocksMessageType} of this {@link SocksMessage}
43 */
44 public SocksMessageType type() {
45 return type;
46 }
47
48 /**
49 * Returns the {@link SocksProtocolVersion} of this {@link SocksMessage}
50 *
51 * @return The {@link SocksProtocolVersion} of this {@link SocksMessage}
52 */
53 public SocksProtocolVersion protocolVersion() {
54 return protocolVersion;
55 }
56
57 /**
58 * @deprecated Do not use; this method was intended for an internal use only.
59 */
60 @Deprecated
61 public abstract void encodeAsByteBuf(ByteBuf byteBuf);
62 }