BusinessObjectDataFinalizeRestoreJob.java

/*
* Copyright 2015 herd contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.finra.herd.service.systemjobs;

import java.util.List;

import org.quartz.DisallowConcurrentExecution;
import org.quartz.JobDataMap;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.util.Assert;
import org.springframework.util.CollectionUtils;

import org.finra.herd.dao.helper.JsonHelper;
import org.finra.herd.model.api.xml.Parameter;
import org.finra.herd.model.dto.ConfigurationValue;
import org.finra.herd.model.dto.StorageUnitAlternateKeyDto;
import org.finra.herd.service.BusinessObjectDataFinalizeRestoreService;
import org.finra.herd.service.helper.BusinessObjectDataHelper;
import org.finra.herd.service.helper.ParameterHelper;

/**
 * The business object data finalize restore job.
 */
@Component(BusinessObjectDataFinalizeRestoreJob.JOB_NAME)
@DisallowConcurrentExecution
public class BusinessObjectDataFinalizeRestoreJob extends AbstractSystemJob
{
    private static final Logger LOGGER = LoggerFactory.getLogger(BusinessObjectDataFinalizeRestoreJob.class);

    public static final String JOB_NAME = "businessObjectDataFinalizeRestore";

    @Autowired
    private BusinessObjectDataFinalizeRestoreService businessObjectDataFinalizeRestoreService;

    @Autowired
    private BusinessObjectDataHelper businessObjectDataHelper;

    @Autowired
    private JsonHelper jsonHelper;

    @Autowired
    private ParameterHelper parameterHelper;

    @Override
    protected void executeInternal(JobExecutionContext context) throws JobExecutionException
    {
        // Log that the system job is started.
        LOGGER.info("Started system job. systemJobName=\"{}\"", JOB_NAME);

        // Get the parameter values.
        int maxBusinessObjectDataInstancesToFinalize =
            parameterHelper.getParameterValueAsInteger(parameters, ConfigurationValue.BDATA_FINALIZE_RESTORE_JOB_MAX_BDATA_INSTANCES);

        // Log the parameter values.
        LOGGER.info("systemJobName=\"{}\" {}={}", JOB_NAME, ConfigurationValue.BDATA_FINALIZE_RESTORE_JOB_MAX_BDATA_INSTANCES,
            maxBusinessObjectDataInstancesToFinalize);

        // Continue the processing only if the maximum number of business object data instances
        // that is allowed to be processed in a single run of this system job is greater than zero.
        int finalizedRestores = 0;
        if (maxBusinessObjectDataInstancesToFinalize > 0)
        {
            // Get business object data that is currently being restored.
            List<StorageUnitAlternateKeyDto> storageUnitKeys =
                businessObjectDataFinalizeRestoreService.getS3StorageUnitsToRestore(maxBusinessObjectDataInstancesToFinalize);

            // Log the number of storage units selected for processing.
            LOGGER.info("Selected for processing S3 storage units. systemJobName=\"{}\" storageUnitCount={}", JOB_NAME, storageUnitKeys.size());

            // Try to finalize restore for each of the selected storage units.
            for (StorageUnitAlternateKeyDto storageUnitKey : storageUnitKeys)
            {
                try
                {
                    businessObjectDataFinalizeRestoreService.finalizeRestore(storageUnitKey);
                    finalizedRestores += 1;
                }
                catch (RuntimeException runtimeException)
                {
                    // Log the exception.
                    LOGGER.error("Failed to finalize a business object data restore from the Glacier storage. " +
                        "systemJobName=\"{}\" storageName=\"{}\" businessObjectDataKey={}", JOB_NAME,
                        jsonHelper.objectToJson(businessObjectDataHelper.createBusinessObjectDataKeyFromStorageUnitKey(storageUnitKey)),
                        storageUnitKey.getStorageName(), runtimeException);
                }
            }
        }

        // Log the number of finalized restores.
        LOGGER.info("Finalized restore for business object data instances. systemJobName=\"{}\" businessObjectDataCount={}", JOB_NAME, finalizedRestores);

        // Log that the system job is ended.
        LOGGER.info("Completed system job. systemJobName=\"{}\"", JOB_NAME);
    }

    @Override
    public void validateParameters(List<Parameter> parameters)
    {
        // This system job accepts only one optional parameter with an integer value.
        if (!CollectionUtils.isEmpty(parameters))
        {
            Assert.isTrue(parameters.size() == 1, String.format("Too many parameters are specified for \"%s\" system job.", JOB_NAME));
            Assert.isTrue(parameters.get(0).getName().equalsIgnoreCase(ConfigurationValue.BDATA_FINALIZE_RESTORE_JOB_MAX_BDATA_INSTANCES.getKey()),
                String.format("Parameter \"%s\" is not supported by \"%s\" system job.", parameters.get(0).getName(), JOB_NAME));
            parameterHelper.getParameterValueAsInteger(parameters.get(0));
        }
    }

    @Override
    public JobDataMap getJobDataMap()
    {
        return getJobDataMap(ConfigurationValue.BDATA_FINALIZE_RESTORE_JOB_MAX_BDATA_INSTANCES);
    }

    @Override
    public String getCronExpression()
    {
        return configurationHelper.getProperty(ConfigurationValue.BDATA_FINALIZE_RESTORE_JOB_CRON_EXPRESSION);
    }
}