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