Package net.shibboleth.idp.attribute.resolver.spring.dc.impl

Class DataConnectorFactoryBean

java.lang.Object

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

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

net.shibboleth.idp.attribute.resolver.spring.impl.AbstractResolverPluginFactoryBean<AbstractDataConnector>

net.shibboleth.idp.attribute.resolver.spring.dc.impl.DataConnectorFactoryBean

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, DisposableBean, FactoryBean<AbstractDataConnector>, InitializingBean, ApplicationContextAware

public class DataConnectorFactoryBean
extends AbstractResolverPluginFactoryBean<AbstractDataConnector>
implements ApplicationContextAware

A factory bean to collect the parameterization that goes onto a AbstractDataConnector. It is specifically aimed at the implementations where contents are plugged in via external resources.

Field Summary

Fields

Modifier and Type	Field	Description
private GenericApplicationContext	appContext	The context we fired up.
private Class<? extends AbstractDataConnector>	connectorClass	The class that we are implementing.
private Boolean	exportAllAttributes	Do we release all attributes?.
private Collection<String>	exportAttributes	Which named attributes do we release?.
private List<BeanFactoryPostProcessor>	factoryPostProcessors	List of bean factory post processors for this connector's content.
private String	failoverDataConnectorId	Data Connector property "failoverDataConnectorId".
private org.slf4j.Logger	log	Log4j logger.
private Duration	noRetryDelay	Data Connector property "noRetryDelay".
private ApplicationContext	parentContext	Our parent context.
private List<BeanPostProcessor>	postProcessors	List of bean post processors for this connector's content.
private List<Resource>	resources	The resources we are importing.

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
DataConnectorFactoryBean()

Method Summary

Modifier and Type	Method	Description
protected void	destroyInstance(AbstractDataConnector instance)
protected AbstractDataConnector	doCreateInstance()
List<BeanFactoryPostProcessor>	getBeanFactoryPostProcessors()	Get the post processors.
List<BeanPostProcessor>	getBeanPostProcessors()	Get the list of bean post processors for this connector.
String	getFailoverDataConnectorId()	Data Connector property "failoverDataConnectorId".
Duration	getNoRetryDelay()	Data Connector property "noRetryDelay".
Class<? extends AbstractDataConnector>	getObjectType()
ApplicationContext	getParentContext()	Returns the parentContext.
List<Resource>	getResources()	The resources to use.
void	setApplicationContext(ApplicationContext applicationContext)
void	setBeanFactoryPostProcessors(List<BeanFactoryPostProcessor> processors)	Set the list of bean factory post processors for this connector.
void	setBeanPostProcessors(List<BeanPostProcessor> processors)	Set the list of bean post processors for this connector.
void	setExportAllAttributes(boolean what)	Set whether we export all attributes.
void	setExportAttributes(Collection<String> what)	Sets the list of attribute names to export during resolution.
void	setFailoverDataConnectorId(String id)	Data Connector property "failoverDataConnectorId".
void	setNoRetryDelay(Duration delay)	Data Connector property "noRetryDelay".
void	setObjectType(Class<? extends AbstractDataConnector> claz)	Set the class we are going to build.
void	setResources(List<Resource> theResources)	The resources to use.
void	setSingleton(boolean singleton)	We do not allow non-singleton beans, if we did then we loose constructability.
protected void	setValues(AbstractDataConnector what)	Set the locally define values into the object under construction.

Methods inherited from class net.shibboleth.idp.attribute.resolver.spring.impl.AbstractResolverPluginFactoryBean

getActivationCondition, getAttributeDependencies, getDataConnectorDependencies, getId, getProfileContextStrategy, getPropagateResolutionExceptions, setActivationCondition, setAttributeDependencies, setDataConnectorDependencies, setId, setProfileContextStrategy, setPropagateResolutionExceptions

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

createInstance

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

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

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

Log4j logger.

connectorClass

@Nonnull
private Class<? extends AbstractDataConnector> connectorClass

The class that we are implementing.

resources

@Nullable
private List<Resource> resources

The resources we are importing.

parentContext

@Nullable
private ApplicationContext parentContext

Our parent context.

appContext

private GenericApplicationContext appContext

The context we fired up.

factoryPostProcessors

@Nonnull
@NonnullElements
private List<BeanFactoryPostProcessor> factoryPostProcessors

List of bean factory post processors for this connector's content.

postProcessors

@Nonnull
@NonnullElements
private List<BeanPostProcessor> postProcessors

List of bean post processors for this connector's content.

failoverDataConnectorId

@Nullable
private String failoverDataConnectorId

Data Connector property "failoverDataConnectorId".

noRetryDelay

@Nullable
private Duration noRetryDelay

Data Connector property "noRetryDelay".

exportAllAttributes

private Boolean exportAllAttributes

Do we release all attributes?.

exportAttributes

@Nonnull
@NonnullElements
private Collection<String> exportAttributes

Which named attributes do we release?.

Constructor Details

DataConnectorFactoryBean

public DataConnectorFactoryBean()

Method Details

getFailoverDataConnectorId

@Nullable
public String getFailoverDataConnectorId()

Data Connector property "failoverDataConnectorId".

Returns:

the value of property to set or null if never set

setFailoverDataConnectorId

public void setFailoverDataConnectorId(@Nullable
String id)

Data Connector property "failoverDataConnectorId".

Parameters:

id - the value to set

getNoRetryDelay

@Nullable
public Duration getNoRetryDelay()

Data Connector property "noRetryDelay".

Returns:

the value of property to set or null if never set

setNoRetryDelay

public void setNoRetryDelay(@Nullable
Duration delay)

Data Connector property "noRetryDelay".

Parameters:

delay - the value to set

setResources

public void setResources(@Nonnull @NonnullElements
List<Resource> theResources)

The resources to use.

Parameters:

theResources - the resources to look at

getResources

@Nonnull
@NonnullElements
public List<Resource> getResources()

The resources to use.

Returns:

the resources to look at

setExportAttributes

public void setExportAttributes(@Nonnull
Collection<String> what)

Sets the list of attribute names to export during resolution.

Parameters:

what - the list

setExportAllAttributes

public void setExportAllAttributes(boolean what)

Set whether we export all attributes.

Parameters:

what - whether we export all attributes

setBeanFactoryPostProcessors

public void setBeanFactoryPostProcessors(@Nonnull @NonnullElements
List<BeanFactoryPostProcessor> processors)

Set the list of bean factory post processors for this connector.

Parameters:

processors - bean factory post processors to apply

getBeanFactoryPostProcessors

@Nonnull
@NonnullElements
public List<BeanFactoryPostProcessor> getBeanFactoryPostProcessors()

Get the post processors.

Returns:

the bean factory post processors

setBeanPostProcessors

public void setBeanPostProcessors(@Nonnull @NonnullElements
List<BeanPostProcessor> processors)

Set the list of bean post processors for this connector.

Parameters:

processors - bean post processors to apply

getBeanPostProcessors

@Nonnull
@NonnullElements
public List<BeanPostProcessor> getBeanPostProcessors()

Get the list of bean post processors for this connector.

Returns:

processors bean post processors to apply

setValues

protected void setValues(AbstractDataConnector what)

Set the locally define values into the object under construction.

Overrides:

setValues in class AbstractResolverPluginFactoryBean<AbstractDataConnector>

Parameters:

what - the object being built.

setSingleton

public void setSingleton(boolean singleton)

We do not allow non-singleton beans, if we did then we loose constructability.

Overrides:

setSingleton in class AbstractFactoryBean<AbstractDataConnector>

setObjectType

public void setObjectType(@Nonnull
Class<? extends AbstractDataConnector> claz)

Set the class we are going to build.

Parameters:

claz - the class.

getObjectType

public Class<? extends AbstractDataConnector> getObjectType()

Specified by:

getObjectType in interface FactoryBean<AbstractDataConnector>

Specified by:

getObjectType in class AbstractFactoryBean<AbstractDataConnector>

getParentContext

public ApplicationContext getParentContext()

Returns the parentContext.

Returns:

Returns the parentContext.

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

destroyInstance

protected void destroyInstance(AbstractDataConnector instance)
                        throws Exception

Overrides:

destroyInstance in class AbstractComponentAwareFactoryBean<AbstractDataConnector>

Throws:

Exception

doCreateInstance

protected AbstractDataConnector doCreateInstance()
                                          throws Exception

In order to create the bean we introspect with respect to contents of the Spring resources and inject as required.

Specified by:

doCreateInstance in class AbstractComponentAwareFactoryBean<AbstractDataConnector>

Throws:

Exception