View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.mail;
18  
19  import javax.mail.Authenticator;
20  import javax.mail.PasswordAuthentication;
21  
22  /**
23   * This is a very simple authentication object that can be used for any
24   * transport needing basic userName and password type authentication.
25   *
26   * @since 1.0
27   * @version $Id: DefaultAuthenticator.java 1459997 2013-03-22 21:23:15Z tn $
28   */
29  public class DefaultAuthenticator extends Authenticator
30  {
31      /** Stores the login information for authentication. */
32      private final PasswordAuthentication authentication;
33  
34      /**
35       * Default constructor.
36       *
37       * @param userName user name to use when authentication is requested
38       * @param password password to use when authentication is requested
39       * @since 1.0
40       */
41      public DefaultAuthenticator(String userName, String password)
42      {
43          this.authentication = new PasswordAuthentication(userName, password);
44      }
45  
46      /**
47       * Gets the authentication object that will be used to login to the mail
48       * server.
49       *
50       * @return A <code>PasswordAuthentication</code> object containing the
51       *         login information.
52       * @since 1.0
53       */
54      @Override
55      protected PasswordAuthentication getPasswordAuthentication()
56      {
57          return this.authentication;
58      }
59  }