Класс Filter

protected Filter()

public abstract void doFilter(HttpExchange exchange, Filter.Chain chain) throws IOException

Параметры:

exchange — HttpExchange, подлежащий фильтрации

chain — Chain, позволяющая вызвать следующий фильтр

Выбрасывает:

IOException — может быть выброшено любым модулем фильтра; если исключение перехвачено, его необходимо выбросить повторно

NullPointerException — если exchange или chain равны null

public abstract String description()

Возвращает:

String, описывающую Filter

public static Filter beforeHandler(String description, Consumer<HttpExchange> operation)

Примечание API:

Фильтр beforeHandler обычно используется для проверки или изменения состояния обмена до его обработки. operation фильтра выполняется до вызова Filter.Chain.doFilter(HttpExchange), то есть до выполнения любых последующих фильтров в цепочке и обработчика обмена. От operation фильтра не ожидается обработка запроса или отправка заголовков ответа, поскольку обычно это делает обработчик обмена.

Пример добавления заголовка ответа "Foo" ко всем ответам:

    var filter = Filter.beforeHandler("Add response header Foo",
                e -> e.getResponseHeaders().set("Foo", "Bar"));
    httpContext.getFilters().add(filter);

Параметры:

description — строка, возвращаемая методом description()

operation — операция возвращаемого фильтра

Возвращает:

фильтр, операция которого вызывается до обработки обмена

Выбрасывает:

NullPointerException — если любой аргумент равен null

Начиная с:

17

public static Filter afterHandler(String description, Consumer<HttpExchange> operation)

Примечание API:

Фильтр afterHandler обычно используется для проверки состояния обмена, а не для его изменения. operation фильтра выполняется после вызова Filter.Chain.doFilter(HttpExchange), то есть после выполнения всех последующих фильтров в цепочке и обработчика обмена. От operation фильтра не ожидается обработка обмена или отправка заголовков ответа. Это, скорее всего, приведёт к сбою, поскольку обмен обычно обрабатывается до вызова operation. В частности, ответ может быть отправлен до выполнения operation фильтра.

Пример добавления фильтра, регистрирующего код ответа для всех обменов:

    var filter = Filter.afterHandler("Log response code", e -> log(e.getResponseCode());
    httpContext.getFilters().add(filter);

Пример добавления последовательности фильтров afterHandler в контекст:
Операции фильтров вызываются в порядке, обратном порядку добавления фильтров в список фильтров контекста.

    var a1Set = Filter.afterHandler("Set a1", e -> e.setAttribute("a1", "some value"));
    var a1Get = Filter.afterHandler("Get a1", e -> doSomething(e.getAttribute("a1")));
    httpContext.getFilters().addAll(List.of(a1Get, a1Set));

Операция a1Get будет вызвана после операции a1Set, поскольку a1Get был добавлен до a1Set.

Параметры:

description — строка, возвращаемая методом description()

operation — операция возвращаемого фильтра

Возвращает:

фильтр, операция которого вызывается после обработки обмена

Выбрасывает:

NullPointerException — если любой аргумент равен null

Начиная с:

17

public static Filter adaptRequest(String description, UnaryOperator<Request> requestOperator)

Примечание API:

При вызове возвращаемого фильтра он сначала вызывает requestOperator с указанным обменом, ex, чтобы получить адаптированное состояние запроса. Затем он вызывает следующий фильтр в цепочке или обработчик обмена, передавая обмен, эквивалентный ex, с заданным в качестве фактического состояния запроса адаптированным состоянием запроса.

Пример добавления заголовка запроса "Foo" ко всем запросам:

    var filter = Filter.adaptRequest("Add Foo header", r -> r.with("Foo", List.of("Bar")));
    httpContext.getFilters().add(filter);

Параметры:

description — строка, возвращаемая методом description()

requestOperator — оператор запроса

Возвращает:

фильтр, адаптирующий состояние запроса до обработки обмена

Выбрасывает:

NullPointerException — если любой аргумент равен null

Начиная с:

18