net.shibboleth.ext.spring.service

Class AbstractServiceableComponent<T>

java.lang.Object

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

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

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

Type Parameters:

T - The type of service.

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.IdentifiedComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, net.shibboleth.utilities.java.support.service.ServiceableComponent<T>, Aware, ApplicationContextAware

public abstract class AbstractServiceableComponent<T>
extends net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent
implements net.shibboleth.utilities.java.support.service.ServiceableComponent<T>, ApplicationContextAware

Implementation of ServiceableComponent that does most of the work required. It leverages the spring environment to allow easy cleanup.

Field Summary

Fields

Modifier and Type	Field and Description
private ApplicationContext	applicationContext The context used to load this bean.
private Logger	log Class logger.
private ReentrantReadWriteLock	serviceLock Lock for this service.

Constructor Summary

Constructors

Constructor and Description
AbstractServiceableComponent() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doDestroy() .
protected void	doInitialize()
ApplicationContext	getApplicationContext() Get the context used to load this bean.
abstract T	getComponent() .
void	pinComponent() Grab the service lock shared.
void	setApplicationContext(ApplicationContext context)
void	unloadComponent() .
void	unpinComponent() drop the shared lock.

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

getId, setId

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

Field Detail

log

@Nonnull
private final Logger log

Class logger.

applicationContext

@Nullable
private ApplicationContext applicationContext

The context used to load this bean.

serviceLock

@Nonnull
private final ReentrantReadWriteLock serviceLock

Lock for this service. We make it unfair since we will control access and there will only ever be contention during unload.

Constructor Detail

AbstractServiceableComponent

public AbstractServiceableComponent()

Constructor.

Method Detail

setApplicationContext

public void setApplicationContext(ApplicationContext context)

Specified by:

setApplicationContext in interface ApplicationContextAware

getApplicationContext

@Nullable
public ApplicationContext getApplicationContext()

Get the context used to load this bean.

Returns:

the context.

getComponent

@Nonnull
public abstract T getComponent()

.

Specified by:

getComponent in interface net.shibboleth.utilities.java.support.service.ServiceableComponent<T>

pinComponent

public void pinComponent()

Grab the service lock shared. This will block unloads until unpinComponent() is called.

Specified by:

pinComponent in interface net.shibboleth.utilities.java.support.service.ServiceableComponent<T>

unpinComponent

public void unpinComponent()

drop the shared lock.

Specified by:

unpinComponent in interface net.shibboleth.utilities.java.support.service.ServiceableComponent<T>

unloadComponent

public void unloadComponent()

. Grab the service lock ex and then call spring to tear everything down.

Specified by:

unloadComponent in interface net.shibboleth.utilities.java.support.service.ServiceableComponent<T>

doDestroy

protected void doDestroy()

. Force unload; this will usually be a no-op since the component should have been explicitly unloaded, but we do the unload here so that error cases also clean up.

Overrides:

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

doInitialize

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

Overrides:

doInitialize in class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

Throws:

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