mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-07-24 17:32:48 +00:00
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
This commit is contained in:
Derek Hulley
@@ -0,0 +1,348 @@
|
||||
/*
|
||||
* 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.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
import org.alfresco.error.AlfrescoRuntimeException;
|
||||
import org.alfresco.i18n.I18NUtil;
|
||||
import org.alfresco.repo.security.authentication.AuthenticationComponent;
|
||||
import org.alfresco.service.ServiceRegistry;
|
||||
import org.alfresco.service.cmr.module.ModuleService;
|
||||
import org.alfresco.util.EqualsHelper;
|
||||
import org.alfresco.util.PropertyCheck;
|
||||
import org.alfresco.util.VersionNumber;
|
||||
import org.springframework.beans.factory.BeanNameAware;
|
||||
|
||||
/**
|
||||
* Implementation of a {@link org.alfresco.repo.module.ModuleComponent} to provide
|
||||
* the basic necessities.
|
||||
*
|
||||
* @see #executeInternal()
|
||||
*
|
||||
* @author Roy Wetherall
|
||||
* @author Derek Hulley
|
||||
* @since 2.0
|
||||
*/
|
||||
public abstract class AbstractModuleComponent implements ModuleComponent, BeanNameAware
|
||||
{
|
||||
private static final String ERR_ALREADY_EXECUTED = "module.err.already_executed";
|
||||
private static final String ERR_EXECUTION_FAILED = "module.err.execution_failed";
|
||||
|
||||
// Supporting components
|
||||
protected ServiceRegistry serviceRegistry;
|
||||
protected AuthenticationComponent authenticationComponent;
|
||||
protected ModuleService moduleService;
|
||||
|
||||
private String moduleId;
|
||||
private String name;
|
||||
private String description;
|
||||
private VersionNumber sinceVersion;
|
||||
private VersionNumber appliesFromVersion;
|
||||
private VersionNumber appliesToVersion;
|
||||
private List<ModuleComponent> dependsOn;
|
||||
/** Defaults to <tt>true</tt> */
|
||||
private boolean executeOnceOnly;
|
||||
private boolean executed;
|
||||
|
||||
public AbstractModuleComponent()
|
||||
{
|
||||
sinceVersion = VersionNumber.VERSION_ZERO;
|
||||
appliesFromVersion = VersionNumber.VERSION_ZERO;
|
||||
appliesToVersion = VersionNumber.VERSION_BIG;
|
||||
dependsOn = new ArrayList<ModuleComponent>(0);
|
||||
executeOnceOnly = true;
|
||||
executed = false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks for the presence of all generally-required properties.
|
||||
*/
|
||||
protected void checkProperties()
|
||||
{
|
||||
PropertyCheck.mandatory(this, "serviceRegistry", serviceRegistry);
|
||||
PropertyCheck.mandatory(this, "authenticationComponent", authenticationComponent);
|
||||
PropertyCheck.mandatory(this, "moduleId", moduleId);
|
||||
PropertyCheck.mandatory(this, "name", name);
|
||||
PropertyCheck.mandatory(this, "sinceVersion", sinceVersion);
|
||||
PropertyCheck.mandatory(this, "appliesFromVersion", appliesFromVersion);
|
||||
PropertyCheck.mandatory(this, "appliesToVersion", appliesToVersion);
|
||||
}
|
||||
|
||||
/**
|
||||
* @see #getModuleId()
|
||||
* @see #getName()
|
||||
*/
|
||||
@Override
|
||||
public String toString()
|
||||
{
|
||||
StringBuilder sb = new StringBuilder(128);
|
||||
sb.append("ModuleComponent")
|
||||
.append("[ module=").append(moduleId)
|
||||
.append(", name=").append(name)
|
||||
.append(", since=").append(sinceVersion)
|
||||
.append(", appliesFrom=").append(appliesFromVersion)
|
||||
.append(", appliesTo=").append(appliesToVersion)
|
||||
.append(", onceOnly=").append(executeOnceOnly)
|
||||
.append("]");
|
||||
return sb.toString();
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean equals(Object obj)
|
||||
{
|
||||
if (this == obj)
|
||||
{
|
||||
return true;
|
||||
}
|
||||
if (false == obj instanceof ModuleComponent)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
ModuleComponent that = (ModuleComponent) obj;
|
||||
return (EqualsHelper.nullSafeEquals(this.moduleId, that.getModuleId())
|
||||
&& EqualsHelper.nullSafeEquals(this.name, that.getName()));
|
||||
}
|
||||
|
||||
@Override
|
||||
public int hashCode()
|
||||
{
|
||||
return moduleId.hashCode() + 17 * name.hashCode();
|
||||
}
|
||||
|
||||
public void setAuthenticationComponent(AuthenticationComponent authenticationComponent)
|
||||
{
|
||||
this.authenticationComponent = authenticationComponent;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the module service to register with. If not set, the component will not be
|
||||
* automatically started.
|
||||
*
|
||||
* @param moduleService the service to register against. This is optional.
|
||||
*/
|
||||
public void setModuleService(ModuleService moduleService)
|
||||
{
|
||||
this.moduleService = moduleService;
|
||||
}
|
||||
|
||||
public void setServiceRegistry(ServiceRegistry serviceRegistry)
|
||||
{
|
||||
this.serviceRegistry = serviceRegistry;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public String getModuleId()
|
||||
{
|
||||
return moduleId;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param moduleId the globally unique module name.
|
||||
*/
|
||||
public void setModuleId(String moduleId)
|
||||
{
|
||||
this.moduleId = moduleId;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public String getName()
|
||||
{
|
||||
return name;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the component name, which must be unique within the context of the
|
||||
* module. If the is not set, then the bean name will be used.
|
||||
*
|
||||
* @param name the name of the component within the module.
|
||||
*
|
||||
* @see #setBeanName(String)
|
||||
*/
|
||||
public void setName(String name)
|
||||
{
|
||||
this.name = name;
|
||||
}
|
||||
|
||||
/**
|
||||
* Convenience method that will set the name of the component to
|
||||
* match the bean name, unless the {@link #setName(String) name} has
|
||||
* been explicitly set.
|
||||
*/
|
||||
public void setBeanName(String name)
|
||||
{
|
||||
setName(name);
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public String getDescription()
|
||||
{
|
||||
return description;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the component's description. This will automatically be I18N'ized, so it may just
|
||||
* be a resource bundle key.
|
||||
*
|
||||
* @param description a description of the component.
|
||||
*/
|
||||
public void setDescription(String description)
|
||||
{
|
||||
this.description = description;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public VersionNumber getSinceVersionNumber()
|
||||
{
|
||||
return sinceVersion;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the version number for which this component was added.
|
||||
*/
|
||||
public void setSinceVersion(String version)
|
||||
{
|
||||
this.sinceVersion = new VersionNumber(version);
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public VersionNumber getAppliesFromVersionNumber()
|
||||
{
|
||||
return appliesFromVersion;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the minimum module version number to which this component applies.
|
||||
* Default <b>0.0</b>.
|
||||
*/
|
||||
public void setAppliesFromVersion(String version)
|
||||
{
|
||||
this.appliesFromVersion = new VersionNumber(version);
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public VersionNumber getAppliesToVersionNumber()
|
||||
{
|
||||
return appliesToVersion;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the minimum module version number to which this component applies.
|
||||
* Default <b>999.0</b>.
|
||||
*/
|
||||
public void setAppliesToVersion(String version)
|
||||
{
|
||||
this.appliesToVersion = new VersionNumber(version);
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public List<ModuleComponent> getDependsOn()
|
||||
{
|
||||
return dependsOn;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param dependsOn a list of modules that must be executed before this one
|
||||
*/
|
||||
public void setDependsOn(List<ModuleComponent> dependsOn)
|
||||
{
|
||||
this.dependsOn = dependsOn;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*
|
||||
* @return Returns <tt>true</tt> always. Override as required.
|
||||
*/
|
||||
public boolean isExecuteOnceOnly()
|
||||
{
|
||||
return executeOnceOnly;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param executeOnceOnly <tt>true</tt> to force execution of this component with
|
||||
* each startup or <tt>false</tt> if it must only be executed once.
|
||||
*/
|
||||
public void setExecuteOnceOnly(boolean executeOnceOnly)
|
||||
{
|
||||
this.executeOnceOnly = executeOnceOnly;
|
||||
}
|
||||
|
||||
public void init()
|
||||
{
|
||||
// Ensure that the description gets I18N'ized
|
||||
description = I18NUtil.getMessage(description);
|
||||
// Register the component with the service
|
||||
if (moduleService != null) // Allows optional registration of the component
|
||||
{
|
||||
moduleService.registerComponent(this);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* The method that performs the actual work. For the most part, derived classes will
|
||||
* only have to override this method to be fully functional.
|
||||
*
|
||||
* @throws Throwable any problems, just throw them
|
||||
*/
|
||||
protected abstract void executeInternal() throws Throwable;
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*
|
||||
* @see #executeInternal() the abstract method to be implemented by subclasses
|
||||
*/
|
||||
public final synchronized void execute()
|
||||
{
|
||||
// ensure that this has not been executed already
|
||||
if (executed)
|
||||
{
|
||||
throw AlfrescoRuntimeException.create(ERR_ALREADY_EXECUTED, moduleId, name);
|
||||
}
|
||||
// Ensure properties have been set
|
||||
checkProperties();
|
||||
// Execute
|
||||
try
|
||||
{
|
||||
executeInternal();
|
||||
}
|
||||
catch (Throwable e)
|
||||
{
|
||||
throw AlfrescoRuntimeException.create(e, ERR_EXECUTION_FAILED, name, e.getMessage());
|
||||
}
|
||||
finally
|
||||
{
|
||||
// There are no second chances
|
||||
executed = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user