鸿蒙OS Authenticator

Authenticator

java.lang.Object

|---java.net.Authenticator

public abstract class Authenticator
extends Object

Authenticator 类表示一个知道如何获得网络连接身份验证的对象。 通常，它会通过提示用户输入信息来做到这一点。

应用程序通过覆盖子类中的 getPasswordAuthentication() 来使用此类。 此方法通常会使用各种 getXXX() 访问器方法来获取有关请求身份验证的实体的信息。 然后，它必须通过与用户交互或通过其他一些非交互方式来获取用户名和密码。 然后将凭据作为 PasswordAuthentication 返回值返回。

然后通过调用 setDefault(java.net.Authenticator) 向系统注册这个具体子类的实例。 当需要身份验证时，系统将调用其中一个 requestPasswordAuthentication() 方法，该方法又将调用注册对象的 getPasswordAuthentication() 方法。

所有请求身份验证的方法都有一个失败的默认实现。

嵌套类摘要

修饰符和类型	类	描述
static class	Authenticator.RequestorType	请求身份验证的实体的类型。

构造函数摘要

构造函数	描述
Authenticator()

方法总结

修饰符和类型	方法	描述
protected PasswordAuthentication	getPasswordAuthentication()	需要密码授权时调用。
protected String	getRequestingHost()	获取请求身份验证的站点或代理的主机名，如果不可用，则为 null。
protected int	getRequestingPort()	获取所请求连接的端口号。
protected String	getRequestingPrompt()	获取请求者给出的提示字符串。
protected String	getRequestingProtocol()	给出请求连接的协议。
protected String	getRequestingScheme()	获取请求者的方案（例如 HTTP 防火墙的 HTTP 方案）。
protected InetAddress	getRequestingSite()	获取请求授权的站点的 InetAddress，如果不可用，则为 null。
protected URL	getRequestingURL()	返回导致此身份验证请求的 URL。
protected Authenticator.RequestorType	getRequestorType()	返回请求者是代理还是服务器。
static PasswordAuthentication	requestPasswordAuthentication(String host, InetAddress addr, int port, String protocol, String prompt, String scheme)	向已在系统中注册的身份验证器询问密码。
static PasswordAuthentication	requestPasswordAuthentication(String host, InetAddress addr, int port, String protocol, String prompt, String scheme, URL url, Authenticator.RequestorType reqType)	向已在系统中注册的身份验证器询问密码。
static PasswordAuthentication	requestPasswordAuthentication(InetAddress addr, int port, String protocol, String prompt, String scheme)	向已在系统中注册的身份验证器询问密码。
static void	setDefault(Authenticator a)	设置当代理或 HTTP 服务器请求身份验证时网络代码将使用的身份验证器。

从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造函数详细信息

Authenticator

public Authenticator()

方法详情

setDefault

public static void setDefault(Authenticator a)

设置当代理或 HTTP 服务器请求身份验证时网络代码将使用的身份验证器。

首先，如果有安全管理器，则使用 NetPermission("setDefaultAuthenticator") 权限调用其 checkPermission 方法。 这可能会导致 java.lang.SecurityException。

参数：

参数名称	参数描述
a	要设置的身份验证器。 如果 a 为 null，则删除任何先前设置的身份验证器。

Throws:

Throw名称	Throw描述
SecurityException	如果存在安全管理器并且其 checkPermission 方法不允许设置默认身份验证器。

requestPasswordAuthentication

public static PasswordAuthentication requestPasswordAuthentication(InetAddress addr, int port, String protocol, String prompt, String scheme)

向已在系统中注册的身份验证器询问密码。

首先，如果存在安全管理器，则使用 NetPermission("requestPasswordAuthentication") 权限调用其 checkPermission 方法。 这可能会导致 java.lang.SecurityException。

参数：

参数名称	参数描述
addr	请求授权的站点的 InetAddress，如果未知，则为 null。
port	请求连接的端口
protocol	请求连接的协议 (getRequestingProtocol())
prompt	用户的提示字符串
scheme	认证方案

返回:

用户名/密码，如果无法获取，则返回 null。

Throws:

Throw名称	Throw描述
SecurityException	如果存在安全管理器并且其 checkPermission 方法不允许密码身份验证请求。

requestPasswordAuthentication

public static PasswordAuthentication requestPasswordAuthentication(String host, InetAddress addr, int port, String protocol, String prompt, String scheme)

向已在系统中注册的身份验证器询问密码。 这是请求密码的首选方法，因为在 InetAddress 不可用的情况下可以提供主机名。

首先，如果存在安全管理器，则使用 NetPermission("requestPasswordAuthentication") 权限调用其 checkPermission 方法。 这可能会导致 java.lang.SecurityException。

参数：

参数名称	参数描述
host	请求身份验证的站点的主机名。
addr	请求身份验证的站点的 InetAddress，如果未知，则为 null。
port	请求连接的端口。
protocol	请求连接的协议 (getRequestingProtocol())
prompt	用于标识身份验证领域的用户提示字符串。
scheme	认证方案

返回:

用户名/密码，如果无法获取，则返回 null。

Throws:

Throw名称	Throw描述
SecurityException	如果存在安全管理器并且其 checkPermission 方法不允许密码身份验证请求。

requestPasswordAuthentication

public static PasswordAuthentication requestPasswordAuthentication(String host, InetAddress addr, int port, String protocol, String prompt, String scheme, URL url, Authenticator.RequestorType reqType)

向已在系统中注册的身份验证器询问密码。

首先，如果存在安全管理器，则使用 NetPermission("requestPasswordAuthentication") 权限调用其 checkPermission 方法。 这可能会导致 java.lang.SecurityException。

参数：

参数名称	参数描述
host	请求身份验证的站点的主机名。
addr	请求授权的站点的 InetAddress，如果未知，则为 null。
port	请求连接的端口
protocol	请求连接的协议 (getRequestingProtocol())
prompt	用户的提示字符串
scheme	认证方案
url	导致身份验证的请求 URL
reqType	请求身份验证的实体的类型（服务器或代理）。

返回:

用户名/密码，如果无法获取，则返回 null。

Throws:

Throw名称	Throw描述
SecurityException	如果存在安全管理器并且其 checkPermission 方法不允许密码身份验证请求。

getRequestingHost

protected final String getRequestingHost()

获取请求身份验证的站点或代理的主机名，如果不可用，则为 null。

返回:

需要身份验证的连接的主机名，如果不可用，则为 null。

getRequestingSite

protected final InetAddress getRequestingSite()

获取请求授权的站点的 InetAddress，如果不可用，则为 null。

返回:

请求授权的站点的 InetAddress，如果不可用，则返回 null。

getRequestingPort

protected final int getRequestingPort()

获取所请求连接的端口号。

返回:

一个 int 指示所请求连接的端口。

getRequestingProtocol

protected final String getRequestingProtocol()

给出请求连接的协议。 通常这将基于 URL，但在未来的 JDK 中，它可能是例如“SOCKS”，用于受密码保护的 SOCKS5 防火墙。

返回:

协议，可选择后跟“/version”，其中 version 是版本号。

getRequestingPrompt

protected final String getRequestingPrompt()

获取请求者给出的提示字符串。

返回:

请求者给出的提示字符串（http请求的领域）

getRequestingScheme

protected final String getRequestingScheme()

获取请求者的方案（例如 HTTP 防火墙的 HTTP 方案）。

返回:

请求者的计划

getPasswordAuthentication

protected PasswordAuthentication getPasswordAuthentication()

需要密码授权时调用。 子类应该覆盖默认实现，它返回 null。

返回:

从用户收集的 PasswordAuthentication，如果没有提供，则返回 null。

getRequestingURL

protected URL getRequestingURL()

返回导致此身份验证请求的 URL。

返回:

请求的 URL

getRequestorType

protected Authenticator.RequestorType getRequestorType()

返回请求者是代理还是服务器。

返回:

请求者的身份验证类型