/*
   Copyright 2016 Nationale-Nederlanden

   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 nl.nn.adapterframework.pipes;

import nl.nn.adapterframework.configuration.ConfigurationException;
import nl.nn.adapterframework.core.IPipeLineSession;
import nl.nn.adapterframework.core.PipeForward;
import nl.nn.adapterframework.core.PipeRunException;
import nl.nn.adapterframework.core.PipeRunResult;
import nl.nn.adapterframework.statistics.StatisticsKeeper;

/**
 * Selects an exitState, based on the number of received messages by this pipe.
 * 
 * The exitState is the difference (subtraction) between the <code>divisor</code> and
 * the remainder of [number of received messages] modulus <code>divisor</code>.
 * This will always be an integer between 1 and <code>divisor</code>, inclusive.
 * 
 * <p><b>Configuration:</b>
 * <table border="1">
 * <tr><th>attributes</th><th>description</th><th>default</th></tr>
 * <tr><td>className</td><td>nl.nn.adapterframework.pipes.XmlIf</td><td> </td></tr>
 * <tr><td>{@link #setName(String) name}</td><td>name of the Pipe</td><td> </td></tr>
 * <tr><td>{@link #setDivisor(int) divisor}</td><td> </td><td>2</td></tr>
 * </table>
 * </p>
 *
 * @author  Peter Leeuwenburgh
 */

public class CounterSwitchPipe extends FixedForwardPipe {
	private int divisor = 2;

	public void configure() throws ConfigurationException {
		super.configure();

		if (getDivisor() < 2) {
			throw new ConfigurationException(getLogPrefix(null) + "mod ["
					+ getDivisor() + "] should be greater than or equal to 2");
		}

		for (int i = 1; i <= getDivisor(); i++) {
			if (null == findForward("" + i))
				throw new ConfigurationException(getLogPrefix(null)
						+ "forward [" + i + "] is not defined");
		}
	}

	public PipeRunResult doPipe(Object input, IPipeLineSession session)
			throws PipeRunException {
		String forward = "";
		PipeForward pipeForward = null;

		StatisticsKeeper sk = getPipeLine().getPipeStatistics(this);
		if (sk != null) {
			long count = sk.getCount();
			forward = "" + (getDivisor() - (count % getDivisor()));
		}

		log.debug(getLogPrefix(session) + "determined forward [" + forward
				+ "]");

		pipeForward = findForward(forward);

		if (pipeForward == null) {
			throw new PipeRunException(this, getLogPrefix(null)
					+ "cannot find forward or pipe named [" + forward + "]");
		}
		log.debug(getLogPrefix(session) + "resolved forward [" + forward
				+ "] to path [" + pipeForward.getPath() + "]");
		return new PipeRunResult(pipeForward, input);
	}

	public int getDivisor() {
		return divisor;
	}

	public void setDivisor(int i) {
		divisor = i;
	}
}