Spec-Zone.ru › OpenJDK 27

Класс HttpURLConnection

java.lang.Object
java.net.URLConnection
java.net.HttpURLConnection
Прямые известные подклассы:
HttpsURLConnection
public abstract class HttpURLConnection extends URLConnection
URLConnection с поддержкой функций, специфичных для HTTP. Подробности см. в спецификации .

Каждый экземпляр HttpURLConnection используется для выполнения одного запроса, однако базовое сетевое подключение к HTTP-серверу может прозрачно совместно использоваться другими экземплярами. Вызов методов close() для InputStream или OutputStream объекта HttpURLConnection после запроса может освободить сетевые ресурсы, связанные с этим экземпляром, но не влияет на совместное постоянное соединение. Вызов метода disconnect() может закрыть базовый сокет, если в этот момент постоянное соединение не используется.

Обработчик протокола HTTP имеет несколько параметров, доступных через системные свойства. К ним относятся параметры прокси-сервера, а также различные другие параметры.

С версии:
1.1
См. также:
  • disconnect()

Краткое описание полей

Модификатор и тип Поле Описание
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: успешно.
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 boolean allowUserInteraction
Если true, этот URL рассматривается в контексте, в котором допустимо взаимодействие с пользователем, например отображение диалогового окна аутентификации.
protected boolean connected
Если false, этот объект соединения ещё не создал канал связи с указанным URL.
protected boolean doInput
Эта переменная задаётся методом setDoInput.
protected boolean doOutput
Эта переменная задаётся методом setDoOutput.
protected long ifModifiedSince
Некоторые протоколы поддерживают пропуск получения объекта, если объект не изменялся после определённого момента времени.
protected URL url
URL представляет удалённый объект во Всемирной паутине, с которым устанавливается это соединение.
protected boolean useCaches
Если true, протоколу разрешено использовать кэширование, когда это возможно.

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

HttpURLConnection(URL u)
Модификатор Конструктор Описание
protected
Конструктор класса HttpURLConnection.

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

Модификатор и тип Метод Описание
abstract void disconnect()
Указывает, что в ближайшем будущем другие запросы к серверу маловероятны.
InputStream getErrorStream()
Возвращает поток ошибок, если соединение не удалось установить, но сервер всё же отправил полезные данные.
static boolean getFollowRedirects()
Возвращает boolean, указывающее, должны ли перенаправления HTTP (3xx) выполняться автоматически.
String getHeaderField(int n)
Возвращает значение n-го поля заголовка.
String getHeaderFieldKey(int n)
Возвращает ключ n-го поля заголовка.
boolean getInstanceFollowRedirects()
Возвращает значение поля instanceFollowRedirects этого HttpURLConnection.
Permission getPermission()
Устарело, будет удалено: этот элемент API может быть удалён в будущей версии.
Разрешения больше нельзя использовать для управления доступом к ресурсам, поскольку диспетчер безопасности больше не поддерживается.
String getRequestMethod()
Возвращает метод запроса.
int getResponseCode()
Возвращает код состояния из сообщения ответа HTTP.
String getResponseMessage()
Возвращает сообщение ответа HTTP, если оно было получено от сервера вместе с кодом ответа.
void setAuthenticator(Authenticator auth)
Предоставляет Authenticator, используемый при запросе аутентификации через протокол HTTP для этого HttpURLConnection.
void setChunkedStreamingMode(int chunklen)
Этот метод включает потоковую передачу тела HTTP-запроса без внутренней буферизации, если длина содержимого заранее не известна.
void setFixedLengthStreamingMode(int contentLength)
Этот метод включает потоковую передачу тела HTTP-запроса без внутренней буферизации, если длина содержимого заранее известна.
void setFixedLengthStreamingMode(long contentLength)
Этот метод включает потоковую передачу тела HTTP-запроса без внутренней буферизации, если длина содержимого заранее известна.
static void setFollowRedirects(boolean set)
Задаёт, должны ли перенаправления HTTP (запросы с кодом ответа 3xx) автоматически обрабатываться этим классом.
void setInstanceFollowRedirects(boolean followRedirects)
Задаёт, должны ли перенаправления HTTP (запросы с кодом ответа 3xx) автоматически обрабатываться этим экземпляром HttpURLConnection.
void setRequestMethod(String method)
Задаёт метод 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
Модификатор и тип Метод Описание
void addRequestProperty(String key, String value)
Добавляет общее свойство запроса, заданное парой ключ-значение.
abstract void connect()
Открывает канал связи с ресурсом, на который указывает этот URL, если такое соединение ещё не установлено.
boolean getAllowUserInteraction()
Возвращает значение поля allowUserInteraction этого объекта.
int getConnectTimeout()
Возвращает значение времени ожидания подключения.
Object getContent()
Получает содержимое этого URL-соединения.
Object getContent(Class<?>[] classes)
Получает содержимое этого URL-соединения.
String getContentEncoding()
Возвращает значение поля заголовка content-encoding.
int getContentLength()
Возвращает значение поля заголовка content-length.
long getContentLengthLong()
Возвращает значение поля заголовка content-length в виде long.
String getContentType()
Возвращает значение поля заголовка content-type.
long getDate()
Возвращает значение поля заголовка date.
static boolean getDefaultAllowUserInteraction()
Возвращает значение поля allowUserInteraction по умолчанию.
static String getDefaultRequestProperty(String key)
Устарело.
После получения соответствующего экземпляра URLConnection следует использовать метод getRequestProperty, относящийся к конкретному экземпляру.
boolean getDefaultUseCaches()
Возвращает значение флага useCaches объекта URLConnection по умолчанию.
static boolean getDefaultUseCaches(String protocol)
Возвращает значение флага useCaches по умолчанию для указанного протокола.
boolean getDoInput()
Возвращает значение флага doInput этого URLConnection.
boolean getDoOutput()
Возвращает значение флага doOutput этого URLConnection.
long getExpiration()
Возвращает значение поля заголовка expires.
static FileNameMap getFileNameMap()
Загружает карту имён файлов (таблицу MIME-типов) из файла данных.
String getHeaderField(String name)
Возвращает значение указанного поля заголовка.
long getHeaderFieldDate(String name, long defaultValue)
Возвращает значение указанного поля, преобразованное в дату.
int getHeaderFieldInt(String name, int defaultValue)
Возвращает значение указанного поля, преобразованное в число.
long getHeaderFieldLong(String name, long defaultValue)
Возвращает значение указанного поля, преобразованное в число.
Map<String, List<String>> getHeaderFields()
Возвращает неизменяемую карту полей заголовка.
long getIfModifiedSince()
Возвращает значение поля ifModifiedSince этого объекта.
InputStream getInputStream()
Возвращает входной поток для чтения из этого открытого соединения.
long getLastModified()
Возвращает значение поля заголовка last-modified.
OutputStream getOutputStream()
Возвращает выходной поток для записи в это соединение.
int getReadTimeout()
Возвращает значение времени ожидания чтения. Возвращаемое значение 0 означает, что параметр отключён (то есть время ожидания не ограничено).
Map<String, List<String>> getRequestProperties()
Возвращает неизменяемую карту общих свойств запроса для этого соединения.
String getRequestProperty(String key)
Возвращает значение указанного общего свойства запроса для этого соединения.
URL getURL()
Возвращает значение поля URL этого URLConnection.
boolean getUseCaches()
Возвращает значение поля useCaches этого URLConnection.
static String guessContentTypeFromName(String fname)
Пытается определить тип содержимого объекта на основе компонента URL, содержащего имя файла.
static String guessContentTypeFromStream(InputStream is)
Пытается определить тип входного потока на основе символов в его начале.
void setAllowUserInteraction(boolean allowuserinteraction)
Задаёт значение поля allowUserInteraction этого URLConnection.
void setConnectTimeout(int timeout)
Задаёт время ожидания в миллисекундах, используемое при открытии канала связи с ресурсом, на который указывает этот URLConnection.
static void setContentHandlerFactory(ContentHandlerFactory fac)
Задаёт ContentHandlerFactory приложения.
static void setDefaultAllowUserInteraction(boolean defaultallowuserinteraction)
Задаёт указанное значение по умолчанию для поля allowUserInteraction всех будущих объектов URLConnection.
static void setDefaultRequestProperty(String key, String value)
Устарело.
После получения соответствующего экземпляра URLConnection следует использовать метод setRequestProperty, относящийся к конкретному экземпляру.
void setDefaultUseCaches(boolean defaultusecaches)
Задаёт для поля useCaches указанное значение по умолчанию.
static void setDefaultUseCaches(String protocol, boolean defaultVal)
Задаёт указанное значение по умолчанию для поля useCaches именованного протокола.
void setDoInput(boolean doinput)
Задаёт указанное значение поля doInput для этого URLConnection.
void setDoOutput(boolean dooutput)
Задаёт указанное значение поля doOutput для этого URLConnection.
static void setFileNameMap(FileNameMap map)
Задаёт FileNameMap.
void setIfModifiedSince(long ifmodifiedsince)
Задаёт указанное значение поля ifModifiedSince этого URLConnection.
void setReadTimeout(int timeout)
Задаёт время ожидания чтения в миллисекундах.
void setRequestProperty(String key, String value)
Задаёт общее свойство запроса.
void setUseCaches(boolean usecaches)
Задаёт указанное значение поля useCaches этого URLConnection.
String toString()
Возвращает представление этого URL-соединения в виде String.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Модификатор и тип Метод Описание
protected Object clone()
Создаёт и возвращает копию этого объекта.
boolean equals(Object obj)
Указывает, равен ли какой-либо другой объект этому объекту.
protected void finalize()
Устарело, будет удалено: этот элемент API может быть удалён в будущей версии.
Финализация устарела и может быть удалена в одном из следующих выпусков.
final Class<?> getClass()
Возвращает класс времени выполнения этого Object.
int hashCode()
Возвращает хеш-код этого объекта.
final void notify()
Пробуждает один поток, ожидающий на мониторе этого объекта.
final void notifyAll()
Пробуждает все потоки, ожидающие на мониторе этого объекта.
final void wait()
Заставляет текущий поток ожидать пробуждения, обычно посредством уведомления или прерывания.
final void wait(long timeoutMillis)
Заставляет текущий поток ожидать пробуждения, обычно посредством уведомления или прерывания, либо до истечения заданного промежутка реального времени.
final void wait(long timeoutMillis, int nanos)
Заставляет текущий поток ожидать пробуждения, обычно посредством уведомления или прерывания, либо до истечения заданного промежутка реального времени.

Подробное описание полей

method

protected String method
Метод HTTP (GET,POST,PUT и т. д.).

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
Сообщение ответа HTTP.

instanceFollowRedirects

protected boolean instanceFollowRedirects
Если true, протокол будет автоматически следовать перенаправлениям. Если false, протокол не будет автоматически следовать перенаправлениям.

Это поле задается методом setInstanceFollowRedirects. Его значение возвращается методом getInstanceFollowRedirects.

Значение по умолчанию определяется значением статического поля followRedirects на момент создания HttpURLConnection.

См. также:
  • setInstanceFollowRedirects(boolean)
  • getInstanceFollowRedirects()
  • setFollowRedirects(boolean)

HTTP_OK

public static final int HTTP_OK
Код состояния HTTP 200: OK (успешно).
См. также:
  • Значения константных полей

HTTP_CREATED

public static final int HTTP_CREATED
Код состояния HTTP 201: Created (создано).
См. также:
  • Значения константных полей

HTTP_ACCEPTED

public static final int HTTP_ACCEPTED
Код состояния HTTP 202: Accepted (принято).
См. также:
  • Значения константных полей

HTTP_NOT_AUTHORITATIVE

public static final int HTTP_NOT_AUTHORITATIVE
Код состояния HTTP 203: Non-Authoritative Information (недостоверная информация).
См. также:
  • Значения константных полей

HTTP_NO_CONTENT

public static final int HTTP_NO_CONTENT
Код состояния HTTP 204: No Content (нет содержимого).
См. также:
  • Значения константных полей

HTTP_RESET

public static final int HTTP_RESET
Код состояния HTTP 205: Reset Content (сброс содержимого).
См. также:
  • Значения константных полей

HTTP_PARTIAL

public static final int HTTP_PARTIAL
Код состояния HTTP 206: Partial Content (частичное содержимое).
См. также:
  • Значения константных полей

HTTP_MULT_CHOICE

public static final int HTTP_MULT_CHOICE
Код состояния HTTP 300: Multiple Choices (несколько вариантов).
См. также:
  • Значения константных полей

HTTP_MOVED_PERM

public static final int HTTP_MOVED_PERM
Код состояния HTTP 301: Moved Permanently (перемещено навсегда).
См. также:
  • Значения константных полей

HTTP_MOVED_TEMP

public static final int HTTP_MOVED_TEMP
Код состояния HTTP 302: Temporary Redirect (временное перенаправление).
См. также:
  • Значения константных полей

HTTP_SEE_OTHER

public static final int HTTP_SEE_OTHER
Код состояния HTTP 303: See Other (см. другой ресурс).
См. также:
  • Значения константных полей

HTTP_NOT_MODIFIED

public static final int HTTP_NOT_MODIFIED
Код состояния HTTP 304: Not Modified (не изменено).
См. также:
  • Значения константных полей

HTTP_USE_PROXY

public static final int HTTP_USE_PROXY
Код состояния HTTP 305: Use Proxy (используйте прокси-сервер).
См. также:
  • Значения константных полей

HTTP_BAD_REQUEST

public static final int HTTP_BAD_REQUEST
Код состояния HTTP 400: Bad Request (неверный запрос).
См. также:
  • Значения константных полей

HTTP_UNAUTHORIZED

public static final int HTTP_UNAUTHORIZED
Код состояния HTTP 401: Unauthorized (не авторизован).
См. также:
  • Значения константных полей

HTTP_PAYMENT_REQUIRED

public static final int HTTP_PAYMENT_REQUIRED
Код состояния HTTP 402: Payment Required (требуется оплата).
См. также:
  • Значения константных полей

HTTP_FORBIDDEN

public static final int HTTP_FORBIDDEN
Код состояния HTTP 403: Forbidden (доступ запрещен).
См. также:
  • Значения константных полей

HTTP_NOT_FOUND

public static final int HTTP_NOT_FOUND
Код состояния HTTP 404: Not Found (не найдено).
См. также:
  • Значения константных полей

HTTP_BAD_METHOD

public static final int HTTP_BAD_METHOD
Код состояния HTTP 405: Method Not Allowed (метод не разрешен).
См. также:
  • Значения константных полей

HTTP_NOT_ACCEPTABLE

public static final int HTTP_NOT_ACCEPTABLE
Код состояния HTTP 406: Not Acceptable (неприемлемо).
См. также:
  • Значения константных полей

HTTP_PROXY_AUTH

public static final int HTTP_PROXY_AUTH
Код состояния HTTP 407: Proxy Authentication Required (требуется аутентификация прокси-сервера).
См. также:
  • Значения константных полей

HTTP_CLIENT_TIMEOUT

public static final int HTTP_CLIENT_TIMEOUT
Код состояния HTTP 408: Request Time-Out (истекло время ожидания запроса).
См. также:
  • Значения константных полей

HTTP_CONFLICT

public static final int HTTP_CONFLICT
Код состояния HTTP 409: Conflict (конфликт).
См. также:
  • Значения константных полей

HTTP_GONE

public static final int HTTP_GONE
Код состояния HTTP 410: Gone (ресурс удален).
См. также:
  • Значения константных полей

HTTP_LENGTH_REQUIRED

public static final int HTTP_LENGTH_REQUIRED
Код состояния HTTP 411: Length Required (требуется указать длину).
См. также:
  • Значения константных полей

HTTP_PRECON_FAILED

public static final int HTTP_PRECON_FAILED
Код состояния HTTP 412: Precondition Failed (условие не выполнено).
См. также:
  • Значения константных полей

HTTP_ENTITY_TOO_LARGE

public static final int HTTP_ENTITY_TOO_LARGE
Код состояния HTTP 413: Request Entity Too Large (объект запроса слишком велик).
См. также:
  • Значения константных полей

HTTP_REQ_TOO_LONG

public static final int HTTP_REQ_TOO_LONG
Код состояния HTTP 414: Request-URI Too Large (URI запроса слишком длинный).
См. также:
  • Значения константных полей

HTTP_UNSUPPORTED_TYPE

public static final int HTTP_UNSUPPORTED_TYPE
Код состояния HTTP 415: Unsupported Media Type (неподдерживаемый тип данных).
См. также:
  • Значения константных полей

HTTP_SERVER_ERROR

@Deprecated public static final int HTTP_SERVER_ERROR
Устарело.
это поле расположено не на своем месте и не должно было существовать.
Код состояния HTTP 500: Internal Server Error (внутренняя ошибка сервера).
См. также:
  • Значения константных полей

HTTP_INTERNAL_ERROR

public static final int HTTP_INTERNAL_ERROR
Код состояния HTTP 500: Internal Server Error (внутренняя ошибка сервера).
См. также:
  • Значения константных полей

HTTP_NOT_IMPLEMENTED

public static final int HTTP_NOT_IMPLEMENTED
Код состояния HTTP 501: Not Implemented (не реализовано).
См. также:
  • Значения константных полей

HTTP_BAD_GATEWAY

public static final int HTTP_BAD_GATEWAY
Код состояния HTTP 502: Bad Gateway (ошибочный ответ шлюза).
См. также:
  • Значения константных полей

HTTP_UNAVAILABLE

public static final int HTTP_UNAVAILABLE
Код состояния HTTP 503: Service Unavailable (служба недоступна).
См. также:
  • Значения константных полей

HTTP_GATEWAY_TIMEOUT

public static final int HTTP_GATEWAY_TIMEOUT
Код состояния HTTP 504: Gateway Timeout (истекло время ожидания ответа шлюза).
См. также:
  • Значения константных полей

HTTP_VERSION

public static final int HTTP_VERSION
Код состояния HTTP 505: HTTP Version Not Supported (версия HTTP не поддерживается).
См. также:
  • Значения константных полей

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

HttpURLConnection

protected HttpURLConnection(URL u)
Конструктор HttpURLConnection.
Параметры:
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)
Этот метод используется для включения потоковой передачи тела HTTP-запроса без внутренней буферизации, если длина содержимого известна заранее.

Будет выброшено исключение, если приложение попытается записать больше данных, чем указано в длине содержимого, или если приложение закроет OutputStream, не записав указанное количество данных.

При включенной потоковой передаче вывода автоматическая обработка аутентификации и перенаправлений невозможна. При чтении ответа будет выброшено исключение HttpRetryException, если требуется аутентификация или перенаправление. Это исключение можно запросить для получения сведений об ошибке.

Этот метод необходимо вызвать до подключения URLConnection.

ПРИМЕЧАНИЕ: Вместо этого метода рекомендуется использовать setFixedLengthStreamingMode(long), поскольку он позволяет задавать большую длину содержимого.

Параметры:
contentLength — количество байтов, которые будут записаны в OutputStream.
Исключения:
IllegalStateException — если URLConnection уже подключен или уже включен другой режим потоковой передачи.
IllegalArgumentException — если указана длина содержимого меньше нуля.
Начиная с:
1.5
См. также:
  • setChunkedStreamingMode(int)

setFixedLengthStreamingMode

public void setFixedLengthStreamingMode(long contentLength)
Этот метод используется для включения потоковой передачи тела HTTP-запроса без внутренней буферизации, если длина содержимого известна заранее.

Будет выброшено исключение, если приложение попытается записать больше данных, чем указано в длине содержимого, или если приложение закроет OutputStream, не записав указанное количество данных.

При включенной потоковой передаче вывода автоматическая обработка аутентификации и перенаправлений невозможна. При чтении ответа будет выброшено исключение HttpRetryException, если требуется аутентификация или перенаправление. Это исключение можно запросить для получения сведений об ошибке.

Этот метод необходимо вызвать до подключения URLConnection.

Длина содержимого, заданная вызовом этого метода, имеет приоритет над любым значением, заданным методом setFixedLengthStreamingMode(int).

Параметры:
contentLength — количество байтов, которые будут записаны в OutputStream.
Исключения:
IllegalStateException — если URLConnection уже подключен или уже включен другой режим потоковой передачи.
IllegalArgumentException — если указана длина содержимого меньше нуля.
Начиная с:
1.7

setChunkedStreamingMode

public void setChunkedStreamingMode(int chunklen)
Этот метод используется для включения потоковой передачи тела HTTP-запроса без внутренней буферизации, если длина содержимого заранее не известна. В этом режиме для отправки тела запроса используется передача с кодированием фрагментами. Обратите внимание: не все HTTP-серверы поддерживают этот режим.

При включенной потоковой передаче вывода автоматическая обработка аутентификации и перенаправлений невозможна. При чтении ответа будет выброшено исключение HttpRetryException, если требуется аутентификация или перенаправление. Это исключение можно запросить для получения сведений об ошибке.

Этот метод необходимо вызвать до подключения URLConnection.

Параметры:
chunklen — количество байтов в каждом фрагменте, включая заголовок размера фрагмента в виде шестнадцатеричной строки (минимум 1 байт), два CRLF (4 байта) и полезную нагрузку длиной не менее 1 байта. Если chunklen меньше или равен 5, будет использовано большее значение по умолчанию.
Исключения:
IllegalStateException — если URLConnection уже подключен или уже включен другой режим потоковой передачи.
Начиная с:
1.5
См. также:
  • setFixedLengthStreamingMode(int)

getHeaderField

public String getHeaderField(int n)
Возвращает значение n-го поля заголовка. Некоторые реализации могут считать 0-е поле заголовка специальным, то есть строкой состояния, возвращаемой HTTP-сервером.

Этот метод можно использовать совместно с методом getHeaderFieldKey для перебора всех заголовков сообщения.

Переопределяет:
getHeaderField в классе URLConnection
Параметры:
n — индекс, где n>=0.
Возвращает:
значение n-го поля заголовка или null, если значение не существует.
См. также:
  • getHeaderFieldKey(int)

setFollowRedirects

public static void setFollowRedirects(boolean set)
Задает, следует ли этому классу автоматически переходить по перенаправлениям HTTP (запросам с кодом ответа 3xx). По умолчанию — true.
Параметры:
set — boolean, указывающее, следует ли переходить по перенаправлениям HTTP.
См. также:
  • getFollowRedirects()

getFollowRedirects

public static boolean getFollowRedirects()
Возвращает boolean, указывающее, следует ли автоматически переходить по перенаправлениям HTTP (3xx).
Возвращает:
true, если следует автоматически переходить по перенаправлениям HTTP, и false в противном случае.
См. также:
  • setFollowRedirects(boolean)

setInstanceFollowRedirects

public void setInstanceFollowRedirects(boolean followRedirects)
Задает, должен ли этот экземпляр HttpURLConnection автоматически переходить по перенаправлениям HTTP (запросам с кодом ответа 3xx).

Значение по умолчанию берется из followRedirects, значение которого по умолчанию — true.

Параметры:
followRedirects — boolean, указывающее, следует ли переходить по перенаправлениям HTTP.
Начиная с:
1.3
См. также:
  • instanceFollowRedirects
  • getInstanceFollowRedirects()

getInstanceFollowRedirects

public boolean getInstanceFollowRedirects()
Возвращает значение поля instanceFollowRedirects этого HttpURLConnection.
Возвращает:
значение поля instanceFollowRedirects этого HttpURLConnection.
Начиная с:
1.3
См. также:
  • instanceFollowRedirects
  • setInstanceFollowRedirects(boolean)

setRequestMethod

public void setRequestMethod(String method) throws ProtocolException
Задаёт метод запроса URL. Допустимы следующие методы:
  • GET
  • POST
  • HEAD
  • OPTIONS
  • PUT
  • DELETE
  • TRACE
с учётом ограничений протокола. Методом по умолчанию является GET.
Параметры:
method — метод HTTP
Исключения:
ProtocolException — если метод нельзя сбросить или запрошенный метод недопустим для HTTP.
См. также:
  • getRequestMethod()

getRequestMethod

public String getRequestMethod()
Возвращает метод запроса.
Возвращает:
метод HTTP-запроса
См. также:
  • setRequestMethod(java.lang.String)

getResponseCode

public int getResponseCode() throws IOException
Возвращает код состояния из сообщения HTTP-ответа. Например, для следующих строк состояния: 
HTTP/1.0 200 OK
HTTP/1.0 401 Unauthorized
будут возвращены соответственно 200 и 401. Возвращает -1, если код не удалось определить по ответу (то есть ответ не является допустимым HTTP-ответом).
Возвращает:
код состояния HTTP или -1
Исключения:
IOException — если при подключении к серверу произошла ошибка.

getResponseMessage

public String getResponseMessage() throws IOException
Возвращает сообщение HTTP-ответа, если оно есть, которое сервер передал вместе с кодом ответа. Из ответов вида: 
HTTP/1.0 200 OK
HTTP/1.0 404 Not Found
извлекаются строки «OK» и «Not Found» соответственно. Возвращает null, если сообщение не удалось определить по ответам (результат не является допустимым HTTP-ответом).
Возвращает:
сообщение HTTP-ответа или null
Исключения:
IOException — если при подключении к серверу произошла ошибка.

disconnect

public abstract void disconnect()
Указывает, что в ближайшем будущем другие запросы к серверу маловероятны. Вызов disconnect() не означает, что этот экземпляр HttpURLConnection можно повторно использовать для других запросов.

usingProxy

public abstract boolean usingProxy()
Указывает, проходит ли соединение через прокси-сервер. Этот метод возвращает true, если известно, что соединение проходит или проходило через прокси-серверы, и возвращает false, если соединение никогда не будет проходить через прокси-сервер или использование прокси-сервера определить невозможно.
Возвращает:
логическое значение, указывающее, использует ли соединение прокси-сервер.

getPermission

@Deprecated(since="25", forRemoval=true) public Permission getPermission() throws IOException
Устарело, подлежит удалению: этот элемент API может быть удалён в будущей версии.
Разрешения больше нельзя использовать для управления доступом к ресурсам, поскольку диспетчер безопасности больше не поддерживается.
Возвращает объект SocketPermission, представляющий разрешение, необходимое для подключения к целевому узлу и порту.
Переопределяет:
getPermission в классе URLConnection
Возвращает:
объект SocketPermission, представляющий разрешение, необходимое для подключения к целевому узлу и порту.
Исключения:
IOException — если при вычислении разрешения произошла ошибка.

getErrorStream

public InputStream getErrorStream()
Возвращает поток ошибок, если соединение установить не удалось, но сервер тем не менее отправил полезные данные. Типичный пример — ответ HTTP-сервера с кодом 404: при подключении будет выброшено исключение FileNotFoundException, но сервер отправит HTML-страницу справки с рекомендациями.

Этот метод не инициирует установление соединения. Если соединение не было установлено, если при подключении не возникла ошибка на сервере или если ошибка возникла, но данные об ошибке не были отправлены, метод вернёт null. Это поведение по умолчанию.

Возвращает:
поток ошибок, если он есть; null, если ошибок не было, соединение не установлено или сервер не отправил полезные данные.

Сообщить об ошибке или предложить улучшение
Дополнительную справочную информацию по API и документацию для разработчиков см. в документации Java SE, содержащей более подробные описания для разработчиков, обзоры концепций, определения терминов, обходные решения и примеры работающего кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или её аффилированных лиц в США и других странах.
Авторское право © 1993, 2026, Oracle и/или её аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 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.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API