org.springframework.security.saml.key

Class EmptyKeyManager

java.lang.Object

org.springframework.security.saml.key.EmptyKeyManager

All Implemented Interfaces:

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

public class EmptyKeyManager
extends Object
implements KeyManager

Key manager doesn't provide access to any keys and can be used to skip inclusion of keystore files in the Spring SAML projects. Empty key store can only be used in situations when Spring SAML doesn't perform decryption of incoming messages and doesn't need to create digital signatures.

Author:

Vladimir Schafer

Constructor Summary

Constructors

Constructor and Description
EmptyKeyManager()

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.
Iterable<org.opensaml.xml.security.credential.Credential>	resolve(org.opensaml.xml.security.CriteriaSet criteria)
org.opensaml.xml.security.credential.Credential	resolveSingle(org.opensaml.xml.security.CriteriaSet criteria)

Methods inherited from class java.lang.Object

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

Constructor Detail

EmptyKeyManager

public EmptyKeyManager()

Method Detail

getCredential

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

Description copied from interface: KeyManager

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

Specified by:

getCredential in interface KeyManager

Parameters:

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

Returns:

credential

getDefaultCredential

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

Description copied from interface: KeyManager

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

Specified by:

getDefaultCredential in interface KeyManager

Returns:

credential

getDefaultCredentialName

public String getDefaultCredentialName()

Description copied from interface: KeyManager

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.

Specified by:

getDefaultCredentialName in interface KeyManager

Returns:

default credential name

getAvailableCredentials

public Set<String> getAvailableCredentials()

Description copied from interface: KeyManager

Method provides list of all credentials available in the storage.

Specified by:

getAvailableCredentials in interface KeyManager

Returns:

available credentials

getCertificate

public X509Certificate getCertificate(String alias)

Description copied from interface: KeyManager

Returns certificate with the given alias from the keystore.

Specified by:

getCertificate in interface KeyManager

Parameters:

alias - alias of certificate to find

Returns:

certificate with the given alias or null if not found

resolve

public Iterable<org.opensaml.xml.security.credential.Credential> resolve(org.opensaml.xml.security.CriteriaSet criteria)
                                                                  throws org.opensaml.xml.security.SecurityException

Specified by:

resolve in interface org.opensaml.xml.security.Resolver<org.opensaml.xml.security.credential.Credential,org.opensaml.xml.security.CriteriaSet>

Throws:

org.opensaml.xml.security.SecurityException

resolveSingle

public org.opensaml.xml.security.credential.Credential resolveSingle(org.opensaml.xml.security.CriteriaSet criteria)
                                                              throws org.opensaml.xml.security.SecurityException

Specified by:

resolveSingle in interface org.opensaml.xml.security.Resolver<org.opensaml.xml.security.credential.Credential,org.opensaml.xml.security.CriteriaSet>

Throws:

org.opensaml.xml.security.SecurityException