org.mailster.smtp.api.handler.AbstractDeliveryHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mailster-smtp Show documentation
A NIO SMTP server API written in Java
There is a newer version: 1.0.6
package org.mailster.smtp.api.handler;

import java.io.IOException;
import java.io.InputStream;
import java.net.SocketAddress;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;

import org.mailster.smtp.api.MessageListener;
import org.mailster.smtp.core.SMTPContext;
import org.mailster.smtp.core.TooMuchDataException;
import org.mailster.smtp.core.auth.AuthenticationHandler;
import org.mailster.smtp.core.auth.Credential;
import org.mailster.smtp.core.auth.LoginFailedException;

/**
 * A simple base class to make implementation of delivery handlers easier.
 *
 * @author De Oliveira Edouard <[email protected]>
 */
abstract public class AbstractDeliveryHandler implements AuthenticationHandler {

    private AuthenticationHandler authHandler;
    private Collection listeners;
    private DeliveryContext ctx;
    private SessionContextImpl sessionCtx;

    protected AbstractDeliveryHandler(DeliveryContext ctx, AuthenticationHandler authHandler) {
        this.authHandler = authHandler;
        this.ctx = ctx;
        this.sessionCtx = new SessionContextImpl();
    }

    public DeliveryContext getDeliveryContext() {
        return ctx;
    }

    public SessionContext getSessionContext() {
        return sessionCtx;
    }

    public Collection getListeners() {
        return listeners;
    }

    public void setListeners(Collection listeners) {
        this.listeners = listeners;
    }

    @Override
    public boolean auth(String clientInput, StringBuilder response, SMTPContext ctx) throws LoginFailedException {
        return authHandler.auth(clientInput, response, ctx);
    }

    @Override
    public void resetState() {
        authHandler.resetState();
    }

    @Override
    public List getAuthenticationMechanisms() {
        return authHandler.getAuthenticationMechanisms();
    }

    /**
     * Returns the @link {@link AuthenticationHandler}.
     */
    public AuthenticationHandler getAuthenticationHandler() {
        return authHandler;
    }

    /**
     * Called first, after the MAIL FROM during a SMTP exchange.
     *
     * @param from is the sender as specified by the client.  It will
     *             be a rfc822-compliant email address, already validated by
     *             the server.
     * @throws RejectException if the sender should be denied.
     */
    public abstract void from(String from) throws RejectException;

    /**
     * Called once for every RCPT TO during a SMTP exchange.
     * This will occur after a from() call.
     *
     * @param recipient is a rfc822-compliant email address,
     *                  validated by the server.
     * @throws RejectException if the recipient should be denied.
     */
    public abstract void recipient(String recipient) throws RejectException;

    /**
     * Called when the DATA part of the SMTP exchange begins.  Will
     * only be called if at least one recipient was accepted.
     *
     * @param data will be the smtp data stream, stripped of any extra '.' chars
     * @throws TooMuchDataException if the listener can't handle that much data.
     *                              An error will be reported to the client.
     * @throws IOException          if there is an IO error reading the input data.
     */
    public abstract void data(InputStream data) throws TooMuchDataException, IOException;

    /**
     * This method is called whenever a RSET command is sent or after the end of
     * the DATA command. It can be used to clean up any pending deliveries.
     */
    public abstract void resetMessageState();

    private class SessionContextImpl implements SessionContext {

        private HashMap attrs = new HashMap<>();

        public SessionContextImpl() {
        }

        @Override
        public void addAttribute(String key, Object attr) {
            attrs.put(key, attr);
        }

        @Override
        public Object getAttribute(String key) {
            return attrs.get(key);
        }

        @Override
        public Credential getCredential() {
            return ctx.getCredential();
        }

        @Override
        public SocketAddress getRemoteAddress() {
            return ctx.getRemoteAddress();
        }

        @Override
        public void removeAttribute(String key) {
            attrs.remove(key);
        }

        @Override
        public void setAttribute(String key, Object attr) {
            attrs.put(key, attr);
        }
    }
}