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 String	keyName
private static final org.slf4j.Logger	LOG
private PrivateKey	privateKey
private PublicKey	publicKey
private SecretKey	secretKey

Fields inherited from class KeyResolverSpi

globalResolver, properties, secureValidation

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
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 Method engineLookupAndResolvePrivateKey
PublicKey	engineLookupAndResolvePublicKey(Element element, String baseURI, StorageResolver storage)	Method engineLookupAndResolvePublicKey
X509Certificate	engineLookupResolveX509Certificate(Element element, String baseURI, StorageResolver storage)	Method engineResolveX509Certificate Method engineLookupResolveX509Certificate
SecretKey	engineResolveSecretKey(Element element, String baseURI, StorageResolver storage)	Method engineResolveSecretKey

Methods inherited from class KeyResolverSpi

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

Methods inherited from class Object

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

Field Details

LOG

private static final org.slf4j.Logger LOG

keyName

private String keyName

publicKey

private PublicKey publicKey

privateKey

private PrivateKey privateKey

secretKey

private 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

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 Method engineLookupResolveX509Certificate

Overrides:

engineLookupResolveX509Certificate in class KeyResolverSpi

Parameters:

element -

baseURI -

storage -

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 Method engineLookupAndResolvePrivateKey

Overrides:

engineLookupAndResolvePrivateKey in class KeyResolverSpi

Parameters:

element -

baseURI -

storage -

Returns:

resolved PrivateKey key or null if no PrivateKey could be obtained

Throws:

KeyResolverException