org.opensaml.xmlsec.keyinfo.impl.provider

Class DEREncodedKeyValueProvider

java.lang.Object

org.opensaml.xmlsec.keyinfo.impl.provider.AbstractKeyInfoProvider

org.opensaml.xmlsec.keyinfo.impl.provider.DEREncodedKeyValueProvider

All Implemented Interfaces:

KeyInfoProvider

public class DEREncodedKeyValueProvider
extends AbstractKeyInfoProvider

Implementation of KeyInfoProvider which supports DEREncodedKeyValue.

Field Summary

Fields

Modifier and Type	Field and Description
private Logger	log Class logger.

Constructor Summary

Constructors

Constructor and Description
DEREncodedKeyValueProvider()

Method Summary

Methods

Modifier and Type	Method and Description
protected DEREncodedKeyValue	getDEREncodedKeyValue(org.opensaml.core.xml.XMLObject xmlObject) Get the DEREncodedKeyValue from the passed XML object.
boolean	handles(org.opensaml.core.xml.XMLObject keyInfoChild) Evaluate whether the given provider should attempt to handle resolving a credential from the specified KeyInfo child.
Collection<org.opensaml.security.credential.Credential>	process(KeyInfoCredentialResolver resolver, org.opensaml.core.xml.XMLObject keyInfoChild, net.shibboleth.utilities.java.support.resolver.CriteriaSet criteriaSet, KeyInfoResolutionContext kiContext) Process a specified KeyInfo child (XMLobject) and attempt to resolve a credential from it.

Methods inherited from class org.opensaml.xmlsec.keyinfo.impl.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

DEREncodedKeyValueProvider

public DEREncodedKeyValueProvider()

Method Detail

handles

public boolean handles(@Nonnull
              org.opensaml.core.xml.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

@Nullable
public Collection<org.opensaml.security.credential.Credential> process(@Nonnull
                                                                       KeyInfoCredentialResolver resolver,
                                                                       @Nonnull
                                                                       org.opensaml.core.xml.XMLObject keyInfoChild,
                                                                       @Nullable
                                                                       net.shibboleth.utilities.java.support.resolver.CriteriaSet criteriaSet,
                                                                       @Nonnull
                                                                       KeyInfoResolutionContext kiContext)
                                                                throws org.opensaml.security.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:

org.opensaml.security.SecurityException - if there is an error during credential resolution. Note: failure to resolve a credential is not an error.

getDEREncodedKeyValue

@Nullable
protected DEREncodedKeyValue getDEREncodedKeyValue(@Nonnull
                                                org.opensaml.core.xml.XMLObject xmlObject)

Get the DEREncodedKeyValue from the passed XML object.

Parameters:

xmlObject - an XML object, presumably a DEREncodedKeyValue

Returns:

the DEREncodedKeyValue which was found, or null if none