net.shibboleth.metadata.pipeline
Interface Component

All Known Subinterfaces:

Pipeline<ItemType>, Stage<ItemType>

All Known Implementing Classes:

AbstractComponent, AbstractItemMetadataSelectionStage, AbstractXSLProcessingStage, BaseIteratingStage, BaseStage, CompositeStage, DomFilesystemSourceStage, DomResourceSourceStage, EntitiesDescriptorAssemblerStage, EntitiesDescriptorDisassemblerStage, EntityDescriptorItemIdPopulationStage, EntityFilterStage, EntityPublisherPathFilterStage, EntityRegistrationAuthorityFilterStage, EntityRoleFilterStage, ItemMetadataFilterStage, ItemMetadataTerminationStage, MultiOutputXSLTransformationStage, PipelineDemultiplexerStage, PipelineMergeStage, PullUpCacheDurationStage, PullUpValidUntilStage, PushDownCacheDurationStage, PushDownValidUntilStage, RemoveContactPersonStage, RemoveOrganizationStage, ScriptletStage, SerializationStage, SetCacheDurationStage, SetPublicationInfo, SetValidUntilStage, SimplePipeline, SplitMergeStage, StaticItemSourceStage, StatusMetadataLoggingStage, ValidateValidUntilStage, XMLSchemaValidationStage, XMLSignatureSigningStage, XMLSignatureValidationStage, XPathFilteringStage, XSLTransformationStage, XSLValidationStage

public interface Component

Base interface for all the components of a Pipeline, including the pipeline itself.

Method Summary

String	getId() Gets a unique identifier for the component.
DateTime	getInitializationInstant() Gets the instant the component was initialized.
void	initialize() Initializes the component.
boolean	isInitialized() Checks whether the component has been initialized.

Method Detail

getId

String getId()

Gets a unique identifier for the component.

Returns:

unique identifier for the component

isInitialized

boolean isInitialized()

Checks whether the component has been initialized.

Returns:

whether the component has been initialized

initialize

void initialize()
                throws ComponentInitializationException

Initializes the component. Once a component has been initialized this method will throw an IllegalStateException.

Throws:

ComponentInitializationException - thrown if there is a problem initializing the component for use

getInitializationInstant

DateTime getInitializationInstant()

Gets the instant the component was initialized. All instants are given in UTC time.

Returns:

instant the component was initialized