org.opensaml.security

クラス MetadataCredentialResolver

java.lang.Object

org.opensaml.xml.security.credential.AbstractCredentialResolver

org.opensaml.xml.security.credential.AbstractCriteriaFilteringCredentialResolver

org.opensaml.security.MetadataCredentialResolver

すべての実装されたインタフェース:

CredentialResolver, Resolver<Credential,CriteriaSet>

public class MetadataCredentialResolver
extends AbstractCriteriaFilteringCredentialResolver

A credential resolver capable of resolving credentials from SAML 2 metadata; The instance of CriteriaSet passed to AbstractCriteriaFilteringCredentialResolver.resolve(CriteriaSet) and AbstractCredentialResolver.resolveSingle(CriteriaSet) must minimally contain 2 criteria: EntityIDCriteria and MetadataCriteria. The values for EntityIDCriteria.getEntityID() and MetadataCriteria.getRole() are mandatory. If the protocol value obtained via MetadataCriteria.getProtocol() is not supplied, credentials will be resolved from all matching roles, regardless of protocol support. Specification of a UsageCriteria is optional. If usage criteria is absent from the criteria set, the effective value UsageType.UNSPECIFIED will be used for credential resolution. This credential resolver will cache the resolved the credentials in a memory-sensitive cache. If the metadata provider is an ObservableMetadataProvider this resolver will also clear its cache when the underlying metadata changes.

ネストされたクラスの概要

ネストされたクラス

修飾子とタイプ	クラスと説明
protected class	MetadataCredentialResolver.MetadataCacheKey A class which serves as the key into the cache of credentials previously resolved.
protected class	MetadataCredentialResolver.MetadataProviderObserver An observer that clears the credential cache if the underlying metadata changes.

コンストラクタの概要

コンストラクタ

コンストラクタと説明
MetadataCredentialResolver(MetadataProvider metadataProvider) Constructor.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
protected void	cacheCredentials(MetadataCredentialResolver.MetadataCacheKey cacheKey, Collection<Credential> credentials) Adds resolved credentials to the cache.
protected void	checkCriteriaRequirements(CriteriaSet criteriaSet) Check that all necessary credential criteria are available.
KeyInfoCredentialResolver	getKeyInfoCredentialResolver() Get the KeyInfo credential resolver used by this metadata resolver to handle KeyInfo elements.
MetadataProvider	getMetadataProvider() Get the metadata provider instance used by this resolver.
protected ReadWriteLock	getReadWriteLock() Get the lock instance used to synchronize access to the credential cache.
protected List<RoleDescriptor>	getRoleDescriptors(String entityID, QName role, String protocol) Get the list of metadata role descriptors which match the given entityID, role and protocol.
protected boolean	matchUsage(UsageType metadataUsage, UsageType criteriaUsage) Match usage enum type values from metadata KeyDescriptor and from credential criteria.
protected Iterable<Credential>	resolveFromSource(CriteriaSet criteriaSet) Subclasses are required to implement this method to resolve credentials from the implementation-specific type of underlying credential source.
protected Collection<Credential>	retrieveFromCache(MetadataCredentialResolver.MetadataCacheKey cacheKey) Retrieves pre-resolved credentials from the cache.
protected Collection<Credential>	retrieveFromMetadata(String entityID, QName role, String protocol, UsageType usage) Retrieves credentials from the provided metadata.
void	setKeyInfoCredentialResolver(KeyInfoCredentialResolver keyInfoResolver) Set the KeyInfo credential resolver used by this metadata resolver to handle KeyInfo elements.

クラスから継承されたメソッド org.opensaml.xml.security.credential.AbstractCriteriaFilteringCredentialResolver

isMeetAllCriteria, isUnevaluableSatisfies, resolve, setMeetAllCriteria, setUnevaluableSatisfies

クラスから継承されたメソッド org.opensaml.xml.security.credential.AbstractCredentialResolver

resolveSingle

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

MetadataCredentialResolver

public MetadataCredentialResolver(MetadataProvider metadataProvider)

Constructor.

パラメータ:

metadataProvider - provider of the metadata

例外:

IllegalArgumentException - thrown if the supplied provider is null

メソッドの詳細

getMetadataProvider

public MetadataProvider getMetadataProvider()

Get the metadata provider instance used by this resolver.

戻り値:

the resolver's metadata provider instance

getKeyInfoCredentialResolver

public KeyInfoCredentialResolver getKeyInfoCredentialResolver()

Get the KeyInfo credential resolver used by this metadata resolver to handle KeyInfo elements.

戻り値:

KeyInfo credential resolver

setKeyInfoCredentialResolver

public void setKeyInfoCredentialResolver(KeyInfoCredentialResolver keyInfoResolver)

Set the KeyInfo credential resolver used by this metadata resolver to handle KeyInfo elements.

パラメータ:

keyInfoResolver - the new KeyInfoCredentialResolver to use

getReadWriteLock

protected ReadWriteLock getReadWriteLock()

Get the lock instance used to synchronize access to the credential cache.

戻り値:

a read-write lock instance

resolveFromSource

protected Iterable<Credential> resolveFromSource(CriteriaSet criteriaSet)
                                          throws SecurityException

Subclasses are required to implement this method to resolve credentials from the implementation-specific type of underlying credential source.

定義:

resolveFromSource クラス内 AbstractCriteriaFilteringCredentialResolver

パラメータ:

criteriaSet - the set of criteria used to resolve credentials from the credential source

戻り値:

an Iterable for the resolved set of credentials

例外:

SecurityException - thrown if there is an error resolving credentials from the credential source

checkCriteriaRequirements

protected void checkCriteriaRequirements(CriteriaSet criteriaSet)

Check that all necessary credential criteria are available.

パラメータ:

criteriaSet - the credential set to evaluate

retrieveFromCache

protected Collection<Credential> retrieveFromCache(MetadataCredentialResolver.MetadataCacheKey cacheKey)

Retrieves pre-resolved credentials from the cache.

パラメータ:

cacheKey - the key to the metadata cache

戻り値:

the collection of cached credentials or null

retrieveFromMetadata

protected Collection<Credential> retrieveFromMetadata(String entityID,
                                          QName role,
                                          String protocol,
                                          UsageType usage)
                                               throws SecurityException

Retrieves credentials from the provided metadata.

パラメータ:

entityID - entityID of the credential owner

role - role in which the entity is operating

protocol - protocol over which the entity is operating (may be null)

usage - intended usage of resolved credentials

戻り値:

the resolved credentials or null

例外:

SecurityException - thrown if the key, certificate, or CRL information is represented in an unsupported format

matchUsage

protected boolean matchUsage(UsageType metadataUsage,
                 UsageType criteriaUsage)

Match usage enum type values from metadata KeyDescriptor and from credential criteria.

パラメータ:

metadataUsage - the value from the 'use' attribute of a metadata KeyDescriptor element

criteriaUsage - the value from credential criteria

戻り値:

true if the two usage specifiers match for purposes of resolving credentials, false otherwise

getRoleDescriptors

protected List<RoleDescriptor> getRoleDescriptors(String entityID,
                                      QName role,
                                      String protocol)
                                           throws SecurityException

Get the list of metadata role descriptors which match the given entityID, role and protocol.

パラメータ:

entityID - entity ID of the credential owner

role - role in which the entity is operating

protocol - protocol over which the entity is operating (may be null)

戻り値:

a list of role descriptors matching the given parameters, or null

例外:

SecurityException - thrown if there is an error retrieving role descriptors from the metadata provider

cacheCredentials

protected void cacheCredentials(MetadataCredentialResolver.MetadataCacheKey cacheKey,
                    Collection<Credential> credentials)

Adds resolved credentials to the cache.

パラメータ:

cacheKey - the key for caching the credentials

credentials - collection of credentials to cache