Класс URLStreamHandler

java.lang.Object

java.net.URLStreamHandler

public abstract class URLStreamHandler extends Object

Абстрактный класс URLStreamHandler — общий суперкласс для всех обработчиков протоколов потоков. Обработчик протокола потока знает, как установить соединение для конкретного типа протокола, например, http или https.

В большинстве случаев экземпляр подкласса URLStreamHandler не создаётся напрямую приложением. Вместо этого, при первом обнаружении имени протокола при построении URL, соответствующий обработчик протокола потока автоматически загружается.

С момента:

1.0

См. также:

Краткое описание конструкторов

Конструктор	Описание
`URLStreamHandler()`	Конструктор для вызова подклассами.

Краткое описание методов

Модификатор и тип	Метод	Описание
`protected boolean`	`equals(URL u1, URL u2)`	Предоставляет вычисление equals по умолчанию.
`protected int`	`getDefaultPort()`	Возвращает порт по умолчанию для URL, разобранного этим обработчиком.
`protected InetAddress`	`getHostAddress(URL u)`	Получение IP-адреса нашего хоста.
`protected int`	`hashCode(URL u)`	Предоставляет вычисление hash по умолчанию.
`protected boolean`	`hostsEqual(URL u1, URL u2)`	Сравнивает компоненты хоста двух URL.
`protected abstract URLConnection`	`openConnection(URL u)`	Открывает подключение к объекту, на который ссылается аргумент `URL`.
`protected URLConnection`	`openConnection(URL u, Proxy p)`	Аналогично openConnection(URL), за исключением того, что подключение будет установлено через указанный прокси; обработчики протоколов, которые не поддерживают проксирование, проигнорируют параметр прокси и установят обычное подключение.
`protected void`	`parseURL(URL u, String spec, int start, int limit)`	Парсит строковое представление `URL` в объект `URL`.
`protected boolean`	`sameFile(URL u1, URL u2)`	Сравнение двух URL, чтобы определить, ссылаются ли они на один и тот же файл, то есть, имеют ли они одинаковый протокол, хост, порт и путь.
`protected void`	`setURL(URL u, String protocol, String host, int port, String file, String ref)`	Устарело. Используйте setURL(URL, String, String, int, String, String, String, String);
`protected void`	`setURL(URL u, String protocol, String host, int port, String authority, String userInfo, String path, String query, String ref)`	Устанавливает поля аргумента `URL` в указанные значения.
`protected String`	`toExternalForm(URL u)`	Преобразует `URL` определённого протокола в `String`.

Методы, объявленные в классе java.lang.Object

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

Подробное описание конструкторов

URLStreamHandler

public URLStreamHandler()

Конструктор для вызова подклассами.

Подробное описание методов

openConnection

protected abstract URLConnection openConnection(URL u) throws IOException

Открывает соединение с объектом, на который ссылается аргумент URL. Этот метод должен быть переопределён подклассом.

Если для протокола обработчика (например, HTTP или JAR) существует общедоступный специализированный подкласс URLConnection, принадлежащий одному из следующих пакетов или одному из их подпакетов: java.lang, java.io, java.util, java.net, возвращаемое соединение будет этого подкласса. Например, для HTTP будет возвращён HttpURLConnection, а для JAR — JarURLConnection.

Параметры:: u - URL, к которому осуществляется подключение.
Возвращает:: объект URLConnection для URL.
Исключения:: IOException - если при открытии соединения произошла ошибка ввода-вывода.

openConnection

protected URLConnection openConnection(URL u, Proxy p) throws IOException

То же, что и openConnection(URL), за исключением того, что соединение будет установлено через указанный прокси-сервер; обработчики протоколов, которые не поддерживают проксирование, игнорируют параметр прокси и устанавливают обычное соединение.

Вызов этого метода отменяет настройки системных значений по умолчанию для ProxySelector.

Требования к реализации:: Базовая реализация этого метода сначала проверяет, что заданные URL и Proxy не равны null, а затем выбрасывает UnsupportedOperationException. Подклассы должны переопределить этот метод соответствующей реализацией.
Параметры:: u - URL, к которому осуществляется подключение.; p - прокси-сервер, через который будет установлено соединение. Если требуется прямое соединение, следует указать Proxy.NO_PROXY.
Возвращает:: объект URLConnection для URL.
Исключения:: IOException - если при открытии соединения произошла ошибка ввода-вывода.; IllegalArgumentException - если u или p равны null, или p имеет неправильный тип.; UnsupportedOperationException - если подкласс, реализующий протокол, не поддерживает этот метод.
С момента:: 1.5

parseURL

protected void parseURL(URL u, String spec, int start, int limit)

Разбирает строковое представление URL в объект URL.

Если существует какой-либо унаследованный контекст, то он уже был скопирован в аргумент URL.

Метод parseURL URLStreamHandler разбирает строковое представление так, как если бы это была спецификация http. Большинство семейств протоколов URL имеют подобный синтаксический разбор. Обработчик потоков для протокола, имеющего другой синтаксис, должен переопределить эту процедуру.

Параметры:: u - URL для получения результата разбора спецификации.; spec - String, представляющий URL, который необходимо разобрать.; start - индекс символа, с которого нужно начать разбор. Это сразу после ':' (если он есть), который определяет имя протокола.; limit - позиция символа, на которой нужно остановить разбор. Это конец строки или позиция символа "#", если он есть. Вся информация после знака диеза указывает на якорь.
Исключения:: IllegalArgumentException - если реализация обработчика протокола отклоняет любой из заданных параметров; NullPointerException - если u является null, или если start < limit и spec равны null

getDefaultPort

protected int getDefaultPort()

Возвращает порт по умолчанию для URL, проанализированного этим обработчиком. Этот метод предназначен для переопределения обработчиками с номерами портов по умолчанию.

Возвращает:: порт по умолчанию для URL , проанализированного этим обработчиком.
С момента:: 1.3

equals

protected boolean equals(URL u1, URL u2)

Предоставляет стандартное вычисление equals. Может быть переопределён обработчиками других протоколов, имеющих разные требования к equals(). Этот метод требует, чтобы ни один из его аргументов не был null. Это гарантируется тем, что он вызывается только классом java.net.URL.

Параметры:: u1 - объект URL; u2 - объект URL
Возвращает:: true если два URL считаются равными, то есть они ссылаются на один и тот же фрагмент в одном и том же файле.
С момента:: 1.3

hashCode

protected int hashCode(URL u)

Предоставляет стандартное вычисление хэш-кода. Может быть переопределён обработчиками других протоколов, имеющими разные требования к вычислению hashCode.

Параметры:: u - объект URL
Возвращает:: значение int, подходящее для индексации в хеш-таблице
С момента:: 1.3

sameFile

protected boolean sameFile(URL u1, URL u2)

Сравнивает два URL, чтобы определить, ссылаются ли они на один и тот же файл, то есть имеют ли одинаковый протокол, хост, порт и путь. Этот метод требует, чтобы ни один из его аргументов не был null. Это гарантируется тем, что он вызывается косвенно классом java.net.URL.

Параметры:: u1 - объект URL; u2 - объект URL
Возвращает:: true, если u1 и u2 ссылаются на один и тот же файл
С момента:: 1.3

getHostAddress

protected InetAddress getHostAddress(URL u)

Получение IP-адреса хоста. Пустое поле хоста или ошибка DNS приведут к возврату null.

Параметры:: u - объект URL
Возвращает:: строка InetAddress, представляющая IP-адрес хоста.
С момента:: 1.3

hostsEqual

protected boolean hostsEqual(URL u1, URL u2)

Сравнивает компоненты хоста двух URL.

Параметры:: u1 - URL первого хоста для сравнения; u2 - URL второго хоста для сравнения
Возвращает:: true если они равны, false в противном случае.
С момента:: 1.3

toExternalForm

protected String toExternalForm(URL u)

Преобразует URL определённого протокола в String.

Параметры:: u - URL.
Возвращает:: строковое представление аргумента URL.

setURL

protected void setURL(URL u, String protocol, String host, int port, String authority, String userInfo, String path, String query, String ref)

Устанавливает поля аргумента URL в указанные значения. Только классы, производные от URLStreamHandler, могут использовать этот метод для установки значений полей URL.

Параметры:: u - URL для изменения.; protocol - имя протокола.; host - значение удалённого хоста для URL.; port - порт на удалённой машине.; authority - часть авторизации для URL.; userInfo - часть userInfo URL.; path - компонент пути URL.; query - часть запроса для URL.; ref - ссылка.
Исключения:: SecurityException - если протокол URL отличается от текущего; IllegalArgumentException - если реализация обработчика протокола отклоняет любой из заданных параметров; NullPointerException - если u равно null
С момента:: 1.3

setURL

@Deprecated protected void setURL(URL u, String protocol, String host, int port, String file, String ref)

Устарело.

Используйте setURL(URL, String, String, int, String, String, String, String);

Параметры:: u - URL для изменения.; protocol - имя протокола. Это значение игнорируется начиная с 1.2.; host - значение удалённого хоста для URL.; port - порт на удалённой машине.; file - файл.; ref - ссылка.
Исключения:: SecurityException - если протокол URL отличается от текущего; IllegalArgumentException - если реализация обработчика протокола отклоняет любой из заданных параметров; NullPointerException - если u равно null

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/net/URLStreamHandler.html