edu.lternet.pasta.datapackagemanager.DataPackageError.java Source code

Introduction

Here is the source code for edu.lternet.pasta.datapackagemanager.DataPackageError.java

Source

/*
 *
 * Copyright 2011, 2012, 2013 the University of New Mexico.
 *
 * This work was supported by National Science Foundation Cooperative
 * Agreements #DEB-0832652 and #DEB-0936498.
 *
 * 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 edu.lternet.pasta.datapackagemanager;

import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;

import org.apache.commons.io.FileUtils;
import org.apache.log4j.Logger;

import edu.lternet.pasta.common.ResourceExistsException;
import edu.ucsb.nceas.utilities.Options;

/**
 * @author servilla
 * @since Mar 28, 2013
 * 
 *        Class that manages data package error messages. Error messages are
 *        persisted in the local directory for PASTA metadata/<packageId> in the
 *        form of errorlog.<transaction>.txt.
 * 
 */
public class DataPackageError {

    /*
     * Class variables
     */

    private static Logger logger = Logger.getLogger(DataPackageError.class);

    private static final String dirPath = "WebRoot/WEB-INF/conf";

    /*
     * Instance variables
     */

    String errorDir = null;

    /*
     * Constructors
     */

    public DataPackageError() throws Exception {

        Options options = null;
        options = ConfigurationListener.getOptions();

        if (options == null) {
            ConfigurationListener configurationListener = new ConfigurationListener();
            configurationListener.initialize(dirPath);
            options = ConfigurationListener.getOptions();
        }

        errorDir = options.getOption("datapackagemanager.errorDir");

        if (errorDir == null || errorDir.isEmpty()) {
            String gripe = "Error directory property not set!";
            throw new Exception(gripe);
        }

    }

    /*
     * Class methods
     */

    /**
     * @param args
     */
    public static void main(String[] args) {
        // TODO Auto-generated method stub

    }

    /*
     * Instance methods
     */

    /**
     * Write the error message from the exception object to the file
     * "errorlog.<transaction>.txt" in the "metadata" directory for the given
     * package identifier.
     * 
     * @param packageId
     *          The data package identifier
     * @param transaction
     *          The transaction identifier
     * @param error
     *          The exception object of the error
     */
    public void writeError(String transaction, Exception error) throws Exception {

        String errorName = transaction + ".txt";
        String errorPath = errorDir + "/";

        File file = new File(errorPath + errorName);

        if (file.exists()) {
            String gripe = "The resource " + errorName + " already exists!";
            throw new ResourceExistsException(gripe);
        }

        try {
            FileUtils.writeStringToFile(file, error.getMessage(), "UTF-8");
            logger.error("Transaction Error: " + transaction + " - " + error.getMessage());
        } catch (IOException e) {
            logger.error(e.getMessage());
            e.printStackTrace();
        }

    }

    /**
     * Read the error message from the file errorlog.<transaction>.txt in the
     * "metadata" directory for the given package identifier.
     * 
     * @param packageId
     *          The data package identifier
     * @param transaction
     *          The transaction identifier
     * @return The error message
     * @throws FileNotFoundException
     */
    public String readError(String transaction) throws FileNotFoundException {

        String error = null;

        String errorPath = errorDir + "/";
        String errorName = transaction + ".txt";

        File file = new File(errorPath + errorName);

        if (!file.exists()) {
            String gripe = "The error file " + errorName + " was not found!";
            throw new FileNotFoundException(gripe);
        }

        try {
            error = FileUtils.readFileToString(file, "UTF-8");
        } catch (IOException e) {
            logger.error(e.getMessage());
            e.printStackTrace();
        }

        return error;

    }

    /**
     * Delete the error file [transaction].txt in the "error" directory for the
     * given package identifier.
     * 
     * @param packageId
     *          The data package identifier
     * @param transaction
     *          The transaction identifier
     * @throws FileNotFoundException
     */
    public void deleteError(String transaction) throws FileNotFoundException {

        String errorPath = errorDir + "/";
        String errorName = transaction + ".txt";
        File file = new File(errorPath + errorName);

        if (!file.exists()) {
            String gripe = "The error file " + errorName + " was not found!";
            throw new FileNotFoundException(gripe);
        }

        try {
            FileUtils.forceDelete(file);
        } catch (IOException e) {
            logger.error(e.getMessage());
            e.printStackTrace();
        }

    }

}