net.shibboleth.idp.profile.spring.factory

Class BasicX509CredentialFactoryBean

java.lang.Object

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

net.shibboleth.ext.spring.factory.AbstractComponentAwareFactoryBean<T>

net.shibboleth.idp.profile.spring.factory.AbstractCredentialFactoryBean<BasicX509Credential>

net.shibboleth.idp.profile.spring.factory.AbstractX509CredentialFactoryBean

net.shibboleth.idp.profile.spring.factory.BasicX509CredentialFactoryBean

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<BasicX509Credential>, org.springframework.beans.factory.InitializingBean

public class BasicX509CredentialFactoryBean
extends AbstractX509CredentialFactoryBean

Spring bean factory for producing a BasicX509Credential from Resources.

This factory bean supports DER and PEM encoded certificate resources and encrypted and non-encrypted PKCS8, DER, or PEM encoded private key resources.

Field Summary

Fields

Modifier and Type	Field and Description
private List<org.springframework.core.io.Resource>	certificateResources Where the certificates are to be found.
private List<org.springframework.core.io.Resource>	crlResources Where the crls are to be found.
private org.springframework.core.io.Resource	entityResource The specification of where the entity Resource is to be found.
private org.slf4j.Logger	log log.
private org.springframework.core.io.Resource	privateKeyResource Where the private key is to be found.

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

logger

Constructor Summary

Constructors

Constructor and Description
BasicX509CredentialFactoryBean()

Method Summary

Methods

Modifier and Type	Method and Description
protected List<X509Certificate>	getCertificates() Get the configured certificates.
protected List<X509CRL>	getCRLs() Get the configured CRL list.
protected X509Certificate	getEntityCertificate() return the explicitly configured entity certificate.
protected PrivateKey	getPrivateKey() Get the configured private key.
boolean	isSingleton()
void	setCertificateResource(org.springframework.core.io.Resource res) Set the certificate resource.
void	setCertificates(List<org.springframework.core.io.Resource> what) Sets the Resources which contain the certificates.
void	setCRLs(List<org.springframework.core.io.Resource> what) Sets the Resources which contain the crls.
void	setEntity(org.springframework.core.io.Resource what) Set the Resource with the entity certificate.
void	setEntityId(String id) Set the entityID for the credential.
void	setPrivateKey(org.springframework.core.io.Resource what) Set the Resource with the entity certificate.
void	setPrivateKeyPassword(String password) Set the password for the private key.
void	setPrivateKeyResource(org.springframework.core.io.Resource res) Set the resource containing the private key.

Methods inherited from class net.shibboleth.idp.profile.spring.factory.AbstractX509CredentialFactoryBean

doCreateInstance, getObjectType

Methods inherited from class net.shibboleth.idp.profile.spring.factory.AbstractCredentialFactoryBean

getConfigDescription, getEntityID, getKeyNames, getPrivateKeyPassword, getUsageType, setConfigDescription, setEntityID, setKeyNames, setPrivateKeyPassword, setUsageType

Methods inherited from class net.shibboleth.ext.spring.factory.AbstractComponentAwareFactoryBean

createInstance, destroyInstance

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

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

Methods inherited from class java.lang.Object

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

Field Detail

log

private final org.slf4j.Logger log

log.

entityResource

private org.springframework.core.io.Resource entityResource

The specification of where the entity Resource is to be found.

certificateResources

private List<org.springframework.core.io.Resource> certificateResources

Where the certificates are to be found.

privateKeyResource

private org.springframework.core.io.Resource privateKeyResource

Where the private key is to be found.

crlResources

private List<org.springframework.core.io.Resource> crlResources

Where the crls are to be found.

Constructor Detail

BasicX509CredentialFactoryBean

public BasicX509CredentialFactoryBean()

Method Detail

setEntity

public void setEntity(@Nonnull
             org.springframework.core.io.Resource what)

Set the Resource with the entity certificate.

Parameters:

what - The Resource to set.

setCertificates

public void setCertificates(@Nullable@NotEmpty
                   List<org.springframework.core.io.Resource> what)

Sets the Resources which contain the certificates.

Parameters:

what - The values to set.

setPrivateKey

public void setPrivateKey(@Nullable
                 org.springframework.core.io.Resource what)

Set the Resource with the entity certificate.

Parameters:

what - The resource to set.

setCRLs

public void setCRLs(@Nullable@NotEmpty
           List<org.springframework.core.io.Resource> what)

Sets the Resources which contain the crls.

Parameters:

what - The value to set.

setPrivateKeyResource

public void setPrivateKeyResource(@Nonnull
                         org.springframework.core.io.Resource res)

Set the resource containing the private key.

Parameters:

res - private key resource, never null

setPrivateKeyPassword

public void setPrivateKeyPassword(@Nullable
                         String password)

Set the password for the private key.

Parameters:

password - password for the private key, may be null if the key is not encrypted

setCertificateResource

public void setCertificateResource(@Nonnull
                          org.springframework.core.io.Resource res)

Set the certificate resource.

Parameters:

res - certificate resource

setEntityId

public void setEntityId(@Nullable
               String id)

Set the entityID for the credential.

Parameters:

id - entityID

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface org.springframework.beans.factory.FactoryBean<BasicX509Credential>

Overrides:

isSingleton in class org.springframework.beans.factory.config.AbstractFactoryBean<BasicX509Credential>

getEntityCertificate

@Nullable
protected X509Certificate getEntityCertificate()

return the explicitly configured entity certificate..

Specified by:

getEntityCertificate in class AbstractX509CredentialFactoryBean

Returns:

the certificate, or none if not configured.

getCertificates

@Nonnull
protected List<X509Certificate> getCertificates()

Get the configured certificates. This MUST include the entity certificate if it was configured.

Specified by:

getCertificates in class AbstractX509CredentialFactoryBean

Returns:

the certificates.

getPrivateKey

@Nullable
protected PrivateKey getPrivateKey()

Get the configured private key.

Specified by:

getPrivateKey in class AbstractX509CredentialFactoryBean

Returns:

the key or null if non configured

getCRLs

@Nullable
protected List<X509CRL> getCRLs()

Get the configured CRL list.

Specified by:

getCRLs in class AbstractX509CredentialFactoryBean

Returns:

the crls or null