org.alfresco.repo.admin.patch.impl

Class WCMFoldersPatch

java.lang.Object

org.alfresco.repo.admin.patch.AbstractPatch

org.alfresco.repo.admin.patch.impl.WCMFoldersPatch

All Implemented Interfaces:

Patch, org.springframework.context.ApplicationEventPublisherAware

public class WCMFoldersPatch
extends AbstractPatch

Ensures that the Web Projects and Web Formsfolders are present.

This uses the bootstrap importer to get the paths to look for. If not present, the required structures are created.

Author:

Kevin Roast

Field Summary

Fields

Modifier and Type	Field and Description
protected org.alfresco.service.cmr.repository.NodeRef	companyHomeNodeRef
protected Properties	configuration
protected org.alfresco.service.cmr.repository.NodeRef	dictionaryNodeRef
static String	PROPERTY_WEBFORMS_FOLDER_CHILDNAME
static String	PROPERTY_WEBPROJECTS_FOLDER_CHILDNAME
protected org.alfresco.service.cmr.repository.NodeRef	wcmFormsFolderNodeRef
protected org.alfresco.service.cmr.repository.NodeRef	wcmProjectsFolderNodeRef

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
WCMFoldersPatch()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	applyInternal() This method does the work.
protected void	checkCommonProperties() Ensure that required common properties have been set
void	setImporterBootstrap(ImporterBootstrap importerBootstrap)
void	setMessageSource(org.springframework.context.MessageSource messageSource)
protected void	setUp() Extracts pertinent references and properties that are common to execution of this and derived patches.

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

applies, apply, applyAsync, checkProperties, 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

PROPERTY_WEBPROJECTS_FOLDER_CHILDNAME

public static final String PROPERTY_WEBPROJECTS_FOLDER_CHILDNAME

See Also:

Constant Field Values

PROPERTY_WEBFORMS_FOLDER_CHILDNAME

public static final String PROPERTY_WEBFORMS_FOLDER_CHILDNAME

See Also:

Constant Field Values

companyHomeNodeRef

protected org.alfresco.service.cmr.repository.NodeRef companyHomeNodeRef

dictionaryNodeRef

protected org.alfresco.service.cmr.repository.NodeRef dictionaryNodeRef

configuration

protected Properties configuration

wcmProjectsFolderNodeRef

protected org.alfresco.service.cmr.repository.NodeRef wcmProjectsFolderNodeRef

wcmFormsFolderNodeRef

protected org.alfresco.service.cmr.repository.NodeRef wcmFormsFolderNodeRef

Constructor Detail

WCMFoldersPatch

public WCMFoldersPatch()

Method Detail

setImporterBootstrap

public void setImporterBootstrap(ImporterBootstrap importerBootstrap)

setMessageSource

public void setMessageSource(org.springframework.context.MessageSource messageSource)

checkCommonProperties

protected void checkCommonProperties()
                              throws Exception

Ensure that required common properties have been set

Throws:

Exception

setUp

protected void setUp()
              throws Exception

Extracts pertinent references and properties that are common to execution of this and derived patches.

Throws:

Exception

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()