se.litsec.opensaml.saml2.metadata.build.spring

Class KeyDescriptorFactoryBean

java.lang.Object

org.springframework.beans.factory.config.AbstractFactoryBean<T>

se.litsec.opensaml.core.spring.AbstractSAMLObjectBuilderFactoryBean<KeyDescriptor>

se.litsec.opensaml.saml2.metadata.build.spring.KeyDescriptorFactoryBean

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<KeyDescriptor>, org.springframework.beans.factory.InitializingBean

public class KeyDescriptorFactoryBean
extends AbstractSAMLObjectBuilderFactoryBean<KeyDescriptor>

A Spring factory bean for creating KeyDescriptor objects.

Author:

Martin Lindström (martin.lindstrom@litsec.se)

See Also:

KeyDescriptorBuilder

Field Summary

Fields inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

logger

Constructor Summary

Constructors

Constructor and Description
KeyDescriptorFactoryBean() Constructor.

Method Summary

Modifier and Type	Method and Description
protected AbstractSAMLObjectBuilder<KeyDescriptor>	builder() Returns the builder.
Class<?>	getObjectType()
void	setCertificate(X509Certificate certificate) Assigns a certificate to be used as a X.509 data element of the KeyInfo element within the key descriptor.
void	setCertificate(X509Credential credential) Assigns a certificate in OpenSAML credential format to be used as a X.509 data element of the KeyInfo element within the key descriptor.
void	setCertificateResource(org.springframework.core.io.Resource certificateResource) Assigns a resource to a certificate resource that is to be used as a X.509 data element of the KeyInfo element within the key descriptor.
void	setEncryptionMethods(List<String> encryptionMethods) Assigns a list of encryption methods.
void	setKeyName(String name) Assigns the key name of the KeyInfo element within the key descriptor.
void	setUse(UsageType usageType) Assigns the usage type for the key descriptor.

Methods inherited from class se.litsec.opensaml.core.spring.AbstractSAMLObjectBuilderFactoryBean

createInstance, localizedStringListToVarArgs, stringListToVarArgs, toVarArgs

Methods inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

afterPropertiesSet, destroy, destroyInstance, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyDescriptorFactoryBean

public KeyDescriptorFactoryBean()

Constructor.

Method Detail

setUse

public void setUse(UsageType usageType)

Assigns the usage type for the key descriptor.

Parameters:

usageType - the usage type

setKeyName

public void setKeyName(String name)

Assigns the key name of the KeyInfo element within the key descriptor.

Parameters:

name - the key name

setCertificate

public void setCertificate(X509Certificate certificate)

Assigns a certificate to be used as a X.509 data element of the KeyInfo element within the key descriptor.

Parameters:

certificate - the certificate

setCertificate

public void setCertificate(X509Credential credential)

Assigns a certificate in OpenSAML credential format to be used as a X.509 data element of the KeyInfo element within the key descriptor.

Parameters:

credential - the credential

setCertificateResource

public void setCertificateResource(org.springframework.core.io.Resource certificateResource)
                            throws IOException

Assigns a resource to a certificate resource that is to be used as a X.509 data element of the KeyInfo element within the key descriptor.

Parameters:

certificateResource - the certificate resource

Throws:

IOException - if the resource can not be read

setEncryptionMethods

public void setEncryptionMethods(List<String> encryptionMethods)

Assigns a list of encryption methods.

Note: the method only accepts algorithm URI:s. If you need to assign other parts of an EncryptionMethod object you must install the method manually and not via the builder.

Parameters:

encryptionMethods - list of algorithms

builder

protected AbstractSAMLObjectBuilder<KeyDescriptor> builder()

Returns the builder.

Specified by:

builder in class AbstractSAMLObjectBuilderFactoryBean<KeyDescriptor>

Returns:

the builder

getObjectType

public Class<?> getObjectType()

Specified by:

getObjectType in interface org.springframework.beans.factory.FactoryBean<KeyDescriptor>

Specified by:

getObjectType in class org.springframework.beans.factory.config.AbstractFactoryBean<KeyDescriptor>