Merged DEV\EXTENSIONS to HEAD

svn merge svn://svn.alfresco.com:3691/alfresco/BRANCHES/DEV/EXTENSIONS@4868 svn://svn.alfresco.com:3691/alfresco/BRANCHES/DEV/EXTENSIONS@4869 . svn merge svn://svn.alfresco.com:3691/alfresco/BRANCHES/DEV/EXTENSIONS@4904 svn://svn.alfresco.com:3691/alfresco/BRANCHES/DEV/EXTENSIONS@4938 . Module management support Modularization of Records Management git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@4956 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2025-07-24 17:32:48 +00:00 · 2007-01-29 14:43:37 +00:00
parent 0e3da160a2
commit f047c6baaf
42 changed files with 3324 additions and 664 deletions
--- a/source/java/org/alfresco/repo/module/ModuleComponent.java
+++ b/source/java/org/alfresco/repo/module/ModuleComponent.java
@@ -0,0 +1,93 @@
+/*
+ * Copyright (C) 2007 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.alfresco.repo.module;
+
+import java.util.List;
+
+import org.alfresco.util.VersionNumber;
+
+/**
+ * Interface for classes that control the startup and shutdown behaviour of modules.
+ * <p/>
+ * 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.
+ * <p/>
+ * Equals and Hashcode method must be implemented.
+ * 
+ * @author Derek Hulley
+ * @since 2.0
+ */
+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.
+     */
+    VersionNumber getSinceVersionNumber();
+    
+    /**
+     * @return Returns the smallest version number of the module to which this component applies.
+     */
+    VersionNumber getAppliesFromVersionNumber();
+    
+    /**
+     * @return Returns the largest version number of the module to which this component applies.
+     */
+    VersionNumber getAppliesToVersionNumber();
+    
+    /**
+     * A list of module components that <b>must</b> 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<ModuleComponent> getDependsOn();
+    
+    /**
+     * @return Returns <tt>true</tt> if the component is to be successfully executed exactly once,
+     *      or <tt>false</tt> if the component must be executed with each startup.
+     */
+    boolean isExecuteOnceOnly();
+    
+    /**
+     * Perform the actual component's work.  Execution will be done within the context of a
+     * system account with an enclosing transaction.  Long-running processes should be spawned
+     * from the calling thread, if required.
+     * <p/>
+     * All failures should just be thrown out as runtime exceptions and will be dealt with by
+     * the associated module infrastructure.
+     */
+    void execute();
+}