io.vertx.core.http.HttpResponseHead Maven / Gradle / Ivy
/*
* Copyright (c) 2011-2024 Contributors to the Eclipse Foundation
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
* which is available at https://www.apache.org/licenses/LICENSE-2.0.
*
* SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
*/
package io.vertx.core.http;
import io.vertx.codegen.annotations.CacheReturn;
import io.vertx.codegen.annotations.GenIgnore;
import io.vertx.codegen.annotations.Nullable;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.MultiMap;
import java.util.List;
/**
* The state of the HTTP response head:
*
*
* - Status code / Message
* - Headers
*
*/
@VertxGen(concrete = false)
public interface HttpResponseHead {
/**
* @return the version of the response
*/
HttpVersion version();
/**
* @return the status code of the response
*/
int statusCode();
/**
* @return the status message of the response
*/
String statusMessage();
/**
* @return the headers
*/
@CacheReturn
MultiMap headers();
/**
* Return the first header value with the specified name
*
* @param headerName the header name
* @return the header value
*/
@Nullable String getHeader(String headerName);
/**
* Return the first header value with the specified name
*
* @param headerName the header name
* @return the header value
*/
@GenIgnore(GenIgnore.PERMITTED_TYPE)
String getHeader(CharSequence headerName);
/**
* @return the Set-Cookie headers (including trailers)
*/
@CacheReturn
List cookies();
}