Module net.shibboleth.utilities.java.support

Package net.shibboleth.utilities.java.support.component

Class AbstractInitializableComponent

java.lang.Object

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

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent

Direct Known Subclasses:

AbstractIdentifiedInitializableComponent, BasicKeystoreKeyStrategy, BasicParserPool, CookieManager, DataSealer, ScriptedKeyStrategy

public abstract class AbstractInitializableComponent
extends Object
implements DestructableComponent, InitializableComponent

Base class for things that implement DestructableComponent and InitializableComponent.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	isDestroyed	Whether this component has been destroyed.
private boolean	isInitialized	Whether this component has been initialized.

Constructor Summary

Constructors

Constructor	Description
AbstractInitializableComponent()

Method Summary

Modifier and Type	Method	Description
void	destroy()	Destroys the component.
protected void	doDestroy()	Performs component specific destruction logic.
protected void	doInitialize()	Performs the initialization of the component.
void	initialize()	Initializes the component.
boolean	isDestroyed()	Gets whether this component has been destroyed.
boolean	isInitialized()	Gets whether this component is initialized.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

isDestroyed

private boolean isDestroyed

Whether this component has been destroyed.

isInitialized

private boolean isInitialized

Whether this component has been initialized.

Constructor Detail

AbstractInitializableComponent

public AbstractInitializableComponent()

Method Detail

isDestroyed

public final boolean isDestroyed()

Gets whether this component has been destroyed. Normally, once a component has been destroyed it cannot be used.

Specified by:

isDestroyed in interface DestructableComponent

Returns:

true iff the component has been destroyed

isInitialized

public boolean isInitialized()

Gets whether this component is initialized.

Specified by:

isInitialized in interface InitializableComponent

Returns:

true iff this component is initialized

destroy

public final void destroy()

Destroys the component.

Specified by:

destroy in interface DestructableComponent

initialize

public final void initialize()
                      throws ComponentInitializationException

Initializes the component.

Specified by:

initialize in interface InitializableComponent

Throws:

ComponentInitializationException - thrown if there is a problem initializing the component

doDestroy

protected void doDestroy()

Performs component specific destruction logic. This method is executed within the lock on the object being destroyed. The default implementation of this method is a no-op.

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Performs the initialization of the component. This method is executed within the lock on the object being initialized. The default implementation of this method is a no-op.

Throws:

ComponentInitializationException - thrown if there is a problem initializing the component