Package net.shibboleth.oidc.security.credential

Class BasicJWKCredentialFactoryBean

java.lang.Object

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

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

org.opensaml.spring.credential.AbstractCredentialFactoryBean<BasicJWKCredential>

net.shibboleth.oidc.security.credential.BasicJWKCredentialFactoryBean

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, DisposableBean, FactoryBean<BasicJWKCredential>, InitializingBean

public class BasicJWKCredentialFactoryBean
extends AbstractCredentialFactoryBean<BasicJWKCredential>

Factory bean for Basic JSON Web Keys (JWK).

Since:

2.2.0

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	failIfResourceIsNull	Should the factory throw an exception if the resource is null?.
private Resource	jwkResource	Where the private key is to be found.
private final org.slf4j.Logger	log	Class logger.
private String	symmetricKeyAlgorithm	The JCA algorithm name to use if the key to be converted is a symmetric key.

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

logger

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Constructor Summary

Constructors

Constructor	Description
BasicJWKCredentialFactoryBean()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected BasicJWKCredential	doCreateInstance()
Class<?>	getObjectType()
void	setFailIfResourceIsNull(boolean flag)	Should the factory throw an exeception if the resource is null?
void	setResource(Resource res)	Set the resource containing the private key.
void	setSymmetricKeyAlgorithm(String algorithm)	Set the JCA algorithm name to use if the key to be converted is a symmetric key.

Methods inherited from class org.opensaml.spring.credential.AbstractCredentialFactoryBean

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

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

createInstance, destroyInstance

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

afterPropertiesSet, destroy, 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

Field Details

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

jwkResource

@Nullable
private Resource jwkResource

Where the private key is to be found.

failIfResourceIsNull

private boolean failIfResourceIsNull

Should the factory throw an exception if the resource is null?.

symmetricKeyAlgorithm

@Nonnull
private String symmetricKeyAlgorithm

The JCA algorithm name to use if the key to be converted is a symmetric key. Default is AES.

Constructor Details

BasicJWKCredentialFactoryBean

public BasicJWKCredentialFactoryBean()

Constructor.

Method Details

setSymmetricKeyAlgorithm

public void setSymmetricKeyAlgorithm(@Nonnull @NotEmpty
 String algorithm)

Set the JCA algorithm name to use if the key to be converted is a symmetric key.

Parameters:

algorithm - the JCA name

setFailIfResourceIsNull

public void setFailIfResourceIsNull(boolean flag)

Should the factory throw an exeception if the resource is null?

Parameters:

flag - the flag

setResource

public void setResource(@Nonnull
 Resource res)

Set the resource containing the private key.

Parameters:

res - private key resource, never null

doCreateInstance

protected BasicJWKCredential doCreateInstance()
                                       throws Exception

Specified by:

doCreateInstance in class AbstractComponentAwareFactoryBean<BasicJWKCredential>

Throws:

Exception

getObjectType

public Class<?> getObjectType()

Specified by:

getObjectType in interface FactoryBean<BasicJWKCredential>

Specified by:

getObjectType in class AbstractFactoryBean<BasicJWKCredential>