Класс HttpsServer

java.lang.Object

com.sun.net.httpserver.HttpServer

com.sun.net.httpserver.HttpsServer

public abstract class HttpsServer extends HttpServer

Этот класс является расширением HttpServer, обеспечивающим поддержку HTTPS.

Объект HttpsServer должен быть связан с объектом HttpsConfigurator, который используется для настройки SSL-соединений.

Все остальные настройки такие же, как для HttpServer.

С версии:: 1.6

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

HttpsServer()

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

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

Модификатор и тип	Метод	Описание
`static HttpsServer`	`create()`	Создает экземпляр `HttpsServer`, изначально не связанный ни с каким локальным адресом/портом.
`static HttpsServer`	`create(InetSocketAddress addr, int backlog)`	Создает экземпляр `HttpsServer`, который связывается с указанным `InetSocketAddress` (IP-адресом и номером порта).
`static HttpsServer`	`create(InetSocketAddress addr, int backlog, String path, HttpHandler handler, Filter... filters)`	Создает экземпляр `HttpsServer` с исходным контекстом.
`abstract HttpsConfigurator`	`getHttpsConfigurator()`	Возвращает объект `HttpsConfigurator` этого сервера, если он был задан.
`abstract void`	`setHttpsConfigurator(HttpsConfigurator config)`	Задает объект `HttpsConfigurator` этого сервера.

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

bind, createContext, createContext, getAddress, getExecutor, removeContext, removeContext, setExecutor, start, stop

Модификатор и тип	Метод	Описание
`abstract void`	`bind(InetSocketAddress addr, int backlog)`	Связывает ранее не связанный `HttpServer` с заданными адресом и номером порта.
`abstract HttpContext`	`createContext(String path)`	Создает HttpContext без указания обработчика.
`abstract HttpContext`	`createContext(String path, HttpHandler handler)`	Создает `HttpContext`.
`abstract InetSocketAddress`	`getAddress()`	Возвращает адрес, на котором сервер принимает соединения
`abstract Executor`	`getExecutor()`	Возвращает объект `Executor` этого сервера, если он был задан с помощью `HttpServer.setExecutor(Executor)`, или `null`, если он не был задан.
`abstract void`	`removeContext(HttpContext context)`	Удаляет указанный контекст с сервера.
`abstract void`	`removeContext(String path)`	Удаляет с сервера контекст, указанный заданным путем.
`abstract void`	`setExecutor(Executor executor)`	Задает объект `Executor` этого сервера.
`abstract void`	`start()`	Запускает сервер в новом фоновом потоке.
`abstract void`	`stop(int delay)`	Останавливает сервер, закрывая прослушивающий сокет и запрещая обработку новых обменов.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо истечения определенного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо истечения определенного промежутка реального времени.

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

HttpsServer

protected HttpsServer()

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

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

create

public static HttpsServer create() throws IOException

Создает экземпляр HttpsServer, изначально не связанный ни с каким локальным адресом/портом. Объект HttpsServer получается от установленного в данный момент объекта HttpServerProvider. Перед использованием сервер необходимо связать с адресом с помощью HttpServer.bind(InetSocketAddress, int). Кроме того, для сервера необходимо настроить HttpsConfigurator с помощью setHttpsConfigurator(HttpsConfigurator).

Возвращает:: экземпляр HttpsServer
Выбрасывает:: IOException — если произошла ошибка ввода-вывода

create

public static HttpsServer create(InetSocketAddress addr, int backlog) throws IOException

Создает экземпляр HttpsServer, который связывается с указанным InetSocketAddress (IP-адресом и номером порта). Также можно указать максимальную длину очереди. Это максимальное количество входящих соединений, ожидающих в очереди прослушивающего сокета. TCP-соединения, ожидающие в очереди сверх этого предела, могут быть отклонены реализацией TCP. Объект HttpsServer получается от установленного в данный момент объекта HttpServerProvider. Для сервера необходимо настроить HttpsConfigurator с помощью setHttpsConfigurator(HttpsConfigurator).

Параметры:: addr — адрес для прослушивания; если null, необходимо вызвать HttpServer.bind(InetSocketAddress, int), чтобы задать адрес; backlog — длина очереди сокета. Если это значение меньше или равно нулю, используется системное значение по умолчанию.
Возвращает:: экземпляр HttpsServer
Выбрасывает:: BindException — если сервер не может связаться с запрошенным адресом или уже связан с адресом; IOException — если произошла ошибка ввода-вывода

create

public static HttpsServer create(InetSocketAddress addr, int backlog, String path, HttpHandler handler, Filter... filters) throws IOException

Создает экземпляр HttpsServer с исходным контекстом.

Сервер создается с исходным контекстом, сопоставляющим URI path с обменом handler. Исходный контекст создается так же, как при вызове createContext(path). Указанные filters добавляются к исходному контексту в заданном порядке. Возвращаемый сервер не запущен, поэтому при необходимости его можно дополнительно настроить.

Экземпляр сервера связывается с заданным InetSocketAddress.

Также можно указать максимальную длину очереди. Это максимальное количество входящих соединений, ожидающих в очереди прослушивающего сокета. TCP-соединения, ожидающие в очереди сверх этого предела, могут быть отклонены реализацией TCP. HttpsServer получается от установленного в данный момент объекта HttpServerProvider.

Для сервера необходимо настроить HttpsConfigurator с помощью setHttpsConfigurator(HttpsConfigurator).

Параметры:: addr — адрес для прослушивания; если null, необходимо вызвать bind, чтобы задать адрес; backlog — длина очереди сокета. Если это значение меньше или равно нулю, используется системное значение по умолчанию; path — корневой URI-путь контекста; должен быть абсолютным; handler — HttpHandler для контекста; filters — фильтры для контекста, необязательный параметр
Возвращает:: HttpsServer
Выбрасывает:: BindException — если сервер не может связаться с адресом; IOException — если произошла ошибка ввода-вывода; IllegalArgumentException — если путь недопустим; NullPointerException — если любой из следующих параметров: path, handler, filters или любой элемент filters имеет значение null
С версии:: 18

setHttpsConfigurator

public abstract void setHttpsConfigurator(HttpsConfigurator config)

Задает объект HttpsConfigurator этого сервера.

Параметры:: config — объект HttpsConfigurator, который нужно задать
Выбрасывает:: NullPointerException — если config имеет значение null

getHttpsConfigurator

public abstract HttpsConfigurator getHttpsConfigurator()

Возвращает объект HttpsConfigurator этого сервера, если он был задан.

Возвращает:: объект HttpsConfigurator этого сервера или 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.