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

Class PrivateKeyResolver

java.lang.Object

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

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

public class PrivateKeyResolver
extends KeyResolverSpi

Resolves a PrivateKey within a KeyStore based on the KeyInfo hints. For X509Data hints, the certificate associated with the private key entry must match. For a KeyName hint, the KeyName must match the alias of a PrivateKey entry within the KeyStore.

Field Summary

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

globalResolver, properties, secureValidation

Constructor Summary

Constructors

Constructor	Description
PrivateKeyResolver(KeyStore keyStore, char[] password)	Constructor.

Method Summary

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

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

engineGetProperty, engineLookupAndResolveSecretKey, engineResolvePublicKey, engineResolveX509Certificate, engineSetProperty, getDocFromBytes, setGlobalResolver, setSecureValidation, understandsProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

PrivateKeyResolver

public PrivateKeyResolver(KeyStore keyStore,
                          char[] password)

Constructor.

Method Detail

engineCanResolve

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

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

Overrides:

engineCanResolve in class KeyResolverSpi

Parameters:

element -

baseURI -

storage -

Returns:

whether the KeyResolverSpi is able to perform the requested action.

engineLookupAndResolvePublicKey

public PublicKey engineLookupAndResolvePublicKey(Element element,
                                                 String baseURI,
                                                 StorageResolver storage)
                                          throws KeyResolverException

Method engineLookupAndResolvePublicKey

Overrides:

engineLookupAndResolvePublicKey in class KeyResolverSpi

Parameters:

element -

baseURI -

storage -

Returns:

null if no PublicKey could be obtained

Throws:

KeyResolverException

engineLookupResolveX509Certificate

public X509Certificate engineLookupResolveX509Certificate(Element element,
                                                          String baseURI,
                                                          StorageResolver storage)
                                                   throws KeyResolverException

Method engineResolveX509Certificate

Overrides:

engineLookupResolveX509Certificate in class KeyResolverSpi

Returns:

resolved X509Certificate key from the registered from the elements

Throws:

KeyResolverException

engineResolveSecretKey

public SecretKey engineResolveSecretKey(Element element,
                                        String baseURI,
                                        StorageResolver storage)
                                 throws KeyResolverException

Method engineResolveSecretKey

Overrides:

engineResolveSecretKey in class KeyResolverSpi

Parameters:

element -

baseURI -

storage -

Returns:

resolved SecretKey key or null if no SecretKey could be obtained

Throws:

KeyResolverException

engineLookupAndResolvePrivateKey

public PrivateKey engineLookupAndResolvePrivateKey(Element element,
                                                   String baseURI,
                                                   StorageResolver storage)
                                            throws KeyResolverException

Method engineResolvePrivateKey

Overrides:

engineLookupAndResolvePrivateKey in class KeyResolverSpi

Returns:

resolved PrivateKey key from the registered from the elements

Throws:

KeyResolverException