Android - An Open Handset Alliance Project

java.net
public abstract class

java.net.Authenticator

java.lang.Object
	java.net.Authenticator

This class is able to obtain authentication info for a connection, usually from user. First the application has to set the default authenticator which extends Authenticator by setDefault(Authenticator a).

It should override getPasswordAuthentication() which dictates how the authentication info should be obtained.

Nested Classes

Authenticator.RequestorType an enum class of requestor type

Summary

Public Constructors

Authenticator()

Public Methods

synchronized	static	PasswordAuthentication	requestPasswordAuthentication(String rHost, InetAddress rAddr, int rPort, String rProtocol, String rPrompt, String rScheme)
			If the permission check of the security manager does not result in a security exception, this method 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, RequestorType reqType)
			If the permission check of the security manager does not result in a security exception, this method invokes the methods of the registered authenticator to get the authentication info.
synchronized	static	PasswordAuthentication	requestPasswordAuthentication(InetAddress rAddr, int rPort, String rProtocol, String rPrompt, String rScheme)
			If the permission check of the security manager does not result in a security exception, this method invokes the methods of the registered authenticator to get the authentication info.
	static	void	setDefault(Authenticator a)
			This method sets `a` to be the default authenticator.

Protected Methods

	PasswordAuthentication	getPasswordAuthentication()
		This method is responsible for retrieving the username and password for the sender.
final	String	getRequestingHost()
		Return the host name of the connection that requests authentication, or null if unknown.
final	int	getRequestingPort()
		Answers the port of the connection that requests authorization.
final	String	getRequestingPrompt()
		Answers the realm (prompt string) of the connection that requires authorization.
final	String	getRequestingProtocol()
		Answers the protocol of the connection that requests authorization.
final	String	getRequestingScheme()
		Answers the scheme of the connection that requires authorization.
final	InetAddress	getRequestingSite()
		Answers the address of the connection that requests authorization or null if unknown.
	URL	getRequestingURL()
		returns the URL of the authentication resulted in this request.
	RequestorType	getRequestorType()
		returns the type of this request, it can be proxy or server

Methods inherited from class java.lang.Object

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

	Object	clone()
		Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
	boolean	equals(Object o)
		Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final	Class	getClass()
		Answers the unique instance of java.lang.Class which represents the class of the receiver.
	int	hashCode()
		Answers an integer hash code for the receiver.
final	void	notify()
		Causes one thread which is `wait` ing on the receiver to be made ready to run.
final	void	notifyAll()
		Causes all threads which are `wait` ing on the receiver to be made ready to run.
	String	toString()
		Answers a string containing a concise, human-readable description of the receiver.
final	void	wait(long time, int frac)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait(long time)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait()
		Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

Details

Public Constructors

public Authenticator()

Public Methods

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

If the permission check of the security manager does not result in a security exception, this method invokes the methods of the registered authenticator to get the authentication info.

Parameters

rHost	java.lang.String the host name of the connection that requests authentication
rAddr	java.net.InetAddress the address of the connection that requests authentication
rPort	int the port of the connection that requests authentication
rProtocol	java.lang.String the protocol of the connection that requests authentication
rPrompt	java.lang.String the realm of the connection that requests authentication
rScheme	java.lang.String the scheme of the connection that requests authentication

Returns

java.net.PasswordAuthentication the authentication info

Throws

SecurityException	if requestPasswordAuthenticationPermission is denied

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

If the permission check of the security manager does not result in a security exception, this method invokes the methods of the registered authenticator to get the authentication info.

Parameters

rHost	java.lang.String the host name of the connection that requests authentication
rAddr	java.net.InetAddress the address of the connection that requests authentication
rPort	int the port of the connection that requests authentication
rProtocol	java.lang.String the protocol of the connection that requests authentication
rPrompt	java.lang.String the realm of the connection that requests authentication
rScheme	java.lang.String the scheme of the connection that requests authentication
rURL	java.net.URL the url of the connection that requests authentication
reqType	java.net.Authenticator.RequestorType the RequestorType of the connection that requests authentication

Returns

java.net.PasswordAuthentication the authentication info

Throws

SecurityException	if requestPasswordAuthenticationPermission is denied

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

If the permission check of the security manager does not result in a security exception, this method invokes the methods of the registered authenticator to get the authentication info.

Parameters

rAddr	java.net.InetAddress the address of the connection that requests authentication
rPort	int the port of the connection that requests authentication
rProtocol	java.lang.String the protocol of the connection that requests authentication
rPrompt	java.lang.String the realm of the connection that requests authentication
rScheme	java.lang.String the scheme of the connection that requests authentication

Returns

java.net.PasswordAuthentication the authentication info

Throws

SecurityException	if requestPasswordAuthenticationPermission is denied

public static void setDefault(Authenticator a)

This method sets a to be the default authenticator. It will be called whenever the realm that the URL is pointing to requires authorization. If there is a security manager set then the caller must have the NetPermission "setDefaultAuthenticator".

Parameters

a	java.net.Authenticator The authenticator to be set.

Throws

SecurityException	if requestPasswordAuthenticationPermission is denied

Protected Methods

protected PasswordAuthentication getPasswordAuthentication()

This method is responsible for retrieving the username and password for the sender. The implementation varies. The subclass has to overwrite this.

It answers null by default.

Returns

java.net.PasswordAuthentication The password authentication that it obtains

protected final String getRequestingHost()

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

protected final int getRequestingPort()

Answers the port of the connection that requests authorization.

Returns

int the port of the connection

protected final String getRequestingPrompt()

Answers the realm (prompt string) of the connection that requires authorization.

Returns

java.lang.String the prompt string of the connection

protected final String getRequestingProtocol()

Answers the protocol of the connection that requests authorization.

Returns

java.lang.String the protocol of connection

protected final String getRequestingScheme()

Answers the scheme of the connection that requires authorization. Eg. Basic

Returns

java.lang.String the scheme of the connection

protected final InetAddress getRequestingSite()

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

Returns

InetAddress the address of the connection

protected URL getRequestingURL()

returns the URL of the authentication resulted in this request.

Returns

the url of request

protected RequestorType getRequestorType()

returns the type of this request, it can be proxy or server

Returns

RequestorType of request


e.g. "intent" or "activity"

Android - An Open Handset Alliance Project

Documentation

Goodies

java.net.Authenticator

Nested Classes

See Also

Summary

Public Constructors

Public Methods

Protected Methods

Methods inherited from class java.lang.Object

Details

Public Constructors

public Authenticator()

Public Methods

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

Parameters

Returns

Throws

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

Parameters

Returns

Throws

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

Parameters

Returns

Throws

public static void setDefault(Authenticator a)

Parameters

Throws

Protected Methods

protected PasswordAuthentication getPasswordAuthentication()

Returns

protected final String getRequestingHost()

protected final int getRequestingPort()

Returns

protected final String getRequestingPrompt()

Returns

protected final String getRequestingProtocol()

Returns

protected final String getRequestingScheme()

Returns

protected final InetAddress getRequestingSite()

Returns

protected URL getRequestingURL()

Returns

protected RequestorType getRequestorType()

Returns