```
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 and Description

static class Authenticator.RequestorType
The type of the entity requesting authentication.

Authenticator (Java Platform SE 7 ) Home of API Java Contents Haut

Constructor Summary

Constructors
Constructor and Description

Authenticator()

Authenticator (Java Platform SE 7 ) Home of API Java Contents Haut

Method Summary

Methods
Modifier and Type	Method and 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.

Authenticator (Java Platform SE 7 ) Home of API Java Contents Haut

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Authenticator
```
public Authenticator()
```
- Method Detail
  - setDefault
```
public 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.
    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 - if a security manager exists and its checkPermission method doesn't allow setting the default authenticator.
    See Also:
    SecurityManager.checkPermission(java.security.Permission), NetPermission
  - requestPasswordAuthentication
```
public 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.
    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())
    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 - if a security manager exists and its checkPermission method doesn't allow the password authentication request.
    See Also:
    SecurityManager.checkPermission(java.security.Permission), NetPermission
  - requestPasswordAuthentication
```
public 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. 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())
    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 - 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), NetPermission
  - requestPasswordAuthentication
```
public 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.
    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())
    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 - 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), NetPermission
  - getRequestingHost
```
protected final String 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 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 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 protcol, optionally followed by "/version", where version is a version number.
    See Also:
    URL.getProtocol()
  - getRequestingPrompt
```
protected final String 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 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 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 getRequestingURL()
```
    Returns the URL that resulted in this request for authentication.
    
    Returns:
    the requesting URL
    Since:
    
    1.5
  - getRequestorType
```
protected Authenticator.RequestorType getRequestorType()
```
    Returns whether the requestor is a Proxy or a Server.
    
    Returns:
    the authentication type of the requestor
    Since:
    
    1.5

Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/net/authenticator.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

Manuel PHP : https://docs.oracle.com

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut

Class Authenticator

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Authenticator

Method Detail

setDefault

requestPasswordAuthentication

requestPasswordAuthentication

requestPasswordAuthentication

getRequestingHost

getRequestingSite

getRequestingPort

getRequestingProtocol

getRequestingPrompt

getRequestingScheme

getPasswordAuthentication

getRequestingURL

getRequestorType

References