AbstractModuleComponent (Alfresco 5.1.4.1 Public Java API)

org.alfresco.repo.module

Class AbstractModuleComponent

org.alfresco.repo.module.AbstractModuleComponent

All Implemented Interfaces:

ModuleComponent, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.Aware

Direct Known Subclasses:

@org.alfresco.api.AlfrescoPublicApi
public abstract class AbstractModuleComponent

implements ModuleComponent, org.springframework.beans.factory.BeanNameAware

Implementation of a ModuleComponent to provide the basic necessities.

Roy Wetherall, Derek Hulley

Field Summary
protected org.alfresco.repo.security.authentication.AuthenticationComponent	authenticationComponent
protected ModuleService	moduleService
protected ServiceRegistry	serviceRegistry

Constructor Summary
AbstractModuleComponent()

Method Summary
protected void	checkProperties() Checks for the presence of all generally-required properties.
boolean	equals(Object obj)
void	execute() Perform the actual component's work.
protected abstract void	executeInternal() The method that performs the actual work.
org.alfresco.repo.module.ModuleVersionNumber	getAppliesFromVersionNumber()
org.alfresco.repo.module.ModuleVersionNumber	getAppliesToVersionNumber()
List<ModuleComponent>	getDependsOn() A list of module components that must be executed prior to this instance.
String	getDescription()
String	getModuleId()
String	getName()
org.alfresco.repo.module.ModuleVersionNumber	getSinceVersionNumber()
int	hashCode()
void	init()
boolean	isExecuteOnceOnly()
void	setAppliesFromVersion(String version) Set the minimum module version number to which this component applies.
void	setAppliesToVersion(String version) Set the minimum module version number to which this component applies.
void	setAuthenticationComponent(org.alfresco.repo.security.authentication.AuthenticationComponent authenticationComponent)
void	setBeanName(String name) Convenience method that will set the name of the component to match the bean name, unless the name has been explicitly set.
void	setDependsOn(List<ModuleComponent> dependsOn)
void	setDescription(String description) Set the component's description.
void	setExecuteOnceOnly(boolean executeOnceOnly)
void	setModuleId(String moduleId)
void	setModuleService(ModuleService moduleService) Set the module service to register with.
void	setName(String name) Set the component name, which must be unique within the context of the module.
void	setServiceRegistry(ServiceRegistry serviceRegistry)
void	setSinceVersion(String version) Set the version number for which this component was added.
void	setTenantAdminService(org.alfresco.repo.tenant.TenantAdminService tenantAdminService)
void	shutdown() Perform any cleanup required to remove module.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

authenticationComponent

protected org.alfresco.repo.security.authentication.AuthenticationComponent authenticationComponent

protected ModuleService moduleService

protected ServiceRegistry serviceRegistry

AbstractModuleComponent

public AbstractModuleComponent()

protected void checkProperties()

Checks for the presence of all generally-required properties.

public String toString()

toString in class Object

public boolean equals(Object obj)

equals in class Object

public int hashCode()

hashCode in class Object

setAuthenticationComponent

public void setAuthenticationComponent(org.alfresco.repo.security.authentication.AuthenticationComponent authenticationComponent)

public void setModuleService(ModuleService moduleService)

Set the module service to register with. If not set, the component will not be automatically started.

moduleService - the service to register against. This is optional.

public void setServiceRegistry(ServiceRegistry serviceRegistry)

setTenantAdminService

public void setTenantAdminService(org.alfresco.repo.tenant.TenantAdminService tenantAdminService)

public String getModuleId()

Returns the globally unique module ID.

public void setModuleId(String moduleId)

moduleId - the globally unique module name.

public String getName()

Returns the name of the component in the context of the module ID. It does not have to be globally unique.

public void setName(String 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.

name - the name of the component within the module.

public void setBeanName(String name)

Convenience method that will set the name of the component to match the bean name, unless the name has been explicitly set.

setBeanName in interface org.springframework.beans.factory.BeanNameAware

public String getDescription()

Returns a description of the component.

public void setDescription(String description)

Set the component's description. This will automatically be I18N'ized, so it may just be a resource bundle key.

description - a description of the component.

getSinceVersionNumber

public org.alfresco.repo.module.ModuleVersionNumber getSinceVersionNumber()

Returns the version number of the module for which this component was introduced.

public void setSinceVersion(String version)

Set the version number for which this component was added.

getAppliesFromVersionNumber

public org.alfresco.repo.module.ModuleVersionNumber getAppliesFromVersionNumber()

Returns the smallest version number of the module to which this component applies.

setAppliesFromVersion

public void setAppliesFromVersion(String version)

Set the minimum module version number to which this component applies. Default 0.0.

getAppliesToVersionNumber

public org.alfresco.repo.module.ModuleVersionNumber getAppliesToVersionNumber()

Returns the largest version number of the module to which this component applies.

public void setAppliesToVersion(String version)

Set the minimum module version number to which this component applies. Default 999.0.

public List<ModuleComponent> getDependsOn()

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.

Returns a list of components that must be executed prior to this component.

public void setDependsOn(List<ModuleComponent> dependsOn)

dependsOn - a list of modules that must be executed before this one

public boolean isExecuteOnceOnly()

Returns true always. Override as required.

public void setExecuteOnceOnly(boolean executeOnceOnly)

executeOnceOnly - true to force execution of this component with each startup or false if it must only be executed once.

protected abstract void executeInternal()
throws Throwable

The method that performs the actual work. For the most part, derived classes will only have to override this method to be fully functional.

Throwable - any problems, just throw them

public final void execute()

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.

All failures should just be thrown out as runtime exceptions and will be dealt with by the associated module infrastructure.

public final void shutdown()

Description copied from interface: ModuleComponent

Perform any cleanup required to remove module.

Java API documentation generated with DocFlex/Javadoc 1.6.1 using JavadocPro template set.