Package org.alfresco.repo.replication

Class ReplicationActionExecutor

java.lang.Object

org.alfresco.repo.action.CommonResourceAbstractBase

org.alfresco.repo.action.ParameterizedItemAbstractBase

org.alfresco.repo.action.executer.ActionExecuterAbstractBase

org.alfresco.repo.replication.ReplicationActionExecutor

All Implemented Interfaces:

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

public class ReplicationActionExecutor
extends ActionExecuterAbstractBase

Since:

3.4

Author:

Nick Burch

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ReplicationActionExecutor.ReplicationDefinitionLockExtender	A TransferCallback which periodically renews the lock held against a ReplicationDefinition

Field Summary

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

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

Method Summary

Modifier and Type	Method	Description
protected void	addParameterDefinitions(java.util.List<ParameterDefinition> paramList)	Adds the parameter definitions to the list
protected TransferDefinition	buildTransferDefinition(ReplicationDefinition replicationDef, java.util.Set<org.alfresco.service.cmr.repository.NodeRef> toTransfer)	Takes a ReplicationDefinition and a list of NodeRefs, and returns the TransferDefinition which will allow the replication to be run.
protected void	executeImpl(Action action, org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef)	Execute the action implementation
protected java.util.Set<org.alfresco.service.cmr.repository.NodeRef>	expandPayload(ReplicationDefinition replicationDef)	Takes a ReplicationDefinition, which contains one or more payloads NodeRefs, and expands them into a full list of nodes to be transfered.
boolean	onLogException(org.apache.commons.logging.Log logger, java.lang.Throwable t, java.lang.String message)	Optional logging of errors callback for the action executer for the cases when the error might be ignored or shown in a different manner for the action
void	setActionTrackingService(ActionTrackingService actionTrackingService)	Injects the ActionTrackingService bean.
void	setExcludedAspects(java.lang.String[] excludedAspects)
void	setJobLockService(JobLockService jobLockService)	Injects the JobLockService bean.
void	setNodeCrawlerFactory(NodeCrawlerFactory nodeCrawlerFactory)	Injects the NodeCrawlerFactory bean.
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)	Injects the NodeService bean.
void	setReplicationDefinitionPersister(ReplicationDefinitionPersisterImpl replicationDefinitionPersister)	Injects the ReplicationDefinitionPersister bean.
void	setReplicationParams(ReplicationParams replicationParams)	Sets Replication Parameters
void	setTransactionService(TransactionService transactionService)	Injects the TransactionService bean.
void	setTransferService(TransferService2 transferService)	Injects the TransferService bean.

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

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

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

Constructor Detail

ReplicationActionExecutor

public ReplicationActionExecutor()

Method Detail

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

Injects the NodeService bean.

Parameters:

nodeService - the NodeService.

setJobLockService

public void setJobLockService(JobLockService jobLockService)

Injects the JobLockService bean.

Parameters:

jobLockService - the JobLockService.

setTransferService

public void setTransferService(TransferService2 transferService)

Injects the TransferService bean.

Parameters:

transferService - the TransferService.

setNodeCrawlerFactory

public void setNodeCrawlerFactory(NodeCrawlerFactory nodeCrawlerFactory)

Injects the NodeCrawlerFactory bean.

Parameters:

nodeCrawlerFactory - the NodeCrawlerFactory.

setActionTrackingService

public void setActionTrackingService(ActionTrackingService actionTrackingService)

Injects the ActionTrackingService bean.

Parameters:

actionTrackingService - the ActionTrackingService.

setTransactionService

public void setTransactionService(TransactionService transactionService)

Injects the TransactionService bean.

Parameters:

transactionService - the TransactionService.

setReplicationDefinitionPersister

public void setReplicationDefinitionPersister(ReplicationDefinitionPersisterImpl replicationDefinitionPersister)

Injects the ReplicationDefinitionPersister bean.

Parameters:

replicationDefinitionPersister - ReplicationDefinitionPersisterImpl

setReplicationParams

public void setReplicationParams(ReplicationParams replicationParams)

Sets Replication Parameters

Parameters:

replicationParams - replication parameters

setExcludedAspects

public void setExcludedAspects(java.lang.String[] excludedAspects)

addParameterDefinitions

protected void addParameterDefinitions(java.util.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

expandPayload

protected java.util.Set<org.alfresco.service.cmr.repository.NodeRef> expandPayload(ReplicationDefinition replicationDef)

Takes a ReplicationDefinition, which contains one or more payloads NodeRefs, and expands them into a full list of nodes to be transfered.

buildTransferDefinition

protected TransferDefinition buildTransferDefinition(ReplicationDefinition replicationDef,
                                                     java.util.Set<org.alfresco.service.cmr.repository.NodeRef> toTransfer)

Takes a ReplicationDefinition and a list of NodeRefs, and returns the TransferDefinition which will allow the replication to be run.

executeImpl

protected void executeImpl(Action action,
                           org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef)

Description copied from class: ActionExecuterAbstractBase

Execute the action implementation

Specified by:

executeImpl in class ActionExecuterAbstractBase

Parameters:

action - the action

actionedUponNodeRef - the actioned upon node

onLogException

public boolean onLogException(org.apache.commons.logging.Log logger,
                              java.lang.Throwable t,
                              java.lang.String message)

Description copied from interface: LoggingAwareExecuter

Optional logging of errors callback for the action executer for the cases when the error might be ignored or shown in a different manner for the action

Specified by:

onLogException in interface LoggingAwareExecuter

Overrides:

onLogException in class ActionExecuterAbstractBase

Parameters:

logger - the logger

t - the exception thrown

message - the proposed message that will be logged

Returns:

true if it was handled, false for default handling