org.apache.james.imapserver.netty

Class NettyImapRequestLineReader

java.lang.Object

org.apache.james.imap.decode.ImapRequestLineReader

org.apache.james.imapserver.netty.AbstractNettyImapRequestLineReader

org.apache.james.imapserver.netty.NettyImapRequestLineReader

public class NettyImapRequestLineReader
extends AbstractNettyImapRequestLineReader

ImapRequestLineReader implementation which will write to a Channel and read from a ChannelBuffer. Please see the docs on nextChar() and read(int, boolean) to understand the special behavior of this implementation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	NettyImapRequestLineReader.NotEnoughDataException RuntimeException which will get thrown by nextChar() and read(int, boolean) if not enough data is readable in the underlying ChannelBuffer

Nested classes/interfaces inherited from class org.apache.james.imap.decode.ImapRequestLineReader

org.apache.james.imap.decode.ImapRequestLineReader.ATOM_CHARValidator, org.apache.james.imap.decode.ImapRequestLineReader.CharacterValidator, org.apache.james.imap.decode.ImapRequestLineReader.MessageSetCharValidator, org.apache.james.imap.decode.ImapRequestLineReader.NoopCharValidator, org.apache.james.imap.decode.ImapRequestLineReader.TagCharValidator

Field Summary

Fields inherited from class org.apache.james.imap.decode.ImapRequestLineReader

nextChar, nextSeen

Constructor Summary

Constructors

Constructor and Description
NettyImapRequestLineReader(org.jboss.netty.channel.Channel channel, org.jboss.netty.buffer.ChannelBuffer buffer, boolean retry, int maxLiteralSize)

Method Summary

Methods

Modifier and Type	Method and Description
char	nextChar() Return the next char to read.
InputStream	read(int size, boolean extraCRLF) Return a ChannelBufferInputStream if the wrapped ChannelBuffer contains enough data.

Methods inherited from class org.apache.james.imapserver.netty.AbstractNettyImapRequestLineReader

commandContinuationRequest

Methods inherited from class org.apache.james.imap.decode.ImapRequestLineReader

astring, astring, atom, cap, consume, consumeChar, consumeLine, consumeLiteral, consumeLiteral, consumeQuoted, consumeQuoted, consumeWord, date, dateTime, eol, flag, flagList, isCHAR, isListWildcard, isQuotedSpecial, mailbox, mailboxUTF7, nextWordChar, nstring, number, number, nzNumber, parseIdRange, parseIdRange, tag

Methods inherited from class java.lang.Object

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

Constructor Detail

NettyImapRequestLineReader

public NettyImapRequestLineReader(org.jboss.netty.channel.Channel channel,
                          org.jboss.netty.buffer.ChannelBuffer buffer,
                          boolean retry,
                          int maxLiteralSize)

Method Detail

nextChar

public char nextChar()
              throws org.apache.james.protocols.imap.DecodingException

Return the next char to read. This will return the same char on every call till ImapRequestLineReader.consume() was called. This implementation will throw a NettyImapRequestLineReader.NotEnoughDataException if the wrapped ChannelBuffer contains not enough data to read the next char

Specified by:

nextChar in class org.apache.james.imap.decode.ImapRequestLineReader

Throws:

org.apache.james.protocols.imap.DecodingException

read

public InputStream read(int size,
               boolean extraCRLF)
                 throws org.apache.james.protocols.imap.DecodingException

Return a ChannelBufferInputStream if the wrapped ChannelBuffer contains enough data. If not it will throw a NettyImapRequestLineReader.NotEnoughDataException

Specified by:

read in class org.apache.james.imap.decode.ImapRequestLineReader

Throws:

org.apache.james.protocols.imap.DecodingException