iaik.ixsil.keyinfo

Interface VerifierKeyManager

All Known Implementing Classes:

KeyManagerImpl

public interface VerifierKeyManager

This interface declares all methods, which IXSIL requires in the context of key management for the signature verification use case.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getId() Gets the Id attribute of the KeyInfo Element represented by this this SignerKeyManager interface.
KeyProviderInterface	getKeyProvider() Returns a reference to the particular key provider that provided the verification public key to this VerifierKeyManager.
KeyProviderInterface[]	getKeyProviders() Gets an array of all key providers registerred at this key manager.
java.security.Key	getVerifierKey() Gets the key which will be used to verify the XML signature.
void	setKeyInfo(org.w3c.dom.Element keyInfo) Initializes the key manager, which is used in for the verification use case, with the DOM representation of the XML KeyInfo element found in the XML signature, which is to be verified.
void	setURIResolverParameters(URIResolverParameters params) Sets the parameters to be used by the key mananger when resolving URIs.

Method Detail

setKeyInfo

void setKeyInfo(org.w3c.dom.Element keyInfo)
                throws KeyManagerException

Initializes the key manager, which is used in for the verification use case, with the DOM representation of the XML KeyInfo element found in the XML signature, which is to be verified. It is the job of the key manager to deduce the verification key from this information.

Parameters:

keyInfo - the DOM representation of the XML KeyInfo element found in the XML signature.

Throws:

KeyManagerException - if the key manager cannot handle the provided information.

getVerifierKey

java.security.Key getVerifierKey()
                                 throws KeyManagerException

Gets the key which will be used to verify the XML signature. It is the job of the key manager to deduce the verification key from the information provided with method setKeyInfo(org.w3c.dom.Element).

Returns:

the key to be used for verification.

Throws:

KeyManagerException - if providing the key fails for any reason.

getId

java.lang.String getId()

Gets the Id attribute of the KeyInfo Element represented by this this SignerKeyManager interface.

Returns:

the value of the Id attribute, or null if the attribute is not set.

getKeyProviders

KeyProviderInterface[] getKeyProviders()

Gets an array of all key providers registerred at this key manager.

Returns:

an array of all registerred key providers, or null, if there are no registerred providers available.

setURIResolverParameters

void setURIResolverParameters(URIResolverParameters params)

Sets the parameters to be used by the key mananger when resolving URIs.

Parameters:

params - The parameters to be set. May be null to indicate a restore of the default values.

getKeyProvider

KeyProviderInterface getKeyProvider()

Returns a reference to the particular key provider that provided the verification public key to this VerifierKeyManager.

Returns:

a reference to the key provider that provided the verification public key, or null, if there is no such key provider.