Spec-Zone.ru › OpenJDK 27

Класс CertPathBuilder

java.lang.Object
java.security.cert.CertPathBuilder
public class CertPathBuilder extends Object
Класс для построения путей сертификации (также известных как цепочки сертификатов).

Этот класс использует архитектуру на основе поставщиков. Чтобы создать CertPathBuilder, вызовите один из статических методов getInstance, передав имя желаемого алгоритма CertPathBuilder и, при необходимости, имя желаемого поставщика.

После создания объекта CertPathBuilder можно строить пути сертификации, вызывая метод build и передавая ему набор параметров, зависящий от алгоритма. В случае успеха результат (включая построенный CertPath) возвращается в объекте, реализующем интерфейс CertPathBuilderResult.

Метод getRevocationChecker() позволяет приложению указать дополнительные параметры и параметры настройки, зависящие от алгоритма, которые используются CertPathBuilder при проверке статуса отзыва сертификатов. Ниже показан пример его использования с алгоритмом PKIX:

CertPathBuilder cpb = CertPathBuilder.getInstance("PKIX");
PKIXRevocationChecker rc = (PKIXRevocationChecker)cpb.getRevocationChecker();
rc.setOptions(EnumSet.of(Option.PREFER_CRLS));
params.addCertPathChecker(rc);
CertPathBuilderResult cpbr = cpb.build(params);

Каждая реализация платформы Java должна поддерживать следующий стандартный алгоритм CertPathBuilder:

  • PKIX
Этот алгоритм описан в разделе CertPathBuilder спецификации стандартных имен алгоритмов безопасности Java. Обратитесь к документации выпуска для вашей реализации, чтобы узнать, поддерживаются ли какие-либо другие алгоритмы.

Параллельный доступ

Гарантируется, что статические методы этого класса являются потокобезопасными. Несколько потоков могут одновременно вызывать статические методы, определённые в этом классе, без нежелательных последствий.

Однако это не относится к нестатическим методам, определённым этим классом. Если в документации конкретного поставщика не указано иное, потоки, которым требуется одновременно обращаться к одному экземпляру CertPathBuilder, должны синхронизироваться между собой и обеспечивать необходимую блокировку. Потокам, каждый из которых работает с отдельным экземпляром CertPathBuilder, синхронизация не требуется.

С версии:
1.4
Внешние спецификации
  • Стандартные имена алгоритмов безопасности Java
См. также:
  • CertPath

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

CertPathBuilder(CertPathBuilderSpi builderSpi, Provider provider, String algorithm)
Модификатор Конструктор Описание
protected
Создаёт объект CertPathBuilder указанного алгоритма и инкапсулирует в нём указанную реализацию поставщика (объект SPI).

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

Модификатор и тип Метод Описание
final CertPathBuilderResult build(CertPathParameters params)
Пытается построить путь сертификации с использованием указанного набора параметров алгоритма.
final String getAlgorithm()
Возвращает имя алгоритма этого CertPathBuilder.
static final String getDefaultType()
Возвращает тип CertPathBuilder по умолчанию, заданный свойством безопасности certpathbuilder.type, или строку "PKIX", если такое свойство отсутствует.
static CertPathBuilder getInstance(String algorithm)
Возвращает объект CertPathBuilder, реализующий указанный алгоритм.
static CertPathBuilder getInstance(String algorithm, String provider)
Возвращает объект CertPathBuilder, реализующий указанный алгоритм.
static CertPathBuilder getInstance(String algorithm, Provider provider)
Возвращает объект CertPathBuilder, реализующий указанный алгоритм.
final Provider getProvider()
Возвращает поставщика этого CertPathBuilder.
final CertPathChecker getRevocationChecker()
Возвращает CertPathChecker, который инкапсулированная реализация CertPathBuilderSpi использует для проверки статуса отзыва сертификатов.

Методы, объявленные в классе 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, либо до истечения заданного промежутка реального времени.

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

CertPathBuilder

protected CertPathBuilder(CertPathBuilderSpi builderSpi, Provider provider, String algorithm)
Создаёт объект CertPathBuilder указанного алгоритма и инкапсулирует в нём указанную реализацию поставщика (объект SPI).
Параметры:
builderSpi — реализация поставщика
provider — поставщик
algorithm — имя алгоритма

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

getInstance

public static CertPathBuilder getInstance(String algorithm) throws NoSuchAlgorithmException
Возвращает объект CertPathBuilder, реализующий указанный алгоритм.

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

Обратите внимание, что список зарегистрированных поставщиков можно получить с помощью метода Security.getProviders().

Примечание по реализации:
Реализация JDK Reference Implementation дополнительно использует свойство jdk.security.provider.preferred Security, чтобы определить предпочтительный порядок поставщиков для указанного алгоритма. Этот порядок может отличаться от порядка поставщиков, возвращаемых методом Security.getProviders().
Параметры:
algorithm — имя запрошенного алгоритма CertPathBuilder. Сведения о стандартных именах алгоритмов см. в разделе CertPathBuilder спецификации стандартных имён алгоритмов безопасности Java.
Возвращает:
объект CertPathBuilder, реализующий указанный алгоритм
Выбрасывает:
NoSuchAlgorithmException — если ни один Provider не поддерживает реализацию CertPathBuilderSpi для указанного алгоритма
NullPointerException — если algorithm имеет значение null
Внешние спецификации
  • Стандартные имена алгоритмов безопасности Java
См. также:
  • Provider

getInstance

public static CertPathBuilder getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException
Возвращает объект CertPathBuilder, реализующий указанный алгоритм.

Возвращается новый объект CertPathBuilder, инкапсулирующий реализацию CertPathBuilderSpi указанного поставщика. Указанный поставщик должен быть зарегистрирован в списке поставщиков безопасности.

Обратите внимание, что список зарегистрированных поставщиков можно получить с помощью метода Security.getProviders().

Параметры:
algorithm — имя запрошенного алгоритма CertPathBuilder. Сведения о стандартных именах алгоритмов см. в разделе CertPathBuilder спецификации стандартных имён алгоритмов безопасности Java.
provider — имя поставщика.
Возвращает:
объект CertPathBuilder, реализующий указанный алгоритм
Выбрасывает:
IllegalArgumentException — если значение provider равно null или пусто
NoSuchAlgorithmException — если у указанного поставщика недоступна реализация CertPathBuilderSpi для указанного алгоритма
NoSuchProviderException — если указанный поставщик не зарегистрирован в списке поставщиков безопасности
NullPointerException — если algorithm имеет значение null
Внешние спецификации
  • Стандартные имена алгоритмов безопасности Java
См. также:
  • Provider

getInstance

public static CertPathBuilder getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException
Возвращает объект CertPathBuilder, реализующий указанный алгоритм.

Возвращается новый объект CertPathBuilder, инкапсулирующий реализацию CertPathBuilderSpi из указанного объекта Provider. Обратите внимание, что указанный объект Provider не обязательно должен быть зарегистрирован в списке поставщиков.

Параметры:
algorithm — имя запрошенного алгоритма CertPathBuilder. Сведения о стандартных именах алгоритмов см. в разделе CertPathBuilder спецификации стандартных имён алгоритмов безопасности Java.
provider — поставщик.
Возвращает:
объект CertPathBuilder, реализующий указанный алгоритм
Выбрасывает:
IllegalArgumentException — если значение provider равно null
NoSuchAlgorithmException — если указанный объект Provider не предоставляет реализацию CertPathBuilderSpi для указанного алгоритма
NullPointerException — если algorithm имеет значение null
Внешние спецификации
  • Стандартные имена алгоритмов безопасности Java
См. также:
  • Provider

getProvider

public final Provider getProvider()
Возвращает поставщика этого CertPathBuilder.
Возвращает:
поставщика этого CertPathBuilder

getAlgorithm

public final String getAlgorithm()
Возвращает имя алгоритма этого CertPathBuilder.
Возвращает:
имя алгоритма этого CertPathBuilder

build

public final CertPathBuilderResult build(CertPathParameters params) throws CertPathBuilderException, InvalidAlgorithmParameterException
Пытается построить путь сертификации с использованием указанного набора параметров алгоритма.
Параметры:
params — параметры алгоритма
Возвращает:
результат выполнения алгоритма построения
Выбрасывает:
CertPathBuilderException — если построителю не удаётся построить путь сертификации, удовлетворяющий указанным параметрам
InvalidAlgorithmParameterException — если указанные параметры неприменимы к этому CertPathBuilder

getDefaultType

public static final String getDefaultType()
Возвращает тип CertPathBuilder по умолчанию, заданный свойством безопасности certpathbuilder.type, или строку "PKIX", если такое свойство отсутствует.

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

Тип CertPathBuilder по умолчанию можно изменить, задав желаемый тип в свойстве безопасности certpathbuilder.type.

Возвращает:
тип CertPathBuilder по умолчанию, заданный свойством безопасности certpathbuilder.type, или строку "PKIX", если такое свойство отсутствует.
См. также:
  • свойства безопасности

getRevocationChecker

public final CertPathChecker getRevocationChecker()
Возвращает CertPathChecker, который инкапсулированная реализация CertPathBuilderSpi использует для проверки статуса отзыва сертификатов. Реализация PKIX возвращает объекты типа PKIXRevocationChecker. Каждый вызов этого метода возвращает новый экземпляр CertPathChecker.

Основная цель этого метода — позволить вызывающему коду указывать дополнительные входные параметры и параметры настройки для проверки отзыва. Пример см. в описании класса.

Возвращает:
CertPathChecker
Выбрасывает:
UnsupportedOperationException — если поставщик службы не поддерживает этот метод
С версии:
1.8

Сообщить об ошибке или предложить улучшение
Дополнительные справочные материалы по API и документацию для разработчиков см. в документации Java SE, содержащей более подробные описания для разработчиков, обзоры концепций, определения терминов, обходные решения и примеры работающего кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или её аффилированных лиц в США и других странах.
Авторские права © 1993, 2026, Oracle и/или её аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 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.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API