Class KeyResolverSpi
- java.lang.Object
-
- org.apache.xml.security.keys.keyresolver.KeyResolverSpi
-
public abstract class KeyResolverSpi extends java.lang.Object
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 Modifier and Type Field Description protected java.util.Map
_properties
Field _properties
-
Constructor Summary
Constructors Constructor Description KeyResolverSpi()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract boolean
engineCanResolve(org.w3c.dom.Element element, java.lang.String BaseURI, StorageResolver storage)
This method helps theResourceResolver
to decide whether aResourceResolverSpi
is able to perform the requested action.java.lang.String
engineGetProperty(java.lang.String key)
Method engineGetPropertyjava.lang.String[]
engineGetPropertyKeys()
Method engineGetPropertyKeysabstract java.security.PublicKey
engineResolvePublicKey(org.w3c.dom.Element element, java.lang.String BaseURI, StorageResolver storage)
Method engineResolvePublicKeyabstract javax.crypto.SecretKey
engineResolveSecretKey(org.w3c.dom.Element element, java.lang.String BaseURI, StorageResolver storage)
Method engineResolveSecretKeyabstract java.security.cert.X509Certificate
engineResolveX509Certificate(org.w3c.dom.Element element, java.lang.String BaseURI, StorageResolver storage)
Method engineResolveCertificatevoid
engineSetProperty(java.lang.String key, java.lang.String value)
Method engineSetPropertyboolean
understandsProperty(java.lang.String propertyToTest)
Method understandsProperty
-
-
-
Method Detail
-
engineCanResolve
public abstract boolean engineCanResolve(org.w3c.dom.Element element, java.lang.String BaseURI, StorageResolver storage)
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 java.security.PublicKey engineResolvePublicKey(org.w3c.dom.Element element, java.lang.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 java.security.cert.X509Certificate engineResolveX509Certificate(org.w3c.dom.Element element, java.lang.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 javax.crypto.SecretKey engineResolveSecretKey(org.w3c.dom.Element element, java.lang.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
public void engineSetProperty(java.lang.String key, java.lang.String value)
Method engineSetProperty- Parameters:
key
-value
-
-
engineGetProperty
public java.lang.String engineGetProperty(java.lang.String key)
Method engineGetProperty- Parameters:
key
-- Returns:
- obtain the property appointed by key
-
engineGetPropertyKeys
public java.lang.String[] engineGetPropertyKeys()
Method engineGetPropertyKeys- Returns:
- the keys of properties known by this resolver
-
understandsProperty
public boolean understandsProperty(java.lang.String propertyToTest)
Method understandsProperty- Parameters:
propertyToTest
-- Returns:
- true if understood the property
-
-