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

java.lang.Object
  extended byorg.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: 1.11 $
Author:
$Author: raul $

Field Summary
protected  java.util.Map _properties
          Field _properties
 
Constructor Summary
KeyResolverSpi()
           
 
Method Summary
abstract  boolean engineCanResolve(org.w3c.dom.Element element, java.lang.String BaseURI, StorageResolver storage)
          This method helps the ResourceResolver to decide whether a ResourceResolverSpi is able to perform the requested action.
 java.lang.String engineGetProperty(java.lang.String key)
          Method engineGetProperty
 java.lang.String[] engineGetPropertyKeys()
          Method engineGetPropertyKeys
abstract  java.security.PublicKey engineResolvePublicKey(org.w3c.dom.Element element, java.lang.String BaseURI, StorageResolver storage)
          Method engineResolvePublicKey
abstract  javax.crypto.SecretKey engineResolveSecretKey(org.w3c.dom.Element element, java.lang.String BaseURI, StorageResolver storage)
          Method engineResolveSecretKey
abstract  java.security.cert.X509Certificate engineResolveX509Certificate(org.w3c.dom.Element element, java.lang.String BaseURI, StorageResolver storage)
          Method engineResolveCertificate
 void engineSetProperty(java.lang.String key, java.lang.String value)
          Method engineSetProperty
 boolean understandsProperty(java.lang.String propertyToTest)
          Method understandsProperty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_properties

protected java.util.Map _properties
Field _properties

Constructor Detail

KeyResolverSpi

public KeyResolverSpi()
Method Detail

engineCanResolve

public abstract boolean engineCanResolve(org.w3c.dom.Element element,
                                         java.lang.String BaseURI,
                                         StorageResolver storage)
This method helps the ResourceResolver to decide whether a ResourceResolverSpi 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