net.shibboleth.idp.service

Interface ServiceableComponent<T>

Type Parameters:

T - The underlying type of the component. The idea is that the attribute resolver will be public class AttributeResolver extends AbstractServiceableComponent implements AttributeResolver, ServiceableComponent. AbstractServiceableComponent will do all the work around reload and synchronization.

All Known Implementing Classes:

AbstractServiceableComponent

public interface ServiceableComponent<T>

Any Component that wants to be reloaded via the Service interface and spring implements this interface.

Method Summary

Methods

Modifier and Type	Method and Description
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 pinComponent() must be matched by a call to unpinComponent() The need to have the type converting return parameter is to get around the java typing restrictions.
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 getComponent().

Method Detail

getComponent

@Nonnull
T getComponent()

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

Returns:

the component.

pinComponent

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 pinComponent() must be matched by a call to unpinComponent()
The need to have the type converting return parameter is to get around the java typing restrictions.

unpinComponent

void unpinComponent()

This undoes the work that is done by getComponent().

unloadComponent

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.