io.vertx.httpproxy.ProxyResponse Maven / Gradle / Ivy
/*
* Copyright (c) 2011-2020 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.httpproxy;
import io.vertx.codegen.annotations.Fluent;
import io.vertx.codegen.annotations.GenIgnore;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.Future;
import io.vertx.core.MultiMap;
import io.vertx.core.buffer.Buffer;
import io.vertx.core.http.HttpClient;
import io.vertx.core.http.HttpClientResponse;
import io.vertx.core.http.HttpServerRequest;
import io.vertx.core.http.HttpServerResponse;
import io.vertx.core.streams.ReadStream;
import java.util.function.Function;
/**
*
* Handles the interoperability of the response between the origin and the user agent.
*
* @author Julien Viet
*/
@VertxGen
public interface ProxyResponse {
/**
*
* Return the corresponding {@code ProxyRequest}.
*
* @return the proxy request
*/
ProxyRequest request();
/**
* Get the status code.
*
* @return the status code to be sent to the user agent
*/
int getStatusCode();
/**
* Set the status code to be sent to the user agent.
*
* The initial value is the proxied response status code.
*
* @param sc the status code
* @return a reference to this, so the API can be used fluently
*/
@Fluent
ProxyResponse setStatusCode(int sc);
/**
* Get the status message.
*
* @return the status message to be sent to the user agent
*/
String getStatusMessage();
/**
* Set the status message to be sent to the user agent.
*
*
The initial value is the proxied response status message.
*
* @param statusMessage the status message
* @return a reference to this, so the API can be used fluently
*/
@Fluent
ProxyResponse setStatusMessage(String statusMessage);
/**
* @return the headers that will be sent to the user agent, the returned headers can be modified. The headers
* map is populated with the proxied response headers
*/
MultiMap headers();
/**
* Put an HTTP header.
*
* @param name The header name
* @param value The header value
* @return a reference to this, so the API can be used fluently
*/
@GenIgnore
@Fluent
ProxyResponse putHeader(CharSequence name, CharSequence value);
/**
* Get the body of the response.
*
* @return the response body to be sent to the user agent
*/
Body getBody();
/**
* Set the request body to be sent to the user agent.
*
*
The initial request body value is the proxied response body.
*
* @param body the new body
* @return a reference to this, so the API can be used fluently
*/
@Fluent
ProxyResponse setBody(Body body);
/**
* @return the proxied HTTP server response
*/
HttpClientResponse proxiedResponse();
boolean publicCacheControl();
long maxAge();
/**
* @return the {@code etag} sent by the origin response
*/
String etag();
/**
* Send the proxies response to the user agent.
*/
Future send();
/**
* Release the proxy response.
*
* The proxied response is resumed, no HTTP response is sent to the user-agent
*/
@Fluent
ProxyResponse release();
}