/****************************************************************
* Licensed to the Apache Software Foundation (ASF) under one *
* or more contributor license agreements. See the NOTICE file *
* distributed with this work for additional information *
* regarding copyright ownership. The ASF licenses this file *
* to you under the Apache License, Version 2.0 (the *
* "License"); you may not use this file except in compliance *
* with the License. You may obtain a copy of the License at *
* *
* http://www.apache.org/licenses/LICENSE-2.0 *
* *
* Unless required by applicable law or agreed to in writing, *
* software distributed under the License is distributed on an *
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
* KIND, either express or implied. See the License for the *
* specific language governing permissions and limitations *
* under the License. *
****************************************************************/
package org.apache.james.protocols.pop3.core;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import org.apache.james.protocols.api.CommandHandler;
import org.apache.james.protocols.api.Request;
import org.apache.james.protocols.api.Response;
import org.apache.james.protocols.pop3.POP3Exception;
import org.apache.james.protocols.pop3.POP3Response;
import org.apache.james.protocols.pop3.POP3Session;
/**
* Handles STAT command
*/
public abstract class AbstractStatCmdHandler implements CommandHandler<POP3Session> {
private final static String COMMAND_NAME = "STAT";
/**
* Handler method called upon receipt of a STAT command.
* Returns the number of messages in the mailbox and its
* aggregate size.
*
*/
public Response onCommand(POP3Session session, Request request) {
POP3Response response = null;
if (session.getHandlerState() == POP3Session.TRANSACTION) {
try {
long size = getInboxSize(session);
int count = getMessageCount(session);
StringBuilder responseBuffer =
new StringBuilder(32)
.append(count)
.append(" ")
.append(size);
response = new POP3Response(POP3Response.OK_RESPONSE,responseBuffer.toString());
} catch (POP3Exception me) {
response = new POP3Response(POP3Response.ERR_RESPONSE);
}
} else {
response = new POP3Response(POP3Response.ERR_RESPONSE);
}
return response;
}
/**
* Return the count of all messages in the INBOX
*
* @param session
* @return size
* @throws POP3Exception
*/
protected abstract int getMessageCount(POP3Session session) throws POP3Exception;
/**
* Return the size of the INBOX
* @param session
* @return size
* @throws POP3Exception
*/
protected abstract int getInboxSize(POP3Session session) throws POP3Exception;
/**
* @see org.apache.james.api.protocol.CommonCommandHandler#getImplCommands()
*/
public Collection<String> getImplCommands() {
List<String> commands = new ArrayList<String>();
commands.add(COMMAND_NAME);
return commands;
}
}