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     */
017    package org.apache.commons.mail;
018    
019    import javax.mail.Authenticator;
020    import 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     * @author <a href="mailto:quintonm@bellsouth.net">Quinton McCombs</a>
028     * @version $Id: DefaultAuthenticator.java 480401 2006-11-29 04:40:04Z bayard $
029     */
030    public class DefaultAuthenticator extends Authenticator
031    {
032        /** Stores the login information for authentication */
033        private PasswordAuthentication authentication;
034    
035        /**
036         * Default constructor
037         *
038         * @param userName user name to use when authentication is requested
039         * @param password password to use when authentication is requested
040         * @since 1.0
041         */
042        public DefaultAuthenticator(String userName, String password)
043        {
044            this.authentication = new PasswordAuthentication(userName, password);
045        }
046    
047        /**
048         * Gets the authentication object that will be used to login to the mail
049         * server.
050         *
051         * @return A <code>PasswordAuthentication</code> object containing the
052         *         login information.
053         * @since 1.0
054         */
055        protected PasswordAuthentication getPasswordAuthentication()
056        {
057            return this.authentication;
058        }
059    }