/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2000-2003 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache", "Jakarta", "JAMES" and "Apache Software Foundation"
* must not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
* Portions of this software are based upon public domain software
* originally written at the National Center for Supercomputing Applications,
* University of Illinois, Urbana-Champaign.
*/
package org.apache.james.imapserver;
import org.apache.james.imapserver.commands.ImapCommandFactory;
import org.apache.james.imapserver.commands.CommandParser;
import org.apache.james.imapserver.commands.ImapCommand;
import java.io.InputStream;
import java.io.OutputStream;
/**
*
* @author Darrell DeBoer <darrell@apache.org>
*
* @version $Revision: 1.2.2.2 $
*/
public final class ImapRequestHandler
{
private ImapCommandFactory imapCommands = new ImapCommandFactory();
private CommandParser parser = new CommandParser();
private static final String REQUEST_SYNTAX = "Protocol Error: Was expecting <tag SPACE command [arguments]>";
/**
* This method parses POP3 commands read off the wire in handleConnection.
* Actual processing of the command (possibly including additional back and
* forth communication with the client) is delegated to one of a number of
* command specific handler methods. The primary purpose of this method is
* to parse the raw command string to determine exactly which handler should
* be called. It returns true if expecting additional commands, false otherwise.
*
* @return whether additional commands are expected.
*/
public boolean handleRequest( InputStream input,
OutputStream output,
ImapSession session )
throws ProtocolException
{
ImapRequestLineReader request = new ImapRequestLineReader( input, output );
try {
request.nextChar();
}
catch ( ProtocolException e ) {
return false;
}
ImapResponse response = new ImapResponse( output );
doProcessRequest( request, response, session );
// Consume the rest of the line, throwing away any extras. This allows us
// to clean up after a protocol error.
request.consumeLine();
return true;
}
private void doProcessRequest( ImapRequestLineReader request,
ImapResponse response,
ImapSession session)
{
String tag = null;
String commandName = null;
try {
tag = parser.tag( request );
}
catch ( ProtocolException e ) {
response.badResponse( REQUEST_SYNTAX );
return;
}
// System.out.println( "Got <tag>: " + tag );
response.setTag( tag );
try {
commandName = parser.atom( request );
}
catch ( ProtocolException e ) {
response.commandError( REQUEST_SYNTAX );
return;
}
// System.out.println( "Got <command>: " + commandName );
ImapCommand command = imapCommands.getCommand( commandName );
if ( command == null )
{
response.commandError( "Invalid command.");
return;
}
if ( !command.validForState( session.getState() ) ) {
response.commandFailed( command, "Command not valid in this state" );
return;
}
command.process( request, response, session );
}
}