RecordsManagementJob.java

/*
 * #%L
 * Alfresco Records Management Module
 * %%
 * Copyright (C) 2005 - 2016 Alfresco Software Limited
 * %%
 * This file is part of the Alfresco software.
 * -
 * If the software was purchased under a paid Alfresco license, the terms of
 * the paid license agreement will prevail.  Otherwise, the software is
 * provided under the following open source license terms:
 * -
 * 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/>.
 * #L%
 */

package org.alfresco.module.org_alfresco_module_rm.job;

import java.util.concurrent.atomic.AtomicBoolean;

import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.repo.lock.JobLockService;
import org.alfresco.repo.lock.JobLockService.JobLockRefreshCallback;
import org.alfresco.repo.lock.LockAcquisitionException;
import org.alfresco.repo.security.authentication.AuthenticationUtil;
import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork;
import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.QName;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;

/**
 * Base records management job implementation.
 * <p>
 * Delegates job execution and ensures locking is enforced.
 *
 * @author Roy Wetherall
 */
public class RecordsManagementJob implements Job
{
    private static Log logger = LogFactory.getLog(RecordsManagementJob.class);

    /** which user should be used to log audit */
    private String runAuditAs = AuthenticationUtil.getSystemUserName();

    private static final long DEFAULT_TIME = 30000L;

    private JobLockService jobLockService;

    private RecordsManagementJobExecuter jobExecuter = null;

    private String jobName;

    private QName getLockQName()
    {
        return QName.createQName(NamespaceService.SYSTEM_MODEL_1_0_URI, jobName);
    }

    private class LockCallback implements JobLockRefreshCallback
    {
        final AtomicBoolean running = new AtomicBoolean(true);

        @Override
        public boolean isActive()
        {
            return running.get();
        }

        @Override
        public void lockReleased()
        {
            running.set(false);
        }
    }

    /**
     * Attempts to get the lock. If the lock couldn't be taken, then <tt>null</tt> is returned.
     *
     * @return Returns the lock token or <tt>null</tt>
     */
    private String getLock()
    {
        try
        {
            return jobLockService.getLock(getLockQName(), DEFAULT_TIME);
        }
        catch (LockAcquisitionException e)
        {
            return null;
        }
    }

    /**
     * @see org.quartz.Job#execute(org.quartz.JobExecutionContext)
     */
    public void execute(JobExecutionContext context) throws JobExecutionException
    {

        // get the job lock service
        jobLockService = (JobLockService) context.getJobDetail().getJobDataMap().get("jobLockService");
        if (jobLockService == null) { throw new AlfrescoRuntimeException("Job lock service has not been specified."); }

        // get the job executer
        jobExecuter = (RecordsManagementJobExecuter) context.getJobDetail().getJobDataMap().get("jobExecuter");
        if (jobExecuter == null) { throw new AlfrescoRuntimeException("Job executer has not been specified."); }

        // get the job name
        jobName = (String) context.getJobDetail().getJobDataMap().get("jobName");

        if (jobName == null) { throw new AlfrescoRuntimeException("Job name has not been specified."); }

        if (jobName.compareTo("dispositionLifecycle") == 0)
        {
            //RM-3293 - set user for audit
            if (jobExecuter instanceof DispositionLifecycleJobExecuter)
            {
                String auditUser = (String) context.getJobDetail().getJobDataMap().get("runAuditAs");
                if (((DispositionLifecycleJobExecuter) jobExecuter).getPersonService().getPersonOrNull(auditUser) != null)
                {
                    setRunAuditAs(auditUser);
                }
                else
                {
                    setRunAuditAs(AuthenticationUtil.getSystemUserName());
                }

            }

            if (logger.isDebugEnabled())
            {
                logger.debug("DispositionLifecycleJobExecuter() logged audit history with user: " + getRunAuditAs());

            }

        }

        final LockCallback lockCallback = new LockCallback();

        AuthenticationUtil.runAs(new RunAsWork<Void>()
        {
            public Void doWork()
            {
                // try and get the lock
                String lockToken = getLock();
                if (lockToken != null)
                {
                    try
                    {
                        jobLockService.refreshLock(lockToken, getLockQName(), DEFAULT_TIME, lockCallback);
                        // do work
                        jobExecuter.execute();
                    }
                    finally
                    {
                        try
                        {
                            lockCallback.running.set(false);
                            jobLockService.releaseLock(lockToken, getLockQName());
                        }
                        catch (LockAcquisitionException e)
                        {
                            // Ignore
                            if (logger.isDebugEnabled())
                            {
                                logger.debug("Lock release failed: " + getLockQName() + ": " + lockToken + "("
                                            + e.getMessage() + ")");
                            }
                        }
                    }
                }

                // return
                return null;
            }
        }, getRunAuditAs());
    }

    public String getRunAuditAs()
    {
        return runAuditAs;
    }

    public void setRunAuditAs(String runAuditAs)
    {

        this.runAuditAs = runAuditAs;
    }

}