001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.mail;
018
019import javax.mail.Authenticator;
020import javax.mail.PasswordAuthentication;
021
022/**
023 * This is a very simple authentication object that can be used for any
024 * transport needing basic userName and password type authentication.
025 *
026 * @since 1.0
027 * @version $Id: DefaultAuthenticator.java 1459997 2013-03-22 21:23:15Z tn $
028 */
029public class DefaultAuthenticator extends Authenticator
030{
031    /** Stores the login information for authentication. */
032    private final PasswordAuthentication authentication;
033
034    /**
035     * Default constructor.
036     *
037     * @param userName user name to use when authentication is requested
038     * @param password password to use when authentication is requested
039     * @since 1.0
040     */
041    public DefaultAuthenticator(String userName, String password)
042    {
043        this.authentication = new PasswordAuthentication(userName, password);
044    }
045
046    /**
047     * Gets the authentication object that will be used to login to the mail
048     * server.
049     *
050     * @return A <code>PasswordAuthentication</code> object containing the
051     *         login information.
052     * @since 1.0
053     */
054    @Override
055    protected PasswordAuthentication getPasswordAuthentication()
056    {
057        return this.authentication;
058    }
059}