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 */
028public class DefaultAuthenticator extends Authenticator
029{
030    /** Stores the login information for authentication. */
031    private final PasswordAuthentication authentication;
032
033    /**
034     * Default constructor.
035     *
036     * @param userName user name to use when authentication is requested
037     * @param password password to use when authentication is requested
038     * @since 1.0
039     */
040    public DefaultAuthenticator(final String userName, final String password)
041    {
042        this.authentication = new PasswordAuthentication(userName, password);
043    }
044
045    /**
046     * Gets the authentication object that will be used to login to the mail
047     * server.
048     *
049     * @return A <code>PasswordAuthentication</code> object containing the
050     *         login information.
051     * @since 1.0
052     */
053    @Override
054    protected PasswordAuthentication getPasswordAuthentication()
055    {
056        return this.authentication;
057    }
058}