Package org.alfresco.repo.action.executer

Class ImporterActionExecuter

java.lang.Object

org.alfresco.repo.action.CommonResourceAbstractBase

org.alfresco.repo.action.ParameterizedItemAbstractBase

org.alfresco.repo.action.executer.ActionExecuterAbstractBase

org.alfresco.repo.action.executer.ImporterActionExecuter

All Implemented Interfaces:

ActionExecuter, LoggingAwareExecuter, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

public class ImporterActionExecuter
extends ActionExecuterAbstractBase

Importer action executor

Author:

gavinc

Field Summary

Fields

Modifier and Type	Field	Description
static String	ARCHIVE_CONTAINS_SUSPICIOUS_PATHS_ERROR
static String	NAME
static String	PARAM_DESTINATION_FOLDER
static String	PARAM_ENCODING

Fields inherited from class org.alfresco.repo.action.executer.ActionExecuterAbstractBase

actionAccessRestrictions, actionDefinition, applicableTypes, publicAction

Fields inherited from class org.alfresco.repo.action.ParameterizedItemAbstractBase

adhocPropertiesAllowed, DISPLAY_LABEL, runtimeActionService

Fields inherited from class org.alfresco.repo.action.CommonResourceAbstractBase

name

Fields inherited from interface org.alfresco.repo.action.executer.ActionExecuter

PARAM_RESULT

Constructor Summary

Constructors

Constructor	Description
ImporterActionExecuter()

Method Summary

Modifier and Type	Method	Description
protected void	addParameterDefinitions(List<ParameterDefinition> paramList)	Adds the parameter definitions to the list
static void	deleteDir(File dir)	Recursively delete a dir of files and directories
void	executeImpl(Action ruleAction, NodeRef actionedUponNodeRef)	Execute the action implementation
static void	extractFile(org.apache.commons.compress.archivers.zip.ZipFile archive, String extractDir)	Extract the file and folder structure of a ZIP file into the specified directory
static void	extractFile(org.apache.commons.compress.archivers.zip.ZipFile archive, String extractDir, org.alfresco.repo.action.executer.ImporterActionExecuter.ExtractionProgressTracker tracker)	Extract the file and folder structure of a ZIP file into the specified directory using a progress tracker
boolean	isHighByteZip()
void	setContentService(ContentService contentService)	Sets the ContentService to use
void	setFileFolderService(FileFolderService fileFolderService)	Sets the FileFolderService to use
void	setHighByteZip(boolean highByteZip)
void	setImporterService(ImporterService importerService)	Sets the ImporterService to use
void	setNodeService(NodeService nodeService)	Sets the NodeService to use
void	setRatioThreshold(long ratioThreshold)
void	setUncompressedBytesLimit(String limit)	This method sets a value for the uncompressed bytes limit.

Methods inherited from class org.alfresco.repo.action.executer.ActionExecuterAbstractBase

createActionDefinition, execute, getActionAccessRestrictions, getActionDefinition, getIgnoreLock, getQueueName, getTrackStatus, init, isApplicableType, onLogException, setActionAccessRestrictions, setApplicableTypes, setBaseNodeService, setDictionaryService, setIgnoreLock, setLockService, setMlAwareNodeService, setPublicAction, setQueueName, setTrackStatus, verifyActionAccessRestrictions

Methods inherited from class org.alfresco.repo.action.ParameterizedItemAbstractBase

checkMandatoryProperties, getAdhocPropertiesAllowed, getDescriptionKey, getLocalizedParameterDefinitions, getParamDisplayLabel, getParamDisplayLabel, getParameterDefintions, getTitleKey, setAdhocPropertiesAllowed, setLocales, setRuntimeActionService, toString

Methods inherited from class org.alfresco.repo.action.CommonResourceAbstractBase

setBeanName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.alfresco.repo.action.executer.ActionExecuter

isExecuteAsynchronously

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

PARAM_ENCODING

public static final String PARAM_ENCODING

See Also:

Constant Field Values

PARAM_DESTINATION_FOLDER

public static final String PARAM_DESTINATION_FOLDER

See Also:

Constant Field Values

ARCHIVE_CONTAINS_SUSPICIOUS_PATHS_ERROR

public static final String ARCHIVE_CONTAINS_SUSPICIOUS_PATHS_ERROR

See Also:

Constant Field Values

Constructor Detail

ImporterActionExecuter

public ImporterActionExecuter()

Method Detail

setImporterService

public void setImporterService(ImporterService importerService)

Sets the ImporterService to use

Parameters:

importerService - The ImporterService

setNodeService

public void setNodeService(NodeService nodeService)

Sets the NodeService to use

Parameters:

nodeService - The NodeService

setContentService

public void setContentService(ContentService contentService)

Sets the ContentService to use

Parameters:

contentService - The ContentService

setFileFolderService

public void setFileFolderService(FileFolderService fileFolderService)

Sets the FileFolderService to use

Parameters:

fileFolderService - The FileFolderService

isHighByteZip

public boolean isHighByteZip()

Returns:

the highByteZip encoding switch

setHighByteZip

public void setHighByteZip(boolean highByteZip)

Parameters:

highByteZip - the encoding switch for high-byte ZIP filenames to set

setRatioThreshold

public void setRatioThreshold(long ratioThreshold)

Parameters:

ratioThreshold - the compression ratio threshold for Zip bomb detection

setUncompressedBytesLimit

public void setUncompressedBytesLimit(String limit)

This method sets a value for the uncompressed bytes limit. If the string does not parse to a java long.

Parameters:

limit - a String representing a valid Java long.

executeImpl

public void executeImpl(Action ruleAction,
                        NodeRef actionedUponNodeRef)

Description copied from class: ActionExecuterAbstractBase

Execute the action implementation

Specified by:

executeImpl in class ActionExecuterAbstractBase

Parameters:

ruleAction - the action

actionedUponNodeRef - the actioned upon node

See Also:

ActionExecuter.execute(Action, NodeRef)

addParameterDefinitions

protected void addParameterDefinitions(List<ParameterDefinition> paramList)

Description copied from class: ParameterizedItemAbstractBase

Adds the parameter definitions to the list

Specified by:

addParameterDefinitions in class ParameterizedItemAbstractBase

Parameters:

paramList - the parameter definitions list

See Also:

ParameterizedItemAbstractBase.addParameterDefinitions(java.util.List)

extractFile

public static void extractFile(org.apache.commons.compress.archivers.zip.ZipFile archive,
                               String extractDir)

Extract the file and folder structure of a ZIP file into the specified directory

Parameters:

archive - The ZIP archive to extract

extractDir - The directory to extract into

extractFile

public static void extractFile(org.apache.commons.compress.archivers.zip.ZipFile archive,
                               String extractDir,
                               org.alfresco.repo.action.executer.ImporterActionExecuter.ExtractionProgressTracker tracker)

Extract the file and folder structure of a ZIP file into the specified directory using a progress tracker

Parameters:

archive - The ZIP archive to extract

extractDir - The directory to extract into

tracker - The extraction progress tracker to check against during the extraction process

deleteDir

public static void deleteDir(File dir)

Recursively delete a dir of files and directories

Parameters:

dir - directory to delete