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:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.IdentifiableComponent, net.shibboleth.utilities.java.support.component.IdentifiedComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, net.shibboleth.utilities.java.support.component.UnmodifiableComponent, net.shibboleth.utilities.java.support.service.ReloadableService<T>, Aware, BeanNameAware, ApplicationContextAware, Lifecycle

@ThreadSafe
public class ReloadableSpringService<T>
extends net.shibboleth.utilities.java.support.service.AbstractReloadableService<T>
implements ApplicationContextAware, BeanNameAware, 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

net.shibboleth.utilities.java.support.service.AbstractReloadableService.ServiceReloadTask

Field Summary

Fields

Modifier and Type	Field and Description
private String	beanName The bean name.
private net.shibboleth.utilities.java.support.service.ServiceableComponent<T>	cachedComponent The last known good component.
private List<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 Logger	log Class logger.
private ApplicationContext	parentContext Application context owning this engine.
private List<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<Resource>	serviceConfigurations List of configuration resources for this service.
private Function<GenericApplicationContext,net.shibboleth.utilities.java.support.service.ServiceableComponent>	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, Function<GenericApplicationContext,net.shibboleth.utilities.java.support.service.ServiceableComponent> strategy) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doDestroy()
protected void	doInitialize()
protected void	doReload()
ApplicationContext	getParentContext() Gets the application context that is the parent to this service's context.
net.shibboleth.utilities.java.support.service.ServiceableComponent<T>	getServiceableComponent() Get the serviceable component.
List<Resource>	getServiceConfigurations() Gets an unmodifiable list of configurations for this service.
boolean	isRunning() .
void	setApplicationContext(ApplicationContext applicationContext)
void	setBeanFactoryPostProcessors(List<BeanFactoryPostProcessor> processors) Set the list of bean factory post processors for this service.
void	setBeanName(String name)
void	setBeanPostProcessors(List<BeanPostProcessor> processors) Set the list of bean post processors for this service.
void	setParentContext(ApplicationContext context) Sets the application context that is the parent to this service's context.
void	setServiceConfigurations(List<Resource> configs) Sets the list of configurations for this service.
void	setServiceConfigurationStrategy(Function<?,List<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 Logger log

Class logger.

serviceConfigurations

@Nullable
@NonnullElements
private List<Resource> serviceConfigurations

List of configuration resources for this service.

factoryPostProcessors

@Nonnull
@NonnullElements
private List<BeanFactoryPostProcessor> factoryPostProcessors

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

postProcessors

@Nonnull
@NonnullElements
private List<BeanPostProcessor> postProcessors

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

theClaz

@Nonnull
private final Class<T> theClaz

The class we are looking for.

serviceStrategy

@Nonnull
private final Function<GenericApplicationContext,net.shibboleth.utilities.java.support.service.ServiceableComponent> serviceStrategy

How to summon up the ServiceableComponent from the ApplicationContext.

parentContext

@Nullable
private ApplicationContext parentContext

Application context owning this engine.

beanName

@Nullable
private String beanName

The bean name.

cachedComponent

@Nullable
private net.shibboleth.utilities.java.support.service.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")
                       Function<GenericApplicationContext,net.shibboleth.utilities.java.support.service.ServiceableComponent> 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 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
                    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<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<Resource> configs)

Sets 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, may be null or empty

setServiceConfigurationStrategy

public void setServiceConfigurationStrategy(@Nonnull
                                   Function<?,List<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<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<BeanPostProcessor> processors)

Set the list of bean post processors for this service.

Parameters:

processors - bean post processors to apply

start

public final void start()

Specified by:

start in interface Lifecycle

stop

public final void stop()

Specified by:

stop in interface Lifecycle

isRunning

public boolean isRunning()

.

Specified by:

isRunning in interface Lifecycle

shouldReload

protected boolean shouldReload()

Specified by:

shouldReload in class net.shibboleth.utilities.java.support.service.AbstractReloadableService<T>

doReload

protected void doReload()

Overrides:

doReload in class net.shibboleth.utilities.java.support.service.AbstractReloadableService<T>

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class net.shibboleth.utilities.java.support.service.AbstractReloadableService<T>

getServiceableComponent

public net.shibboleth.utilities.java.support.service.ServiceableComponent<T> getServiceableComponent()

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

Specified by:

getServiceableComponent in interface net.shibboleth.utilities.java.support.service.ReloadableService<T>

Returns:

the pinned component.

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface ApplicationContextAware

setBeanName

public void setBeanName(@Nonnull@NotEmpty
               String name)

Specified by:

setBeanName in interface BeanNameAware

doInitialize

protected void doInitialize()
                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Overrides:

doInitialize in class net.shibboleth.utilities.java.support.service.AbstractReloadableService<T>

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException