Module org.apache.santuario.xmlsec

Package org.apache.xml.security.keys.keyresolver.implementations

Class SingleKeyResolver

java.lang.Object

org.apache.xml.security.keys.keyresolver.KeyResolverSpi

org.apache.xml.security.keys.keyresolver.implementations.SingleKeyResolver

public class SingleKeyResolver
extends KeyResolverSpi

Resolves a single Key based on the KeyName.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	keyName
private final PrivateKey	privateKey
private final PublicKey	publicKey
private final SecretKey	secretKey

Constructor Summary

Constructors

Constructor	Description
SingleKeyResolver(String keyName, PrivateKey privateKey)	Constructor.
SingleKeyResolver(String keyName, PublicKey publicKey)	Constructor.
SingleKeyResolver(String keyName, SecretKey secretKey)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected boolean	engineCanResolve(Element element, String baseURI, StorageResolver storage)	This method returns whether the KeyResolverSpi is able to perform the requested action.
PrivateKey	engineResolvePrivateKey(Element element, String baseURI, StorageResolver storage, boolean secureValidation)	Method engineResolvePrivateKey
protected PublicKey	engineResolvePublicKey(Element element, String baseURI, StorageResolver storage, boolean secureValidation)	Method engineResolvePublicKey
protected SecretKey	engineResolveSecretKey(Element element, String baseURI, StorageResolver storage, boolean secureValidation)	Method engineResolveSecretKey
protected X509Certificate	engineResolveX509Certificate(Element element, String baseURI, StorageResolver storage, boolean secureValidation)	Method engineResolveCertificate

Methods inherited from class org.apache.xml.security.keys.keyresolver.KeyResolverSpi

engineLookupAndResolvePrivateKey, engineLookupAndResolvePublicKey, engineLookupAndResolveSecretKey, engineLookupResolveX509Certificate, getDocFromBytes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

keyName

private final String keyName

publicKey

private final PublicKey publicKey

privateKey

private final PrivateKey privateKey

secretKey

private final SecretKey secretKey

Constructor Details

SingleKeyResolver

public SingleKeyResolver(String keyName,
 PublicKey publicKey)

Constructor.

Parameters:

keyName -

publicKey -

SingleKeyResolver

public SingleKeyResolver(String keyName,
 PrivateKey privateKey)

Constructor.

Parameters:

keyName -

privateKey -

SingleKeyResolver

public SingleKeyResolver(String keyName,
 SecretKey secretKey)

Constructor.

Parameters:

keyName -

secretKey -

Method Details

engineCanResolve

protected boolean engineCanResolve(Element element,
 String baseURI,
 StorageResolver storage)

This method returns whether the KeyResolverSpi is able to perform the requested action.

Specified by:

engineCanResolve in class KeyResolverSpi

Returns:

whether the KeyResolverSpi is able to perform the requested action.

engineResolvePublicKey

protected PublicKey engineResolvePublicKey(Element element,
 String baseURI,
 StorageResolver storage,
 boolean secureValidation)
                                    throws KeyResolverException

Method engineResolvePublicKey

Specified by:

engineResolvePublicKey in class KeyResolverSpi

Returns:

resolved public key from the registered from the element.

Throws:

KeyResolverException

engineResolveX509Certificate

protected X509Certificate engineResolveX509Certificate(Element element,
 String baseURI,
 StorageResolver storage,
 boolean secureValidation)
                                                throws KeyResolverException

Method engineResolveCertificate

Specified by:

engineResolveX509Certificate in class KeyResolverSpi

Returns:

resolved X509Certificate key from the registered from the elements

Throws:

KeyResolverException

engineResolveSecretKey

protected SecretKey engineResolveSecretKey(Element element,
 String baseURI,
 StorageResolver storage,
 boolean secureValidation)
                                    throws KeyResolverException

Method engineResolveSecretKey

Specified by:

engineResolveSecretKey in class KeyResolverSpi

Returns:

resolved SecretKey key from the registered from the elements

Throws:

KeyResolverException

engineResolvePrivateKey

public PrivateKey engineResolvePrivateKey(Element element,
 String baseURI,
 StorageResolver storage,
 boolean secureValidation)
                                   throws KeyResolverException

Method engineResolvePrivateKey

Specified by:

engineResolvePrivateKey in class KeyResolverSpi

Returns:

resolved PrivateKey key from the registered from the elements

Throws:

KeyResolverException