Overview  Package   Class  Use  Deprecated  Index
Home >> All >> java >> [ net overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

java.net
Class Authenticator  

java.lang.Object
  java.net.Authenticator

---

public abstract class Authenticator

extends java.lang.Object

This abstract class provides a model for obtaining authentication information (in the form of a username and password) required by some network operations (such as hitting a password protected web site).

To make use of this feature, a programmer must create a subclass that knows how to obtain the necessary info. An example would be a class that popped up a dialog box to prompt the user. After creating an instance of that subclass, the static setDefault method of this class is called to set up that instance as the object to use on subsequent calls to obtain authorization.

Since:

1.2

---

Field Summary
private  InetAddress	addr           InternetAddress of the site requesting authentication
private static Authenticator	defaultAuthenticator           This is the default Authenticator object to use for password requests
private  java.lang.String	host           The hostname of the site requesting authentication
private  int	port           The port number of the site requesting authentication
private  java.lang.String	prompt           The prompt to display to the user when requesting authentication info
private  java.lang.String	protocol           The protocol name of the site requesting authentication
private  java.lang.String	scheme           The authentication scheme in use

 

Constructor Summary

Authenticator()           Default, no-argument constructor for subclasses to call.

 

Method Summary
protected  PasswordAuthentication	getPasswordAuthentication()           This method is called whenever a request for authentication is made.
protected  java.lang.String	getRequestingHost()           Returns the hostname of the host or proxy requesting authorization, or null if not available.
protected  int	getRequestingPort()           This method returns the port of the site that is requesting authentication.
protected  java.lang.String	getRequestingPrompt()           Returns the prompt that should be used when requesting authentication information from the user
protected  java.lang.String	getRequestingProtocol()           This method returns the requesting protocol of the operation that is requesting authentication
protected  java.lang.String	getRequestingScheme()           This method returns the authentication scheme in use
protected  InetAddress	getRequestingSite()           This method returns the address of the site that is requesting authentication.
static PasswordAuthentication	requestPasswordAuthentication(InetAddress addr, int port, java.lang.String protocol, java.lang.String prompt, java.lang.String scheme)           This method is called whenever a username and password for a given network operation is required.
static PasswordAuthentication	requestPasswordAuthentication(java.lang.String host, InetAddress addr, int port, java.lang.String protocol, java.lang.String prompt, java.lang.String scheme)           This method is called whenever a username and password for a given network operation is required.
static void	setDefault(Authenticator defAuth)           This method sets the default Authenticator object (an instance of a subclass of Authenticator) to use when prompting the user for information.

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

defaultAuthenticator

private static Authenticator defaultAuthenticator

This is the default Authenticator object to use for password requests

---

host

private java.lang.String host

The hostname of the site requesting authentication

---

addr

private InetAddress addr

InternetAddress of the site requesting authentication

---

port

private int port

The port number of the site requesting authentication

---

protocol

private java.lang.String protocol

The protocol name of the site requesting authentication

---

prompt

private java.lang.String prompt

The prompt to display to the user when requesting authentication info

---

scheme

private java.lang.String scheme

The authentication scheme in use

Constructor Detail

Authenticator

public Authenticator()

Default, no-argument constructor for subclasses to call.

Method Detail

setDefault

public static void setDefault(Authenticator defAuth)

This method sets the default Authenticator object (an instance of a subclass of Authenticator) to use when prompting the user for information. Note that this method checks to see if the caller is allowed to set this value (the "setDefaultAuthenticator" permission) and throws a SecurityException if it is not.

---

requestPasswordAuthentication

public static PasswordAuthentication requestPasswordAuthentication(InetAddress addr,
                                                                   int port,
                                                                   java.lang.String protocol,
                                                                   java.lang.String prompt,
                                                                   java.lang.String scheme)
                                                            throws java.lang.SecurityException

This method is called whenever a username and password for a given network operation is required. First, a security check is made to see if the caller has the "requestPasswordAuthentication" permission. If not, the method thows an exception. If there is no default Authenticator object, the method then returns null. Otherwise, the default authenticators's instance variables are initialized and it's getPasswordAuthentication method is called to get the actual authentication information to return.

---

requestPasswordAuthentication

public static PasswordAuthentication requestPasswordAuthentication(java.lang.String host,
                                                                   InetAddress addr,
                                                                   int port,
                                                                   java.lang.String protocol,
                                                                   java.lang.String prompt,
                                                                   java.lang.String scheme)
                                                            throws java.lang.SecurityException

This method is called whenever a username and password for a given network operation is required. First, a security check is made to see if the caller has the "requestPasswordAuthentication" permission. If not, the method thows an exception. If there is no default Authenticator object, the method then returns null. Otherwise, the default authenticators's instance variables are initialized and it's getPasswordAuthentication method is called to get the actual authentication information to return. This method is the preferred one as it can be used with hostname when addr is unknown.

Since:

1.4

---

getRequestingSite

protected final InetAddress getRequestingSite()

This method returns the address of the site that is requesting authentication.

---

getRequestingHost

protected final java.lang.String getRequestingHost()

Returns the hostname of the host or proxy requesting authorization, or null if not available.

Since:

1.4

---

getRequestingPort

protected final int getRequestingPort()

This method returns the port of the site that is requesting authentication.

---

getRequestingProtocol

protected final java.lang.String getRequestingProtocol()

This method returns the requesting protocol of the operation that is requesting authentication

---

getRequestingPrompt

protected final java.lang.String getRequestingPrompt()

Returns the prompt that should be used when requesting authentication information from the user

---

getRequestingScheme

protected final java.lang.String getRequestingScheme()

This method returns the authentication scheme in use

---

getPasswordAuthentication

protected PasswordAuthentication getPasswordAuthentication()

This method is called whenever a request for authentication is made. It can call the other getXXX methods to determine the information relevant to this request. Subclasses should override this method, which returns null by default.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> java >> [ net overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---