Home » openjdk-7 » java » net » [javadoc | source]
java.net
abstract public class: Authenticator [javadoc | source]
java.lang.Object
   java.net.Authenticator
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.

Nested Class Summary:
public enum class  Authenticator.RequestorType  The type of the entity requesting authentication. 
Method from java.net.Authenticator Summary:
getPasswordAuthentication,   getRequestingHost,   getRequestingPort,   getRequestingPrompt,   getRequestingProtocol,   getRequestingScheme,   getRequestingSite,   getRequestingURL,   getRequestorType,   requestPasswordAuthentication,   requestPasswordAuthentication,   requestPasswordAuthentication,   setDefault
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.net.Authenticator Detail:
 protected PasswordAuthentication getPasswordAuthentication() 
    Called when password authorization is needed. Subclasses should override the default implementation, which returns null.
 protected final String getRequestingHost() 
    Gets the hostname of the site or proxy requesting authentication, or null if not available.
 protected final int getRequestingPort() 
    Gets the port number for the requested connection.
 protected final String getRequestingPrompt() 
    Gets the prompt string given by the requestor.
 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.
 protected final String getRequestingScheme() 
    Gets the scheme of the requestor (the HTTP scheme for an HTTP firewall, for example).
 protected final 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 RequestorType getRequestorType() 
    Returns whether the requestor is a Proxy or a Server.
 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.

 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.

 public static PasswordAuthentication requestPasswordAuthentication(String host,
    InetAddress addr,
    int port,
    String protocol,
    String prompt,
    String scheme,
    URL url,
    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.

 public static synchronized  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.