Spec-Zone.ru › OpenJDK 17

Класс HttpContext

java.lang.Object
com.sun.net.httpserver.HttpContext
public abstract class HttpContext extends Object
HttpContext представляет собой отображение между корневым URI путём приложения и HttpHandler, который вызывается для обработки запросов, предназначенных для этого пути в ассоциированном HttpServer или HttpsServer.

HttpContext экземпляры создаются методами create в HttpServer и HttpsServer.

Цепочка объектов Filter может быть добавлена в HttpContext. Все обмены, обработанные контекстом, могут быть предварительно и послеобработаны каждым Filter в цепочке.

Since:
1.6

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

HttpContext()
Модификатор Конструктор Описание
protected
Конструктор для вызова подклассами.

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

Модификатор и тип Метод Описание
abstract Map<String,Object> getAttributes()
Возвращает изменяемую Map, которая может использоваться для передачи конфигурации и других данных модулям Filter и обработчику обмена контекста.
abstract Authenticator getAuthenticator()
Возвращает текущий установленный Authenticator для данного контекста, если он существует.
abstract List<Filter> getFilters()
Возвращает список List фильтров данного контекста.
abstract HttpHandler getHandler()
Возвращает обработчик для данного контекста.
abstract String getPath()
Возвращает путь, с которым был создан данный контекст.
abstract HttpServer getServer()
Возвращает сервер, с которым был создан данный контекст.
abstract Authenticator setAuthenticator(Authenticator auth)
Устанавливает Authenticator для данного HttpContext.
abstract void setHandler(HttpHandler handler)
Устанавливает обработчик для данного контекста, если он ещё не установлен.

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

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

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

HttpContext

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

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

getHandler

public abstract HttpHandler getHandler()
Возвращает обработчик для данного контекста.
Возвращает:
обработчик для данного контекста

setHandler

public abstract void setHandler(HttpHandler handler)
Устанавливает обработчик для данного контекста, если он ещё не установлен.
Параметры:
handler - обработчик, который нужно установить для данного контекста
Исключения:
IllegalArgumentException - если контекст для этого обработчика уже установлен.
NullPointerException - если обработчик null

getPath

public abstract String getPath()
Возвращает путь, с которым был создан данный контекст.
Возвращает:
путь контекста

getServer

public abstract HttpServer getServer()
Возвращает сервер, с которым был создан данный контекст.
Возвращает:
сервер контекста

getAttributes

public abstract Map<String,Object> getAttributes()
Возвращает изменяемую Map, которая может использоваться для передачи конфигурации и других данных модулям Filter и обработчику обмена контекста.

Каждый атрибут, сохранённый в этом Map, будет виден каждому HttpExchange обработанному данным контекстом.

Возвращает:
словарь атрибутов контекста

getFilters

public abstract List<Filter> getFilters()
Возвращает список List фильтров данного контекста. Это фактический список, используемый сервером при передаче запросов, поэтому изменения в этом списке немедленно влияют на обработку обменов.
Возвращает:
список фильтров данного контекста

setAuthenticator

public abstract Authenticator setAuthenticator(Authenticator auth)
Устанавливает Authenticator для данного HttpContext . После установления аутентификатора в контексте все клиентские запросы должны быть аутентифицированы, и указанный объект будет вызываться для валидации каждого запроса. Каждый вызов этого метода заменяет любое предыдущее значение.
Параметры:
auth - устанавливаемый Authenticator. Если null, то любой ранее установленный Authenticator удаляется, и аутентификация клиентов больше не требуется.
Возвращает:
предыдущий Authenticator, если таковой был установлен, иначе null.

getAuthenticator

public abstract Authenticator getAuthenticator()
Возвращает текущий установленный Authenticator для данного контекста, если он существует.
Возвращает:
аутентификатор данного Authenticator , или null если он не установлен

© 1993, 2021, 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/17/docs/api/jdk.httpserver/com/sun/net/httpserver/HttpContext.html

Spec-Zone.ru

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