1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
/*
* Authenticator.java
* Copyright (C) 2002 The Free Software Foundation
*
* This file is part of GNU JavaMail, a library.
*
* GNU JavaMail is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* GNU JavaMail is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* As a special exception, if you link this library with other files to
* produce an executable, this library does not by itself cause the
* resulting executable to be covered by the GNU General Public License.
* This exception does not however invalidate any other reasons why the
* executable file might be covered by the GNU General Public License.
*/
package javax.mail;
import java.net.InetAddress;
/**
* The class Authenticator represents an object that knows how to obtain
* authentication for a network connection.
* Usually, it will do this by prompting the user for information.
* <p>
* Applications use this class by creating a subclass, and registering an
* instance of that subclass with the session when it is created.
* When authentication is required, the system will invoke a method on the
* subclass (like getPasswordAuthentication). The subclass's method can
* query about the authentication being requested with a number of inherited
* methods (getRequestingXXX()), and form an appropriate message for the
* user.
* <p>
* All methods that request authentication have a default implementation that
* fails.
*
* @author <a href="mailto:dog@gnu.org">Chris Burdess</a>
* @version 1.3
*/
public abstract class Authenticator
{
private String defaultUserName;
private int requestingPort = -1;
private String requestingPrompt;
private String requestingProtocol;
private InetAddress requestingSite;
final PasswordAuthentication requestPasswordAuthentication(
InetAddress requestingSite,
int requestingPort,
String requestingProtocol,
String requestingPrompt,
String defaultUserName)
{
this.requestingSite = requestingSite;
this.requestingPort = requestingPort;
this.requestingProtocol = requestingProtocol;
this.requestingPrompt = requestingPrompt;
this.defaultUserName = defaultUserName;
return getPasswordAuthentication();
}
/**
* Returns the default user name given by the requestor.
*/
protected final String getDefaultUserName()
{
return defaultUserName;
}
/**
* Called when password authentication is needed.
* Subclasses should override the default implementation, which returns null.
* <p>
* Note that if this method uses a dialog to prompt the user for this
* information, the dialog needs to block until the user supplies the
* information. This method can not simply return after showing the dialog.
*/
protected PasswordAuthentication getPasswordAuthentication()
{
return null;
}
/**
* Returns the port for the requested connection.
*/
protected final int getRequestingPort()
{
return requestingPort;
}
/**
* Returns the prompt string given by the requestor.
*/
protected final String getRequestingPrompt()
{
return requestingPrompt;
}
/**
* Returns the protocol requesting the connection.
* Often this will be based on a URLName.
*/
protected final String getRequestingProtocol()
{
return requestingProtocol;
}
/**
* Returns the address of the site requesting authorization,
* or null if not available.
*/
protected final InetAddress getRequestingSite()
{
return requestingSite;
}
}
|
