org.springframework.security.saml.key

Interface KeyManager

All Superinterfaces:

org.opensaml.xml.security.credential.CredentialResolver, org.opensaml.xml.security.Resolver<org.opensaml.xml.security.credential.Credential,org.opensaml.xml.security.CriteriaSet>

All Known Implementing Classes:

EmptyKeyManager, JKSKeyManager

public interface KeyManager
extends org.opensaml.xml.security.credential.CredentialResolver

Interface defines basic service required by the SAML Extension implementation.

Author:

Vladimir Schafer

Method Summary

Modifier and Type	Method and Description
Set<String>	getAvailableCredentials() Method provides list of all credentials available in the storage.
X509Certificate	getCertificate(String alias) Returns certificate with the given alias from the keystore.
org.opensaml.xml.security.credential.Credential	getCredential(String keyName) Returns Credential object used to sign the messages issued by this entity.
org.opensaml.xml.security.credential.Credential	getDefaultCredential() Returns Credential object used to sign the messages issued by this entity.
String	getDefaultCredentialName() Method provides name of the credential which should be used by default when no other is specified.

Methods inherited from interface org.opensaml.xml.security.Resolver

resolve, resolveSingle

Method Detail

getCredential

org.opensaml.xml.security.credential.Credential getCredential(String keyName)

Returns Credential object used to sign the messages issued by this entity. Public, X509 and Private keys are set in the credential.

Parameters:

keyName - name of the key to use, in case of null default key is used

Returns:

credential

getDefaultCredential

org.opensaml.xml.security.credential.Credential getDefaultCredential()

Returns Credential object used to sign the messages issued by this entity. Public, X509 and Private keys are set in the credential.

Returns:

credential

getDefaultCredentialName

String getDefaultCredentialName()

Method provides name of the credential which should be used by default when no other is specified. It must be possible to call getCredential with the returned name in order to obtain Credential value.

Returns:

default credential name

getAvailableCredentials

Set<String> getAvailableCredentials()

Method provides list of all credentials available in the storage.

Returns:

available credentials

getCertificate

X509Certificate getCertificate(String alias)

Returns certificate with the given alias from the keystore.

Parameters:

alias - alias of certificate to find

Returns:

certificate with the given alias or null if not found