Класс SettingControl

java.lang.Object

jdk.jfr.SettingControl

public abstract class SettingControl extends Object

Базовый класс для расширения, чтобы создать элементы управления настройками.

Следующий пример демонстрирует простое реализацию элемента управления настройками для регулярных выражений:

final class RegExpControl extends SettingControl {
    private Pattern pattern = Pattern.compile(".*");

    @Override
    public void setValue(String value) {
        this.pattern = Pattern.compile(value);
    }

    @Override
    public String combine(Set<String> values) {
        return String.join("|", values);
    }

    @Override
    public String getValue() {
        return pattern.toString();
    }

    public boolean matches(String s) {
        return pattern.matcher(s).find();
    }
}

Методы setValue(String), getValue() и combine(Set<String>) вызываются при изменении значения настройки, что обычно происходит при запуске или остановке записи. Метод combine(Set<String>) вызывается для определения значения, используемого, когда несколько записей выполняются одновременно.

Элемент управления настройками должен иметь конструктор по умолчанию, который может быть вызван при регистрации события.

Чтобы использовать элемент управления настройками с событием, добавьте метод, возвращающий значение boolean и принимающий элемент управления настройками в качестве параметра. Отметьте метод аннотацией @SettingDefinition. По умолчанию имя метода используется в качестве имени настройки, но имя можно явно задать, используя аннотацию @Name. Если метод возвращает true, событие будет подтверждено.

Рекомендуется, чтобы метод setValue(String) обновлял эффективную структуру данных, которая может быть быстро проверена при подтверждении события.

Следующий пример демонстрирует создание события, использующего фильтр регулярных выражений, определенный выше.

abstract class HTTPRequest extends Event {
    @Label("Request URI")
    protected String uri;

    @Label("Servlet URI Filter")
    @SettingDefinition
    protected boolean uriFilter(RegExpControl regExp) {
        return regExp.matches(uri);
    }
}

@Label("HTTP Get Request")
class HTTPGetRequest extends HTTPRequest {
}

@Label("HTTP Post Request")
class HTTPPostRequest extends HTTPRequest {
}

class ExampleServlet extends HttpServlet {
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) {
        HTTPGetRequest request = new HTTPGetRequest();
        request.begin();
        request.uri = req.getRequestURI();
        ...
        request.commit();
    }

    protected void doPost(HttpServletRequest req, HttpServletResponse resp) {
        HTTPPostRequest request = new HTTPPostRequest();
        request.begin();
        request.uri = req.getRequestURI();
        ...
        request.commit();
    }
}

Следующий пример показывает, как событие можно отфильтровать, присвоив настройку "uriFilter" указанными регулярными выражениями.

Recording r = new Recording();
r.enable("HTTPGetRequest").with("uriFilter", "https://www.example.com/list/.*");
r.enable("HTTPPostRequest").with("uriFilter", "https://www.example.com/login/.*");
r.start();

Since:

См. также:

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

SettingControl()

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

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

Модификатор и тип	Метод	Описание
`abstract String`	`combine(Set<String> settingValues)`	Объединяет значения настроек для всех активных записей в одно значение при одновременном выполнении нескольких записей.
`abstract String`	`getValue()`	Возвращает текущее используемое значение для этой настройки, не `null`.
`abstract void`	`setValue(String settingValue)`	Устанавливает значение для этой настройки.

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

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

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

SettingControl

protected SettingControl()

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

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

combine

public abstract String combine(Set<String> settingValues)

Объединяет значения настроек для всех активных записей в одно значение при одновременном выполнении нескольких записей,

Семантика объединения значений настроек зависит от реализованного элемента управления настройками, но все записи должны получить, как минимум, все запрошенные события.

Этот метод не должен иметь побочных эффектов, потому что вызывающая сторона может кэшировать значения. Этот метод никогда не должен возвращать null или выбрасывать исключение. Если значение не является допустимым для данного элемента управления настройками, значение должно быть проигнорировано.

Примеры:

Если элемент управления настройками представляет порог, а три записи выполняются одновременно со значениями настроек "10 ms", "8 s", и "1 ms", этот метод возвращает "1 ms", потому что это означает, что все записи получают, как минимум, все запрошенные данные.

Если элемент управления настройками представляет набор имен, а две записи выполняются одновременно со значениями настроек "Smith, Jones" и "Jones, Williams", возвращаемое значение составляет "Smith, Jones, Williams", потому что все имена будут приняты.

Если элемент управления настройками представляет булево условие, и четыре записи выполняются одновременно со значениями "true", "false", "false", и "incorrect", этот метод возвращает "true", потому что все записи получают, как минимум, все запрошенные данные.

Параметры:: settingValues - набор значений, не null
Возвращает:: значение для использования, не null

setValue

public abstract void setValue(String settingValue)

Устанавливает значение для этой настройки.

Если значение настройки не является допустимым для этого элемента управления настройками, этот метод не выбрасывает исключение. Вместо этого значение игнорируется.

Параметры:: settingValue - строковое значение, не null

getValue

public abstract String getValue()

Возвращает текущее используемое значение для этой настройки, не null.

Возвращаемое этим методом значение является допустимым аргументом для метода setValue(String) и метода combine(Set).

Этот метод вызывается при регистрации события для получения значения по умолчанию. Поэтому важно, чтобы допустимое значение можно было вернуть сразу после создания экземпляра этого класса. Недопустимо возвращать null.

Возвращает:: значение настройки, не null

© 1993, 2023, 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/21/docs/api/jdk.jfr/jdk/jfr/SettingControl.html