/*
 * Copyright 2002-2020 the original author or authors.
 *
 * 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
 *
 *      https://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 org.springframework.http.server.reactive;

import org.springframework.http.HttpStatus;
import org.springframework.http.ReactiveHttpOutputMessage;
import org.springframework.http.ResponseCookie;
import org.springframework.lang.Nullable;
import org.springframework.util.MultiValueMap;

Represents a reactive server-side HTTP response.
Author:
Arjen Poutsma, Sebastien Deleuze, Rossen Stoyanchev
Since:
5.0/**
 * Represents a reactive server-side HTTP response.
 *
 * @author Arjen Poutsma
 * @author Sebastien Deleuze
 * @author Rossen Stoyanchev
 * @since 5.0
 */
public interface ServerHttpResponse extends ReactiveHttpOutputMessage {

	
Set the HTTP status code of the response.
Params:
status – the HTTP status as an HttpStatus enum value
Returns:
false if the status code change wasn't processed because the HTTP response is committed, true if successfully set./**
	 * Set the HTTP status code of the response.
	 * @param status the HTTP status as an {@link HttpStatus} enum value
	 * @return {@code false} if the status code change wasn't processed because
	 * the HTTP response is committed, {@code true} if successfully set.
	 */
	boolean setStatusCode(@Nullable HttpStatus status);

	
Return the status code that has been set, or otherwise fall back on the status of the response from the underlying server. The return value may be null if the status code value is outside the HttpStatus enum range, or if there is no default value from the underlying server. /**
	 * Return the status code that has been set, or otherwise fall back on the
	 * status of the response from the underlying server. The return value may
	 * be {@code null} if the status code value is outside the
	 * {@link HttpStatus} enum range, or if there is no default value from the
	 * underlying server.
	 */
	@Nullable
	HttpStatus getStatusCode();

	
Set the HTTP status code to the given value (potentially non-standard and not resolvable through the HttpStatus enum) as an integer. 
Params:
value – the status code value
Returns:
false if the status code change wasn't processed because the HTTP response is committed, true if successfully set.
Since:
5.2.4/**
	 * Set the HTTP status code to the given value (potentially non-standard and
	 * not resolvable through the {@link HttpStatus} enum) as an integer.
	 * @param value the status code value
	 * @return {@code false} if the status code change wasn't processed because
	 * the HTTP response is committed, {@code true} if successfully set.
	 * @since 5.2.4
	 */
	default boolean setRawStatusCode(@Nullable Integer value) {
		if (value == null) {
			return setStatusCode(null);
		}
		else {
			HttpStatus httpStatus = HttpStatus.resolve(value);
			if (httpStatus == null) {
				throw new IllegalStateException(
						"Unresolvable HttpStatus for general ServerHttpResponse: " + value);
			}
			return setStatusCode(httpStatus);
		}
	}

	
Return the status code that has been set, or otherwise fall back on the status of the response from the underlying server. The return value may be null if there is no default value from the underlying server. 
Since:
5.2.4/**
	 * Return the status code that has been set, or otherwise fall back on the
	 * status of the response from the underlying server. The return value may
	 * be {@code null} if there is no default value from the underlying server.
	 * @since 5.2.4
	 */
	@Nullable
	default Integer getRawStatusCode() {
		HttpStatus httpStatus = getStatusCode();
		return (httpStatus != null ? httpStatus.value() : null);
	}

	
Return a mutable map with the cookies to send to the server.
/**
	 * Return a mutable map with the cookies to send to the server.
	 */
	MultiValueMap<String, ResponseCookie> getCookies();

	
Add the given ResponseCookie. 
Params:
cookie – the cookie to add
Throws:
IllegalStateException – if the response has already been committed/**
	 * Add the given {@code ResponseCookie}.
	 * @param cookie the cookie to add
	 * @throws IllegalStateException if the response has already been committed
	 */
	void addCookie(ResponseCookie cookie);

}