Authenticator (Java Platform SE 8 ) (original) (raw)

java.lang.Object
- java.net.Authenticator

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 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 PasswordAuthentication return value.
An instance of this concrete sub-class is then registered with the system by calling 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.
Since:
1.2
See Also:
setDefault(java.net.Authenticator), getPasswordAuthentication()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Authenticator.RequestorType	The type of the entity requesting authentication.

Constructor Summary

Constructors

Constructor	Description
Authenticator()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods

Modifier and Type	Method	Description
protected PasswordAuthentication	getPasswordAuthentication()	Called when password authorization is needed.
protected String	getRequestingHost()	Gets the hostname of the site or proxy requesting authentication, or null if not available.
protected int	getRequestingPort()	Gets the port number for the requested connection.
protected String	getRequestingPrompt()	Gets the prompt string given by the requestor.
protected String	getRequestingProtocol()	Give the protocol that's requesting the connection.
protected String	getRequestingScheme()	Gets the scheme of the requestor (the HTTP scheme for an HTTP firewall, for example).
protected InetAddress	getRequestingSite()	Gets the InetAddress of the site requesting authorization, or null if not available.
protected URL	getRequestingURL()	Returns the URL that resulted in this request for authentication.
protected Authenticator.RequestorType	getRequestorType()	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	setDefault(Authenticator a)	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](../../java/lang/Object.html "class in java.lang")  
   `[clone](../../java/lang/Object.html#clone--), [equals](../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../java/lang/Object.html#finalize--), [getClass](../../java/lang/Object.html#getClass--), [hashCode](../../java/lang/Object.html#hashCode--), [notify](../../java/lang/Object.html#notify--), [notifyAll](../../java/lang/Object.html#notifyAll--), [toString](../../java/lang/Object.html#toString--), [wait](../../java/lang/Object.html#wait--), [wait](../../java/lang/Object.html#wait-long-), [wait](../../java/lang/Object.html#wait-long-int-)`

Constructor Detail

 * #### Authenticator  
 public Authenticator()

Method Detail

* #### setDefault  
public static void setDefault([Authenticator](../../java/net/Authenticator.html "class in java.net") a)  
Sets the authenticator that will be used by the networking code when a proxy or an HTTP server asks for authentication.  
 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.  
Parameters:  
`a` \- The authenticator to be set. If a is `null` then any previously set authenticator is removed.  
Throws:  
`[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- if a security manager exists and its`checkPermission` method doesn't allow setting the default authenticator.  
See Also:  
[SecurityManager.checkPermission(java.security.Permission)](../../java/lang/SecurityManager.html#checkPermission-java.security.Permission-), [NetPermission](../../java/net/NetPermission.html "class in java.net")  
* #### requestPasswordAuthentication  
public static [PasswordAuthentication](../../java/net/PasswordAuthentication.html "class in java.net") requestPasswordAuthentication([InetAddress](../../java/net/InetAddress.html "class in java.net") addr,  
                                                                   int port,  
                                                                   [String](../../java/lang/String.html "class in java.lang") protocol,  
                                                                   [String](../../java/lang/String.html "class in java.lang") prompt,  
                                                                   [String](../../java/lang/String.html "class in java.lang") scheme)  
Ask the authenticator that has been registered with the system for a password.  
 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.  
Parameters:  
`addr` \- The InetAddress of the site requesting authorization, or null if not known.  
`port` \- the port for the requested connection  
`protocol` \- The protocol that's requesting the connection ([getRequestingProtocol()](../../java/net/Authenticator.html#getRequestingProtocol--))  
`prompt` \- A prompt string for the user  
`scheme` \- The authentication scheme  
Returns:  
The username/password, or null if one can't be gotten.  
Throws:  
`[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- if a security manager exists and its`checkPermission` method doesn't allow the password authentication request.  
See Also:  
[SecurityManager.checkPermission(java.security.Permission)](../../java/lang/SecurityManager.html#checkPermission-java.security.Permission-), [NetPermission](../../java/net/NetPermission.html "class in java.net")  
* #### requestPasswordAuthentication  
public static [PasswordAuthentication](../../java/net/PasswordAuthentication.html "class in java.net") requestPasswordAuthentication([String](../../java/lang/String.html "class in java.lang") host,  
                                                                   [InetAddress](../../java/net/InetAddress.html "class in java.net") addr,  
                                                                   int port,  
                                                                   [String](../../java/lang/String.html "class in java.lang") protocol,  
                                                                   [String](../../java/lang/String.html "class in java.lang") prompt,  
                                                                   [String](../../java/lang/String.html "class in java.lang") scheme)  
Ask the authenticator that has been registered with the system for a password. This is the preferred method for requesting a password because the hostname can be provided in cases where the InetAddress is not available.  
 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.  
Parameters:  
`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 ([getRequestingProtocol()](../../java/net/Authenticator.html#getRequestingProtocol--))  
`prompt` \- A prompt string for the user which identifies the authentication realm.  
`scheme` \- The authentication scheme  
Returns:  
The username/password, or null if one can't be gotten.  
Throws:  
`[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- if a security manager exists and its`checkPermission` method doesn't allow the password authentication request.  
Since:  
1.4  
See Also:  
[SecurityManager.checkPermission(java.security.Permission)](../../java/lang/SecurityManager.html#checkPermission-java.security.Permission-), [NetPermission](../../java/net/NetPermission.html "class in java.net")  
* #### requestPasswordAuthentication  
public static [PasswordAuthentication](../../java/net/PasswordAuthentication.html "class in java.net") requestPasswordAuthentication([String](../../java/lang/String.html "class in java.lang") host,  
                                                                   [InetAddress](../../java/net/InetAddress.html "class in java.net") addr,  
                                                                   int port,  
                                                                   [String](../../java/lang/String.html "class in java.lang") protocol,  
                                                                   [String](../../java/lang/String.html "class in java.lang") prompt,  
                                                                   [String](../../java/lang/String.html "class in java.lang") scheme,  
                                                                   [URL](../../java/net/URL.html "class in java.net") url,  
                                                                   [Authenticator.RequestorType](../../java/net/Authenticator.RequestorType.html "enum in java.net") reqType)  
Ask the authenticator that has been registered with the system for a password.  
 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.  
Parameters:  
`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 connection  
`protocol` \- The protocol that's requesting the connection ([getRequestingProtocol()](../../java/net/Authenticator.html#getRequestingProtocol--))  
`prompt` \- A prompt string for the user  
`scheme` \- The authentication scheme  
`url` \- The requesting URL that caused the authentication  
`reqType` \- The type (server or proxy) of the entity requesting authentication.  
Returns:  
The username/password, or null if one can't be gotten.  
Throws:  
`[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- if a security manager exists and its`checkPermission` method doesn't allow the password authentication request.  
Since:  
1.5  
See Also:  
[SecurityManager.checkPermission(java.security.Permission)](../../java/lang/SecurityManager.html#checkPermission-java.security.Permission-), [NetPermission](../../java/net/NetPermission.html "class in java.net")  
* #### getRequestingHost  
protected final [String](../../java/lang/String.html "class in java.lang") getRequestingHost()  
Gets the `hostname` of the site or proxy requesting authentication, or `null` if not available.  
Returns:  
the hostname of the connection requiring authentication, or null if it's not available.  
Since:  
1.4  
* #### getRequestingSite  
protected final [InetAddress](../../java/net/InetAddress.html "class in java.net") getRequestingSite()  
Gets the `InetAddress` of the site requesting authorization, or `null` if not available.  
Returns:  
the InetAddress of the site requesting authorization, or null if it's not available.  
* #### getRequestingPort  
protected final int getRequestingPort()  
Gets the port number for the requested connection.  
Returns:  
an `int` indicating the port for the requested connection.  
* #### getRequestingProtocol  
protected final [String](../../java/lang/String.html "class in java.lang") getRequestingProtocol()  
Give the protocol that's requesting the connection. Often this will be based on a URL, but in a future JDK it could be, for example, "SOCKS" for a password-protected SOCKS5 firewall.  
Returns:  
the protocol, optionally followed by "/version", where version is a version number.  
See Also:  
[URL.getProtocol()](../../java/net/URL.html#getProtocol--)  
* #### getRequestingPrompt  
protected final [String](../../java/lang/String.html "class in java.lang") getRequestingPrompt()  
Gets the prompt string given by the requestor.  
Returns:  
the prompt string given by the requestor (realm for http requests)  
* #### getRequestingScheme  
protected final [String](../../java/lang/String.html "class in java.lang") getRequestingScheme()  
Gets the scheme of the requestor (the HTTP scheme for an HTTP firewall, for example).  
Returns:  
the scheme of the requestor  
* #### getPasswordAuthentication  
protected [PasswordAuthentication](../../java/net/PasswordAuthentication.html "class in java.net") getPasswordAuthentication()  
Called when password authorization is needed. Subclasses should override the default implementation, which returns null.  
Returns:  
The PasswordAuthentication collected from the user, or null if none is provided.  
* #### getRequestingURL  
protected [URL](../../java/net/URL.html "class in java.net") getRequestingURL()  
Returns the URL that resulted in this request for authentication.  
Returns:  
the requesting URL  
Since:  
1.5  
* #### getRequestorType  
protected [Authenticator.RequestorType](../../java/net/Authenticator.RequestorType.html "enum in java.net") getRequestorType()  
Returns whether the requestor is a Proxy or a Server.  
Returns:  
the authentication type of the requestor  
Since:  
1.5

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

Authenticator (Java Platform SE 8 ) (original) (raw)

Nested Class Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail