Класс XMLSignatureFactory

protected XMLSignatureFactory()

public static XMLSignatureFactory getInstance(String mechanismType)

Примечание по реализации:

Эталонная реализация JDK дополнительно использует свойство jdk.security.provider.preferred Security, чтобы определить предпочтительный порядок поставщиков для указанного алгоритма. Этот порядок может отличаться от порядка поставщиков, возвращаемых методом Security.getProviders().

Параметры:

mechanismType — тип механизма обработки XML и представления. Список стандартных типов механизмов см. в разделе XMLSignatureFactory спецификации «Стандартные имена алгоритмов безопасности Java».

Возвращает:

новый XMLSignatureFactory

Исключения:

NullPointerException — если mechanismType равно null

NoSuchMechanismException — если ни один Provider не поддерживает реализацию XMLSignatureFactory для указанного механизма

Внешние спецификации

• Стандартные имена алгоритмов безопасности Java

См. также:

• Provider

public static XMLSignatureFactory getInstance(String mechanismType, Provider provider)

Параметры:

mechanismType — тип механизма обработки XML и представления. Список стандартных типов механизмов см. в разделе XMLSignatureFactory спецификации «Стандартные имена алгоритмов безопасности Java».

provider — объект Provider

Возвращает:

новый XMLSignatureFactory

Исключения:

NullPointerException — если provider или mechanismType равно null

NoSuchMechanismException — если реализация XMLSignatureFactory для указанного механизма недоступна у указанного объекта Provider

Внешние спецификации

• Стандартные имена алгоритмов безопасности Java

См. также:

• Provider

public static XMLSignatureFactory getInstance(String mechanismType, String provider) throws NoSuchProviderException

Параметры:

mechanismType — тип механизма обработки XML и представления. Список стандартных типов механизмов см. в разделе XMLSignatureFactory спецификации «Стандартные имена алгоритмов безопасности Java».

provider — строковое имя поставщика

Возвращает:

новый XMLSignatureFactory

Исключения:

NoSuchProviderException — если указанный поставщик не зарегистрирован в списке поставщиков безопасности

NullPointerException — если provider или mechanismType равно null

NoSuchMechanismException — если реализация XMLSignatureFactory для указанного механизма недоступна у указанного поставщика

Внешние спецификации

• Стандартные имена алгоритмов безопасности Java

См. также:

• Provider

public static XMLSignatureFactory getInstance()

Возвращает:

новый XMLSignatureFactory

Исключения:

NoSuchMechanismException — если ни один Provider не поддерживает реализацию XMLSignatureFactory для механизма DOM

См. также:

• Provider

public final String getMechanismType()

Возвращает:

тип механизма обработки XML, поддерживаемый этой XMLSignatureFactory

public final Provider getProvider()

Возвращает:

поставщика этой XMLSignatureFactory

public abstract XMLSignature newXMLSignature(SignedInfo si, KeyInfo ki)

Параметры:

si — сведения о подписи

ki — сведения о ключе (может быть null)

Возвращает:

XMLSignature

Исключения:

NullPointerException — если si равно null

public abstract XMLSignature newXMLSignature(SignedInfo si, KeyInfo ki, List<? extends XMLObject> objects, String id, String signatureValueId)

Параметры:

si — сведения о подписи

ki — сведения о ключе (может быть null)

objects — список объектов XMLObject (может быть пустым или null)

id — идентификатор (может быть null)

signatureValueId — идентификатор SignatureValue (может быть null)

Возвращает:

XMLSignature

Исключения:

NullPointerException — если si равно null

ClassCastException — если любой из объектов objects не имеет тип XMLObject

public abstract Reference newReference(String uri, DigestMethod dm)

Параметры:

uri — URI ссылки (может быть null)

dm — метод дайджеста

Возвращает:

Reference

Исключения:

IllegalArgumentException — если uri не соответствует RFC 2396

NullPointerException — если dm равно null

public abstract Reference newReference(String uri, DigestMethod dm, List<? extends Transform> transforms, String type, String id)

Параметры:

uri — URI ссылки (может быть null)

dm — метод дайджеста

transforms — список объектов Transform. Список копируется для защиты от последующих изменений. Может быть null или пустым.

type — тип ссылки в виде URI (может быть null)

id — идентификатор ссылки (может быть null)

Возвращает:

Reference

Исключения:

ClassCastException — если любой из объектов transforms не имеет тип Transform

IllegalArgumentException — если uri не соответствует RFC 2396

NullPointerException — если dm равно null

public abstract Reference newReference(String uri, DigestMethod dm, List<? extends Transform> transforms, String type, String id, byte[] digestValue)

Параметры:

uri — URI ссылки (может быть null)

dm — метод дайджеста

transforms — список объектов Transform. Список копируется для защиты от последующих изменений. Может быть null или пустым.

type — тип ссылки в виде URI (может быть null)

id — идентификатор ссылки (может быть null)

digestValue — значение дайджеста. Массив клонируется для защиты от последующих изменений.

Возвращает:

Reference

Исключения:

ClassCastException — если любой из объектов transforms не имеет тип Transform

IllegalArgumentException — если uri не соответствует RFC 2396

NullPointerException — если dm или digestValue равно null

public abstract Reference newReference(String uri, DigestMethod dm, List<? extends Transform> appliedTransforms, Data result, List<? extends Transform> transforms, String type, String id)

Параметры:

uri — URI ссылки (может быть null)

dm — метод дайджеста

appliedTransforms — список объектов Transform, которые уже были применены. Список копируется для защиты от последующих изменений. Список должен содержать как минимум одну запись.

result — результат обработки последовательности appliedTransforms

transforms — список объектов Transform, которые будут применены при создании подписи. Список копируется для защиты от последующих изменений. Может быть null или пустым.

type — тип ссылки в виде URI (может быть null)

id — идентификатор ссылки (может быть null)

Возвращает:

Reference

Исключения:

ClassCastException — если какое-либо преобразование (в любом из списков) не имеет тип Transform

IllegalArgumentException — если uri не соответствует RFC 2396 или appliedTransforms пуст

NullPointerException — если dm, appliedTransforms или result равно null

public abstract SignedInfo newSignedInfo(CanonicalizationMethod cm, SignatureMethod sm, List<? extends Reference> references)

Параметры:

cm — метод каноникализации

sm — метод подписи

references — список из одной или нескольких ссылок Reference. Список копируется для защиты от последующих изменений.

Возвращает:

SignedInfo

Исключения:

ClassCastException — если какая-либо ссылка не имеет тип Reference

IllegalArgumentException — если references пуст

NullPointerException — если какой-либо параметр равен null

public abstract SignedInfo newSignedInfo(CanonicalizationMethod cm, SignatureMethod sm, List<? extends Reference> references, String id)

Параметры:

cm — метод каноникализации

sm — метод подписи

references — список из одной или нескольких ссылок Reference. Список копируется для защиты от последующих изменений.

id — идентификатор (может быть null)

Возвращает:

SignedInfo

Исключения:

ClassCastException — если какая-либо ссылка не имеет тип Reference

IllegalArgumentException — если references пуст

NullPointerException — если cm, sm или references равны null

public abstract XMLObject newXMLObject(List<? extends XMLStructure> content, String id, String mimeType, String encoding)

Параметры:

content — список объектов XMLStructure. Список копируется для защиты от последующих изменений. Может быть null или пустым.

id — идентификатор (может быть null)

mimeType — MIME-тип (может быть null)

encoding — кодировка (может быть null)

Возвращает:

XMLObject

Исключения:

ClassCastException — если content содержит записи, не имеющие тип XMLStructure

public abstract Manifest newManifest(List<? extends Reference> references)

Параметры:

references — список из одного или нескольких объектов Reference. Список копируется для защиты от последующих изменений.

Возвращает:

Manifest

Исключения:

NullPointerException — если references равно null

IllegalArgumentException — если references пуст

ClassCastException — если references содержит записи, не имеющие тип Reference

public abstract Manifest newManifest(List<? extends Reference> references, String id)

Параметры:

references — список из одного или нескольких объектов Reference. Список копируется для защиты от последующих изменений.

id — идентификатор (может быть null)

Возвращает:

Manifest

Исключения:

NullPointerException — если references равно null

IllegalArgumentException — если references пуст

ClassCastException — если references содержит записи, не имеющие тип Reference

public abstract SignatureProperty newSignatureProperty(List<? extends XMLStructure> content, String target, String id)

Параметры:

content — список из одного или нескольких объектов XMLStructure. Список копируется для защиты от последующих изменений.

target — целевой URI подписи, к которой относится это свойство

id — идентификатор (может быть null)

Возвращает:

SignatureProperty

Исключения:

NullPointerException — если content или target равно null

IllegalArgumentException — если content пуст

ClassCastException — если content содержит записи, не имеющие тип XMLStructure

public abstract SignatureProperties newSignatureProperties(List<? extends SignatureProperty> properties, String id)

Параметры:

properties — список из одного или нескольких объектов SignatureProperty. Список копируется для защиты от последующих изменений.

id — идентификатор (может быть null)

Возвращает:

SignatureProperties

Исключения:

NullPointerException — если properties равно null

IllegalArgumentException — если properties пуст

ClassCastException — если properties содержит записи, не имеющие тип SignatureProperty

public abstract DigestMethod newDigestMethod(String algorithm, DigestMethodParameterSpec params) throws NoSuchAlgorithmException, InvalidAlgorithmParameterException

Параметры:

algorithm — URI, идентифицирующий алгоритм дайджеста

params — параметры дайджеста, зависящие от алгоритма (могут быть null)

Возвращает:

DigestMethod

Исключения:

InvalidAlgorithmParameterException — если указанные параметры не подходят для запрошенного алгоритма

NoSuchAlgorithmException — если не удалось найти реализацию указанного алгоритма

NullPointerException — если algorithm равно null

public abstract SignatureMethod newSignatureMethod(String algorithm, SignatureMethodParameterSpec params) throws NoSuchAlgorithmException, InvalidAlgorithmParameterException

Параметры:

algorithm — URI, идентифицирующий алгоритм подписи

params — параметры подписи, зависящие от алгоритма (могут быть null)

Возвращает:

SignatureMethod

Исключения:

InvalidAlgorithmParameterException — если указанные параметры не подходят для запрошенного алгоритма

NoSuchAlgorithmException — если не удалось найти реализацию указанного алгоритма

NullPointerException — если algorithm равно null

public abstract Transform newTransform(String algorithm, TransformParameterSpec params) throws NoSuchAlgorithmException, InvalidAlgorithmParameterException

Параметры:

algorithm — URI, идентифицирующий алгоритм преобразования

params — параметры преобразования, зависящие от алгоритма (могут быть null)

Возвращает:

Transform

Исключения:

InvalidAlgorithmParameterException — если указанные параметры не подходят для запрошенного алгоритма

NoSuchAlgorithmException — если не удалось найти реализацию указанного алгоритма

NullPointerException — если algorithm равно null

public abstract Transform newTransform(String algorithm, XMLStructure params) throws NoSuchAlgorithmException, InvalidAlgorithmParameterException

Параметры:

algorithm — URI, идентифицирующий алгоритм преобразования

params — зависящая от механизма структура XML, из которой следует выполнить десериализацию параметров (может быть null, если она не требуется или является необязательной)

Возвращает:

Transform

Исключения:

ClassCastException — если тип params не подходит для этого XMLSignatureFactory

InvalidAlgorithmParameterException — если указанные параметры не подходят для запрошенного алгоритма

NoSuchAlgorithmException — если не удалось найти реализацию указанного алгоритма

NullPointerException — если algorithm равно null

public abstract CanonicalizationMethod newCanonicalizationMethod(String algorithm, C14NMethodParameterSpec params) throws NoSuchAlgorithmException, InvalidAlgorithmParameterException

Параметры:

algorithm — URI, идентифицирующий алгоритм каноникализации

params — параметры каноникализации, зависящие от алгоритма (могут быть null)

Возвращает:

CanonicalizationMethod

Исключения:

InvalidAlgorithmParameterException — если указанные параметры не подходят для запрошенного алгоритма

NoSuchAlgorithmException — если не удалось найти реализацию указанного алгоритма

NullPointerException — если algorithm равно null

public abstract CanonicalizationMethod newCanonicalizationMethod(String algorithm, XMLStructure params) throws NoSuchAlgorithmException, InvalidAlgorithmParameterException

Параметры:

algorithm - URI, идентифицирующий алгоритм каноникализации

params - механизм-специфичная XML-структура, из которой следует демаршалировать параметры (может быть null, если параметры не требуются или являются необязательными)

Возвращает:

CanonicalizationMethod

Исключения:

ClassCastException - если тип params не подходит для этой XMLSignatureFactory

InvalidAlgorithmParameterException - если указанные параметры не подходят для запрошенного алгоритма

NoSuchAlgorithmException - если не удается найти реализацию указанного алгоритма

NullPointerException - если algorithm является null

public final KeyInfoFactory getKeyInfoFactory()

Возвращает:

KeyInfoFactory

Исключения:

NoSuchMechanismException - если реализация KeyFactory с тем же типом механизма и поставщиком недоступна

public abstract XMLSignature unmarshalXMLSignature(XMLValidateContext context) throws MarshalException

Параметры:

context - механизм-специфичный контекст, из которого следует демаршалировать подпись

Возвращает:

XMLSignature

Исключения:

NullPointerException - если context является null

ClassCastException - если тип context не подходит для этой фабрики

MarshalException - если во время демаршалирования возникает невосстановимое исключение

public abstract XMLSignature unmarshalXMLSignature(XMLStructure xmlStructure) throws MarshalException

Параметры:

xmlStructure - механизм-специфичная XML-структура, из которой следует демаршалировать подпись

Возвращает:

XMLSignature

Исключения:

NullPointerException - если xmlStructure является null

ClassCastException - если тип xmlStructure не подходит для этой фабрики

MarshalException - если во время демаршалирования возникает невосстановимое исключение

public abstract boolean isFeatureSupported(String feature)

Параметры:

feature - имя функции (в виде абсолютного URI)

Возвращает:

true, если указанная функция поддерживается, и false в противном случае

Исключения:

NullPointerException - если feature является null

public abstract URIDereferencer getURIDereferencer()

Возвращает:

ссылку на используемый по умолчанию URIDereferencer (никогда не null)