mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-10-29 15:21:53 +00:00
9441ab7bd9
108512: Merged DEV to 5.0.N (5.0.3)
107232: MNT-14195 : Replication Jobs: An error is thrown every time that a scheduled job should be run if it was disabled
108319: MNT-14195 : Replication Jobs: An error is thrown every time that a scheduled job should be run if it was disabled
- added tests
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@108535 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
569 lines
20 KiB
Java
569 lines
20 KiB
Java
/*
|
|
* Copyright (C) 2005-2010 Alfresco Software Limited.
|
|
*
|
|
* This file is part of Alfresco
|
|
*
|
|
* Alfresco is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Alfresco is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
package org.alfresco.repo.replication;
|
|
|
|
import java.util.ArrayList;
|
|
import java.util.HashSet;
|
|
import java.util.List;
|
|
import java.util.Set;
|
|
|
|
import org.alfresco.model.ContentModel;
|
|
import org.alfresco.model.RenditionModel;
|
|
import org.alfresco.repo.action.ActionCancelledException;
|
|
import org.alfresco.repo.action.executer.ActionExecuterAbstractBase;
|
|
import org.alfresco.repo.lock.JobLockService;
|
|
import org.alfresco.repo.lock.LockAcquisitionException;
|
|
import org.alfresco.repo.transaction.RetryingTransactionHelper;
|
|
import org.alfresco.repo.transfer.ChildAssociatedNodeFinder;
|
|
import org.alfresco.repo.transfer.ContentClassFilter;
|
|
import org.alfresco.service.cmr.action.Action;
|
|
import org.alfresco.service.cmr.action.ActionTrackingService;
|
|
import org.alfresco.service.cmr.action.ParameterDefinition;
|
|
import org.alfresco.service.cmr.replication.DisabledReplicationJobException;
|
|
import org.alfresco.service.cmr.replication.ReplicationDefinition;
|
|
import org.alfresco.service.cmr.replication.ReplicationServiceException;
|
|
import org.alfresco.service.cmr.repository.NodeRef;
|
|
import org.alfresco.service.cmr.repository.NodeService;
|
|
import org.alfresco.service.cmr.transfer.NodeCrawler;
|
|
import org.alfresco.service.cmr.transfer.NodeCrawlerFactory;
|
|
import org.alfresco.service.cmr.transfer.TransferCallback;
|
|
import org.alfresco.service.cmr.transfer.TransferDefinition;
|
|
import org.alfresco.service.cmr.transfer.TransferEndEvent;
|
|
import org.alfresco.service.cmr.transfer.TransferEvent;
|
|
import org.alfresco.service.cmr.transfer.TransferEventBegin;
|
|
import org.alfresco.service.cmr.transfer.TransferEventCancelled;
|
|
import org.alfresco.service.cmr.transfer.TransferEventEnterState;
|
|
import org.alfresco.service.cmr.transfer.TransferEventError;
|
|
import org.alfresco.service.cmr.transfer.TransferFailureException;
|
|
import org.alfresco.service.cmr.transfer.TransferService2;
|
|
import org.alfresco.service.namespace.QName;
|
|
import org.alfresco.service.transaction.TransactionService;
|
|
import org.apache.commons.logging.Log;
|
|
import org.apache.commons.logging.LogFactory;
|
|
import org.springframework.extensions.surf.util.I18NUtil;
|
|
|
|
/**
|
|
* @author Nick Burch
|
|
* @since 3.4
|
|
*/
|
|
public class ReplicationActionExecutor extends ActionExecuterAbstractBase {
|
|
/**
|
|
* I18N labels
|
|
*/
|
|
private static final String MSG_ERR_TARGET_NOT_GIVEN = "replication.targetNotGiven";
|
|
private static final String MSG_ERR_NO_PAYLOADS_SPECIFIED = "replication.exception.noPayloadsSpecified";
|
|
private static final String MSG_ERR_REPLICATION_DEF_DISABLED = "replication.exception.replicationDefIsDisabled";
|
|
private static final String MSG_ERR_UNABLE_TO_REPLICATE = "replication.exception.unableToReplicate";
|
|
private static final String MSG_ERR_PROCESSING_PAYLOAD = "replication.exception.errorProcessingPayload";
|
|
private static final String MSG_ERR_EXECUTING_TRANSFER = "replication.exception.errorExecutingTransfer";
|
|
|
|
/**
|
|
* The logger
|
|
*/
|
|
private static Log logger = LogFactory.getLog(ReplicationActionExecutor.class);
|
|
|
|
private NodeService nodeService;
|
|
private JobLockService jobLockService;
|
|
private TransferService2 transferService;
|
|
private NodeCrawlerFactory nodeCrawlerFactory;
|
|
private ActionTrackingService actionTrackingService;
|
|
private TransactionService transactionService;
|
|
private ReplicationDefinitionPersisterImpl replicationDefinitionPersister;
|
|
private ReplicationParams replicationParams;
|
|
private List<QName> excludedAspects = new ArrayList<QName>();
|
|
|
|
/**
|
|
* By default, we lock for a minute, so if this server is shutdown another can take over a
|
|
* minute later.
|
|
*/
|
|
private long replicationActionLockDuration = 60*1000;
|
|
|
|
/**
|
|
* Injects the NodeService bean.
|
|
*
|
|
* @param nodeService the NodeService.
|
|
*/
|
|
public void setNodeService(NodeService nodeService)
|
|
{
|
|
this.nodeService = nodeService;
|
|
}
|
|
|
|
/**
|
|
* Injects the JobLockService bean.
|
|
*
|
|
* @param jobLockService the JobLockService.
|
|
*/
|
|
public void setJobLockService(JobLockService jobLockService)
|
|
{
|
|
this.jobLockService = jobLockService;
|
|
}
|
|
|
|
/**
|
|
* Injects the TransferService bean.
|
|
*
|
|
* @param transferService the TransferService.
|
|
*/
|
|
public void setTransferService(TransferService2 transferService)
|
|
{
|
|
this.transferService = transferService;
|
|
}
|
|
|
|
/**
|
|
* Injects the NodeCrawlerFactory bean.
|
|
*
|
|
* @param nodeCrawlerFactory the NodeCrawlerFactory.
|
|
*/
|
|
public void setNodeCrawlerFactory(NodeCrawlerFactory nodeCrawlerFactory)
|
|
{
|
|
this.nodeCrawlerFactory = nodeCrawlerFactory;
|
|
}
|
|
|
|
/**
|
|
* Injects the ActionTrackingService bean.
|
|
*
|
|
* @param actionTrackingService the ActionTrackingService.
|
|
*/
|
|
public void setActionTrackingService(ActionTrackingService actionTrackingService)
|
|
{
|
|
this.actionTrackingService = actionTrackingService;
|
|
}
|
|
|
|
/**
|
|
* Injects the TransactionService bean.
|
|
*
|
|
* @param transactionService the TransactionService.
|
|
*/
|
|
public void setTransactionService(TransactionService transactionService)
|
|
{
|
|
this.transactionService = transactionService;
|
|
}
|
|
|
|
/**
|
|
* Injects the ReplicationDefinitionPersister bean.
|
|
* @param replicationDefinitionPersister ReplicationDefinitionPersisterImpl
|
|
*/
|
|
public void setReplicationDefinitionPersister(ReplicationDefinitionPersisterImpl replicationDefinitionPersister)
|
|
{
|
|
this.replicationDefinitionPersister = replicationDefinitionPersister;
|
|
}
|
|
|
|
/**
|
|
* Sets Replication Parameters
|
|
*
|
|
* @param replicationParams replication parameters
|
|
*/
|
|
public void setReplicationParams(ReplicationParams replicationParams)
|
|
{
|
|
this.replicationParams = replicationParams;
|
|
}
|
|
|
|
public void setExcludedAspects(String[] excludedAspects)
|
|
{
|
|
for (String aspect : excludedAspects)
|
|
{
|
|
this.excludedAspects.add(QName.createQName(aspect));
|
|
}
|
|
}
|
|
|
|
@Override
|
|
protected void addParameterDefinitions(List<ParameterDefinition> paramList) {
|
|
// Not used - our definitions hold everything on them
|
|
}
|
|
|
|
/**
|
|
* Takes a {@link ReplicationDefinition}, which contains one or
|
|
* more payloads {@link NodeRef}s, and expands them into a
|
|
* full list of nodes to be transfered.
|
|
*/
|
|
protected Set<NodeRef> expandPayload(ReplicationDefinition replicationDef) {
|
|
// Turn our payload list of root nodes into something that
|
|
// the transfer service can work with
|
|
Set<NodeRef> toTransfer = new HashSet<NodeRef>(89);
|
|
|
|
NodeCrawler crawler = nodeCrawlerFactory.getNodeCrawler();
|
|
crawler.setNodeFinders(new ChildAssociatedNodeFinder(
|
|
ContentModel.ASSOC_CONTAINS,
|
|
RenditionModel.ASSOC_RENDITION
|
|
));
|
|
crawler.setNodeFilters(new ContentClassFilter(
|
|
ContentModel.TYPE_FOLDER,
|
|
ContentModel.TYPE_CONTENT,
|
|
ContentModel.TYPE_THUMBNAIL
|
|
));
|
|
|
|
for(NodeRef payload : replicationDef.getPayload())
|
|
{
|
|
if(nodeService.exists(payload))
|
|
{
|
|
Set<NodeRef> crawledNodes = crawler.crawl(payload);
|
|
toTransfer.addAll(crawledNodes);
|
|
}
|
|
else
|
|
{
|
|
logger.warn("Skipping replication of non-existant node " + payload);
|
|
}
|
|
}
|
|
|
|
return toTransfer;
|
|
}
|
|
/**
|
|
* Takes a {@link ReplicationDefinition} and a list of
|
|
* {@link NodeRef}s, and returns the
|
|
* {@link TransferDefinition} which will allow the
|
|
* replication to be run.
|
|
*/
|
|
protected TransferDefinition buildTransferDefinition(
|
|
ReplicationDefinition replicationDef, Set<NodeRef> toTransfer)
|
|
{
|
|
TransferDefinition transferDefinition =
|
|
new TransferDefinition();
|
|
transferDefinition.setNodes(toTransfer);
|
|
transferDefinition.setSync(true);
|
|
transferDefinition.setReadOnly(replicationParams.getTransferReadOnly());
|
|
|
|
// Exclude aspects from transfer
|
|
// NOTE: this list of aspects should be synced up with the NodeCrawler in expandPayload to
|
|
// ensure a coherent set of nodes are transferred
|
|
transferDefinition.setExcludedAspects(excludedAspects);
|
|
|
|
return transferDefinition;
|
|
}
|
|
|
|
@Override
|
|
protected void executeImpl(Action action, NodeRef actionedUponNodeRef) {
|
|
if(action instanceof ReplicationDefinition)
|
|
{
|
|
// Already of the correct type
|
|
}
|
|
else if(action.getActionDefinitionName().equals(ReplicationDefinitionImpl.EXECUTOR_NAME))
|
|
{
|
|
// Specialise the action if needed, eg when loaded directly from
|
|
// the NodeRef without going via the replication service
|
|
action = new ReplicationDefinitionImpl(action);
|
|
}
|
|
|
|
// Off we go
|
|
final ReplicationDefinition replicationDef = (ReplicationDefinition)action;
|
|
if(replicationDef.getTargetName() == null ||
|
|
replicationDef.getTargetName().equals(""))
|
|
{
|
|
throw new ReplicationServiceException(I18NUtil.getMessage(MSG_ERR_TARGET_NOT_GIVEN));
|
|
}
|
|
if(replicationDef.getPayload().size() == 0)
|
|
{
|
|
throw new ReplicationServiceException(I18NUtil.getMessage(MSG_ERR_NO_PAYLOADS_SPECIFIED));
|
|
}
|
|
if(!replicationDef.isEnabled())
|
|
{
|
|
throw new DisabledReplicationJobException(I18NUtil.getMessage(MSG_ERR_REPLICATION_DEF_DISABLED));
|
|
}
|
|
if(!replicationParams.isEnabled())
|
|
{
|
|
throw new ReplicationServiceException(I18NUtil.getMessage(MSG_ERR_UNABLE_TO_REPLICATE));
|
|
}
|
|
|
|
// Lock the service - only one instance of the replication
|
|
// should occur at a time
|
|
ReplicationDefinitionLockExtender lock =
|
|
new ReplicationDefinitionLockExtender(replicationDef);
|
|
|
|
// Turn our payload list of root nodes into something that
|
|
// the transfer service can work with
|
|
Set<NodeRef> toTransfer;
|
|
try
|
|
{
|
|
toTransfer = expandPayload(replicationDef);
|
|
}
|
|
catch(Exception e) {
|
|
lock.close();
|
|
throw new ReplicationServiceException(I18NUtil.getMessage(MSG_ERR_PROCESSING_PAYLOAD, e.getMessage()), e);
|
|
}
|
|
|
|
// Ask the transfer service to do the replication
|
|
// work for us
|
|
TransferEndEvent endEvent = null;
|
|
try
|
|
{
|
|
// Build the definition
|
|
TransferDefinition transferDefinition =
|
|
buildTransferDefinition(replicationDef, toTransfer);
|
|
|
|
// Off we go
|
|
endEvent = transferService.transfer(
|
|
replicationDef.getTargetName(),
|
|
transferDefinition,
|
|
lock);
|
|
|
|
if (endEvent instanceof TransferEventCancelled)
|
|
{
|
|
if (logger.isDebugEnabled())
|
|
logger.debug("Cancelling replication job");
|
|
|
|
// If we were cancelled, throw the magic exception so
|
|
// that this is correctly recorded
|
|
throw new ActionCancelledException(replicationDef);
|
|
}
|
|
|
|
// Record details of the transfer reports (in success case)
|
|
replicationDef.setLocalTransferReport(endEvent.getSourceReport());
|
|
replicationDef.setRemoteTransferReport(endEvent.getDestinationReport());
|
|
replicationDefinitionPersister.saveReplicationDefinition(replicationDef);
|
|
}
|
|
catch(Exception e)
|
|
{
|
|
if (e instanceof ActionCancelledException)
|
|
{
|
|
writeDefinitionReports(replicationDef, endEvent.getSourceReport(), endEvent.getDestinationReport());
|
|
throw (ActionCancelledException)e;
|
|
}
|
|
if (e instanceof TransferFailureException)
|
|
{
|
|
TransferEventError failureEndEvent = ((TransferFailureException)e).getErrorEvent();
|
|
writeDefinitionReports(replicationDef, failureEndEvent.getSourceReport(), failureEndEvent.getDestinationReport());
|
|
Throwable cause = (e.getCause() == null) ? e : e.getCause();
|
|
throw new ReplicationServiceException(I18NUtil.getMessage(MSG_ERR_EXECUTING_TRANSFER, cause.getMessage()), cause);
|
|
}
|
|
writeDefinitionReports(replicationDef, null, null);
|
|
throw new ReplicationServiceException(I18NUtil.getMessage(MSG_ERR_EXECUTING_TRANSFER, e.getMessage()), e);
|
|
}
|
|
finally
|
|
{
|
|
lock.close();
|
|
}
|
|
}
|
|
|
|
private void writeDefinitionReports(final ReplicationDefinition replicationDef, NodeRef sourceReport, NodeRef destinationReport)
|
|
{
|
|
replicationDef.setLocalTransferReport(sourceReport);
|
|
replicationDef.setRemoteTransferReport(destinationReport);
|
|
|
|
if (replicationDef.getNodeRef() != null)
|
|
{
|
|
// Record details of the transfer reports
|
|
transactionService.getRetryingTransactionHelper().doInTransaction(
|
|
new RetryingTransactionHelper.RetryingTransactionCallback<Object>()
|
|
{
|
|
public Object execute() throws Throwable
|
|
{
|
|
if (logger.isDebugEnabled())
|
|
logger.debug("Exception - writing replication def reports");
|
|
|
|
replicationDefinitionPersister.saveReplicationDefinition(replicationDef);
|
|
return null;
|
|
}
|
|
}, false, true);
|
|
}
|
|
}
|
|
|
|
@Override
|
|
public boolean onLogException(Log logger, Throwable t, String message)
|
|
{
|
|
if(t instanceof ActionCancelledException || t instanceof DisabledReplicationJobException)
|
|
{
|
|
logger.debug(message);
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* A {@link TransferCallback} which periodically renews the
|
|
* lock held against a {@link ReplicationDefinition}
|
|
*/
|
|
protected class ReplicationDefinitionLockExtender
|
|
implements TransferCallback, JobLockService.JobLockRefreshCallback
|
|
|
|
{
|
|
private ReplicationDefinition replicationDef;
|
|
private String transferId;
|
|
private String lockToken;
|
|
private boolean active;
|
|
|
|
protected ReplicationDefinitionLockExtender(ReplicationDefinition replicationDef)
|
|
{
|
|
this.replicationDef = replicationDef;
|
|
acquireLock();
|
|
}
|
|
|
|
/**
|
|
* No matter what the event is, refresh
|
|
* our lock on the {@link ReplicationDefinition}, and
|
|
* handle a cancel if it was requested.
|
|
*/
|
|
public void processEvent(TransferEvent event)
|
|
{
|
|
// If it's the enter event, do skip
|
|
if(event instanceof TransferEventEnterState)
|
|
{
|
|
return;
|
|
}
|
|
|
|
// If this is a begin event, make a note of the ID
|
|
if(event instanceof TransferEventBegin)
|
|
{
|
|
transferId = ((TransferEventBegin)event).getTransferId();
|
|
}
|
|
|
|
checkCancel();
|
|
}
|
|
|
|
/**
|
|
* Give up our lock on the
|
|
* {@link ReplicationDefinition}
|
|
*/
|
|
public void close()
|
|
{
|
|
releaseLock();
|
|
}
|
|
|
|
/**
|
|
* Get a lock on the job.
|
|
* Tries every 5 seconds for 30 seconds, then
|
|
* every 30 seconds for half an hour.
|
|
*
|
|
* @throws LockAcquisitionException
|
|
*/
|
|
private void acquireLock()
|
|
{
|
|
try
|
|
{
|
|
// Quick try
|
|
lockToken = jobLockService.getLock(
|
|
replicationDef.getReplicationQName(),
|
|
replicationActionLockDuration,
|
|
5 * 1000, // Every 5 seconds
|
|
6 // 6 times = wait up to 30 seconds
|
|
);
|
|
|
|
active = true;
|
|
|
|
/**
|
|
* Got the lock - now register the refresh callback which will keep the
|
|
* lock alive
|
|
*/
|
|
jobLockService.refreshLock(
|
|
lockToken,
|
|
replicationDef.getReplicationQName(),
|
|
replicationActionLockDuration,
|
|
this
|
|
);
|
|
|
|
if(logger.isDebugEnabled())
|
|
{
|
|
logger.debug("lock aquired:" + replicationDef.getReplicationQName() );
|
|
}
|
|
}
|
|
catch(LockAcquisitionException e)
|
|
{
|
|
long retryTime = 30*1000;
|
|
int retries = (int)(60);
|
|
|
|
logger.debug(
|
|
"Unable to get the replication job lock on " +
|
|
replicationDef.getReplicationQName() +
|
|
", retrying every " + (int)(retryTime/1000) + " seconds"
|
|
);
|
|
|
|
active = true;
|
|
|
|
// Long try - every 30 seconds
|
|
lockToken = jobLockService.getLock(
|
|
replicationDef.getReplicationQName(),
|
|
replicationActionLockDuration,
|
|
retryTime,
|
|
retries
|
|
);
|
|
|
|
/**
|
|
* Got the lock - now register the refresh callback which will keep the
|
|
* lock alive
|
|
*/
|
|
jobLockService.refreshLock(
|
|
lockToken,
|
|
replicationDef.getReplicationQName(),
|
|
replicationActionLockDuration,
|
|
this
|
|
);
|
|
|
|
if(logger.isDebugEnabled())
|
|
{
|
|
logger.debug("lock aquired (from long timeout):" + replicationDef.getReplicationQName() );
|
|
}
|
|
}
|
|
}
|
|
|
|
private void releaseLock()
|
|
{
|
|
if(active)
|
|
{
|
|
if(logger.isDebugEnabled())
|
|
{
|
|
logger.debug("about to release lock:" + replicationDef.getReplicationQName());
|
|
}
|
|
jobLockService.releaseLock(
|
|
lockToken,
|
|
replicationDef.getReplicationQName());
|
|
active=false;
|
|
}
|
|
}
|
|
|
|
private void checkCancel()
|
|
{
|
|
// Has someone tried to cancel us?
|
|
if(actionTrackingService.isCancellationRequested(replicationDef))
|
|
{
|
|
// Tell the transfer service to cancel, if we can
|
|
if(transferId != null)
|
|
{
|
|
transferService.cancelAsync(transferId);
|
|
logger.debug("Replication cancel was requested for " + replicationDef.getReplicationQName());
|
|
}
|
|
else
|
|
{
|
|
logger.warn("Unable to cancel replication as requested, as transfer has yet to reach a cancellable state");
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Job Lock Refresh
|
|
* @return boolean
|
|
*/
|
|
@Override
|
|
public boolean isActive()
|
|
{
|
|
if(logger.isDebugEnabled())
|
|
{
|
|
logger.debug("lock callback isActive:" + active + ", " + replicationDef.getReplicationQName());
|
|
}
|
|
return active;
|
|
}
|
|
|
|
/**
|
|
* Job Lock Service has released us.
|
|
*/
|
|
@Override
|
|
public void lockReleased()
|
|
{
|
|
logger.debug("lock released:" + replicationDef.getReplicationQName());
|
|
// nothing to do
|
|
}
|
|
}
|
|
}
|