net.shibboleth.ext.spring.service

Class ReloadableSpringService<T>

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

net.shibboleth.utilities.java.support.service.AbstractReloadableService<T>

net.shibboleth.ext.spring.service.ReloadableSpringService<T>

Type Parameters:

T - The precise service being implemented.

All Implemented Interfaces:

Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, UnmodifiableComponent, ReloadableService<T>, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle

@ThreadSafe
public class ReloadableSpringService<T>
extends AbstractReloadableService<T>
implements org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.BeanNameAware, org.springframework.context.Lifecycle

This class provides a reloading interface to a ServiceableComponent via Spring. This class extends Lifecycle. and thus It acts as the bridge between this interface and InitializableComponent and DestructableComponent

Nested Class Summary

Nested classes/interfaces inherited from class net.shibboleth.utilities.java.support.service.AbstractReloadableService

AbstractReloadableService.ServiceReloadTask

Field Summary

Fields

Modifier and Type	Field and Description
private String	beanName The bean name.
private Collection<String>	beanProfiles Bean profiles to enable.
private ServiceableComponent<T>	cachedComponent The last known good component.
private org.springframework.core.convert.ConversionService	conversionService Conversion service to use.
private List<org.springframework.beans.factory.config.BeanFactoryPostProcessor>	factoryPostProcessors List of bean factory post processors for this service's content.
private boolean	lastLoadFailed Did the last load fail? An optimization only.
private org.slf4j.Logger	log Class logger.
private org.springframework.context.ApplicationContext	parentContext Application context owning this engine.
private List<org.springframework.beans.factory.config.BeanPostProcessor>	postProcessors List of bean post processors for this service's content.
private long[]	resourceLastModifiedTimes Time, in milliseconds, when the service configuration for the given index was last observed to have changed.
private List<org.springframework.core.io.Resource>	serviceConfigurations List of configuration resources for this service.
private com.google.common.base.Function<org.springframework.context.ApplicationContext,ServiceableComponent<T>>	serviceStrategy How to summon up the ServiceableComponent from the ApplicationContext.
private Class<T>	theClaz The class we are looking for.

Constructor Summary

Constructors

Constructor and Description
ReloadableSpringService(Class<T> claz) Constructor.
ReloadableSpringService(Class<T> claz, com.google.common.base.Function<org.springframework.context.ApplicationContext,ServiceableComponent<T>> strategy) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	doDestroy()
protected void	doInitialize()
protected void	doReload()
org.springframework.context.ApplicationContext	getParentContext() Gets the application context that is the parent to this service's context.
ServiceableComponent<T>	getServiceableComponent() Get the serviceable component.
List<org.springframework.core.io.Resource>	getServiceConfigurations() Gets an unmodifiable list of configurations for this service.
boolean	isRunning() .
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setBeanFactoryPostProcessors(List<org.springframework.beans.factory.config.BeanFactoryPostProcessor> processors) Set the list of bean factory post processors for this service.
void	setBeanName(String name)
void	setBeanPostProcessors(List<org.springframework.beans.factory.config.BeanPostProcessor> processors) Set the list of bean post processors for this service.
void	setBeanProfiles(Collection<String> profiles) Set the bean profiles for this service.
void	setConversionService(org.springframework.core.convert.ConversionService service) Set a conversion service to use.
void	setParentContext(org.springframework.context.ApplicationContext context) Sets the application context that is the parent to this service's context.
void	setServiceConfigurations(List<org.springframework.core.io.Resource> configs) Set the list of configurations for this service.
void	setServiceConfigurationStrategy(com.google.common.base.Function<?,List<org.springframework.core.io.Resource>> strategy) Set the strategy by which the Service can locate the resources it needs to know about.
protected boolean	shouldReload()
void	start()
void	stop()

Methods inherited from class net.shibboleth.utilities.java.support.service.AbstractReloadableService

getLastReloadAttemptInstant, getLastSuccessfulReloadInstant, getLogPrefix, getReloadCheckDelay, getReloadFailureCause, getReloadTaskTimer, isFailFast, reload, setFailFast, setReloadCheckDelay, setReloadTaskTimer

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

getId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

serviceConfigurations

@Nullable
 @NonnullElements
private List<org.springframework.core.io.Resource> serviceConfigurations

List of configuration resources for this service.

factoryPostProcessors

@Nonnull
 @NonnullElements
private List<org.springframework.beans.factory.config.BeanFactoryPostProcessor> factoryPostProcessors

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

postProcessors

@Nonnull
 @NonnullElements
private List<org.springframework.beans.factory.config.BeanPostProcessor> postProcessors

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

beanProfiles

@Nonnull
 @NonnullElements
private Collection<String> beanProfiles

Bean profiles to enable.

conversionService

@Nullable
private org.springframework.core.convert.ConversionService conversionService

Conversion service to use.

theClaz

@Nonnull
private final Class<T> theClaz

The class we are looking for.

serviceStrategy

@Nonnull
private final com.google.common.base.Function<org.springframework.context.ApplicationContext,ServiceableComponent<T>> serviceStrategy

How to summon up the ServiceableComponent from the ApplicationContext.

parentContext

@Nullable
private org.springframework.context.ApplicationContext parentContext

Application context owning this engine.

beanName

@Nullable
private String beanName

The bean name.

cachedComponent

@Nullable
private ServiceableComponent<T> cachedComponent

The last known good component.

lastLoadFailed

private boolean lastLoadFailed

Did the last load fail? An optimization only.

resourceLastModifiedTimes

@Nullable
private long[] resourceLastModifiedTimes

Time, in milliseconds, when the service configuration for the given index was last observed to have changed. -1 indicates the configuration resource did not exist.

Constructor Detail

ReloadableSpringService

public ReloadableSpringService(@Nonnull @ParameterName(name="claz")
                               Class<T> claz)

Constructor.

Parameters:

claz - The interface being implemented.

ReloadableSpringService

public ReloadableSpringService(@Nonnull @ParameterName(name="claz")
                               Class<T> claz,
                               @Nonnull @ParameterName(name="strategy")
                               com.google.common.base.Function<org.springframework.context.ApplicationContext,ServiceableComponent<T>> strategy)

Constructor.

Parameters:

claz - The interface being implemented.

strategy - the strategy to use to look up servicable component to look for.

Method Detail

getParentContext

@Nullable
public org.springframework.context.ApplicationContext getParentContext()

Gets the application context that is the parent to this service's context.

Returns:

application context that is the parent to this service's context

setParentContext

public void setParentContext(@Nullable
                             org.springframework.context.ApplicationContext context)

Sets the application context that is the parent to this service's context. This setting can not be changed after the service has been initialized.

Parameters:

context - context that is the parent to this service's context, may be null

getServiceConfigurations

@Nonnull
public List<org.springframework.core.io.Resource> getServiceConfigurations()

Gets an unmodifiable list of configurations for this service.

Returns:

unmodifiable list of configurations for this service

setServiceConfigurations

public void setServiceConfigurations(@Nonnull @NonnullElements
                                     List<org.springframework.core.io.Resource> configs)

Set the list of configurations for this service. This setting can not be changed after the service has been initialized.

Parameters:

configs - list of configurations for this service

setServiceConfigurationStrategy

public void setServiceConfigurationStrategy(@Nonnull
                                            com.google.common.base.Function<?,List<org.springframework.core.io.Resource>> strategy)

Set the strategy by which the Service can locate the resources it needs to know about.
Not implemented

Parameters:

strategy - the way to get the resources. Precise details are tbd.

setBeanFactoryPostProcessors

public void setBeanFactoryPostProcessors(@Nonnull @NonnullElements
                                         List<org.springframework.beans.factory.config.BeanFactoryPostProcessor> processors)

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

Parameters:

processors - bean factory post processors to apply

setBeanPostProcessors

public void setBeanPostProcessors(@Nonnull @NonnullElements
                                  List<org.springframework.beans.factory.config.BeanPostProcessor> processors)

Set the list of bean post processors for this service.

Parameters:

processors - bean post processors to apply

setBeanProfiles

public void setBeanProfiles(@Nonnull @NonnullElements
                            Collection<String> profiles)

Set the bean profiles for this service.

Parameters:

profiles - bean profiles to apply

Since:

5.4.0

setConversionService

public void setConversionService(@Nullable
                                 org.springframework.core.convert.ConversionService service)

Set a conversion service to use.

Parameters:

service - conversion service

Since:

5.4.0

start

public final void start()

Specified by:

start in interface org.springframework.context.Lifecycle

stop

public final void stop()

Specified by:

stop in interface org.springframework.context.Lifecycle

isRunning

public boolean isRunning()

.

Specified by:

isRunning in interface org.springframework.context.Lifecycle

shouldReload

protected boolean shouldReload()

Specified by:

shouldReload in class AbstractReloadableService<T>

doReload

protected void doReload()

Overrides:

doReload in class AbstractReloadableService<T>

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class AbstractReloadableService<T>

getServiceableComponent

public ServiceableComponent<T> getServiceableComponent()

Get the serviceable component. We do this under interlock and grab the lock on the component.

Specified by:

getServiceableComponent in interface ReloadableService<T>

Returns:

the pinned component.

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

setBeanName

public void setBeanName(@Nonnull @NotEmpty
                        String name)

Specified by:

setBeanName in interface org.springframework.beans.factory.BeanNameAware

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractReloadableService<T>

Throws:

ComponentInitializationException