com.jkoolcloud.tnt4j.streams.scenario.WsResponse 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.concurrent.Semaphore;

/**
 * This class defines TNT4J-Streams-WS response data container.
 *
 * @param 
 *            type of request data
 * @param 
 *            type of response data
 *
 * @version $Revision: 2 $
 */
public class WsResponse extends WsRequest {

	private WsRequest originalRequest;

	/**
	 * Constructs a new WsResponse. Defines response data and tag as {@code null}.
	 *
	 * @param responseData
	 *            response data package
	 */
	public WsResponse(RS responseData) {
		super(responseData);
	}

	/**
	 * Constructs a new WsResponse. Defines response data and tag.
	 *
	 * @param responseData
	 *            response data package
	 * @param tags
	 *            response tags
	 */
	public WsResponse(RS responseData, String... tags) {
		super(responseData, tags);
	}

	/**
	 * Constructs a new WsResponse. Defines response and original request data.
	 * 
	 * @param responseData
	 *            response data package
	 * @param request
	 *            original request data
	 */
	public WsResponse(RS responseData, WsRequest request) {
		super(responseData, request.getTags());
		this.originalRequest = request;
	}

	/**
	 * Constructs a new WsResponse. Defines response and original request data from interim response data.
	 * 
	 * @param responseData
	 *            response data package
	 * @param iResponse
	 *            interim response data
	 */
	public WsResponse(RS responseData, WsResponse iResponse) {
		super(responseData, iResponse.getTags());
		this.originalRequest = iResponse.getOriginalRequest();
	}

	/**
	 * Returns original request data.
	 * 
	 * @return original request data
	 */
	public WsRequest getOriginalRequest() {
		return originalRequest;
	}

	/**
	 * Returns scenario step bound to this request over original request.
	 * 
	 * @return scenario step bound to this request
	 */
	@Override
	public WsScenarioStep getScenarioStep() {
		return originalRequest.getScenarioStep();
	}

	/**
	 * Returns semaphore instance for this response from bound scenario step.
	 * 
	 * @return semaphore instance for this response from bound scenario step
	 */
	public Semaphore getSemaphore() {
		WsScenarioStep step = getScenarioStep();

		return step == null ? null : step.getSemaphore();
	}
}