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 */
28 public class DefaultAuthenticator extends Authenticator
29 {
30 /** Stores the login information for authentication. */
31 private final PasswordAuthentication authentication;
32
33 /**
34 * Default constructor.
35 *
36 * @param userName user name to use when authentication is requested
37 * @param password password to use when authentication is requested
38 * @since 1.0
39 */
40 public DefaultAuthenticator(final String userName, final String password)
41 {
42 this.authentication = new PasswordAuthentication(userName, password);
43 }
44
45 /**
46 * Gets the authentication object that will be used to login to the mail
47 * server.
48 *
49 * @return A <code>PasswordAuthentication</code> object containing the
50 * login information.
51 * @since 1.0
52 */
53 @Override
54 protected PasswordAuthentication getPasswordAuthentication()
55 {
56 return this.authentication;
57 }
58 }