Класс Filter

protected Filter()

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

Параметры:

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

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

Исключения:

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

NullPointerException - если обмен или цепочка 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