WeightWatcherConfiguration.java

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is part of dcm4che, an implementation of DICOM(TM) in
 * Java(TM), hosted at https://github.com/gunterze/dcm4che.
 *
 * The Initial Developer of the Original Code is
 * Agfa Healthcare.
 * Portions created by the Initial Developer are Copyright (C) 2011-2015
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 * See @authors listed below
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

package org.dcm4chee.archive.conf;

import org.dcm4che3.conf.core.api.ConfigurableClass;
import org.dcm4che3.conf.core.api.ConfigurableProperty;

import java.io.Serializable;

/**
 * Configuration for WeightWatcher
 *
 * @author Hermann Czedik-Eysenberg <hermann-agfa@czedik.net>
 */
@ConfigurableClass
public class WeightWatcherConfiguration implements Serializable {

    @ConfigurableProperty(defaultValue = "true", description = "")
    private boolean weightWatcherEnabled = true;

    @ConfigurableProperty(defaultValue = "0", description = "Total number of tasks that are allowed to run concurrently. The default (0) means no concurrency limit.")
    private int totalConcurrentTasksLimit = 0;

    @ConfigurableProperty(defaultValue = "0.6", description = "Percentage (given as factor between 0 and 1) of the total (maximum) heap size that will be managed by the Weight Watcher. E.g. a value of 0.6 means 60% of the total heap size.")
    private double memoryUsageFactor = 0.6;

    @ConfigurableProperty(defaultValue = "3000", description = "Time (in milliseconds) after which a warning will be logged, if a task needs to be blocked because of concurrency or memory limits.")
    private int blockedWarnTimeMillis = 3000;

    // note: if adding new fields, please adapt the copy constructor below

    /**
     * Default constructor
     */
    public WeightWatcherConfiguration() {
        // empty
    }

    /**
     * Copy constructor
     *
     * @param configToCopy config to copy
     */
    public WeightWatcherConfiguration(WeightWatcherConfiguration configToCopy) {
        this.weightWatcherEnabled = configToCopy.isWeightWatcherEnabled();
        this.totalConcurrentTasksLimit = configToCopy.getTotalConcurrentTasksLimit();
        this.memoryUsageFactor = configToCopy.getMemoryUsageFactor();
        this.blockedWarnTimeMillis = configToCopy.getBlockedWarnTimeMillis();
    }

    public boolean isWeightWatcherEnabled() {
        return weightWatcherEnabled;
    }

    public void setWeightWatcherEnabled(boolean weightWatcherEnabled) {
        this.weightWatcherEnabled = weightWatcherEnabled;
    }

    public int getTotalConcurrentTasksLimit() {
        return totalConcurrentTasksLimit;
    }

    public void setTotalConcurrentTasksLimit(int totalConcurrentTasksLimit) {
        this.totalConcurrentTasksLimit = totalConcurrentTasksLimit;
    }

    public double getMemoryUsageFactor() {
        return memoryUsageFactor;
    }

    public void setMemoryUsageFactor(double memoryUsageFactor) {
        this.memoryUsageFactor = memoryUsageFactor;
    }

    public int getBlockedWarnTimeMillis() {
        return blockedWarnTimeMillis;
    }

    public void setBlockedWarnTimeMillis(int blockedWarnTimeMillis) {
        this.blockedWarnTimeMillis = blockedWarnTimeMillis;
    }
}