ResultsLogger.java

/*
 * Copyright (c) 2002-2009, The DSpace Foundation.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * - Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * - Neither the name of the DSpace Foundation nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 */
package org.dspace.checker;

import java.text.SimpleDateFormat;
import java.util.Date;

import org.apache.log4j.Logger;
import org.dspace.core.I18nUtil;

/**
 * <p>
 * Collects results from a Checksum process and outputs them to a Log4j Logger.
 * </p>
 * 
 * 
 * @author Jim Downing
 * @author Grace Carpenter
 * @author Nathan Sarr
 * 
 * 
 */
public class ResultsLogger implements ChecksumResultsCollector
{
    /**
     * Usual Log4J logger.
     */
    private static final Logger LOG = Logger.getLogger(ResultsLogger.class);

    /**
     * Utility date format.
     */
    private static final SimpleDateFormat DATE_FORMAT = new SimpleDateFormat(
            "MM/dd/yyyy hh:mm:ss");

    /**
     * Date the current checking run started.
     */
    Date startDate = null;

    /**
     * ChecksumResultDAO dependency variable.
     */
    private ChecksumResultDAO resultDAO;

    /**
     * Blanked off, no-op constructor. Do not use.
     */
    private ResultsLogger()
    {
        ;
    }

    /**
     * Main constructor.
     * 
     * @param startDt
     *            Date the checking run started.
     */
    public ResultsLogger(Date startDt)
    {
        this.resultDAO = new ChecksumResultDAO();

        LOG.info(msg("run-start-time") + ": " + DATE_FORMAT.format(startDt));
    }

    /**
     * Get the i18N string.
     * 
     * @param key
     *            to get the message.
     * @return the message found.
     */
    private String msg(String key)
    {
        return I18nUtil.getMessage("org.dspace.checker.ResultsLogger." + key);
    }

    /**
     * Collect a result for logging.
     * 
     * @param info
     *            the BitstreamInfo representing the result.
     * @see org.dspace.checker.ChecksumResultsCollector#collect(org.dspace.checker.BitstreamInfo)
     */
    public void collect(BitstreamInfo info)
    {
        LOG.info("******************************************************");
        LOG.info(msg("bitstream-id") + ": " + info.getBitstreamId());
        LOG.info(msg("bitstream-info-found") + ": " + info.getInfoFound());
        LOG.info(msg("bitstream-marked-deleted") + ": " + info.getDeleted());
        LOG.info(msg("bitstream-found") + ": " + info.getBitstreamFound());
        LOG.info(msg("to-be-processed") + ": " + info.getToBeProcessed());
        LOG.info(msg("internal-id") + ": " + info.getInternalId());
        LOG.info(msg("name") + ": " + info.getName());
        LOG.info(msg("store-number") + ": " + info.getStoreNumber());
        LOG.info(msg("size") + ": " + info.getSize());
        LOG.info(msg("bitstream-format") + ": " + info.getBitstreamFormatId());
        LOG.info(msg("user-format-description") + ": "
                + info.getUserFormatDescription());
        LOG.info(msg("source") + ": " + info.getSource());
        LOG
                .info(msg("checksum-algorithm") + ": "
                        + info.getChecksumAlgorithm());
        LOG.info(msg("previous-checksum") + ": " + info.getStoredChecksum());
        LOG.info(msg("previous-checksum-date")
                + ": "
                + ((info.getProcessEndDate() != null) ? DATE_FORMAT.format(info
                        .getProcessEndDate()) : "unknown"));
        LOG.info(msg("new-checksum") + ": " + info.getCalculatedChecksum());
        LOG.info(msg("checksum-comparison-result") + ": "
                + resultDAO.getChecksumCheckStr(info.getChecksumCheckResult()));
        LOG.info("\n\n");
    }
}