org.opensaml.xml.security.credential

クラス KeyStoreCredentialResolver

java.lang.Object

org.opensaml.xml.security.credential.AbstractCredentialResolver

org.opensaml.xml.security.credential.AbstractCriteriaFilteringCredentialResolver

org.opensaml.xml.security.credential.KeyStoreCredentialResolver

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

CredentialResolver, Resolver<Credential,CriteriaSet>

public class KeyStoreCredentialResolver
extends AbstractCriteriaFilteringCredentialResolver

A CredentialResolver that extracts Credential's from a key store. If no key usage type is presented at construction time this resolver will return the key, if available, regardless of the usage type provided to its resolve method.

コンストラクタの概要

コンストラクタ

コンストラクタと説明
KeyStoreCredentialResolver(KeyStore store, Map<String,String> passwords) Constructor.
KeyStoreCredentialResolver(KeyStore store, Map<String,String> passwords, UsageType usage) Constructor.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
protected Credential	buildCredential(KeyStore.Entry keyStoreEntry, String entityID, UsageType usage) Build a credential instance from the key store entry.
protected void	checkCriteriaRequirements(CriteriaSet criteriaSet) Check that required credential criteria are available.
protected boolean	matchUsage(UsageType keyStoreUsage, UsageType criteriaUsage) Match usage enum type values from keystore configured usage and from credential criteria.
protected X509Credential	processPrivateKeyEntry(KeyStore.PrivateKeyEntry privateKeyEntry, String entityID, UsageType usage) Build an X509Credential from a keystore private key entry.
protected Credential	processSecretKeyEntry(KeyStore.SecretKeyEntry secretKeyEntry, String entityID, UsageType usage) Build a Credential from a keystore secret key entry.
protected X509Credential	processTrustedCertificateEntry(KeyStore.TrustedCertificateEntry trustedCertEntry, String entityID, UsageType usage) Build an X509Credential from a keystore trusted certificate entry.
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.

クラスから継承されたメソッド 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

コンストラクタの詳細

KeyStoreCredentialResolver

public KeyStoreCredentialResolver(KeyStore store,
                          Map<String,String> passwords)
                           throws IllegalArgumentException

Constructor.

パラメータ:

store - key store credentials are retrieved from

passwords - for key entries, map key is the entity id, map value is the password

例外:

IllegalArgumentException - thrown if the given keystore is null

KeyStoreCredentialResolver

public KeyStoreCredentialResolver(KeyStore store,
                          Map<String,String> passwords,
                          UsageType usage)
                           throws IllegalArgumentException

Constructor.

パラメータ:

store - key store credentials are retrieved from

passwords - for key entries, map key is the entity id, map value is the password

usage - usage type of all keys in the store

例外:

IllegalArgumentException - thrown if the given keystore is null

メソッドの詳細

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 required credential criteria are available.

パラメータ:

criteriaSet - the credential criteria set to evaluate

matchUsage

protected boolean matchUsage(UsageType keyStoreUsage,
                 UsageType criteriaUsage)

Match usage enum type values from keystore configured usage and from credential criteria.

パラメータ:

keyStoreUsage - the usage type configured for the keystore

criteriaUsage - the value from credential criteria

戻り値:

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

buildCredential

protected Credential buildCredential(KeyStore.Entry keyStoreEntry,
                         String entityID,
                         UsageType usage)
                              throws SecurityException

Build a credential instance from the key store entry.

パラメータ:

keyStoreEntry - the key store entry to process

entityID - the entityID to include in the credential

usage - the usage type to include in the credential

戻り値:

the new credential instance, appropriate to the type of key store entry being processed

例外:

SecurityException - throw if there is a problem building a credential from the key store entry

processTrustedCertificateEntry

protected X509Credential processTrustedCertificateEntry(KeyStore.TrustedCertificateEntry trustedCertEntry,
                                            String entityID,
                                            UsageType usage)

Build an X509Credential from a keystore trusted certificate entry.

パラメータ:

trustedCertEntry - the entry being processed

entityID - the entityID to set

usage - the usage type to set

戻り値:

new X509Credential instance

processPrivateKeyEntry

protected X509Credential processPrivateKeyEntry(KeyStore.PrivateKeyEntry privateKeyEntry,
                                    String entityID,
                                    UsageType usage)

Build an X509Credential from a keystore private key entry.

パラメータ:

privateKeyEntry - the entry being processed

entityID - the entityID to set

usage - the usage type to set

戻り値:

new X509Credential instance

processSecretKeyEntry

protected Credential processSecretKeyEntry(KeyStore.SecretKeyEntry secretKeyEntry,
                               String entityID,
                               UsageType usage)

Build a Credential from a keystore secret key entry.

パラメータ:

secretKeyEntry - the entry being processed

entityID - the entityID to set

usage - the usage type to set

戻り値:

new Credential instance