Authenticator

Added in API level 1

public abstract class

Authenticator

extends Object

java.lang.Object
↳	java.net.Authenticator

Class Overview

An implementation of this class is able to obtain authentication information for a connection in several ways. For this purpose it has to set the default authenticator which extends Authenticator by setDefault(Authenticator a). Then it should override getPasswordAuthentication() which dictates how the authentication info is obtained. Usually, it prompts the user for the required input.

See also:

Summary

Nested Classes
enum	Authenticator.RequestorType	Enumeration class for the origin of the authentication request.

Public Constructors
	Authenticator()

Public Methods
static PasswordAuthentication	requestPasswordAuthentication(String rHost, InetAddress rAddr, int rPort, String rProtocol, String rPrompt, String rScheme) Invokes the methods of the registered authenticator to get the authentication info.
static PasswordAuthentication	requestPasswordAuthentication(String rHost, InetAddress rAddr, int rPort, String rProtocol, String rPrompt, String rScheme, URL rURL, Authenticator.RequestorType reqType) Invokes the methods of the registered authenticator to get the authentication info.
static PasswordAuthentication	requestPasswordAuthentication(InetAddress rAddr, int rPort, String rProtocol, String rPrompt, String rScheme) Invokes the methods of the registered authenticator to get the authentication info.
static void	setDefault(Authenticator a) Sets `a` as the default authenticator.

Protected Methods
PasswordAuthentication	getPasswordAuthentication() Returns the collected username and password for authorization.
final String	getRequestingHost() Returns the host name of the connection that requests authentication or `null` if unknown.
final int	getRequestingPort() Returns the port of the connection that requests authorization.
final String	getRequestingPrompt() Returns the realm (prompt string) of the connection that requests authorization.
final String	getRequestingProtocol() Returns the protocol of the connection that requests authorization.
final String	getRequestingScheme() Returns the scheme of the connection that requests authorization, for example HTTP Basic Authentication.
final InetAddress	getRequestingSite() Returns the address of the connection that requests authorization or `null` if unknown.
URL	getRequestingURL() Returns the URL of the authentication request.
Authenticator.RequestorType	getRequestorType() Returns the type of this request, it can be `PROXY` or `SERVER`.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Constructors

public Authenticator ()

Added in API level 1

Public Methods

public static PasswordAuthentication requestPasswordAuthentication (String rHost, InetAddress rAddr, int rPort, String rProtocol, String rPrompt, String rScheme)

Added in API level 1

Invokes the methods of the registered authenticator to get the authentication info.

Parameters
`rHost`	`String`: host name of the connection that requests authentication.
`rAddr`	`InetAddress`: address of the connection that requests authentication.
`rPort`	`int`: port of the connection that requests authentication.
`rProtocol`	`String`: protocol of the connection that requests authentication.
`rPrompt`	`String`: realm of the connection that requests authentication.
`rScheme`	`String`: scheme of the connection that requests authentication.

Returns
`PasswordAuthentication`	password authentication info or `null` if no authenticator exists.

public static PasswordAuthentication requestPasswordAuthentication (String rHost, InetAddress rAddr, int rPort, String rProtocol, String rPrompt, String rScheme, URL rURL, Authenticator.RequestorType reqType)

Added in API level 1

Invokes the methods of the registered authenticator to get the authentication info.

Parameters
`rHost`	`String`: host name of the connection that requests authentication.
`rAddr`	`InetAddress`: address of the connection that requests authentication.
`rPort`	`int`: port of the connection that requests authentication.
`rProtocol`	`String`: protocol of the connection that requests authentication.
`rPrompt`	`String`: realm of the connection that requests authentication.
`rScheme`	`String`: scheme of the connection that requests authentication.
`rURL`	`URL`: url of the connection that requests authentication.
`reqType`	`Authenticator.RequestorType`: requestor type of the connection that requests authentication.

Returns
`PasswordAuthentication`	password authentication info or `null` if no authenticator exists.

public static PasswordAuthentication requestPasswordAuthentication (InetAddress rAddr, int rPort, String rProtocol, String rPrompt, String rScheme)

Added in API level 1

Invokes the methods of the registered authenticator to get the authentication info.

Parameters
`rAddr`	`InetAddress`: address of the connection that requests authentication.
`rPort`	`int`: port of the connection that requests authentication.
`rProtocol`	`String`: protocol of the connection that requests authentication.
`rPrompt`	`String`: realm of the connection that requests authentication.
`rScheme`	`String`: scheme of the connection that requests authentication.

Returns
`PasswordAuthentication`	password authentication info or `null` if no authenticator exists.

public static void setDefault (Authenticator a)

Added in API level 1

Sets a as the default authenticator. It will be called whenever the realm that the URL is pointing to requires authorization.

Parameters
`a`	`Authenticator`: authenticator which has to be set as default.

Protected Methods

protected PasswordAuthentication getPasswordAuthentication ()

Added in API level 1

Returns the collected username and password for authorization. The subclass has to override this method to return a value different to the default which is null.

Returns null by default.

Returns
`PasswordAuthentication`	collected password authentication data.

protected final String getRequestingHost ()

Added in API level 1

Returns the host name of the connection that requests authentication or null if unknown.

Returns
`String`	name of the requesting host or `null`.

protected final int getRequestingPort ()

Added in API level 1

Returns the port of the connection that requests authorization.

Returns
`int`	port of the connection.

protected final String getRequestingPrompt ()

Added in API level 1

Returns the realm (prompt string) of the connection that requests authorization.

Returns
`String`	prompt string of the connection.

protected final String getRequestingProtocol ()

Added in API level 1

Returns the protocol of the connection that requests authorization.

Returns
`String`	protocol of the connection.

protected final String getRequestingScheme ()

Added in API level 1

Returns the scheme of the connection that requests authorization, for example HTTP Basic Authentication.

Returns
`String`	scheme of the connection.

protected final InetAddress getRequestingSite ()

Added in API level 1

Returns the address of the connection that requests authorization or null if unknown.

Returns
`InetAddress`	address of the connection.

protected URL getRequestingURL ()

Added in API level 1

Returns the URL of the authentication request.

Returns
`URL`	authentication request url.

protected Authenticator.RequestorType getRequestorType ()

Added in API level 1

Returns the type of this request, it can be PROXY or SERVER.

Returns
`Authenticator.RequestorType`	RequestorType of the authentication request.

Results

Interfaces

Classes

Enums

Exceptions

Authenticator

Class Overview

Summary

Public Constructors

public Authenticator ()

Public Methods

public static PasswordAuthentication requestPasswordAuthentication (String rHost, InetAddress rAddr, int rPort, String rProtocol, String rPrompt, String rScheme)

public static PasswordAuthentication requestPasswordAuthentication (String rHost, InetAddress rAddr, int rPort, String rProtocol, String rPrompt, String rScheme, URL rURL, Authenticator.RequestorType reqType)

public static PasswordAuthentication requestPasswordAuthentication (InetAddress rAddr, int rPort, String rProtocol, String rPrompt, String rScheme)

public static void setDefault (Authenticator a)

Protected Methods

protected PasswordAuthentication getPasswordAuthentication ()

protected final String getRequestingHost ()

protected final int getRequestingPort ()

protected final String getRequestingPrompt ()

protected final String getRequestingProtocol ()

protected final String getRequestingScheme ()

protected final InetAddress getRequestingSite ()

protected URL getRequestingURL ()

protected Authenticator.RequestorType getRequestorType ()