ApiResponse.java

/*
 * GovWay - A customizable API Gateway 
 * https://govway.org
 * 
 * Copyright (c) 2005-2024 Link.it srl (https://link.it). 
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 3, as published by
 * the Free Software Foundation.
 *
 * 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, see <http://www.gnu.org/licenses/>.
 *
 */

package org.openspcoop2.utils.rest.api;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;

import org.openspcoop2.utils.beans.BaseBean;

/**
 * ApiResponse
 *
 *
 * @author Poli Andrea (apoli@link.it)
 * @author $Author$
 * @version $Rev$, $Date$
 */
public class ApiResponse extends BaseBean implements Serializable {

	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;
	
	private static final int defaultHttpReturnCode = -2;
	public static final int getDefaultHttpReturnCode() {
		return defaultHttpReturnCode;
	}
	public static final boolean isDefaultHttpReturnCode(int value) {
		return defaultHttpReturnCode==value;
	}
	
	private String description;
	private int httpReturnCode;
	
	private List<ApiCookieParameter> cookieParameters = new ArrayList<>();
	private List<ApiHeaderParameter> headerParameters = new ArrayList<>();
	
	private List<ApiBodyParameter> bodyParameters = new ArrayList<>();
	
	public String getDescription() {
		return this.description;
	}
	public void setDescription(String description) {
		this.description = description;
	}
	public boolean isDefaultHttpReturnCode() {
		return isDefaultHttpReturnCode(this.httpReturnCode);
	}
	public int getHttpReturnCode() {
		return this.httpReturnCode;
	}
	public void setDefaultHttpReturnCode() {
		this.httpReturnCode = getDefaultHttpReturnCode();
	}
	public void setHttpReturnCode(int httpReturnCode) {
		this.httpReturnCode = httpReturnCode;
	}
	
	public void addCookieParameter(ApiCookieParameter parameter) {
		this.cookieParameters.add(parameter);
	}

	public ApiCookieParameter getCookieParameter(int index) {
		return this.cookieParameters.get( index );
	}

	public ApiCookieParameter removeCookieParameter(int index) {
		return this.cookieParameters.remove( index );
	}

	public List<ApiCookieParameter> getCookieParameters() {
		return this.cookieParameters;
	}

	public void setCookieParameters(List<ApiCookieParameter> parameters) {
		this.cookieParameters=parameters;
	}

	public int sizeCookieParameters() {
		return this.cookieParameters.size();
	}
	
	
	public void addHeaderParameter(ApiHeaderParameter parameter) {
		this.headerParameters.add(parameter);
	}

	public ApiHeaderParameter getHeaderParameter(int index) {
		return this.headerParameters.get( index );
	}

	public ApiHeaderParameter removeHeaderParameter(int index) {
		return this.headerParameters.remove( index );
	}

	public List<ApiHeaderParameter> getHeaderParameters() {
		return this.headerParameters;
	}

	public void setHeaderParameters(List<ApiHeaderParameter> parameters) {
		this.headerParameters=parameters;
	}

	public int sizeHeaderParameters() {
		return this.headerParameters.size();
	}
	
	
	public void addBodyParameter(ApiBodyParameter parameter) {
		this.bodyParameters.add(parameter);
	}

	public ApiBodyParameter getBodyParameter(int index) {
		return this.bodyParameters.get( index );
	}

	public ApiBodyParameter removeBodyParameter(int index) {
		return this.bodyParameters.remove( index );
	}

	public List<ApiBodyParameter> getBodyParameters() {
		return this.bodyParameters;
	}

	public void setBodyParameters(List<ApiBodyParameter> parameters) {
		this.bodyParameters=parameters;
	}

	public int sizeBodyParameters() {
		return this.bodyParameters.size();
	}
}