com.github.sleroy.junit.mail.server.SMTPAuthHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fakesmtp-junit-runner Show documentation

JUnit Rule to create a FakeSmtp server to write mailing integration tests

There is a newer version: 0.1.1

Show newest version

/*
 *
 */
package com.github.sleroy.junit.mail.server;

import org.subethamail.smtp.AuthenticationHandler;

/**
 * Simulates an authentication handler to allow capturing emails that are set up
 * with login authentication.
 *
 * @author jasonpenny
 * @since 1.2
 */
final class SMTPAuthHandler implements AuthenticationHandler {
    public static final String USER_IDENTITY = "User";

    private int pass = 0;

    private final String userName;

    private final String password;

    public SMTPAuthHandler(final String userName, final String password) {
	super();
	this.userName = userName;
	this.password = password;
    }

    /**
     * Simulates an authentication process.
     * 
     * 

     * first prompts for username;
     * then, prompts for password;
     * finally, returns {@code null} to finish the authentication
     * process;
     * 
     * 
     *
     * @return null if the authentication process is finished,
     *         otherwise a string to hand back to the client.
     * @param clientInput
     *            The client's input, eg "AUTH PLAIN dGVzdAB0ZXN0ADEyMzQ="
     */
    @Override
    public String auth(final String clientInput) {
	String prompt;

	if (++pass == 1) {
	    prompt = userName;
	} else if (pass == 2) {
	    prompt = password;
	} else {
	    pass = 0;
	    prompt = null;
	}
	return prompt;
    }

    /**
     * If the authentication process was successful, this returns the identity
     * of the user. The type defining the identity can vary depending on the
     * authentication mechanism used, but typically this returns a String
     * username. If authentication was not successful, the return value is
     * undefined.
     */
    @Override
    public Object getIdentity() {
	return SMTPAuthHandler.USER_IDENTITY;
    }
}