net.shibboleth.idp.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.idp.service.AbstractReloadableService

net.shibboleth.idp.service.ReloadableSpringService<T>

Type Parameters:

T - The precise service being implemented.

All Implemented Interfaces:

ReloadableService, 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, Aware, BeanNameAware, ApplicationContextAware, Lifecycle

@ThreadSafe
public class ReloadableSpringService<T>
extends AbstractReloadableService
implements ApplicationContextAware, BeanNameAware

This class provides a reloading interface to a ServiceableComponent.

Nested Class Summary

Nested classes/interfaces inherited from class net.shibboleth.idp.service.AbstractReloadableService

AbstractReloadableService.ServiceReloadTask

Field Summary

Fields

Modifier and Type	Field and Description
private String	beanName The bean name.
private ServiceableComponent<T>	cachedComponent The last known good component.
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 Class<T>	theClaz The class we are looking for.
private Class<? extends ServiceableComponent>	theServiceClaz The precise class to look for.

Constructor Summary

Constructors

Constructor and Description
ReloadableSpringService(Class<T> claz) Constructor.
ReloadableSpringService(Class<T> claz, Class<? extends ServiceableComponent> servicableClaz) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doDestroy()
protected void	doInitialize()
protected void	doReload() Performs the actual reload.
ApplicationContext	getParentContext() Gets the application context that is the parent to this service's context.
ServiceableComponent<T>	getServiceableComponent() Get the serviceable component.
List<Resource>	getServiceConfigurations() Gets an unmodifiable list of configurations for this service.
void	setApplicationContext(ApplicationContext applicationContext)
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.
protected boolean	shouldReload() Called by the AbstractReloadableService.ServiceReloadTask to determine if the service should be reloaded.

Methods inherited from class net.shibboleth.idp.service.AbstractReloadableService

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

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.IdentifiedComponent

getId

Field Detail

log

private final Logger log

Class logger.

serviceConfigurations

private List<Resource> serviceConfigurations

List of configuration resources for this service.

postProcessors

private List<BeanPostProcessor> postProcessors

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

theClaz

private final Class<T> theClaz

The class we are looking for.

theServiceClaz

private final Class<? extends ServiceableComponent> theServiceClaz

The precise class to look for. This is required if the parsed file may produce more than one ServiceableComponent.

parentContext

private ApplicationContext parentContext

Application context owning this engine.

beanName

private String beanName

The bean name.

cachedComponent

private ServiceableComponent<T> cachedComponent

The last known good component.

lastLoadFailed

private boolean lastLoadFailed

Did the last load fail? An optimization only.

resourceLastModifiedTimes

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(Class<T> claz)

Constructor.

Parameters:

claz - The interface being implemented.

ReloadableSpringService

public ReloadableSpringService(Class<T> claz,
                       Class<? extends ServiceableComponent> servicableClaz)

Constructor.

Parameters:

claz - The interface being implemented.

servicableClaz - the service 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

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

shouldReload

protected boolean shouldReload()

Called by the AbstractReloadableService.ServiceReloadTask to determine if the service should be reloaded.

No lock is held when this method is called, so any locking needed should be handled internally.

Specified by:

shouldReload in class AbstractReloadableService

Returns:

true iff the service should be reloaded

doReload

protected void doReload()
                 throws ServiceException

Performs the actual reload.

No lock is held when this method is called, so any locking needed should be handled internally.

Overrides:

doReload in class AbstractReloadableService

Throws:

ServiceException - thrown if there is a problem reloading the service

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

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

Returns:

the pinned component.

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface ApplicationContextAware

setBeanName

public void setBeanName(String name)

Specified by:

setBeanName in interface BeanNameAware

doInitialize

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

Overrides:

doInitialize in class AbstractReloadableService

Throws:

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