Package org.alfresco.repo.module

Class ImporterModuleComponent

java.lang.Object

org.alfresco.repo.module.AbstractModuleComponent

org.alfresco.repo.module.ImporterModuleComponent

All Implemented Interfaces:

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

@AlfrescoPublicApi
public class ImporterModuleComponent
extends AbstractModuleComponent

Generic module component that can be wired up to import data into the system.

Since:

2.0

Author:

Derek Hulley

Field Summary

Fields inherited from class org.alfresco.repo.module.AbstractModuleComponent

authenticationComponent, moduleService, serviceRegistry

Constructor Summary

Constructors

Constructor	Description
ImporterModuleComponent()

Method Summary

Modifier and Type	Method	Description
protected void	checkProperties()	Checks for the presence of all generally-required properties.
protected void	executeInternal()	The method that performs the actual work.
void	setBootstrapView(java.util.Properties bootstrapView)	Set a list of bootstrap views to import. This is an alternative to setBootstrapViews(List).
void	setBootstrapViews(java.util.List<java.util.Properties> bootstrapViews)	Set a list of bootstrap views to import. This is an alternative to setBootstrapView(Properties).
void	setImporter(ImporterBootstrap importer)	Set the helper that has details of the store to load the data into.

Methods inherited from class org.alfresco.repo.module.AbstractModuleComponent

equals, execute, getAppliesFromVersionNumber, getAppliesToVersionNumber, getDependsOn, getDescription, getModuleId, getName, getSinceVersionNumber, hashCode, init, isExecuteOnceOnly, setAppliesFromVersion, setAppliesToVersion, setAuthenticationComponent, setBeanName, setDependsOn, setDescription, setExecuteOnceOnly, setModuleId, setModuleService, setName, setServiceRegistry, setSinceVersion, setTenantAdminService, shutdown, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ImporterModuleComponent

public ImporterModuleComponent()

Method Detail

setImporter

public void setImporter(ImporterBootstrap importer)

Set the helper that has details of the store to load the data into. Alfresco has a set of predefined importers for all the common stores in use.

Parameters:

importer - the bootstrap bean that performs the store bootstrap.

setBootstrapView

public void setBootstrapView(java.util.Properties bootstrapView)

Set a list of bootstrap views to import.
This is an alternative to setBootstrapViews(List).

Parameters:

bootstrapView - the bootstrap data location

See Also:

ImporterBootstrap.setBootstrapViews(List)

setBootstrapViews

public void setBootstrapViews(java.util.List<java.util.Properties> bootstrapViews)

Set a list of bootstrap views to import.
This is an alternative to setBootstrapView(Properties).

Parameters:

bootstrapViews - the bootstrap data locations

See Also:

ImporterBootstrap.setBootstrapViews(List)

checkProperties

protected void checkProperties()

Description copied from class: AbstractModuleComponent

Checks for the presence of all generally-required properties.

Overrides:

checkProperties in class AbstractModuleComponent

executeInternal

protected void executeInternal()
                        throws java.lang.Throwable

Description copied from class: AbstractModuleComponent

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

Specified by:

executeInternal in class AbstractModuleComponent

Throws:

java.lang.Throwable - any problems, just throw them