log4j-smtp/src/test/java/org/apache/logging/dumbster/smtp/SmtpActionType.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.logging.dumbster.smtp;

/**
 * Represents an SMTP action or command.
 */
public class SmtpActionType {
    /**
     * Internal value for the action type.
     */
    private final byte value;

    /**
     * Internal representation of the CONNECT action.
     */
    private static final byte CONNECT_BYTE = (byte) 1;
    /**
     * Internal representation of the EHLO action.
     */
    private static final byte EHLO_BYTE = (byte) 2;
    /**
     * Internal representation of the MAIL FROM action.
     */
    private static final byte MAIL_BYTE = (byte) 3;
    /**
     * Internal representation of the RCPT action.
     */
    private static final byte RCPT_BYTE = (byte) 4;
    /**
     * Internal representation of the DATA action.
     */
    private static final byte DATA_BYTE = (byte) 5;
    /**
     * Internal representation of the DATA END (.) action.
     */
    private static final byte DATA_END_BYTE = (byte) 6;
    /**
     * Internal representation of the QUIT action.
     */
    private static final byte QUIT_BYTE = (byte) 7;
    /**
     * Internal representation of an unrecognized action: body text gets this action type.
     */
    private static final byte UNREC_BYTE = (byte) 8;
    /**
     * Internal representation of the blank line action: separates headers and body text.
     */
    private static final byte BLANK_LINE_BYTE = (byte) 9;

    /**
     * Internal representation of the stateless RSET action.
     */
    private static final byte RSET_BYTE = (byte) -1;
    /**
     * Internal representation of the stateless VRFY action.
     */
    private static final byte VRFY_BYTE = (byte) -2;
    /**
     * Internal representation of the stateless EXPN action.
     */
    private static final byte EXPN_BYTE = (byte) -3;
    /**
     * Internal representation of the stateless HELP action.
     */
    private static final byte HELP_BYTE = (byte) -4;
    /**
     * Internal representation of the stateless NOOP action.
     */
    private static final byte NOOP_BYTE = (byte) -5;

    /**
     * CONNECT action.
     */
    public static final SmtpActionType CONNECT = new SmtpActionType(CONNECT_BYTE);
    /**
     * EHLO action.
     */
    public static final SmtpActionType EHLO = new SmtpActionType(EHLO_BYTE);
    /**
     * MAIL action.
     */
    public static final SmtpActionType MAIL = new SmtpActionType(MAIL_BYTE);
    /**
     * RCPT action.
     */
    public static final SmtpActionType RCPT = new SmtpActionType(RCPT_BYTE);
    /**
     * DATA action.
     */
    public static final SmtpActionType DATA = new SmtpActionType(DATA_BYTE);
    /**
     * "." action.
     */
    public static final SmtpActionType DATA_END = new SmtpActionType(DATA_END_BYTE);
    /**
     * Body text action.
     */
    public static final SmtpActionType UNRECOG = new SmtpActionType(UNREC_BYTE);
    /**
     * QUIT action.
     */
    public static final SmtpActionType QUIT = new SmtpActionType(QUIT_BYTE);
    /**
     * Header/body separator action.
     */
    public static final SmtpActionType BLANK_LINE = new SmtpActionType(BLANK_LINE_BYTE);

    /**
     * Stateless RSET action.
     */
    public static final SmtpActionType RSET = new SmtpActionType(RSET_BYTE);
    /**
     * Stateless VRFY action.
     */
    public static final SmtpActionType VRFY = new SmtpActionType(VRFY_BYTE);
    /**
     * Stateless EXPN action.
     */
    public static final SmtpActionType EXPN = new SmtpActionType(EXPN_BYTE);
    /**
     * Stateless HELP action.
     */
    public static final SmtpActionType HELP = new SmtpActionType(HELP_BYTE);
    /**
     * Stateless NOOP action.
     */
    public static final SmtpActionType NOOP = new SmtpActionType(NOOP_BYTE);

    /**
     * Create a new SMTP action type. Private to ensure no invalid values.
     *
     * @param value one of the _BYTE values
     */
    private SmtpActionType(final byte value) {
        this.value = value;
    }

    /**
     * Indicates whether the action is stateless or not.
     *
     * @return true iff the action is stateless
     */
    public boolean isStateless() {
        return value < 0;
    }

    /**
     * String representation of this SMTP action type.
     *
     * @return a String
     */
    @Override
    public String toString() {
        switch (value) {
            case CONNECT_BYTE:
                return "Connect";
            case EHLO_BYTE:
                return "EHLO";
            case MAIL_BYTE:
                return "MAIL";
            case RCPT_BYTE:
                return "RCPT";
            case DATA_BYTE:
                return "DATA";
            case DATA_END_BYTE:
                return ".";
            case QUIT_BYTE:
                return "QUIT";
            case RSET_BYTE:
                return "RSET";
            case VRFY_BYTE:
                return "VRFY";
            case EXPN_BYTE:
                return "EXPN";
            case HELP_BYTE:
                return "HELP";
            case NOOP_BYTE:
                return "NOOP";
            case UNREC_BYTE:
                return "Unrecognized command / data";
            case BLANK_LINE_BYTE:
                return "Blank line";
            default:
                return "Unknown";
        }
    }
}