com.teamdev.jxbrowser.chromium

Class ProtocolService

java.lang.Object

com.teamdev.jxbrowser.chromium.ProtocolService

public class ProtocolService
extends java.lang.Object

Provides access to functionality that allows registering non-standard protocol handlers and overriding standard protocols.

提供对允许注册非标准协议处理程序和覆盖标准协议的功能的访问。

Since:

6.11

Method Summary

Modifier and Type	Method and Description
ProtocolHandler	removeProtocolHandler(java.lang.String protocol) Unregisters the given protocol handler for the given protocol. 注销给定协议的给定协议处理程序。
ProtocolHandler	setProtocolHandler(java.lang.String protocol, ProtocolHandler handler) Registers protocol handler that allows handling all URL requests for the given protocol. 注册协议处理程序，该处理程序允许处理给定协议的所有URL请求。

Methods inherited from class java.lang.Object

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

Method Detail

setProtocolHandler

public ProtocolHandler setProtocolHandler(java.lang.String protocol,
                                          ProtocolHandler handler)

Registers protocol handler that allows handling all URL requests for the given protocol. You can intercept all URL requests for the given protocol and send your own response data. You can register handlers for standard protocols such as http, https, ftp, etc. as well as for non-standard protocols such as jar, my-protocol, etc.

Note: when protocol handler is registered for the given protocol, the onBeforeSendHeaders(BeforeSendHeadersParams) and onHeadersReceived(HeadersReceivedParams) methods of the NetworkDelegate will not be called if URL request is handled by the registered protocol handler.

注册协议处理程序，该处理程序允许处理给定协议的所有URL请求。您可以拦截给定协议的所有URL请求并发送您自己的响应数据。您可以注册标准协议（例如http，https，ftp等）以及非标准协议（例如jar，my-protocol等）的处理程序。注意：为给定协议注册协议处理程序时，onBeforeSendHeaders（如果URL请求由注册的协议处理程序处理，则不会调用NetworkDelegate的BeforeSendHeadersParams）和onHeadersReceived（HeadersReceivedParams）方法。

Parameters:

protocol - a string that represents protocol name (e.g. "http", "ftp", etc.). It's not case-sensitive. The requirements for protocol name are described in RFC 2396 (chapter 3.1). Cannot be empty or null. -代表协议名称的字符串（例如“ http”，“ ftp”等）。它不区分大小写。协议名称的要求在RFC 2396（第3.1章）中进行了描述。不能为空或。

handler - a protocol handler that will be called to handle URL requests. Cannot be null. -协议处理程序，将被调用以处理URL请求。不可能是 。

Returns:

the previously registered ProtocolHandler instance associated with the given protocol or null if there is no previously registered protocol handler. 与给定关联的先前注册的实例，或者如果没有先前注册的协议处理程序。

Throws:

java.lang.IllegalArgumentException - when protocol is empty or null.

java.lang.IllegalArgumentException - when handler is null.

See Also:

RFC 2396

removeProtocolHandler

public ProtocolHandler removeProtocolHandler(java.lang.String protocol)

Unregisters the given protocol handler for the given protocol. It does nothing if there is no registered protocol handler.

注销给定协议的给定协议处理程序。如果没有注册的协议处理程序，则不执行任何操作。

Parameters:

protocol - the protocol to unregister. -取消注册的协议。

Returns:

unregistered protocol handler or null if there is no protocol handler associated with the given protocol. 未注册的协议处理程序，或者没有与给定的协议处理程序关联的协议处理程序。