Class KeyResolverSpi
java.lang.Object
org.apache.xml.security.keys.keyresolver.KeyResolverSpi
This class is abstract class for a child KeyInfo Elemnet.
If you want the your KeyResolver, at firstly you must extand this class, and register
as following in config.xml
<KeyResolver URI="http://www.w3.org/2000/09/xmldsig#KeyValue" JAVACLASS="MyPackage.MyKeyValueImpl"//gt;
- Version:
- $Revision$
- Author:
- $Author$
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract boolean
engineCanResolve
(Element element, String BaseURI, StorageResolver storage) This method helps theResourceResolver
to decide whether aResourceResolverSpi
is able to perform the requested action.engineGetProperty
(String key) Method engineGetPropertyString[]
Method engineGetPropertyKeysabstract PublicKey
engineResolvePublicKey
(Element element, String BaseURI, StorageResolver storage) Method engineResolvePublicKeyabstract SecretKey
engineResolveSecretKey
(Element element, String BaseURI, StorageResolver storage) Method engineResolveSecretKeyabstract X509Certificate
engineResolveX509Certificate
(Element element, String BaseURI, StorageResolver storage) Method engineResolveCertificatevoid
engineSetProperty
(String key, String value) Method engineSetPropertyboolean
understandsProperty
(String propertyToTest) Method understandsProperty
-
Field Details
-
_properties
Field _properties
-
-
Constructor Details
-
KeyResolverSpi
public KeyResolverSpi()
-
-
Method Details
-
engineCanResolve
This method helps theResourceResolver
to decide whether aResourceResolverSpi
is able to perform the requested action.- Parameters:
element
-BaseURI
-storage
-- Returns:
- true if can resolve the key in the element
-
engineResolvePublicKey
public abstract PublicKey engineResolvePublicKey(Element element, String BaseURI, StorageResolver storage) throws KeyResolverException Method engineResolvePublicKey- Parameters:
element
-BaseURI
-storage
-- Returns:
- resolved public key from the registered from the element.
- Throws:
KeyResolverException
-
engineResolveX509Certificate
public abstract X509Certificate engineResolveX509Certificate(Element element, String BaseURI, StorageResolver storage) throws KeyResolverException Method engineResolveCertificate- Parameters:
element
-BaseURI
-storage
-- Returns:
- resolved X509Certificate key from the registered from the elements
- Throws:
KeyResolverException
-
engineResolveSecretKey
public abstract SecretKey engineResolveSecretKey(Element element, String BaseURI, StorageResolver storage) throws KeyResolverException Method engineResolveSecretKey- Parameters:
element
-BaseURI
-storage
-- Returns:
- resolved SecretKey key from the registered from the elements
- Throws:
KeyResolverException
-
engineSetProperty
Method engineSetProperty- Parameters:
key
-value
-
-
engineGetProperty
Method engineGetProperty- Parameters:
key
-- Returns:
- obtain the property appointed by key
-
engineGetPropertyKeys
Method engineGetPropertyKeys- Returns:
- the keys of properties known by this resolver
-
understandsProperty
Method understandsProperty- Parameters:
propertyToTest
-- Returns:
- true if understood the property
-