Класс HttpURLConnection
- Прямые известные подклассы:
HttpsURLConnection
public abstract class HttpURLConnection extends URLConnection
Каждый экземпляр HttpURLConnection используется для выполнения одного запроса, однако базовое сетевое соединение с HTTP-сервером может прозрачно совместно использоваться другими экземплярами. Вызов методов close() для InputStream или OutputStream объекта HttpURLConnection после выполнения запроса может освободить сетевые ресурсы, связанные с этим экземпляром, но не влияет на общее постоянное соединение. Вызов метода disconnect() может закрыть базовый сокет, если в этот момент постоянное соединение не используется.
Обработчик протокола HTTP имеет несколько параметров, доступных через системные свойства. К ним относятся параметры прокси-сервера, а также различные другие параметры.
- С версии:
- 1.1
- См. также:
Краткое описание полей
| Модификатор и тип | Поле | Описание |
|---|---|---|
protected int |
chunkLength |
Длина фрагмента при использовании потокового режима с кодированием фрагментами для вывода. |
protected int |
fixedContentLength |
Фиксированная длина содержимого при использовании потокового режима с фиксированной длиной. |
protected long |
fixedContentLengthLong |
Фиксированная длина содержимого при использовании потокового режима с фиксированной длиной. |
static final int |
HTTP_ACCEPTED |
Код состояния HTTP 202: принято. |
static final int |
HTTP_BAD_GATEWAY |
Код состояния HTTP 502: ошибка шлюза. |
static final int |
HTTP_BAD_METHOD |
Код состояния HTTP 405: метод не разрешён. |
static final int |
HTTP_BAD_REQUEST |
Код состояния HTTP 400: неверный запрос. |
static final int |
HTTP_CLIENT_TIMEOUT |
Код состояния HTTP 408: истекло время ожидания запроса. |
static final int |
HTTP_CONFLICT |
Код состояния HTTP 409: конфликт. |
static final int |
HTTP_CREATED |
Код состояния HTTP 201: создано. |
static final int |
HTTP_ENTITY_TOO_LARGE |
Код состояния HTTP 413: размер объекта запроса слишком велик. |
static final int |
HTTP_FORBIDDEN |
Код состояния HTTP 403: доступ запрещён. |
static final int |
HTTP_GATEWAY_TIMEOUT |
Код состояния HTTP 504: истекло время ожидания ответа шлюза. |
static final int |
HTTP_GONE |
Код состояния HTTP 410: ресурс больше недоступен. |
static final int |
HTTP_INTERNAL_ERROR |
Код состояния HTTP 500: внутренняя ошибка сервера. |
static final int |
HTTP_LENGTH_REQUIRED |
Код состояния HTTP 411: требуется указать длину. |
static final int |
HTTP_MOVED_PERM |
Код состояния HTTP 301: перемещено навсегда. |
static final int |
HTTP_MOVED_TEMP |
Код состояния HTTP 302: временное перенаправление. |
static final int |
HTTP_MULT_CHOICE |
Код состояния HTTP 300: несколько вариантов. |
static final int |
HTTP_NO_CONTENT |
Код состояния HTTP 204: содержимое отсутствует. |
static final int |
HTTP_NOT_ACCEPTABLE |
Код состояния HTTP 406: неприемлемо. |
static final int |
HTTP_NOT_AUTHORITATIVE |
Код состояния HTTP 203: неавторитетная информация. |
static final int |
HTTP_NOT_FOUND |
Код состояния HTTP 404: не найдено. |
static final int |
HTTP_NOT_IMPLEMENTED |
Код состояния HTTP 501: не реализовано. |
static final int |
HTTP_NOT_MODIFIED |
Код состояния HTTP 304: не изменено. |
static final int |
HTTP_OK |
Код состояния HTTP 200: OK. |
static final int |
HTTP_PARTIAL |
Код состояния HTTP 206: частичное содержимое. |
static final int |
HTTP_PAYMENT_REQUIRED |
Код состояния HTTP 402: требуется оплата. |
static final int |
HTTP_PRECON_FAILED |
Код состояния HTTP 412: предварительное условие не выполнено. |
static final int |
HTTP_PROXY_AUTH |
Код состояния HTTP 407: требуется аутентификация прокси-сервера. |
static final int |
HTTP_REQ_TOO_LONG |
Код состояния HTTP 414: URI запроса слишком длинный. |
static final int |
HTTP_RESET |
Код состояния HTTP 205: содержимое сброшено. |
static final int |
HTTP_SEE_OTHER |
Код состояния HTTP 303: см. другой ресурс. |
static final int |
HTTP_SERVER_ERROR |
Устарело. это поле расположено не на своём месте и не должно было существовать. |
static final int |
HTTP_UNAUTHORIZED |
Код состояния HTTP 401: не авторизовано. |
static final int |
HTTP_UNAVAILABLE |
Код состояния HTTP 503: служба недоступна. |
static final int |
HTTP_UNSUPPORTED_TYPE |
Код состояния HTTP 415: неподдерживаемый тип мультимедиа. |
static final int |
HTTP_USE_PROXY |
Код состояния HTTP 305: используйте прокси-сервер. |
static final int |
HTTP_VERSION |
Код состояния HTTP 505: версия HTTP не поддерживается. |
protected boolean |
instanceFollowRedirects |
Если true, протокол будет автоматически следовать перенаправлениям. |
protected String |
method |
Метод HTTP (GET,POST,PUT и т. д.). |
protected int |
responseCode |
Объект int, представляющий трёхзначный код состояния HTTP. |
protected String |
responseMessage |
Сообщение ответа HTTP. |
Поля, объявленные в классе URLConnection
allowUserInteraction, connected, doInput, doOutput, ifModifiedSince, url, useCaches
Краткое описание конструкторов
| Модификатор | Конструктор | Описание |
|---|---|---|
protected |
Конструктор класса HttpURLConnection. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
abstract void |
disconnect() |
Указывает, что в ближайшем будущем другие запросы к серверу маловероятны. |
InputStream |
getErrorStream() |
Возвращает поток ошибок, если соединение не удалось установить, но сервер всё же отправил полезные данные. |
static boolean |
getFollowRedirects() |
Возвращает boolean, указывающий, следует ли автоматически переходить по перенаправлениям HTTP (3xx). |
String |
getHeaderField |
Возвращает значение n-го поля заголовка. |
String |
getHeaderFieldKey |
Возвращает ключ n-го поля заголовка. |
boolean |
getInstanceFollowRedirects() |
Возвращает значение поля instanceFollowRedirects этого HttpURLConnection. |
Permission |
getPermission() |
Устарело, будет удалено: этот элемент API подлежит удалению в будущей версии. Разрешения больше нельзя использовать для управления доступом к ресурсам, поскольку диспетчер безопасности больше не поддерживается. |
String |
getRequestMethod() |
Возвращает метод запроса. |
int |
getResponseCode() |
Возвращает код состояния из сообщения ответа HTTP. |
String |
getResponseMessage() |
Возвращает сообщение ответа HTTP, если оно есть, полученное от сервера вместе с кодом ответа. |
void |
setAuthenticator |
Предоставляет Authenticator, который будет использоваться при запросе аутентификации через протокол HTTP для этого HttpURLConnection. |
void |
setChunkedStreamingMode |
Этот метод включает потоковую передачу тела HTTP-запроса без внутренней буферизации, когда длина содержимого заранее не известна. |
void |
setFixedLengthStreamingMode |
Этот метод включает потоковую передачу тела HTTP-запроса без внутренней буферизации, когда длина содержимого заранее известна. |
void |
setFixedLengthStreamingMode |
Этот метод включает потоковую передачу тела HTTP-запроса без внутренней буферизации, когда длина содержимого заранее известна. |
static void |
setFollowRedirects |
Задаёт, следует ли этому классу автоматически переходить по перенаправлениям HTTP (запросам с кодом ответа 3xx). |
void |
setInstanceFollowRedirects |
Задаёт, следует ли этому экземпляру HttpURLConnection автоматически переходить по перенаправлениям HTTP (запросам с кодом ответа 3xx). |
void |
setRequestMethod |
Задаёт метод запроса URL. Допустимы GET, POST, HEAD, OPTIONS, PUT, DELETE и TRACE с учётом ограничений протокола. |
abstract boolean |
usingProxy() |
Указывает, проходит ли соединение через прокси-сервер. |
Методы, объявленные в классе URLConnection
addRequestProperty, connect, getAllowUserInteraction, getConnectTimeout, getContent, getContent, getContentEncoding, getContentLength, getContentLengthLong, getContentType, getDate, getDefaultAllowUserInteraction, getDefaultRequestProperty, getDefaultUseCaches, getDefaultUseCaches, getDoInput, getDoOutput, getExpiration, getFileNameMap, getHeaderField, getHeaderFieldDate, getHeaderFieldInt, getHeaderFieldLong, getHeaderFields, getIfModifiedSince, getInputStream, getLastModified, getOutputStream, getReadTimeout, getRequestProperties, getRequestProperty, getURL, getUseCaches, guessContentTypeFromName, guessContentTypeFromStream, setAllowUserInteraction, setConnectTimeout, setContentHandlerFactory, setDefaultAllowUserInteraction, setDefaultRequestProperty, setDefaultUseCaches, setDefaultUseCaches, setDoInput, setDoOutput, setFileNameMap, setIfModifiedSince, setReadTimeout, setRequestProperty, setUseCaches, toString
Подробное описание полей
method
protected String method
chunkLength
protected int chunkLength
-1 означает, что кодирование по частям для вывода отключено.- Начиная с версии:
- 1.5
fixedContentLength
protected int fixedContentLength
-1 означает, что потоковый режим с фиксированной длиной для вывода отключен. ПРИМЕЧАНИЕ: Вместо этого поля рекомендуется использовать fixedContentLengthLong, поскольку оно позволяет задавать большую длину содержимого.
- Начиная с версии:
- 1.5
fixedContentLengthLong
protected long fixedContentLengthLong
-1 означает, что потоковый режим с фиксированной длиной для вывода отключен.- Начиная с версии:
- 1.7
responseCode
protected int responseCode
int, представляющий трехзначный код состояния HTTP. - 1xx: Информационные
- 2xx: Успешные
- 3xx: Перенаправление
- 4xx: Ошибка клиента
- 5xx: Ошибка сервера
responseMessage
protected String responseMessage
instanceFollowRedirects
protected boolean instanceFollowRedirects
true, протокол будет автоматически следовать перенаправлениям. Если false, протокол не будет автоматически следовать перенаправлениям. Это поле задается методом setInstanceFollowRedirects. Его значение возвращается методом getInstanceFollowRedirects.
Значение по умолчанию зависит от значения статического поля followRedirects на момент создания HttpURLConnection.
- См. также:
HTTP_OK
public static final int HTTP_OK
- См. также:
HTTP_CREATED
public static final int HTTP_CREATED
- См. также:
HTTP_ACCEPTED
public static final int HTTP_ACCEPTED
- См. также:
HTTP_NOT_AUTHORITATIVE
public static final int HTTP_NOT_AUTHORITATIVE
- См. также:
HTTP_NO_CONTENT
public static final int HTTP_NO_CONTENT
- См. также:
HTTP_RESET
public static final int HTTP_RESET
- См. также:
HTTP_PARTIAL
public static final int HTTP_PARTIAL
- См. также:
HTTP_MULT_CHOICE
public static final int HTTP_MULT_CHOICE
- См. также:
HTTP_MOVED_PERM
public static final int HTTP_MOVED_PERM
- См. также:
HTTP_MOVED_TEMP
public static final int HTTP_MOVED_TEMP
- См. также:
HTTP_SEE_OTHER
public static final int HTTP_SEE_OTHER
- См. также:
HTTP_NOT_MODIFIED
public static final int HTTP_NOT_MODIFIED
- См. также:
HTTP_USE_PROXY
public static final int HTTP_USE_PROXY
- См. также:
HTTP_BAD_REQUEST
public static final int HTTP_BAD_REQUEST
- См. также:
HTTP_UNAUTHORIZED
public static final int HTTP_UNAUTHORIZED
- См. также:
HTTP_PAYMENT_REQUIRED
public static final int HTTP_PAYMENT_REQUIRED
- См. также:
HTTP_FORBIDDEN
public static final int HTTP_FORBIDDEN
- См. также:
HTTP_NOT_FOUND
public static final int HTTP_NOT_FOUND
- См. также:
HTTP_BAD_METHOD
public static final int HTTP_BAD_METHOD
- См. также:
HTTP_NOT_ACCEPTABLE
public static final int HTTP_NOT_ACCEPTABLE
- См. также:
HTTP_PROXY_AUTH
public static final int HTTP_PROXY_AUTH
- См. также:
HTTP_CLIENT_TIMEOUT
public static final int HTTP_CLIENT_TIMEOUT
- См. также:
HTTP_CONFLICT
public static final int HTTP_CONFLICT
- См. также:
HTTP_GONE
public static final int HTTP_GONE
- См. также:
HTTP_LENGTH_REQUIRED
public static final int HTTP_LENGTH_REQUIRED
- См. также:
HTTP_PRECON_FAILED
public static final int HTTP_PRECON_FAILED
- См. также:
HTTP_ENTITY_TOO_LARGE
public static final int HTTP_ENTITY_TOO_LARGE
- См. также:
HTTP_REQ_TOO_LONG
public static final int HTTP_REQ_TOO_LONG
- См. также:
HTTP_UNSUPPORTED_TYPE
public static final int HTTP_UNSUPPORTED_TYPE
- См. также:
HTTP_SERVER_ERROR
@Deprecated public static final int HTTP_SERVER_ERROR
- См. также:
HTTP_INTERNAL_ERROR
public static final int HTTP_INTERNAL_ERROR
- См. также:
HTTP_NOT_IMPLEMENTED
public static final int HTTP_NOT_IMPLEMENTED
- См. также:
HTTP_BAD_GATEWAY
public static final int HTTP_BAD_GATEWAY
- См. также:
HTTP_UNAVAILABLE
public static final int HTTP_UNAVAILABLE
- См. также:
HTTP_GATEWAY_TIMEOUT
public static final int HTTP_GATEWAY_TIMEOUT
- См. также:
HTTP_VERSION
public static final int HTTP_VERSION
- См. также:
Подробное описание конструкторов
HttpURLConnection
protected HttpURLConnection(URL u)
- Параметры:
-
u— URL
Подробное описание методов
setAuthenticator
public void setAuthenticator(Authenticator auth)
Authenticator, который будет использоваться при запросе аутентификации через протокол HTTP для этого HttpURLConnection. Если аутентификатор не предоставлен, будет использоваться аутентификатор по умолчанию.- Требования к реализации:
- По умолчанию этот метод безусловно выбрасывает исключение
UnsupportedOperationException. Конкретные реализацииHttpURLConnection, поддерживающие предоставлениеAuthenticatorдля определенного экземпляраHttpURLConnection, должны переопределить этот метод, чтобы реализовать другое поведение. - Примечание по реализации:
- В зависимости от схем аутентификации реализации может потребоваться или не потребоваться использовать предоставленный аутентификатор для получения пароля. Например, реализация, использующая сторонние библиотеки безопасности, все равно может вызвать аутентификатор по умолчанию, если эти библиотеки настроены на такое поведение. Аналогично, реализация с поддержкой прозрачной аутентификации NTLM может сначала позволить системе попытаться подключиться с учетными данными системного пользователя, прежде чем вызывать предоставленный аутентификатор.
Однако, если аутентификатор указан явно, базовое соединение можно повторно использовать только для экземпляровHttpURLConnection, использующих один и тот же экземплярAuthenticator; сведения аутентификации, если они кэшируются, можно повторно использовать только дляHttpURLConnection, использующего тот жеAuthenticator. - Параметры:
-
auth—Authenticator, который должен использоваться этимHttpURLConnection. - Исключения:
-
UnsupportedOperationException— если базовая реализация не поддерживает установку Authenticator. -
IllegalStateException— если URLConnection уже подключен. -
NullPointerException— если предоставленныйauthимеет значениеnull. - Начиная с версии:
- 9
getHeaderFieldKey
public String getHeaderFieldKey(int n)
n-го поля заголовка. В некоторых реализациях 0-е поле заголовка может считаться особым, то есть строкой состояния, возвращаемой HTTP-сервером. В этом случае getHeaderField(0) возвращает строку состояния, а getHeaderFieldKey(0) возвращает null.- Переопределяет:
-
getHeaderFieldKeyв классеURLConnection - Параметры:
-
n— индекс, гдеn >=0. - Возвращает:
- ключ
n-го поля заголовка илиnull, если ключ отсутствует.
setFixedLengthStreamingMode
public void setFixedLengthStreamingMode(int contentLength)
Будет выброшено исключение, если приложение попытается записать данных больше, чем указано в длине содержимого, или если приложение закроет OutputStream, не записав указанное количество данных.
При включенной потоковой передаче вывода аутентификация и перенаправления не обрабатываются автоматически. При чтении ответа будет выброшено HttpRetryException, если требуется аутентификация или перенаправление. Сведения об ошибке можно получить из этого исключения.
Этот метод необходимо вызвать до подключения URLConnection.
ПРИМЕЧАНИЕ: Вместо этого метода рекомендуется использовать setFixedLengthStreamingMode(long), поскольку он позволяет задавать большую длину содержимого.
- Параметры:
-
contentLength— количество байтов, которые будут записаны в OutputStream. - Исключения:
-
IllegalStateException— если URLConnection уже подключен или уже включен другой режим потоковой передачи. -
IllegalArgumentException— если указана длина содержимого меньше нуля. - Начиная с версии:
- 1.5
- См. также:
setFixedLengthStreamingMode
public void setFixedLengthStreamingMode(long contentLength)
Будет выброшено исключение, если приложение попытается записать данных больше, чем указано в длине содержимого, или если приложение закроет OutputStream, не записав указанное количество данных.
При включенной потоковой передаче вывода аутентификация и перенаправления не обрабатываются автоматически. При чтении ответа будет выброшено HttpRetryException, если требуется аутентификация или перенаправление. Сведения об ошибке можно получить из этого исключения.
Этот метод необходимо вызвать до подключения URLConnection.
Длина содержимого, заданная вызовом этого метода, имеет приоритет над любым значением, заданным методом setFixedLengthStreamingMode(int).
- Параметры:
-
contentLength— количество байтов, которые будут записаны в OutputStream. - Исключения:
-
IllegalStateException— если URLConnection уже подключен или уже включен другой режим потоковой передачи. -
IllegalArgumentException— если указана длина содержимого меньше нуля. - Начиная с версии:
- 1.7
setChunkedStreamingMode
public void setChunkedStreamingMode(int chunklen)
При включенной потоковой передаче вывода аутентификация и перенаправления не обрабатываются автоматически. При чтении ответа будет выброшено HttpRetryException, если требуется аутентификация или перенаправление. Сведения об ошибке можно получить из этого исключения.
Этот метод необходимо вызвать до подключения URLConnection.
- Параметры:
-
chunklen— количество байтов в каждом блоке, включая заголовок размера блока в виде шестнадцатеричной строки (не менее 1 байта), два CRLF (4 байта) и минимальную длину полезной нагрузки 1 байт. Если значение chunklen меньше или равно 5, будет использовано большее значение по умолчанию. - Исключения:
-
IllegalStateException— если URLConnection уже подключен или уже включен другой режим потоковой передачи. - Начиная с версии:
- 1.5
- См. также:
getHeaderField
public String getHeaderField(int n)
n-го поля заголовка. В некоторых реализациях 0-е поле заголовка может считаться особым, то есть строкой состояния, возвращаемой HTTP-сервером. Этот метод можно использовать совместно с методом getHeaderFieldKey для перебора всех заголовков сообщения.
- Переопределяет:
-
getHeaderFieldв классеURLConnection - Параметры:
-
n— индекс, гдеn>=0. - Возвращает:
- значение
n-го поля заголовка илиnull, если значение отсутствует. - См. также:
setFollowRedirects
public static void setFollowRedirects(boolean set)
- Параметры:
-
set—boolean, указывающее, следует ли переходить по перенаправлениям HTTP. - См. также:
getFollowRedirects
public static boolean getFollowRedirects()
boolean, указывающее, следует ли автоматически переходить по перенаправлениям HTTP (3xx).- Возвращает:
-
true, если перенаправления HTTP должны обрабатываться автоматически, иfalseв противном случае. - См. также:
setInstanceFollowRedirects
public void setInstanceFollowRedirects(boolean followRedirects)
HttpURLConnection. Значение по умолчанию берется из followRedirects, значение которого по умолчанию равно true.
- Параметры:
-
followRedirects—boolean, указывающее, следует ли переходить по перенаправлениям HTTP. - Начиная с версии:
- 1.3
- См. также:
getInstanceFollowRedirects
public boolean getInstanceFollowRedirects()
instanceFollowRedirects этого объекта HttpURLConnection.- Возвращает:
- значение поля
instanceFollowRedirectsэтого объектаHttpURLConnection. - Начиная с:
- 1.3
- См. также:
setRequestMethod
public void setRequestMethod(String method) throws ProtocolException
- GET
- POST
- HEAD
- OPTIONS
- PUT
- DELETE
- TRACE
- Параметры:
-
method— метод HTTP - Исключения:
-
ProtocolException— если метод нельзя сбросить или если указанный метод недопустим для HTTP. - См. также:
getRequestMethod
public String getRequestMethod()
- Возвращает:
- метод HTTP-запроса
- См. также:
getResponseCode
public int getResponseCode() throws IOException
HTTP/1.0 200 OK HTTP/1.0 401 Unauthorizedбудут возвращены значения 200 и 401 соответственно. Возвращает -1, если код не удалось определить по ответу (то есть ответ не является корректным HTTP).
- Возвращает:
- код состояния HTTP или -1
- Исключения:
-
IOException— если при подключении к серверу произошла ошибка.
getResponseMessage
public String getResponseMessage() throws IOException
HTTP/1.0 200 OK HTTP/1.0 404 Not Foundизвлекаются строки "OK" и "Not Found" соответственно. Возвращает null, если сообщение не удалось определить по ответам (результат не является корректным HTTP).
- Возвращает:
- сообщение HTTP-ответа или
null - Исключения:
-
IOException— если при подключении к серверу произошла ошибка.
disconnect
public abstract void disconnect()
usingProxy
public abstract boolean usingProxy()
true, если известно, что соединение проходит или проходило через прокси-серверы, и возвращает false, если соединение никогда не будет проходить через прокси-сервер или если использование прокси-сервера невозможно определить.- Возвращает:
- значение boolean, указывающее, используется ли для соединения прокси-сервер.
getPermission
@Deprecated(since="25", forRemoval=true) public Permission getPermission() throws IOException
SocketPermission, представляющий разрешение, необходимое для подключения к целевому узлу и порту.- Переопределяет:
-
getPermissionв классеURLConnection - Возвращает:
- объект
SocketPermission, представляющий разрешение, необходимое для подключения к целевому узлу и порту. - Исключения:
-
IOException— если при вычислении разрешения произошла ошибка.
getErrorStream
public InputStream getErrorStream()
Этот метод не инициирует подключение. Если соединение не было установлено, если при подключении на сервере не возникла ошибка или если на сервере возникла ошибка, но данные об ошибке не были отправлены, метод возвращает null. Это значение используется по умолчанию.
- Возвращает:
- поток ошибок, если он есть; null, если ошибок не было, соединение не установлено или сервер не отправил полезные данные.
© 1993, 2025, 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/25/docs/api/java.base/java/net/HttpURLConnection.html