- All Known Implementing Classes:
public interface KeyInfoProvider
Interface for providers used in conjunction with a
KeyInfoCredentialResolverwhich support resolving
Credentials based on a child element of
Method SummaryModifier and TypeMethodDescription
booleanEvaluate whether the given provider should attempt to handle resolving a credential from the specified KeyInfo child.
(KeyInfoCredentialResolver resolver, XMLObject keyInfoChild, CriteriaSet criteriaSet, KeyInfoResolutionContext kiContext)Process a specified KeyInfo child (XMLobject) and attempt to resolve a credential from it.
process@Nullable Collection<Credential> process
(@Nonnull KeyInfoCredentialResolver resolver, @Nonnull XMLObject keyInfoChild, @Nullable CriteriaSet criteriaSet, @Nonnull KeyInfoResolutionContext kiContext) throws SecurityExceptionProcess a specified KeyInfo child (XMLobject) and attempt to resolve a credential from it.
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
- a resolved Credential collection, or null
SecurityException- if there is an error during credential resolution. Note: failure to resolve a credential is not an error.
(@Nonnull XMLObject keyInfoChild)Evaluate whether the given provider should attempt to handle resolving a credential from the specified KeyInfo child. An evaluation of
truedoes not guarantee that a credential can or will be extracted form the particular KeyInfo child, only that processing should be attempted.
keyInfoChild- the KeyInfo child object to consider
- true if the provider should attempt to resolve credentials, false otherwise