|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.net.Authenticator
public abstract class Authenticator
The class Authenticator represents an object that knows how to obtain authentication for a network connection. Usually, it will do this by prompting the user for information.
Applications use this class by creating a subclass, and registering an instance of that subclass with the system with setDefault(). When authentication is required, the system will invoke a method on the subclass (like getPasswordAuthentication). The subclass's method can query about the authentication being requested with a number of inherited methods (getRequestingXXX()), and form an appropriate message for the user.
All methods that request authentication have a default implementation that fails.
setDefault(java.net.Authenticator)
,
getPasswordAuthentication()
Constructor Summary | |
---|---|
Authenticator()
|
Method Summary | |
---|---|
static PasswordAuthentication |
requestPasswordAuthentication(InetAddress addr,
int port,
String protocol,
String prompt,
String scheme)
Ask the authenticator that has been registered with the system for a password. |
static PasswordAuthentication |
requestPasswordAuthentication(String host,
InetAddress addr,
int port,
String protocol,
String prompt,
String scheme)
Ask the authenticator that has been registered with the system for a password. |
static void |
setDefault(Authenticator a)
Sets the authenticator that will be used by the networking code when a proxy or an HTTP server asks for authentication. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Authenticator()
Method Detail |
---|
public static void setDefault(Authenticator a)
First, if there is a security manager, its checkPermission
method is called with a
NetPermission("setDefaultAuthenticator")
permission.
This may result in a java.lang.SecurityException.
a
- The authenticator to be set. If a is null
then
any previously set authenticator is removed.
SecurityException
- if a security manager exists and its
checkPermission
method doesn't allow
setting the default authenticator.SecurityManager.checkPermission(java.security.Permission)
,
NetPermission
public static PasswordAuthentication requestPasswordAuthentication(InetAddress addr, int port, String protocol, String prompt, String scheme)
First, if there is a security manager, its checkPermission
method is called with a
NetPermission("requestPasswordAuthentication")
permission.
This may result in a java.lang.SecurityException.
addr
- The InetAddress of the site requesting authorization,
or null if not known.port
- the port for the requested connectionprotocol
- The protocol that's requesting the connection
(getRequestingProtocol()
)prompt
- A prompt string for the userscheme
- The authentication scheme
SecurityException
- if a security manager exists and its
checkPermission
method doesn't allow
the password authentication request.SecurityManager.checkPermission(java.security.Permission)
,
NetPermission
public static PasswordAuthentication requestPasswordAuthentication(String host, InetAddress addr, int port, String protocol, String prompt, String scheme)
First, if there is a security manager, its checkPermission
method is called with a
NetPermission("requestPasswordAuthentication")
permission.
This may result in a java.lang.SecurityException.
host
- The hostname of the site requesting authentication.addr
- The InetAddress of the site requesting authentication,
or null if not known.port
- the port for the requested connection.protocol
- The protocol that's requesting the connection
(getRequestingProtocol()
)prompt
- A prompt string for the user which identifies the authentication realm.scheme
- The authentication scheme
SecurityException
- if a security manager exists and its
checkPermission
method doesn't allow
the password authentication request.SecurityManager.checkPermission(java.security.Permission)
,
NetPermission
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |