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 org.jboss.netty.handler.codec.socks;
17
18 import org.jboss.netty.buffer.ChannelBuffer;
19 import org.jboss.netty.buffer.ChannelBuffers;
20 import org.jboss.netty.channel.Channel;
21 import org.jboss.netty.channel.ChannelHandler;
22 import org.jboss.netty.channel.ChannelHandlerContext;
23 import org.jboss.netty.handler.codec.oneone.OneToOneEncoder;
24
25 /**
26 * Encodes an {@link SocksMessage} into a {@link ChannelBuffer}.
27 * {@link OneToOneEncoder} implementation.
28 * Use this with {@link SocksInitRequest}, {@link SocksInitResponse}, {@link SocksAuthRequest},
29 * {@link SocksAuthResponse}, {@link SocksCmdRequest} and {@link SocksCmdResponse}
30 */
31 @ChannelHandler.Sharable
32 public class SocksMessageEncoder extends OneToOneEncoder {
33 private static final String name = "SOCKS_MESSAGE_ENCODER";
34 private static final int DEFAULT_ENCODER_BUFFER_SIZE = 1024;
35
36 /**
37 * @deprecated Will be removed at the next minor version bump.
38 */
39 @Deprecated
40 public static String getName() {
41 return name;
42 }
43
44 @Override
45 protected Object encode(ChannelHandlerContext ctx, Channel channel, Object msg) throws Exception {
46 ChannelBuffer buffer = null;
47 if (msg instanceof SocksMessage) {
48 buffer = ChannelBuffers.buffer(DEFAULT_ENCODER_BUFFER_SIZE);
49 ((SocksMessage) msg).encodeAsByteBuf(buffer);
50 }
51 return buffer;
52 }
53 }