Spec-Zone.ru › OpenJDK 24

Класс 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 Security. Обратитесь к документации выпуска вашей реализации, чтобы узнать, поддерживаются ли какие-либо другие алгоритмы.

Доступ из нескольких потоков

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

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

Since:
1.4
See Also:
  • 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 использует для проверки статуса отзыва сертификатов.

Методы, унаследованные от класса java.lang.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 Security Standard Algorithm Names Specification для получения информации об именах стандартных алгоритмов.
Возвращает:
объект CertPathBuilder, реализующий указанный алгоритм
Исключения:
NoSuchAlgorithmException - если ни один поставщик не поддерживает реализацию Provider для указанного алгоритма
NullPointerException - если algorithm является null
См. также:
  • Provider

getInstance

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

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

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

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

getInstance

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

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

Параметры:
algorithm - имя запрашиваемого алгоритма CertPathBuilder. См. раздел CertPathBuilder в спецификации Java Security Standard Algorithm Names Specification для получения информации об именах стандартных алгоритмов.
provider - поставщик.
Возвращает:
объект CertPathBuilder, реализующий указанный алгоритм
Исключения:
IllegalArgumentException - если provider является пустым или содержит только пробелы
NoSuchAlgorithmException - если реализация CertPathBuilderSpi для указанного алгоритма недоступна от указанного объекта Provider
NullPointerException - если algorithm равно null
См. также:
  • 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

© 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://download.java.net/java/early_access/jdk24/docs/api/java.base/java/security/cert/CertPathBuilder.html

Spec-Zone.ru

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