hydrograph.ui.graph.debug.service.PurgeViewDataFiles.java Source code

Introduction

Here is the source code for hydrograph.ui.graph.debug.service.PurgeViewDataFiles.java

Source

/*******************************************************************************
 * Copyright 2017 Capital One Services, LLC and Bitwise, Inc.
 * 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 hydrograph.ui.graph.debug.service;

import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;

import org.apache.commons.io.FileUtils;
import org.eclipse.core.runtime.Platform;
import org.slf4j.Logger;

import hydrograph.ui.common.debug.service.IDebugService;
import hydrograph.ui.common.util.XMLConfigUtil;
import hydrograph.ui.dataviewer.utilities.Utils;
import hydrograph.ui.graph.execution.tracking.replay.ViewExecutionHistoryUtility;
import hydrograph.ui.graph.job.Job;
import hydrograph.ui.graph.utility.DataViewerUtility;
import hydrograph.ui.graph.utility.ViewDataUtils;
import hydrograph.ui.logging.factory.LogFactory;

/**
 * The Class PurgeViewDataFiles will remove ViewData Files on tool close.
 * @author Bitwise
 *
 */
public class PurgeViewDataFiles implements IDebugService {

    private static final Logger logger = LogFactory.INSTANCE.getLogger(PurgeViewDataFiles.class);
    private static final String JOB_TRACKING_LOG_PATH = "//logger//JobTrackingLog";
    private static final String JOB_TRACKING_CSV_FILE_PATH = "debugfiles";
    private static final String JOB_TRACKING_FILE_EXTENSION = ".track.log";
    private static final String EXECUTION_TRACKING_LOCAL_MODE = "L_";
    private static final String EXECUTION_TRACKING_REMOTE_MODE = "R_";

    /* (non-Javadoc)
     * @see hydrograph.ui.common.debug.service.IDebugService#deleteDebugFiles()
     */
    @Override
    public void deleteDebugFiles() {
        logger.info("call to api to remove debug files::::::::");
        ViewDataUtils dataUtils = ViewDataUtils.getInstance();
        ViewExecutionHistoryUtility viewExecutionHistoryUtility = ViewExecutionHistoryUtility.getInstance();

        Map<String, List<Job>> viewDataJobMap = viewExecutionHistoryUtility.getTrackingJobs();

        if (Utils.INSTANCE.isPurgeViewDataPrefSet()) {
            for (Entry<String, List<Job>> entry : viewDataJobMap.entrySet()) {
                List<Job> value = (List<Job>) entry.getValue();
                for (Job job : value) {
                    dataUtils.deleteBasePathDebugFiles(job);
                    dataUtils.deleteSchemaAndDataViewerFiles(job.getUniqueJobId());
                    DataViewerUtility.INSTANCE.closeDataViewerWindows(job);
                    String path = ViewExecutionHistoryUtility.INSTANCE.getTrackingPathDetails()
                            .get(job.getUniqueJobId()).getSelectedLogFilePath();
                    path = path + checkJobstatus(job.isRemoteMode()) + job.getUniqueJobId()
                            + JOB_TRACKING_FILE_EXTENSION;
                    removeFiles(path);
                }
            }
            viewExecutionHistoryUtility.getTrackingJobs().clear();
        }

        purgeViewExecutionHistoryLogs();
        purgeViewDataCsvFiles();
    }

    private String checkJobstatus(boolean status) {
        if (status) {
            return EXECUTION_TRACKING_REMOTE_MODE;
        } else {
            return EXECUTION_TRACKING_LOCAL_MODE;
        }
    }

    /**
     * The Function will remove View Execution History Log Files. 
      */
    private void purgeViewExecutionHistoryLogs() {
        try {
            FileUtils.cleanDirectory(new File(XMLConfigUtil.CONFIG_FILES_PATH + JOB_TRACKING_LOG_PATH));
            logger.debug("Removed ViewExecutionHistory logs file:::");
        } catch (IOException exception) {
            logger.error("Failed to remove ViewExecutionHistory logs file.", exception);
        }
    }

    /**
     * The Function will remove View Execution History Csv Files.
     */
    private void purgeViewDataCsvFiles() {
        try {
            FileUtils.cleanDirectory(
                    new File(Platform.getInstallLocation().getURL().getPath() + JOB_TRACKING_CSV_FILE_PATH));
            logger.debug("Removed ViewExecutionHistory csv file:::");
        } catch (IOException exception) {
            logger.error("Failed to remove ViewExecutionHistory csv file.", exception);
        }
    }

    /**
     * Purge the file on specific path
     * @param filePath
     */
    private void removeFiles(String filePath) {
        try {
            File file = new File(filePath);
            boolean result = Files.deleteIfExists(file.toPath());
            if (result) {
                logger.debug(filePath + " file deleted.");
            }
        } catch (Exception exception) {
            logger.error("Failed to remove ViewExecutionHistory log file.", exception);
        }
    }

}