net.shibboleth.utilities.java.support.component

Class AbstractIdentifiedInitializableComponent

java.lang.Object

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

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

All Implemented Interfaces:

Component, DestructableComponent, IdentifiedComponent, InitializableComponent

Direct Known Subclasses:

AbstractIdentifiableInitializableComponent

public abstract class AbstractIdentifiedInitializableComponent
extends AbstractInitializableComponent
implements IdentifiedComponent

Simple implementation of InitializableComponent and IdentifiedComponent. Note, this class synchronizes the setId(String) method and, if the component is already initialized this method is treated as no-op.

Field Summary

Fields

Modifier and Type	Field and Description
private String	id The unique identifier for this component.

Constructor Summary

Constructors

Constructor and Description
AbstractIdentifiedInitializableComponent()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doInitialize() This method checks to ensure that the component ID is not null.
String	getId() Get 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.AbstractInitializableComponent

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

The unique identifier for this component.

Constructor Detail

AbstractIdentifiedInitializableComponent

public AbstractIdentifiedInitializableComponent()

Method Detail

getId

@Nullable
@NonnullAfterInit
public String getId()

Get the ID of this component.

Specified by:

getId in interface IdentifiedComponent

Returns:

ID of this component or null

setId

protected void setId(@Nonnull@NotEmpty
         String componentId)

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

Parameters:

componentId - ID of the component

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

This method checks to ensure that the component ID is not null. 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 AbstractInitializableComponent

Throws:

ComponentInitializationException - thrown if there is a problem initializing the component