Spec-Zone.ru › OpenJDK 25

Класс 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

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

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 дополнительно использует свойство 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 — если реализация CertPathBuilderSpi для указанного алгоритма недоступна у указанного объекта Provider
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, 2025, 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.
https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/security/cert/CertPathBuilder.html

Spec-Zone.ru

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