geronimo-javamail_1.5/geronimo-javamail_1.5_provider/src/main/java/org/apache/geronimo/javamail/transport/smtp/SMTPReply.java

/*
 * 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.geronimo.javamail.transport.smtp;
 
import java.util.ArrayList;
import java.util.List;

/**
 * Util class to represent a reply from a SMTP server
 * 
 * @version $Rev$ $Date$
 */
class SMTPReply {
    // SMTP reply codes
    public static final int SERVICE_READY = 220;

    public static final int SERVICE_CLOSING = 221;

    public static final int AUTHENTICATION_COMPLETE = 235;

    public static final int COMMAND_ACCEPTED = 250;

    public static final int ADDRESS_NOT_LOCAL = 251;

    public static final int AUTHENTICATION_CHALLENGE = 334;

    public static final int START_MAIL_INPUT = 354;

    public static final int SERVICE_NOT_AVAILABLE = 421;

    public static final int MAILBOX_BUSY = 450;

    public static final int PROCESSING_ERROR = 451;

    public static final int INSUFFICIENT_STORAGE = 452;

    public static final int COMMAND_SYNTAX_ERROR = 500;

    public static final int PARAMETER_SYNTAX_ERROR = 501;

    public static final int COMMAND_NOT_IMPLEMENTED = 502;

    public static final int INVALID_COMMAND_SEQUENCE = 503;

    public static final int COMMAND_PARAMETER_NOT_IMPLEMENTED = 504;

    public static final int MAILBOX_NOT_FOUND = 550;

    public static final int USER_NOT_LOCAL = 551;

    public static final int MAILBOX_FULL = 552;

    public static final int INVALID_MAILBOX = 553;

    public static final int TRANSACTION_FAILED = 553;
    
    // The original reply string
    private final String reply;

    // returned message code
    private final int code;

    // the returned message text
    private final String message;
    
    // additional returned lines from a continued response 
    private List lines; 

    // indicates that this is a continuation response
    private boolean continued;

    SMTPReply(String s) throws MalformedSMTPReplyException {
        // save the reply
        reply = s;

        // In a normal response, the first 3 must be the return code. However,
        // the response back from a QUIT command is frequently a null string.
        // Therefore, if the result is
        // too short, just default the code to -1 and use the entire text for
        // the message.
        if (s == null || s.length() < 3) {
            code = -1;
            message = s;
            return;
        }

        try {
            continued = false;
            code = Integer.parseInt(s.substring(0, 3));

            // message should be separated by a space OR a continuation
            // character if this is a
            // multi-line response.
            if (s.length() > 4) {
                //
                if (s.charAt(3) == '-') {
                    continued = true;
                }
                message = s.substring(4);
            } else {
                message = "";
            }
        } catch (NumberFormatException e) {
            throw new MalformedSMTPReplyException("error in parsing code", e);
        }
    }
    
    /**
     * Add a line to a continued response.  This will 
     * update the continued status if the end of the 
     * response is reached. 
     * 
     * @param line   The line to add.
     */
    public void addLine(String line) {
        if (lines == null) {
            lines = new ArrayList(); 
            lines.add(message); 
        }
        // mark if we're still continued 
        continued = line.charAt(3) == '-';
        // add the line to the list 
        lines.add(line.substring(4)); 
    }
    
    /**
     * Get the list of all of the lines associated with 
     * this reply. 
     * 
     * @return A List containing all lines associated with this
     *         reply.
     */
    public List getLines() {
        if (lines == null) {
            lines = new ArrayList(); 
            lines.add(message); 
        }
        return lines;
    }
    

    /**
     * Return the code value associated with the reply.
     * 
     * @return The integer code associated with the reply.
     */
    public int getCode() {
        return this.code;
    }

    /**
     * Get the message text associated with the reply.
     * 
     * @return The string value of the message from the reply.
     */
    public String getMessage() {
        return this.message;
    }

    /**
     * Retrieve the raw reply string for the reponse.
     * 
     * @return The original reply string from the server.
     */
    public String getReply() {
        return reply;
    }

    /**
     * Indicates if reply is an error condition
     */
    boolean isError() {
        // error codes are all above 400
        return code >= 400;
    }

    /**
     * Indicates whether this response is flagged as part of a multiple line
     * response.
     * 
     * @return true if the response has multiple lines, false if this is the
     *         last line of the response.
     */
    public boolean isContinued() {
        return continued;
    }

    public String toString() {
        return "CODE = " + getCode() + " : MSG = " + getMessage();
    }
}