Authenticator

public abstract class Authenticator extends Object

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.

Nested Class Summary

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

Public Constructor Summary

Public Method Summary

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.
synchronized 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.
synchronized 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 void
setDefault(Authenticator a)
Sets a as the default authenticator.

Protected Method Summary

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.

Inherited Method Summary

Public Constructors

public Authenticator ()

Public Methods

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

Parameters
rHost host name of the connection that requests authentication.
rAddr address of the connection that requests authentication.
rPort port of the connection that requests authentication.
rProtocol protocol of the connection that requests authentication.
rPrompt realm of the connection that requests authentication.
rScheme scheme of the connection that requests authentication.
rURL url of the connection that requests authentication.
reqType requestor type of the connection that requests authentication.
Returns
  • password authentication info or null if no authenticator exists.

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

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

Parameters
rAddr address of the connection that requests authentication.
rPort port of the connection that requests authentication.
rProtocol protocol of the connection that requests authentication.
rPrompt realm of the connection that requests authentication.
rScheme scheme of the connection that requests authentication.
Returns
  • password authentication info or null if no authenticator exists.