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

Go to download
/*
 * Copyright 2014-2023 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 java.util.concurrent.Semaphore;

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

import com.jkoolcloud.tnt4j.streams.configure.WsStreamProperties;

/**
 * This class defines TNT4J-Streams-WS configuration scenario step.
 *
 * @version $Revision: 2 $
 */
public class WsScenarioStep extends WsScenarioEntity implements AutoIdGenerator {
	private final List> requests = new ArrayList<>();

	private SchedulerData schedulerData;

	private WsScenario scenario;

	private Semaphore semaphore = null;

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

	/**
	 * Returns requests/commands list for this step.
	 *
	 * @return requests list for this step
	 */
	public List> getRequests() {
		return requests;
	}

	/**
	 * Returns requests/commands array for this step.
	 * 
	 * @return requests array for this step
	 */
	@SuppressWarnings("unchecked")
	public WsRequest[] requestsArray() {
		return requests.toArray(new WsRequest[requests.size()]);
	}

	/**
	 * Returns request/command instance having defined identifier {@code reqId}. Identifiers comparison is case
	 * insensitive.
	 * 
	 * @param reqId
	 *            request identifier
	 * @return request instance having defined identifier
	 */
	public WsRequest getRequest(String reqId) {
		synchronized (requests) {
			if (StringUtils.isNotEmpty(reqId)) {
				for (WsRequest req : requests) {
					if (reqId.equalsIgnoreCase(req.getId())) {
						return req;
					}
				}
			}
		}

		return null;
	}

	/**
	 * Adds request/command data for this step. Request tag is set to {@code null}.
	 *
	 * @param id
	 *            request identifier
	 * @param request
	 *            request data
	 * @return constructed request instance
	 *
	 * @see #addRequest(String, String, String...)
	 */
	public WsRequest addRequest(String id, String request) {
		return addRequest(id, request, null);
	}

	/**
	 * Adds request/command data and tag for this step.
	 *
	 * @param id
	 *            request identifier
	 * @param request
	 *            request data
	 * @param tags
	 *            request tags
	 * @return constructed request instance
	 */
	public WsRequest addRequest(String id, String request, String... tags) {
		WsRequest req = new WsRequest<>(request, tags);
		synchronized (requests) {
			req.setId(StringUtils.isEmpty(id) ? getAutoId() : id);
			req.setScenarioStep(this);
			requests.add(req);
		}

		return req;
	}

	/**
	 * Adds request/command data for this step.
	 *
	 * @param request
	 *            request instance to add
	 */
	public void addRequest(WsRequest request) {
		synchronized (requests) {
			if (StringUtils.isEmpty(request.getId())) {
				request.setId(getAutoId());
			}
			request.setScenarioStep(this);

			requests.add(request);
		}
	}

	/**
	 * Removes request/command data from this step requests list.
	 * 
	 * @param request
	 *            request instance to remove
	 */
	public void removeRequest(WsRequest request) {
		synchronized (requests) {
			requests.remove(request);
		}
		request.setScenarioStep(null);
	}

	@Override
	public String getUrlStr() {
		String url = super.getUrlStr();

		return url == null ? scenario == null ? null : scenario.getUrlStr() : url;
	}

	@Override
	public String getMethod() {
		String method = super.getMethod();

		return method == null ? scenario == null ? null : scenario.getMethod() : method;
	}

	@Override
	public String getUsername() {
		String username = super.getUsername();

		return username == null ? scenario == null ? null : scenario.getUsername() : username;
	}

	@Override
	public String getPassword() {
		String username = super.getUsername();
		String password = super.getPassword();

		return username == null ? scenario == null ? null : scenario.getPassword() : password;
	}

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

	/**
	 * Returns request/command scheduler configuration data.
	 *
	 * @return scheduler configuration data
	 */
	public SchedulerData getSchedulerData() {
		return schedulerData;
	}

	/**
	 * Sets request/command scheduler configuration data.
	 *
	 * @param schedulerData
	 *            scheduler configuration data
	 */
	public void setSchedulerData(SchedulerData schedulerData) {
		this.schedulerData = schedulerData;
	}

	/**
	 * Sets scenario instance this step belongs to.
	 *
	 * @param scenario
	 *            scenario instance this step belongs to
	 */
	void setScenario(WsScenario scenario) {
		this.scenario = scenario;
	}

	/**
	 * Returns scenario instance this step belongs to.
	 * 
	 * @return scenario instance this step belongs to
	 */
	public WsScenario getScenario() {
		return scenario;
	}

	@Override
	public void setProperty(String name, String value) {
		super.setProperty(name, value);

		if (WsStreamProperties.PROP_SYNCHRONIZE_REQUESTS.equalsIgnoreCase(name)) {
			boolean sync = com.jkoolcloud.tnt4j.streams.utils.Utils.toBoolean(value);
			if (sync) {
				this.semaphore = new Semaphore(1);
			}
		}
	}

	/**
	 * Returns requests synchronization semaphore instance for this step.
	 * 
	 * @return step requests synchronization semaphore instance, or {@code null} is step requests does not require
	 *         synchronization
	 */
	public Semaphore getSemaphore() {
		return semaphore;
	}
}