net.shibboleth.idp.service

Class AbstractServiceableComponent<T>

java.lang.Object

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

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

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

Type Parameters:

T - The type of service.

All Implemented Interfaces:

ServiceableComponent<T>, 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, Aware, ApplicationContextAware

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

Implementation of ServiceableComponent that does most of the work required.

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

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() Extract the component that does the actual work.
void	pinComponent() This function takes a lock on the component which guarantees that it will not be disposed until the release call is made. Every call to ServiceableComponent.pinComponent() must be matched by a call to ServiceableComponent.unpinComponent() The need to have the type converting return parameter is to get around the java typing restrictions.
void	setApplicationContext(ApplicationContext context)
void	unloadComponent() This call will wait for all transient operations to complete and then calls dispose on the components.
void	unpinComponent() This undoes the work that is done by ServiceableComponent.getComponent().

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

private final Logger log

Class logger.

applicationContext

private ApplicationContext applicationContext

The context used to load this bean.

serviceLock

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

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

Extract the component that does the actual work. Callers MUST have the ServiceableComponent pinned at this stage..

Specified by:

getComponent in interface ServiceableComponent<T>

Returns:

the component.

pinComponent

public void pinComponent()

This function takes a lock on the component which guarantees that it will not be disposed until the release call is made.
Every call to ServiceableComponent.pinComponent() must be matched by a call to ServiceableComponent.unpinComponent()
The need to have the type converting return parameter is to get around the java typing restrictions. Grab the service lock shared. This will block unloads until unpinComponent() is called.

Specified by:

pinComponent in interface ServiceableComponent<T>

unpinComponent

public void unpinComponent()

This undoes the work that is done by ServiceableComponent.getComponent(). drop the shared lock.

Specified by:

unpinComponent in interface ServiceableComponent<T>

unloadComponent

public void unloadComponent()

This call will wait for all transient operations to complete and then calls dispose on the components.
Implementations should avoid calling this with locks held.. Grab the service lock ex and then call spring to tear everything down.

Specified by:

unloadComponent in interface 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