java.net
public abstract class Authenticator extends Object
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.
Constructor and Description |
---|
Authenticator()
Default, no-argument constructor for subclasses to call.
|
Modifier and Type | Method and Description |
---|---|
protected PasswordAuthentication |
getPasswordAuthentication()
This method is called whenever a request for authentication is made.
|
protected 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 String |
getRequestingPrompt()
Returns the prompt that should be used when requesting authentication
information from the user
|
protected String |
getRequestingProtocol()
This method returns the requesting protocol of the operation that is
requesting authentication
|
protected 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,
String protocol,
String prompt,
String scheme)
This method is called whenever a username and password for a given
network operation is required.
|
static PasswordAuthentication |
requestPasswordAuthentication(String host,
InetAddress addr,
int port,
String protocol,
String prompt,
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. |
public Authenticator()
public static void setDefault(Authenticator defAuth)
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.defAuth
- The new default Authenticator
object to useSecurityException
- If the caller does not have permission
to perform this operationpublic static PasswordAuthentication requestPasswordAuthentication(InetAddress addr, int port, String protocol, String prompt, String scheme) throws SecurityException
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.addr
- The address requesting authenticationport
- The port requesting authenticationprotocol
- The protocol requesting authenticationprompt
- The prompt to display to the user when requesting
authentication infoscheme
- The authentication scheme in usePasswordAuthentication
object with the user's
authentication info.SecurityException
- If the caller does not have permission to
perform this operationpublic static PasswordAuthentication requestPasswordAuthentication(String host, InetAddress addr, int port, String protocol, String prompt, String scheme) throws SecurityException
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.host
- The hostname requesting authenticationaddr
- The address requesting authenticationport
- The port requesting authenticationprotocol
- The protocol requesting authenticationprompt
- The prompt to display to the user when requesting
authentication infoscheme
- The authentication scheme in usePasswordAuthentication
object with the user's
authentication info.SecurityException
- If the caller does not have permission to
perform this operationprotected final InetAddress getRequestingSite()
protected final String getRequestingHost()
null
if not available.null
if it is not available.protected final int getRequestingPort()
protected final String getRequestingProtocol()
protected final String getRequestingPrompt()
protected final String getRequestingScheme()
protected PasswordAuthentication getPasswordAuthentication()
null
by default.PasswordAuthentication
information