org.alfresco.repo.admin.patch.impl

Class GenericBootstrapPatch

java.lang.Object

org.alfresco.repo.admin.patch.AbstractPatch

org.alfresco.repo.admin.patch.impl.GenericBootstrapPatch

All Implemented Interfaces:

Patch, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationEventPublisherAware

Direct Known Subclasses:

SharedFolderPatch

public class GenericBootstrapPatch
extends AbstractPatch

Generic patch that uses existing importers to import snippets into the system. These snippets would otherwise have been bootstrapped by a clean install.

By providing this class with a bootstrap view and an importer, it can check whether the path exists and perform the import if it doesn't.

Author:

Derek Hulley

Field Summary

Fields

Modifier and Type	Field and Description
protected Properties	bootstrapView
protected String	checkPath
protected static String	ERR_MULTIPLE_FOUND
protected ImporterBootstrap	importerBootstrap
protected static String	MSG_CREATED
protected static String	MSG_DEFERRED
protected static String	MSG_EXISTS

Fields inherited from class org.alfresco.repo.admin.patch.AbstractPatch

applicationEventPublisher, authenticationContext, ERR_PROPERTY_NOT_SET, namespaceService, nodeService, patchService, searchService, tenantAdminService, transactionHelper, transactionService

Constructor Summary

Constructors

Constructor and Description
GenericBootstrapPatch()

Method Summary

Modifier and Type	Method and Description
protected String	applyInternal() This method does the work.
protected void	checkProperties() Check that the schema version properties have been set appropriately.
void	setBootstrapView(Properties bootstrapView)
void	setCheckPath(String checkPath) Set the XPath statement that must be executed to check whether the import data is already present or not.
void	setImporterBootstrap(ImporterBootstrap importerBootstrap)

Methods inherited from class org.alfresco.repo.admin.patch.AbstractPatch

applies, apply, applyAsync, checkPropertyNotNull, getAlternatives, getDependsOn, getDescription, getFixesFromSchema, getFixesToSchema, getId, getTargetSchema, init, isDeferred, isForce, isIgnored, reportProgress, requiresTransaction, setAlternatives, setApplicationEventPublisher, setApplyToTenants, setAuthenticationContext, setDeferred, setDependsOn, setDescription, setFixesFromSchema, setFixesToSchema, setForce, setId, setIgnored, setNamespaceService, setNodeService, setPatchService, setRequiresTransaction, setSearchService, setTargetSchema, setTenantAdminService, setTransactionService, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MSG_EXISTS

protected static final String MSG_EXISTS

See Also:

Constant Field Values

MSG_CREATED

protected static final String MSG_CREATED

See Also:

Constant Field Values

MSG_DEFERRED

protected static final String MSG_DEFERRED

See Also:

Constant Field Values

ERR_MULTIPLE_FOUND

protected static final String ERR_MULTIPLE_FOUND

See Also:

Constant Field Values

importerBootstrap

protected ImporterBootstrap importerBootstrap

checkPath

protected String checkPath

bootstrapView

protected Properties bootstrapView

Constructor Detail

GenericBootstrapPatch

public GenericBootstrapPatch()

Method Detail

setImporterBootstrap

public void setImporterBootstrap(ImporterBootstrap importerBootstrap)

Parameters:

importerBootstrap - the bootstrap bean that performs the user store bootstrap

setCheckPath

public void setCheckPath(String checkPath)

Set the XPath statement that must be executed to check whether the import data is already present or not.

Parameters:

checkPath - an XPath statement

setBootstrapView

public void setBootstrapView(Properties bootstrapView)

Parameters:

bootstrapView - the bootstrap location

See Also:

ImporterBootstrap.setBootstrapViews(List)

checkProperties

protected void checkProperties()

Description copied from class: AbstractPatch

Check that the schema version properties have been set appropriately. Derived classes can override this method to perform their own validation provided that this method is called by the derived class.

Overrides:

checkProperties in class AbstractPatch

applyInternal

protected String applyInternal()
                        throws Exception

Description copied from class: AbstractPatch

This method does the work. All transactions and thread-safety will be taken care of by this class. Any exception will result in the transaction being rolled back. Integrity checks are downgraded for the duration of the transaction.

Specified by:

applyInternal in class AbstractPatch

Returns:

Returns the report (only success messages).

Throws:

Exception - anything can be thrown. This must be used for all failures.

See Also:

AbstractPatch.apply()