org.jboss.netty.handler.codec.base64

Class Base64Encoder

java.lang.Object

org.jboss.netty.handler.codec.oneone.OneToOneEncoder

org.jboss.netty.handler.codec.base64.Base64Encoder

All Implemented Interfaces:

ChannelDownstreamHandler, ChannelHandler

@ChannelHandler.Sharable
public class Base64Encoder
extends OneToOneEncoder

Encodes a ChannelBuffer into a Base64-encoded ChannelBuffer. A typical setup for TCP/IP would be:

 ChannelPipeline pipeline = ...;

 // Decoders
 pipeline.addLast("frameDecoder", new DelimiterBasedFrameDecoder(80, Delimiters.nulDelimiter()));
 pipeline.addLast("base64Decoder", new Base64Decoder());

 // Encoder
 pipeline.addLast("base64Encoder", new Base64Encoder());
 

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.netty.channel.ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	breakLines
private Base64Dialect	dialect

Constructor Summary

Constructors

Constructor and Description
Base64Encoder()
Base64Encoder(boolean breakLines)
Base64Encoder(boolean breakLines, Base64Dialect dialect)

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	encode(ChannelHandlerContext ctx, Channel channel, java.lang.Object msg) Transforms the specified message into another message and return the transformed message.

Methods inherited from class org.jboss.netty.handler.codec.oneone.OneToOneEncoder

doEncode, handleDownstream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

breakLines

private final boolean breakLines

dialect

private final Base64Dialect dialect

Constructor Detail

Base64Encoder

public Base64Encoder()

Base64Encoder

public Base64Encoder(boolean breakLines)

Base64Encoder

public Base64Encoder(boolean breakLines,
                     Base64Dialect dialect)

Method Detail

encode

protected java.lang.Object encode(ChannelHandlerContext ctx,
                                  Channel channel,
                                  java.lang.Object msg)
                           throws java.lang.Exception

Description copied from class: OneToOneEncoder

Transforms the specified message into another message and return the transformed message. Note that you can not return null, unlike you can in OneToOneDecoder.decode(ChannelHandlerContext, Channel, Object); you must return something, at least ChannelBuffers.EMPTY_BUFFER.

Specified by:

encode in class OneToOneEncoder

Throws:

java.lang.Exception