com.jkoolcloud.tnt4j.streams.scenario.WsScenario Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014-2018 JKOOL, LLC.
 *
 * 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 com.jkoolcloud.tnt4j.streams.scenario;

import java.util.ArrayList;
import java.util.List;

import org.apache.commons.collections4.CollectionUtils;
import org.apache.commons.lang3.StringUtils;

/**
 * This class defines TNT4J-Streams-WS configuration scenario.
 *
 * @version $Revision: 1 $
 */
public class WsScenario extends WsScenarioEntity {
	private final List stepsList = new ArrayList<>();
	private WsScenarioStep loginStep;

	/**
	 * Constructs a new WsScenario. Defines scenario name.
	 *
	 * @param name
	 *            scenario name
	 */
	public WsScenario(String name) {
		super(name);
	}

	/**
	 * Adds scenario step to steps list.
	 *
	 * @param scenarioStep
	 *            scenario step to add
	 */
	public void addStep(WsScenarioStep scenarioStep) {
		scenarioStep.setScenario(this);

		synchronized (stepsList) {
			if ("login".equalsIgnoreCase(scenarioStep.getName())) { // NON-NLS
				loginStep = scenarioStep;
			} else {
				stepsList.add(scenarioStep);
			}
		}
	}

	/**
	 * Removes scenario step from steps list.
	 * 
	 * @param scenarioStep
	 *            scenario step to remove
	 */
	public void removeStep(WsScenarioStep scenarioStep) {
		synchronized (stepsList) {
			if ("login".equalsIgnoreCase(scenarioStep.getName())) { // NON-NLS
				loginStep = null;
			} else {
				stepsList.remove(scenarioStep);
			}
		}

		scenarioStep.setScenario(null);
	}

	/**
	 * Returns scenario steps list.
	 *
	 * @return scenario steps list
	 */
	public List getStepsList() {
		return stepsList;
	}

	/**
	 * Checks if scenario has no steps defined.
	 *
	 * @return flag indicating scenario has no steps defined
	 */
	public boolean isEmpty() {
		synchronized (stepsList) {
			return CollectionUtils.isEmpty(stepsList);
		}
	}

	/**
	 * Returns scenario step defining login call.
	 *
	 * @return login call step
	 */
	public WsScenarioStep getLoginStep() {
		return loginStep;
	}

	/**
	 * Returns scenario step instance having defined name {@code stepName}. Names comparison is case insensitive.
	 * 
	 * @param stepName
	 *            scenario step name
	 * @return scenario step instance having defined name
	 */
	public WsScenarioStep getStep(String stepName) {
		if (StringUtils.isNotEmpty(stepName)) {
			synchronized (stepsList) {
				for (WsScenarioStep step : stepsList) {
					if (stepName.equalsIgnoreCase(step.getName())) {
						return step;
					}
				}
			}
		}

		return null;
	}
}