DemandBalancerJob.java

/* ==================================================================
 * DemandBalancerJob.java - Mar 23, 2014 3:43:41 PM
 * 
 * Copyright 2007-2014 SolarNetwork.net Dev Team
 * 
 * This program is free software; you can redistribute it and/or 
 * modify it under the terms of the GNU General Public License as 
 * published by the Free Software Foundation; either version 2 of 
 * the License, or (at your option) any later version.
 * 
 * This program 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 
 * General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License 
 * along with this program; if not, write to the Free Software 
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 
 * 02111-1307 USA
 * ==================================================================
 */

package net.solarnetwork.node.control.demandbalancer;

import java.util.ArrayList;
import java.util.List;
import org.quartz.DisallowConcurrentExecution;
import org.quartz.JobExecutionContext;
import org.quartz.PersistJobDataAfterExecution;
import org.springframework.context.MessageSource;
import net.solarnetwork.node.job.AbstractJob;
import net.solarnetwork.node.settings.KeyedSettingSpecifier;
import net.solarnetwork.node.settings.SettingSpecifier;
import net.solarnetwork.node.settings.SettingSpecifierProvider;

/**
 * Job to execute the {@link DemandBalancer} on a schedule.
 * 
 * <p>
 * Note that {@link #getSettingSpecifiers()} will map all
 * {@link KeyedSettingSpecifier} instances to the {@code demandBalancer.}
 * prefix. The corresponding {@link DemandBalancer#getMessageSource()} should be
 * configured as a {@link net.solarnetwork.node.util.PrefixedMessageSource}
 * using the same prefix in order for the mapping to work correctly.
 * </p>
 * 
 * <p>
 * The configurable properties of this class are:
 * </p>
 * 
 * <dl class="class-properties">
 * <dt>demandBalancer</dt>
 * <dd>The {@link DemandBalancer} service.</dd>
 * </dl>
 * 
 * @author matt
 * @version 1.1
 */
@PersistJobDataAfterExecution
@DisallowConcurrentExecution
public class DemandBalancerJob extends AbstractJob implements SettingSpecifierProvider {

	private DemandBalancer demandBalancer;

	@Override
	protected void executeInternal(JobExecutionContext jobContext) throws Exception {
		assert demandBalancer != null;
		demandBalancer.evaluateBalance();
	}

	@Override
	public String getSettingUID() {
		return demandBalancer.getSettingUID();
	}

	@Override
	public String getDisplayName() {
		return demandBalancer.getDisplayName();
	}

	@Override
	public MessageSource getMessageSource() {
		return demandBalancer.getMessageSource();
	}

	@Override
	public List<SettingSpecifier> getSettingSpecifiers() {
		List<SettingSpecifier> result = new ArrayList<SettingSpecifier>();
		for ( SettingSpecifier spec : demandBalancer.getSettingSpecifiers() ) {
			if ( spec instanceof KeyedSettingSpecifier<?> ) {
				KeyedSettingSpecifier<?> keyedSpec = (KeyedSettingSpecifier<?>) spec;
				result.add(keyedSpec.mappedTo("demandBalancer."));
			} else {
				result.add(spec);
			}
		}
		return result;
	}

	public DemandBalancer getDemandBalancer() {
		return demandBalancer;
	}

	public void setDemandBalancer(DemandBalancer demandBalancer) {
		this.demandBalancer = demandBalancer;
	}

}