org.alfresco.repo.admin.patch.impl
Class ScriptsFolderPatch

java.lang.Object
  extended by org.alfresco.repo.admin.patch.AbstractPatch
      extended by org.alfresco.repo.admin.patch.impl.ScriptsFolderPatch
All Implemented Interfaces:
Patch, org.springframework.context.ApplicationEventPublisherAware

public class ScriptsFolderPatch
extends AbstractPatch

Ensures that the scripts folder is present.

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

This class should be replaced with a more generic ImporterPatch that can do conditional importing into given locations.

JIRA: AR-342


Field Summary
protected  java.util.Properties configuration
           
protected  NodeRef dictionaryNodeRef
           
static java.lang.String PROPERTY_COMPANY_HOME_CHILDNAME
           
static java.lang.String PROPERTY_DICTIONARY_CHILDNAME
           
static java.lang.String PROPERTY_SCRIPTS_FOLDER_CHILDNAME
           
protected  NodeRef scriptsFolderNodeRef
           
 
Fields inherited from class org.alfresco.repo.admin.patch.AbstractPatch
applicationEventPublisher, authenticationContext, ERR_PROPERTY_NOT_SET, namespaceService, nodeService, searchService, tenantAdminService, transactionService
 
Constructor Summary
ScriptsFolderPatch()
           
 
Method Summary
protected  java.lang.String applyInternal()
          This method does the work.
protected  void checkCommonProperties()
          Ensure that required common properties have been set
 void setImporterBootstrap(ImporterBootstrap importerBootstrap)
           
 void setImporterService(ImporterService importerService)
           
 void setMessageSource(org.springframework.context.MessageSource messageSource)
           
 void setScriptsACP(java.lang.String scriptsACP)
           
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, checkProperties, checkPropertyNotNull, getAlternatives, getDependsOn, getDescription, getFixesFromSchema, getFixesToSchema, getId, getTargetSchema, init, isForce, reportProgress, setAlternatives, setApplicationEventPublisher, setApplyToTenants, setAuthenticationContext, setDependsOn, setDescription, setFixesFromSchema, setFixesToSchema, setForce, setId, setNamespaceService, setNodeService, setPatchService, 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_COMPANY_HOME_CHILDNAME

public static final java.lang.String PROPERTY_COMPANY_HOME_CHILDNAME
See Also:
Constant Field Values

PROPERTY_DICTIONARY_CHILDNAME

public static final java.lang.String PROPERTY_DICTIONARY_CHILDNAME
See Also:
Constant Field Values

PROPERTY_SCRIPTS_FOLDER_CHILDNAME

public static final java.lang.String PROPERTY_SCRIPTS_FOLDER_CHILDNAME
See Also:
Constant Field Values

dictionaryNodeRef

protected NodeRef dictionaryNodeRef

configuration

protected java.util.Properties configuration

scriptsFolderNodeRef

protected NodeRef scriptsFolderNodeRef
Constructor Detail

ScriptsFolderPatch

public ScriptsFolderPatch()
Method Detail

setImporterBootstrap

public void setImporterBootstrap(ImporterBootstrap importerBootstrap)

setImporterService

public void setImporterService(ImporterService importerService)

setMessageSource

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

setScriptsACP

public void setScriptsACP(java.lang.String scriptsACP)

checkCommonProperties

protected void checkCommonProperties()
                              throws java.lang.Exception
Ensure that required common properties have been set

Throws:
java.lang.Exception

setUp

protected void setUp()
              throws java.lang.Exception
Extracts pertinent references and properties that are common to execution of this and derived patches.

Throws:
java.lang.Exception

applyInternal

protected java.lang.String applyInternal()
                                  throws java.lang.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:
java.lang.Exception - anything can be thrown. This must be used for all failures.
See Also:
AbstractPatch.apply()


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.