Класс Filter

Filter

protected Filter()

doFilter

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

Параметры:

exchange - обмен, подлежащий фильтрации

chain - цепочка, которая позволяет вызвать следующий фильтр

Исключения:

IOException - может быть вызван любым модулем фильтра, и, если пойман, должен быть повторно переброшен

NullPointerException - если обмен или цепочка являются null

description

public abstract String description()

Возвращает:

строку, описывающую Filter

beforeHandler

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

afterHandler

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