You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by pg...@apache.org on 2002/08/08 01:54:34 UTC
cvs commit: jakarta-james/src/java/org/apache/james/pop3server POP3Handler.java
pgoldstein 2002/08/07 16:54:34
Modified: src/java/org/apache/james/pop3server POP3Handler.java
Log:
Large changes to the POP3Handler.java class
Includes String=>StringBuffer, extensive additional commenting,
wrapping of logging calls in log level checks, conversion of
equalsIgnoreCase to equals, introduction of Locale.US to upper
case conversions, additional logging.
For more detail please see messages on the james-dev mailing list
Revision Changes Path
1.8 +553 -108 jakarta-james/src/java/org/apache/james/pop3server/POP3Handler.java
Index: POP3Handler.java
===================================================================
RCS file: /home/cvs/jakarta-james/src/java/org/apache/james/pop3server/POP3Handler.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- POP3Handler.java 28 Jul 2002 11:15:06 -0000 1.7
+++ POP3Handler.java 7 Aug 2002 23:54:34 -0000 1.8
@@ -36,6 +36,8 @@
import java.util.*;
/**
+ * The handler class for POP3 connections.
+ *
* @author Federico Barbieri <sc...@systemy.it>
* @version 0.9
*/
@@ -43,35 +45,80 @@
extends BaseConnectionHandler
implements ConnectionHandler, Composable, Configurable, Target {
- private String softwaretype = "JAMES POP3 Server " + Constants.SOFTWARE_VERSION;
+ // POP3 Server identification string used in POP3 headers
+ private static final String softwaretype = "JAMES POP3 Server "
+ + Constants.SOFTWARE_VERSION;
- private ComponentManager compMgr;
- private MailServer mailServer;
- private MailRepository userInbox;
- private UsersRepository users;
- private TimeScheduler scheduler;
-
- private Socket socket;
- private BufferedReader in;
- private PrintWriter out;
- private OutputStream outs;
- private String remoteHost;
- private String remoteIP;
- private int state;
- private String user;
- private Vector userMailbox = new Vector();
- private Vector backupUserMailbox;
- private static final Mail DELETED = new MailImpl();
-
- private int lengthReset = 20000;
-
- private static int AUTHENTICATION_READY = 0;
- private static int AUTHENTICATION_USERSET = 1;
- private static int TRANSACTION = 2;
+ // POP3 response prefixes
+ private final static String OK_RESPONSE = "+OK"; // OK response. Requested content
+ // will follow
- private final static String OK_RESPONSE = "+OK";
- private final static String ERR_RESPONSE = "-ERR";
+ private final static String ERR_RESPONSE = "-ERR"; // Error response. Requested content
+ // will not be provided. This prefix
+ // is followed by a more detailed
+ // error message
+ // Authentication states for the POP3 interaction
+ private final static int AUTHENTICATION_READY = 0; // Waiting for user id
+
+ private final static int AUTHENTICATION_USERSET = 1; // User id provided, waiting for
+ // password
+
+ private final static int TRANSACTION = 2; // A valid user id/password combination
+ // has been provided. In this state
+ // the client can access the mailbox
+ // of the specified user
+
+ private static final Mail DELETED = new MailImpl(); // A placeholder for emails deleted
+ // during the course of the POP3
+ // transaction. This Mail instance
+ // is used to enable fast checks as
+ // to whether an email has been
+ // deleted from the inbox.
+
+ private MailServer mailServer; // The internal mail server service
+ private UsersRepository users; // The user repository for this server - used to authenticate
+ // users
+
+ private TimeScheduler scheduler; // The scheduler used to handle timeouts for the
+ // POP3 interaction
+
+ private MailRepository userInbox; // The mail server's copy of the user's inbox
+
+ private Socket socket; // The TCP/IP socket over which the POP3 interaction
+ // is occurring
+
+ private BufferedReader in; // The reader associated with incoming characters.
+
+ private PrintWriter out; // The writer to which outgoing messages are written.
+
+ private OutputStream outs; // The socket's output stream
+
+ private int state; // The current transaction state of the handler
+
+ private String user; // The user id associated with the POP3 dialogue
+
+ private Vector userMailbox = new Vector(); // A dynamic list representing the set of
+ // emails in the user's inbox at any given time
+ // during the POP3 transaction
+
+ private Vector backupUserMailbox; // A snapshot list representing the set of
+ // emails in the user's inbox at the beginning
+ // of the transaction
+
+ private int lengthReset = 20000; // The number of bytes to read before resetting
+ // the connection timeout timer. Defaults to
+ // 20 seconds.
+
+
+ /**
+ * This method is called by the ConnectionHandlerFactory with the
+ * handler <code>Configuration</code>. This provides the POP3Handler
+ * with required configuration data.
+ *
+ * @param configuration the class configurations.
+ * @throws ConfigurationException if an error occurs
+ */
public void configure(Configuration configuration)
throws ConfigurationException {
super.configure(configuration);
@@ -79,6 +126,15 @@
lengthReset = configuration.getChild("lengthReset").getValueAsInteger(20000);
}
+ /**
+ * This method is called by the ConnectionHandlerFactory with the
+ * appropriate <code>ComponentManager</code>. This allows the POP3Handler
+ * to access other system components.
+ *
+ * @param componentManager The <code>ComponentManager</code> which this
+ * <code>Composable</code> uses.
+ * @throws ComponentException if an error occurs
+ */
public void compose( final ComponentManager componentManager )
throws ComponentException {
mailServer = (MailServer)componentManager.
@@ -101,46 +157,87 @@
public void handleConnection( Socket connection )
throws IOException {
+ String remoteHost = "";
+ String remoteIP = "";
+
try {
this.socket = connection;
in = new BufferedReader(new InputStreamReader(socket.getInputStream()));
outs = socket.getOutputStream();
out = new InternetPrintWriter(outs, true);
- remoteHost = socket.getInetAddress ().getHostName ();
- remoteIP = socket.getInetAddress ().getHostAddress ();
+ remoteHost = socket.getInetAddress().getHostName ();
+ remoteIP = socket.getInetAddress().getHostAddress ();
} catch (Exception e) {
- getLogger().error( "Cannot open connection from " + remoteHost +
- " (" + remoteIP + "): " + e.getMessage(), e );
+ if (getLogger().isErrorEnabled()) {
+ StringBuffer exceptionBuffer =
+ new StringBuffer(256)
+ .append("Cannot open connection from ")
+ .append(remoteHost)
+ .append(" (")
+ .append(remoteIP)
+ .append("): ")
+ .append(e.getMessage());
+ getLogger().error( exceptionBuffer.toString(), e );
+ }
}
- getLogger().info( "Connection from " + remoteHost + " (" + remoteIP + ")" );
+ if (getLogger().isInfoEnabled()) {
+ StringBuffer logBuffer =
+ new StringBuffer(128)
+ .append("Connection from ")
+ .append(remoteHost)
+ .append(" (")
+ .append(remoteIP)
+ .append(") ");
+ getLogger().info(logBuffer.toString());
+ }
try {
final PeriodicTimeTrigger trigger = new PeriodicTimeTrigger( timeout, -1 );
scheduler.addTrigger( this.toString(), trigger, this );
state = AUTHENTICATION_READY;
user = "unknown";
- out.println( OK_RESPONSE + " " + this.helloName +
- " POP3 server (" + this.softwaretype + ") ready " );
+ StringBuffer responseBuffer =
+ new StringBuffer(256)
+ .append(OK_RESPONSE)
+ .append(" ")
+ .append(this.helloName)
+ .append(" POP3 server (")
+ .append(this.softwaretype)
+ .append(") ready ");
+ out.println(responseBuffer.toString());
while (parseCommand(in.readLine())) {
scheduler.resetTrigger(this.toString());
}
- socket.close();
scheduler.removeTrigger(this.toString());
getLogger().info("Connection closed");
-
} catch (Exception e) {
out.println(ERR_RESPONSE + " Error closing connection.");
out.flush();
- getLogger().error( "Exception during connection from " + remoteHost +
- " (" + remoteIP + ") : " + e.getMessage(), e );
+ StringBuffer exceptionBuffer =
+ new StringBuffer(128)
+ .append("Exception during connection from ")
+ .append(remoteHost)
+ .append(" (")
+ .append(remoteIP)
+ .append(") : ")
+ .append(e.getMessage());
+ getLogger().error(exceptionBuffer.toString(), e );
try {
socket.close();
} catch (IOException ioe) {
}
+ // TODO: In the error condition, shouldn't we be removing the trigger?
}
}
+ /**
+ * Callback method called when the the PeriodicTimeTrigger in
+ * handleConnection is triggered. In this case the trigger is
+ * being used as a timeout, so the method simply closes the connection.
+ *
+ * @param triggerName the name of the trigger
+ */
public void targetTriggered( final String triggerName ) {
getLogger().error("Connection timeout on socket");
try {
@@ -150,6 +247,15 @@
}
}
+ /**
+ * Implements a "stat". If the handler is currently in
+ * a transaction state, this amounts to a rollback of the
+ * mailbox contents to the beginning of the transaction.
+ * This method is also called when first entering the
+ * transaction state to initialize the handler copies of the
+ * user inbox.
+ *
+ */
private void stat() {
userMailbox = new Vector();
userMailbox.addElement(DELETED);
@@ -161,9 +267,22 @@
backupUserMailbox = (Vector) userMailbox.clone();
}
+ /**
+ * 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.
+ *
+ * @param commandRaw the raw command string passed in over the socket
+ *
+ * @return whether additional commands are expected.
+ */
private boolean parseCommand(String commandRaw) {
- if (commandRaw == null) return false;
- //getLogger().info("Command received: " + commandRaw);
+ if (commandRaw == null) {
+ return false;
+ }
String command = commandRaw.trim();
commandRaw = command;
StringTokenizer commandLine = new StringTokenizer(command, " ");
@@ -171,7 +290,15 @@
if (arguments == 0) {
return true;
} else if(arguments > 0) {
- command = commandLine.nextToken();
+ command = commandLine.nextToken().toUpperCase(Locale.US);
+ }
+ if (getLogger().isDebugEnabled()) {
+ // Don't display password in logger
+ if (!command.equals("PASS")) {
+ getLogger().debug("Command received: " + commandRaw);
+ } else {
+ getLogger().debug("Command received: PASS <password omitted>");
+ }
}
String argument = (String) null;
if(arguments > 1) {
@@ -181,70 +308,103 @@
if(arguments > 2) {
argument1 = commandLine.nextToken();
}
- if (getLogger().isInfoEnabled()) {
- // Don't display password in logger
- if (!command.equalsIgnoreCase("PASS")) {
- getLogger().info("Command received: " + commandRaw);
- } else {
- getLogger().info("Command received: PASS <password omitted>");
- }
- }
- if (command.equalsIgnoreCase("USER"))
+ if (command.equals("USER"))
doUSER(command,argument,argument1);
- else if (command.equalsIgnoreCase("PASS"))
+ else if (command.equals("PASS"))
doPASS(command,argument,argument1);
- else if (command.equalsIgnoreCase("STAT"))
+ else if (command.equals("STAT"))
doSTAT(command,argument,argument1);
- else if (command.equalsIgnoreCase("LIST"))
+ else if (command.equals("LIST"))
doLIST(command,argument,argument1);
- else if (command.equalsIgnoreCase("UIDL"))
+ else if (command.equals("UIDL"))
doUIDL(command,argument,argument1);
- else if (command.equalsIgnoreCase("RSET"))
+ else if (command.equals("RSET"))
doRSET(command,argument,argument1);
- else if (command.equalsIgnoreCase("DELE"))
+ else if (command.equals("DELE"))
doDELE(command,argument,argument1);
- else if (command.equalsIgnoreCase("NOOP"))
+ else if (command.equals("NOOP"))
doNOOP(command,argument,argument1);
- else if (command.equalsIgnoreCase("RETR"))
+ else if (command.equals("RETR"))
doRETR(command,argument,argument1);
- else if (command.equalsIgnoreCase("TOP"))
+ else if (command.equals("TOP"))
doTOP(command,argument,argument1);
- else if (command.equalsIgnoreCase("QUIT"))
+ else if (command.equals("QUIT"))
doQUIT(command,argument,argument1);
else
doUnknownCmd(command,argument,argument1);
- return (command.equalsIgnoreCase("QUIT") == false);
+ return (command.equals("QUIT") == false);
}
+ /**
+ * Handler method called upon receipt of a USER command.
+ * Reads in the user id.
+ *
+ * @param command the command parsed by the parseCommand method
+ * @argument the first argument parsed by the parseCommand method
+ * @argument1 the second argument parsed by the parseCommand method
+ */
private void doUSER(String command,String argument,String argument1) {
+ String responseString = null;
if (state == AUTHENTICATION_READY && argument != null) {
user = argument;
state = AUTHENTICATION_USERSET;
- out.println(OK_RESPONSE);
+ responseString = OK_RESPONSE;
} else {
- out.println(ERR_RESPONSE);
+ responseString = ERR_RESPONSE;
}
+ out.println(responseString);
+ out.flush();
+ logResponseString(responseString);
}
+ /**
+ * Handler method called upon receipt of a PASS command.
+ * Reads in and validates the password.
+ *
+ * @param command the command parsed by the parseCommand method
+ * @argument the first argument parsed by the parseCommand method
+ * @argument1 the second argument parsed by the parseCommand method
+ */
private void doPASS(String command,String argument,String argument1) {
+ String responseString = null;
if (state == AUTHENTICATION_USERSET && argument != null) {
String passArg = argument;
if (users.test(user, passArg)) {
+ StringBuffer responseBuffer =
+ new StringBuffer(64)
+ .append(OK_RESPONSE)
+ .append(" Welcome ")
+ .append(user);
+ responseString = responseBuffer.toString();
state = TRANSACTION;
- out.println(OK_RESPONSE + " Welcome " + user);
+ out.println(responseString);
userInbox = mailServer.getUserInbox(user);
stat();
} else {
+ responseString = ERR_RESPONSE + " Authentication failed.";
state = AUTHENTICATION_READY;
- out.println(ERR_RESPONSE + " Authentication failed.");
+ out.println(responseString);
}
} else {
- out.println(ERR_RESPONSE);
+ responseString = ERR_RESPONSE;
+ out.println(responseString);
}
+ out.flush();
+ logResponseString(responseString);
}
+ /**
+ * Handler method called upon receipt of a STAT command.
+ * Returns the number of messages in the mailbox and its
+ * aggregate size.
+ *
+ * @param command the command parsed by the parseCommand method
+ * @argument the first argument parsed by the parseCommand method
+ * @argument1 the second argument parsed by the parseCommand method
+ */
private void doSTAT(String command,String argument,String argument1) {
+ String responseString = null;
if (state == TRANSACTION) {
long size = 0;
int count = 0;
@@ -256,15 +416,39 @@
count++;
}
}
- out.println(OK_RESPONSE + " " + count + " " + size);
+ StringBuffer responseBuffer =
+ new StringBuffer(32)
+ .append(OK_RESPONSE)
+ .append(" ")
+ .append(count)
+ .append(" ")
+ .append(size);
+ responseString = responseBuffer.toString();
+ out.println(responseString);
} catch (MessagingException me) {
- out.println(ERR_RESPONSE);
+ responseString = ERR_RESPONSE;
+ out.println(responseString);
}
} else {
- out.println(ERR_RESPONSE);
+ responseString = ERR_RESPONSE;
+ out.println(responseString);
}
+ out.flush();
+ logResponseString(responseString);
}
+
+ /**
+ * Handler method called upon receipt of a LIST command.
+ * Returns the number of messages in the mailbox and its
+ * aggregate size, or optionally, the number and size of
+ * a single message.
+ *
+ * @param command the command parsed by the parseCommand method
+ * @argument the first argument parsed by the parseCommand method
+ * @argument1 the second argument parsed by the parseCommand method
+ */
private void doLIST(String command,String argument,String argument1) {
+ String responseString = null;
if (state == TRANSACTION) {
if (argument == null) {
long size = 0;
@@ -277,17 +461,31 @@
count++;
}
}
- out.println(OK_RESPONSE + " " + count + " " + size);
+ StringBuffer responseBuffer =
+ new StringBuffer(32)
+ .append(OK_RESPONSE)
+ .append(" ")
+ .append(count)
+ .append(" ")
+ .append(size);
+ responseString = responseBuffer.toString();
+ out.println(responseString);
count = 0;
for (Enumeration e = userMailbox.elements(); e.hasMoreElements(); count++) {
MailImpl mc = (MailImpl) e.nextElement();
if (mc != DELETED) {
- out.println(count + " " + mc.getMessageSize());
+ responseBuffer =
+ new StringBuffer(16)
+ .append(count)
+ .append(" ")
+ .append(mc.getMessageSize());
+ out.println(responseBuffer.toString());
}
}
out.println(".");
} catch (MessagingException me) {
- out.println(ERR_RESPONSE);
+ responseString = ERR_RESPONSE;
+ out.println(responseString);
}
} else {
int num = 0;
@@ -295,32 +493,80 @@
num = Integer.parseInt(argument);
MailImpl mc = (MailImpl) userMailbox.elementAt(num);
if (mc != DELETED) {
- out.println(OK_RESPONSE + " " + num + " " + mc.getMessageSize());
+ StringBuffer responseBuffer =
+ new StringBuffer(64)
+ .append(OK_RESPONSE)
+ .append(" ")
+ .append(num)
+ .append(" ")
+ .append(mc.getMessageSize());
+ responseString = responseBuffer.toString();
+ out.println(responseString);
} else {
- out.println(ERR_RESPONSE + " Message (" + num + ") does not exist.");
+ StringBuffer responseBuffer =
+ new StringBuffer(64)
+ .append(ERR_RESPONSE)
+ .append(" Message (")
+ .append(num)
+ .append(") does not exist.");
+ responseString = responseBuffer.toString();
+ out.println(responseString);
}
} catch (ArrayIndexOutOfBoundsException npe) {
- out.println(ERR_RESPONSE + " Message (" + num + ") does not exist.");
+ StringBuffer responseBuffer =
+ new StringBuffer(64)
+ .append(ERR_RESPONSE)
+ .append(" Message (")
+ .append(num)
+ .append(") does not exist.");
+ responseString = responseBuffer.toString();
+ out.println(responseString);
} catch (NumberFormatException nfe) {
- out.println(ERR_RESPONSE + " " + argument + " is not a valid number");
+ StringBuffer responseBuffer =
+ new StringBuffer(64)
+ .append(ERR_RESPONSE)
+ .append(" ")
+ .append(argument)
+ .append(" is not a valid number");
+ responseString = responseBuffer.toString();
+ out.println(responseString);
} catch (MessagingException me) {
- out.println(ERR_RESPONSE);
+ responseString = ERR_RESPONSE;
+ out.println(responseString);
}
}
} else {
- out.println(ERR_RESPONSE);
+ responseString = ERR_RESPONSE;
+ out.println(responseString);
}
+ out.flush();
+ logResponseString(responseString);
}
+ /**
+ * Handler method called upon receipt of a UIDL command.
+ * Returns a listing of message ids to the client.
+ *
+ * @param command the command parsed by the parseCommand method
+ * @argument the first argument parsed by the parseCommand method
+ * @argument1 the second argument parsed by the parseCommand method
+ */
private void doUIDL(String command,String argument,String argument1) {
+ String responseString = null;
if (state == TRANSACTION) {
if (argument == null) {
- out.println(OK_RESPONSE + " unique-id listing follows");
+ responseString = OK_RESPONSE + " unique-id listing follows";
+ out.println(responseString);
int count = 0;
for (Enumeration e = userMailbox.elements(); e.hasMoreElements(); count++) {
MailImpl mc = (MailImpl) e.nextElement();
if (mc != DELETED) {
- out.println(count + " " + mc.getName());
+ StringBuffer responseBuffer =
+ new StringBuffer(64)
+ .append(count)
+ .append(" ")
+ .append(mc.getName());
+ out.println(responseBuffer.toString());
}
}
out.println(".");
@@ -330,67 +576,169 @@
num = Integer.parseInt(argument);
MailImpl mc = (MailImpl) userMailbox.elementAt(num);
if (mc != DELETED) {
- out.println(OK_RESPONSE + " " + num + " " + mc.getName());
+ StringBuffer responseBuffer =
+ new StringBuffer(64)
+ .append(OK_RESPONSE)
+ .append(" ")
+ .append(num)
+ .append(" ")
+ .append(mc.getName());
+ responseString = responseBuffer.toString();
+ out.println(responseString);
} else {
- out.println(ERR_RESPONSE + " Message (" + num + ") does not exist.");
+ StringBuffer responseBuffer =
+ new StringBuffer(64)
+ .append(ERR_RESPONSE)
+ .append(" Message (")
+ .append(num)
+ .append(") does not exist.");
+ responseString = responseBuffer.toString();
+ out.println(responseString);
}
} catch (ArrayIndexOutOfBoundsException npe) {
- out.println(ERR_RESPONSE + " Message (" + num + ") does not exist.");
+ StringBuffer responseBuffer =
+ new StringBuffer(64)
+ .append(ERR_RESPONSE)
+ .append(" Message (")
+ .append(num)
+ .append(") does not exist.");
+ responseString = responseBuffer.toString();
+ out.println(responseString);
} catch (NumberFormatException nfe) {
- out.println(ERR_RESPONSE + " " + argument + " is not a valid number");
+ StringBuffer responseBuffer =
+ new StringBuffer(64)
+ .append(ERR_RESPONSE)
+ .append(" ")
+ .append(argument)
+ .append(" is not a valid number");
+ responseString = responseBuffer.toString();
+ out.println(responseString);
}
}
} else {
out.println(ERR_RESPONSE);
}
+ out.flush();
+ logResponseString(responseString);
}
+
+ /**
+ * Handler method called upon receipt of a RSET command.
+ * Calls stat() to reset the mailbox.
+ *
+ * @param command the command parsed by the parseCommand method
+ * @argument the first argument parsed by the parseCommand method
+ * @argument1 the second argument parsed by the parseCommand method
+ */
private void doRSET(String command,String argument,String argument1) {
+ String responseString = null;
if (state == TRANSACTION) {
stat();
- out.println(OK_RESPONSE);
+ responseString = OK_RESPONSE;
} else {
- out.println(ERR_RESPONSE);
+ responseString = ERR_RESPONSE;
}
+ out.println(responseString);
+ out.flush();
+ logResponseString(responseString);
}
+ /**
+ * Handler method called upon receipt of a DELE command.
+ * This command deletes a particular mail message from the
+ * mailbox.
+ *
+ * @param command the command parsed by the parseCommand method
+ * @argument the first argument parsed by the parseCommand method
+ * @argument1 the second argument parsed by the parseCommand method
+ */
private void doDELE(String command,String argument,String argument1) {
+ String responseString = null;
if (state == TRANSACTION) {
int num = 0;
try {
num = Integer.parseInt(argument);
} catch (Exception e) {
- out.println(ERR_RESPONSE + " Usage: DELE [mail number]");
+ responseString = ERR_RESPONSE + " Usage: DELE [mail number]";
+ out.println(responseString);
+ out.flush();
+ logResponseString(responseString);
return;
}
try {
MailImpl mc = (MailImpl) userMailbox.elementAt(num);
if (mc == DELETED) {
- out.println(ERR_RESPONSE + " Message (" + num + ") does not exist.");
+ StringBuffer responseBuffer =
+ new StringBuffer(64)
+ .append(ERR_RESPONSE)
+ .append(" Message (")
+ .append(num)
+ .append(") does not exist.");
+ responseString = responseBuffer.toString();
+ out.println(responseString);
} else {
userMailbox.setElementAt(DELETED, num);
out.println(OK_RESPONSE + " Message removed");
}
} catch (ArrayIndexOutOfBoundsException iob) {
- out.println(ERR_RESPONSE + " Message (" + num + ") does not exist.");
+ StringBuffer responseBuffer =
+ new StringBuffer(64)
+ .append(ERR_RESPONSE)
+ .append(" Message (")
+ .append(num)
+ .append(") does not exist.");
+ responseString = responseBuffer.toString();
+ out.println(responseString);
}
} else {
- out.println(ERR_RESPONSE);
+ responseString = ERR_RESPONSE;
+ out.println(responseString);
}
+ out.flush();
+ logResponseString(responseString);
}
+
+ /**
+ * Handler method called upon receipt of a NOOP command.
+ * Like all good NOOPs, does nothing much.
+ *
+ * @param command the command parsed by the parseCommand method
+ * @argument the first argument parsed by the parseCommand method
+ * @argument1 the second argument parsed by the parseCommand method
+ */
private void doNOOP(String command,String argument,String argument1) {
+ String responseString = null;
if (state == TRANSACTION) {
- out.println(OK_RESPONSE);
+ responseString = OK_RESPONSE;
+ out.println(responseString);
} else {
- out.println(ERR_RESPONSE);
+ responseString = ERR_RESPONSE;
+ out.println(responseString);
}
+ out.flush();
+ logResponseString(responseString);
}
+
+ /**
+ * Handler method called upon receipt of a RETR command.
+ * This command retrieves a particular mail message from the
+ * mailbox.
+ *
+ * @param command the command parsed by the parseCommand method
+ * @argument the first argument parsed by the parseCommand method
+ * @argument1 the second argument parsed by the parseCommand method
+ */
private void doRETR(String command,String argument,String argument1) {
+ String responseString = null;
if (state == TRANSACTION) {
int num = 0;
try {
num = Integer.parseInt(argument.trim());
} catch (Exception e) {
- out.println(ERR_RESPONSE + " Usage: RETR [mail number]");
+ responseString = ERR_RESPONSE + " Usage: RETR [mail number]";
+ out.println(responseString);
+ logResponseString(responseString);
+ out.flush();
return;
}
//?May be written as
@@ -398,7 +746,8 @@
try {
MailImpl mc = (MailImpl) userMailbox.elementAt(num);
if (mc != DELETED) {
- out.println(OK_RESPONSE + " Message follows");
+ responseString = OK_RESPONSE + " Message follows";
+ out.println(responseString);
OutputStream nouts =
new ExtraDotOutputStream(
new SchedulerNotifyOutputStream(outs, scheduler,
@@ -407,21 +756,54 @@
out.println();
out.println(".");
} else {
- out.println(ERR_RESPONSE + " Message (" + num + ") deleted.");
+ StringBuffer responseBuffer =
+ new StringBuffer(64)
+ .append(ERR_RESPONSE)
+ .append(" Message (")
+ .append(num)
+ .append(") deleted.");
+ responseString = responseBuffer.toString();
+ out.println(responseString);
}
} catch (IOException ioe) {
- out.println(ERR_RESPONSE + " Error while retrieving message.");
+ responseString = ERR_RESPONSE + " Error while retrieving message.";
+ out.println(responseString);
} catch (MessagingException me) {
- out.println(ERR_RESPONSE + " Error while retrieving message.");
+ responseString = ERR_RESPONSE + " Error while retrieving message.";
+ out.println(responseString);
} catch (ArrayIndexOutOfBoundsException iob) {
- out.println(ERR_RESPONSE + " Message (" + num + ") does not exist.");
+ StringBuffer responseBuffer =
+ new StringBuffer(64)
+ .append(ERR_RESPONSE)
+ .append(" Message (")
+ .append(num)
+ .append(") does not exist.");
+ responseString = responseBuffer.toString();
+ out.println(responseString);
}
// -------------------------------------------?
} else {
- out.println(ERR_RESPONSE);
+ responseString = ERR_RESPONSE;
+ out.println(responseString);
}
+ out.flush();
+ logResponseString(responseString);
}
+
+ /**
+ * Handler method called upon receipt of a TOP command.
+ * This command retrieves the top N lines of a specified
+ * message in the mailbox.
+ *
+ * The expected command format is
+ * TOP [mail message number] [number of lines to return]
+ *
+ * @param command the command parsed by the parseCommand method
+ * @argument the first argument parsed by the parseCommand method
+ * @argument1 the second argument parsed by the parseCommand method
+ */
private void doTOP(String command,String argument,String argument1) {
+ String responseString = null;
if (state == TRANSACTION) {
int num = 0;
int lines = 0;
@@ -429,13 +811,17 @@
num = Integer.parseInt(argument);
lines = Integer.parseInt(argument1);
} catch (NumberFormatException nfe) {
- out.println(ERR_RESPONSE + " Usage: TOP [mail number] [Line number]");
+ responseString = ERR_RESPONSE + " Usage: TOP [mail number] [Line number]";
+ out.println(responseString);
+ out.flush();
+ logResponseString(responseString);
return;
}
try {
MailImpl mc = (MailImpl) userMailbox.elementAt(num);
if (mc != DELETED) {
- out.println(OK_RESPONSE + " Message follows");
+ responseString = OK_RESPONSE + " Message follows";
+ out.println(responseString);
for (Enumeration e = mc.getMessage().getAllHeaderLines(); e.hasMoreElements(); ) {
out.println(e.nextElement());
}
@@ -447,20 +833,49 @@
mc.writeContentTo(nouts, lines);
out.println(".");
} else {
- out.println(ERR_RESPONSE + " Message (" + num + ") already deleted.");
+ StringBuffer responseBuffer =
+ new StringBuffer(64)
+ .append(ERR_RESPONSE)
+ .append(" Message (")
+ .append(num)
+ .append(") already deleted.");
+ responseString = responseBuffer.toString();
+ out.println(responseString);
}
} catch (IOException ioe) {
- out.println(ERR_RESPONSE + " Error while retrieving message.");
+ responseString = ERR_RESPONSE + " Error while retrieving message.";
+ out.println(responseString);
} catch (MessagingException me) {
- out.println(ERR_RESPONSE + " Error while retrieving message.");
+ responseString = ERR_RESPONSE + " Error while retrieving message.";
+ out.println(responseString);
} catch (ArrayIndexOutOfBoundsException iob) {
- out.println(ERR_RESPONSE + " Message (" + num + ") does not exist.");
+ StringBuffer exceptionBuffer =
+ new StringBuffer(64)
+ .append(ERR_RESPONSE)
+ .append(" Message (")
+ .append(num)
+ .append(") does not exist.");
+ responseString = exceptionBuffer.toString();
+ out.println(responseString);
}
} else {
- out.println(ERR_RESPONSE);
+ responseString = ERR_RESPONSE;
+ out.println(responseString);
}
+ out.flush();
+ logResponseString(responseString);
}
+
+ /**
+ * Handler method called upon receipt of a QUIT command.
+ * This method handles cleanup of the POP3Handler state.
+ *
+ * @param command the command parsed by the parseCommand method
+ * @argument the first argument parsed by the parseCommand method
+ * @argument1 the second argument parsed by the parseCommand method
+ */
private void doQUIT(String command,String argument,String argument1) {
+ String responseString = null;
if (state == AUTHENTICATION_READY || state == AUTHENTICATION_USERSET) {
return;
}
@@ -470,14 +885,44 @@
MailImpl mc = (MailImpl) it.next();
userInbox.remove(mc.getName());
}
- out.println(OK_RESPONSE + " Apache James POP3 Server signing off.");
+ responseString = OK_RESPONSE + " Apache James POP3 Server signing off.";
+ out.println(responseString);
} catch (Exception ex) {
- out.println(ERR_RESPONSE + " Some deleted messages were not removed");
+ responseString = ERR_RESPONSE + " Some deleted messages were not removed";
+ out.println(responseString);
getLogger().error("Some deleted messages were not removed: " + ex.getMessage());
}
+ out.flush();
+ logResponseString(responseString);
}
+
+ /**
+ * Handler method called upon receipt of an unrecognized command.
+ * Returns an error response and logs the command.
+ *
+ * @param command the command parsed by the parseCommand method
+ * @argument the first argument parsed by the parseCommand method
+ * @argument1 the second argument parsed by the parseCommand method
+ */
private void doUnknownCmd(String command,String argument,String argument1) {
- out.println(ERR_RESPONSE);
+ String responseString = ERR_RESPONSE;
+ out.println(responseString);
+ out.flush();
+ logResponseString(responseString);
+ }
+
+ /**
+ * This method logs at a "DEBUG" level the response string that
+ * was sent to the POP3 client. The method is provided largely
+ * as syntactic sugar to neaten up the code base. It is declared
+ * private and final to encourage compiler inlining.
+ *
+ * @param responseString the response string sent to the client
+ */
+ private final void logResponseString(String responseString) {
+ if (getLogger().isDebugEnabled()) {
+ getLogger().debug("Sent: " + responseString);
+ }
}
}
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>