/*
 * Copyright (C) 2005-2011 Alfresco Software Limited.
 *
 * This file is part of Alfresco
 *
 * 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 .
 */
package org.alfresco.service.cmr.admin;
import java.util.List;
import org.apache.commons.logging.Log;
/**
 * Bean to carry Red/Amber/Green status messages
 * 
 * @author Derek Hulley
 * @since V3.4 Team
 */
public class RepoUsageStatus
{
    /**
     * Enumeration of usage levels
     * 
     * @author Derek Hulley
     * @since V3.4 Team
     */
    public enum RepoUsageLevel
    {
        OK, WARN_ADMIN, WARN_ALL, LOCKED_DOWN
    }
    
    private RepoUsage restrictions;
    private RepoUsage usage;
    private final RepoUsageLevel level;
    private final List warnings;
    private final List errors;
    
    public RepoUsageStatus(
            RepoUsage restrictions, RepoUsage usage,
            RepoUsageLevel level, List warnings, List errors)
    {
        this.restrictions = restrictions;
        this.usage = usage;
        this.level = level;
        this.warnings = warnings;
        this.errors = errors;
    }
    @Override
    public String toString()
    {
        return "UsageStatus [level=" + level + ", warnings=" + warnings + ", errors=" + errors + "]";
    }
    /**
     * Log warnings and errors to the given logger
     */
    public void logMessages(Log logger)
    {
        for (String msg : warnings)
        {
            logger.warn(msg);
        }
        for (String msg : errors)
        {
            logger.error(msg);
        }
    }
    public RepoUsage getRestrictions()
    {
        return restrictions;
    }
    public RepoUsage getUsage()
    {
        return usage;
    }
    /**
     * @return              Returns the current warning level
     */
    public RepoUsageLevel getLevel()
    {
        return level;
    }
    /**
     * @return              Returns any warnings generated
     */
    public List getWarnings()
    {
        return warnings;
    }
    /**
     * @return              Returns any errors generated
     */
    public List getErrors()
    {
        return errors;
    }
}