| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public abstract class Authenticator extends Object
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.
Applications use this class by overriding {@link #getPasswordAuthentication()} in a sub-class. This method will typically use the various getXXX() accessor methods to get information about the entity requesting authentication. It must then acquire a username and password either by interacting with the user or through some other non-interactive means. The credentials are then returned as a {@link PasswordAuthentication} return value.
An instance of this concrete sub-class is then registered with the system by calling {@link #setDefault(Authenticator)}. When authentication is required, the system will invoke one of the requestPasswordAuthentication() methods which in turn will call the getPasswordAuthentication() method of the registered object.
All methods that request authentication have a default implementation that fails.
Nested Class Summary | |
---|---|
static enum |
The type of the entity requesting authentication. |
Constructor Summary | |
---|---|
|
Method Summary | |
---|---|
protected PasswordAuthentication |
Called when password authorization is needed. |
protected String |
Gets the hostname of the
site or proxy requesting authentication, or null
if not available.
|
protected int |
Gets the port number for the requested connection. |
protected String |
Gets the prompt string given by the requestor. |
protected String |
Give the protocol that's requesting the connection. |
protected String |
Gets the scheme of the requestor (the HTTP scheme for an HTTP firewall, for example). |
protected InetAddress |
Gets the InetAddress of the
site requesting authorization, or null
if not available.
|
protected URL |
Returns the URL that resulted in this request for authentication. |
protected Authenticator.RequestorType |
Returns whether the requestor is a Proxy or a Server. |
static PasswordAuthentication |
requestPasswordAuthentication(InetAddress addr, int port, String protocol, String prompt, String scheme) Ask the authenticator that has been registered with the system for a password. |
static PasswordAuthentication |
requestPasswordAuthentication(String host, InetAddress addr, int port, String protocol, String prompt, String scheme) Ask the authenticator that has been registered with the system for a password. |
static PasswordAuthentication |
requestPasswordAuthentication(String host, InetAddress addr, int port, String protocol, String prompt, String scheme, URL url, Authenticator.RequestorType reqType) Ask the authenticator that has been registered with the system for a password. |
static void |
Sets the authenticator that will be used by the networking code when a proxy or an HTTP server asks for authentication. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Authenticator()
Method Detail |
---|
protected PasswordAuthentication getPasswordAuthentication()
protected final String getRequestingHost()
hostname
of the
site or proxy requesting authentication, or null
if not available.
protected final int getRequestingPort()
int
indicating the
port for the requested connection.protected final String getRequestingPrompt()
protected final String getRequestingProtocol()
protected final String getRequestingScheme()
protected final InetAddress getRequestingSite()
InetAddress
of the
site requesting authorization, or null
if not available.
protected URL getRequestingURL()
protected Authenticator.RequestorType getRequestorType()
public static PasswordAuthentication requestPasswordAuthentication(InetAddress addr, int port, String protocol, String prompt, String scheme)
First, if there is a security manager, its checkPermission
method is called with a
NetPermission("requestPasswordAuthentication")
permission.
This may result in a java.lang.SecurityException.
addr
- The InetAddress of the site requesting authorization,
or null if not known.port
- the port for the requested connectionprotocol
- The protocol that's requesting the connection
({@link java.net.Authenticator#getRequestingProtocol()})prompt
- A prompt string for the userscheme
- The authentication schemepublic static PasswordAuthentication requestPasswordAuthentication(String host, InetAddress addr, int port, String protocol, String prompt, String scheme)
First, if there is a security manager, its checkPermission
method is called with a
NetPermission("requestPasswordAuthentication")
permission.
This may result in a java.lang.SecurityException.
host
- The hostname of the site requesting authentication.addr
- The InetAddress of the site requesting authentication,
or null if not known.port
- the port for the requested connection.protocol
- The protocol that's requesting the connection
({@link java.net.Authenticator#getRequestingProtocol()})prompt
- A prompt string for the user which identifies the authentication realm.scheme
- The authentication schemepublic static PasswordAuthentication requestPasswordAuthentication(String host, InetAddress addr, int port, String protocol, String prompt, String scheme, URL url, Authenticator.RequestorType reqType)
First, if there is a security manager, its checkPermission
method is called with a
NetPermission("requestPasswordAuthentication")
permission.
This may result in a java.lang.SecurityException.
host
- The hostname of the site requesting authentication.addr
- The InetAddress of the site requesting authorization,
or null if not known.port
- the port for the requested connectionprotocol
- The protocol that's requesting the connection
({@link java.net.Authenticator#getRequestingProtocol()})prompt
- A prompt string for the userscheme
- The authentication schemeurl
- The requesting URL that caused the authenticationreqType
- The type (server or proxy) of the entity requesting
authentication.public static synchronized void setDefault(Authenticator a)
First, if there is a security manager, its checkPermission
method is called with a
NetPermission("setDefaultAuthenticator")
permission.
This may result in a java.lang.SecurityException.
a
- The authenticator to be set. If a is null
then
any previously set authenticator is removed.
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |