package org.alfresco.repo.module; import java.util.List; import org.alfresco.api.AlfrescoPublicApi; import org.alfresco.util.VersionNumber; /** * Interface for classes that control the startup and shutdown behaviour of modules. *
* Note that the execution order of these components is on the basis of dependencies * only. The version numbering determines only whether a component will be executed * and doesn't imply any ordering. * * Equals and Hashcode method must be implemented. * * @author Derek Hulley * @since 2.0 */ @AlfrescoPublicApi public interface ModuleComponent { /** * @return Returns the globally unique module ID. */ String getModuleId(); /** * @return Returns the name of the component in the context of the module ID. It does not * have to be globally unique. */ String getName(); /** * * @return Returns a description of the component. */ String getDescription(); /** * @return Returns the version number of the module for which this component was introduced. */ ModuleVersionNumber getSinceVersionNumber(); /** * @return Returns the smallest version number of the module to which this component applies. */ ModuleVersionNumber getAppliesFromVersionNumber(); /** * @return Returns the largest version number of the module to which this component applies. */ ModuleVersionNumber getAppliesToVersionNumber(); /** * A list of module components that must be executed prior to this instance. * This is the only way to guarantee ordered execution. The dependencies may include * components from other modules, guaranteeing an early failure if a module is missing. * * @return Returns a list of components that must be executed prior to this component. */ List