Spec-Zone.ru › OpenJDK 17

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

getInstance

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

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

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

getRevocationChecker

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

Основная цель этого метода — позволить вызывающим сторонам задавать дополнительные входные параметры и опции, специфичные для проверки отзыва. См. описание класса для примера.

Возвращает:
объект CertPathChecker
Исключения:
UnsupportedOperationException - если поставщик сервиса не поддерживает этот метод
С момента:
1.8

© 1993, 2021, 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/17/docs/api/java.base/java/security/cert/CertPathBuilder.html

Spec-Zone.ru

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