|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opensaml.xml.security.credential.AbstractCredentialResolver
org.opensaml.xml.security.credential.AbstractCriteriaFilteringCredentialResolver
org.opensaml.xml.security.keyinfo.KeyInfoCredentialResolver
public class KeyInfoCredentialResolver
Specialized credential resolver interface which resolves credentials based on a KeyInfo
element.
TODO document processing model and hooks in detail, suggested usage, etc
Nested Class Summary | |
---|---|
class |
KeyInfoCredentialResolver.KeyInfoResolutionContext
Resolution context class that can be used to supply information to the providers within a given invocation of the resolver. |
Constructor Summary | |
---|---|
KeyInfoCredentialResolver()
Constructor. |
Method Summary | |
---|---|
KeyInfoCredentialContext |
buildCredentialContext(KeyInfoCredentialResolver.KeyInfoResolutionContext kiContext)
Build a credential context based on the current KeyInfo context, for return in a resolved credential. |
protected Credential |
buildKeyNameOnlyCredential(KeyInfoCredentialResolver.KeyInfoResolutionContext kiContext)
Build a BasicCredential consisting only of the values from KeyName. |
protected java.security.Key |
extractKeyValue(Credential cred)
Utility method to extract any key that might be present in the specified Credential. |
protected void |
postProcess(KeyInfoCredentialResolver.KeyInfoResolutionContext kiContext,
CredentialCriteriaSet criteriaSet,
java.util.List<Credential> credentials)
Hook for subclasses to do post-processing of the credential set after all KeyInfo children have been processed. |
protected void |
postProcessEmptyCredentials(KeyInfoCredentialResolver.KeyInfoResolutionContext kiContext,
CredentialCriteriaSet criteriaSet,
java.util.List<Credential> credentials)
Hook for processing the case where no credentials were returned by any resolution method by any provider, nor by the processing of the postProcess() hook. |
protected java.lang.Iterable<Credential> |
resolveFromSource(CredentialCriteriaSet criteriaSet)
Subclasses are required to implement this method to resolve credentials from the implementation-specific type of underlying credential source. |
protected void |
resolveKeyValue(KeyInfoCredentialResolver.KeyInfoResolutionContext kiContext,
CredentialCriteriaSet criteriaSet,
java.util.List<KeyValue> keyValues)
Resolve the key from any KeyValue element that may be present, and store the resulting credential in the resolution context. |
Methods inherited from class org.opensaml.xml.security.credential.AbstractCriteriaFilteringCredentialResolver |
---|
isMeetAllCriteria, isUnevaluableSatisfies, resolve, setMeetAllCriteria, setUnevaluableSatisfies |
Methods inherited from class org.opensaml.xml.security.credential.AbstractCredentialResolver |
---|
resolveSingle |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public KeyInfoCredentialResolver()
Method Detail |
---|
protected java.lang.Iterable<Credential> resolveFromSource(CredentialCriteriaSet criteriaSet) throws SecurityException
resolveFromSource
in class AbstractCriteriaFilteringCredentialResolver
criteriaSet
- the set of credential criteria used to resolve credentials from the credential source
SecurityException
- thrown if there is an error resolving credentials from the credential sourceprotected void postProcess(KeyInfoCredentialResolver.KeyInfoResolutionContext kiContext, CredentialCriteriaSet criteriaSet, java.util.List<Credential> credentials) throws SecurityException
kiContext
- KeyInfo resolution context containingcriteriaSet
- the credential criteria used to resolve credentialscredentials
- the list which will store the resolved credentials
SecurityException
- thrown if there is an error during processingprotected void postProcessEmptyCredentials(KeyInfoCredentialResolver.KeyInfoResolutionContext kiContext, CredentialCriteriaSet criteriaSet, java.util.List<Credential> credentials) throws SecurityException
kiContext
- KeyInfo resolution context containingcriteriaSet
- the credential criteria used to resolve credentialscredentials
- the list which will store the resolved credentials
SecurityException
- thrown if there is an error during processingprotected void resolveKeyValue(KeyInfoCredentialResolver.KeyInfoResolutionContext kiContext, CredentialCriteriaSet criteriaSet, java.util.List<KeyValue> keyValues) throws SecurityException
kiContext
- KeyInfo resolution contextcriteriaSet
- the credential criteria used to resolve credentialskeyValues
- the KeyValue children to evaluate
SecurityException
- thrown if there is an error resolving the key from the KeyValuepublic KeyInfoCredentialContext buildCredentialContext(KeyInfoCredentialResolver.KeyInfoResolutionContext kiContext)
kiContext
- the current KeyInfo resolution context
protected Credential buildKeyNameOnlyCredential(KeyInfoCredentialResolver.KeyInfoResolutionContext kiContext) throws SecurityException
kiContext
- the current KeyInfo resolution context
SecurityException
- thrown if there is an error building the credentialprotected java.security.Key extractKeyValue(Credential cred)
cred
- the Credential to evaluate
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |