org.opensaml.xml.security.keyinfo.provider
Class RSAKeyValueProvider

java.lang.Object
  extended by org.opensaml.xml.security.keyinfo.provider.AbstractKeyInfoProvider
      extended by org.opensaml.xml.security.keyinfo.provider.RSAKeyValueProvider
All Implemented Interfaces:
KeyInfoProvider

public class RSAKeyValueProvider
extends AbstractKeyInfoProvider

Implementation of KeyInfoProvider which supports RSAKeyValue.


Field Summary
private  Logger log
          Class logger.
 
Constructor Summary
RSAKeyValueProvider()
           
 
Method Summary
protected  RSAKeyValue getRSAKeyValue(XMLObject xmlObject)
          Get the RSAKeyValue from the passed XML object.
 boolean handles(XMLObject keyInfoChild)
          Evaluate whether the given provider should attempt to handle resolving a credential from the specified KeyInfo child.
 Collection<Credential> process(KeyInfoCredentialResolver resolver, XMLObject keyInfoChild, CriteriaSet criteriaSet, KeyInfoResolutionContext kiContext)
          Process a specified KeyInfo child (XMLobject) and attempt to resolve a credential from it.
 
Methods inherited from class org.opensaml.xml.security.keyinfo.provider.AbstractKeyInfoProvider
buildCredentialContext, extractKeyValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

private final Logger log
Class logger.

Constructor Detail

RSAKeyValueProvider

public RSAKeyValueProvider()
Method Detail

handles

public boolean handles(XMLObject keyInfoChild)
Evaluate whether the given provider should attempt to handle resolving a credential from the specified KeyInfo child. An evaluation of true does not guarantee that a credential can or will be extracted form the particular KeyInfo child, only that processing should be attempted.

Parameters:
keyInfoChild - the KeyInfo child object to consider
Returns:
true if the provider should attempt to resolve credentials, false otherwise

process

public Collection<Credential> process(KeyInfoCredentialResolver resolver,
                                      XMLObject keyInfoChild,
                                      CriteriaSet criteriaSet,
                                      KeyInfoResolutionContext kiContext)
                               throws SecurityException
Process a specified KeyInfo child (XMLobject) and attempt to resolve a credential from it.

Parameters:
resolver - reference to a resolver which is calling the provider
keyInfoChild - the KeyInfo child being processed
criteriaSet - the credential criteria the credential must satisfy
kiContext - the resolution context, used for sharing state amongst resolvers and providers
Returns:
a resolved Credential collection, or null
Throws:
SecurityException - if there is an error during credential resolution. Note: failure to resolve a credential is not an error.

getRSAKeyValue

protected RSAKeyValue getRSAKeyValue(XMLObject xmlObject)
Get the RSAKeyValue from the passed XML object.

Parameters:
xmlObject - an XML object, presumably either a KeyValue or an RSAKeyValue
Returns:
the RSAKeyValue which was found, or null if none


Copyright © 1999-2012. All Rights Reserved.