net.shibboleth.utilities.java.support.component

Class AbstractDestructableIdentifiableInitializableComponent

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractDestructableInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractDestructableIdentifiableInitializableComponent

All Implemented Interfaces:

Component, DestructableComponent, IdentifiableComponent, InitializableComponent

public abstract class AbstractDestructableIdentifiableInitializableComponent
extends AbstractDestructableInitializableComponent
implements IdentifiableComponent

Base class for components implementing DestructableComponent, IdentifiableComponent and InitializableComponent.

Field Summary

Fields

Modifier and Type	Field and Description
private String	id ID of this component.

Constructor Summary

Constructors

Constructor and Description
AbstractDestructableIdentifiableInitializableComponent()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doInitialize() Performs the initialization of the component.
String	getId() Gets the ID of this component.
protected void	setId(String componentId) Sets the ID of this component.

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

destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Field Detail

id

@Nullable
@NonnullAfterInit
private String id

ID of this component.

Constructor Detail

AbstractDestructableIdentifiableInitializableComponent

public AbstractDestructableIdentifiableInitializableComponent()

Method Detail

getId

@Nullable
@NonnullAfterInit
public String getId()

Gets the ID of this component.

Specified by:

getId in interface IdentifiableComponent

Returns:

ID of this component

setId

protected void setId(@Nonnull@NotEmpty
         String componentId)

Sets the ID of this component. The component must not be initialized or destroyed.

Parameters:

componentId - ID of the component

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.

Overrides:

doInitialize in class AbstractDestructableInitializableComponent

Throws:

ComponentInitializationException - thrown if there is a problem initializing the component