Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
Copyright (C) 2013-2018 Expedia Inc.
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.hotels.styx.api.messages;
import com.google.common.collect.ImmutableList;
import com.hotels.styx.api.HttpCookie;
import com.hotels.styx.api.HttpHeaders;
import com.hotels.styx.api.HttpResponse;
import io.netty.buffer.Unpooled;
import rx.Observable;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import static com.google.common.base.MoreObjects.toStringHelper;
import static com.google.common.base.Preconditions.checkArgument;
import static com.hotels.styx.api.HttpHeaderNames.CONTENT_LENGTH;
import static com.hotels.styx.api.HttpHeaderNames.TRANSFER_ENCODING;
import static com.hotels.styx.api.HttpHeaderValues.CHUNKED;
import static com.hotels.styx.api.messages.HttpResponseStatus.OK;
import static com.hotels.styx.api.messages.HttpResponseStatus.statusWithCode;
import static com.hotels.styx.api.messages.HttpVersion.HTTP_1_1;
import static com.hotels.styx.api.messages.HttpVersion.httpVersion;
import static com.hotels.styx.api.support.CookiesSupport.findCookie;
import static java.lang.Integer.parseInt;
import static java.util.Objects.requireNonNull;
import static rx.Observable.just;
/**
* HTTP response with a fully aggregated/decoded body.
*/
public class FullHttpResponse implements FullHttpMessage {
private final HttpVersion version;
private final HttpResponseStatus status;
private final HttpHeaders headers;
private final byte[] body;
private final List cookies;
FullHttpResponse(Builder builder) {
this.version = builder.version;
this.status = builder.status;
this.headers = builder.headers.build();
this.body = requireNonNull(builder.body);
this.cookies = ImmutableList.copyOf(builder.cookies);
}
/**
* Creates an HTTP response builder with a status of 200 OK and empty body.
*
* @return a new builder
*/
public static Builder response() {
return new Builder();
}
/**
* Creates an HTTP response builder with a given status and empty body.
*
* @param status response status
* @return a new builder
*/
public static Builder response(HttpResponseStatus status) {
return new Builder(status);
}
@Override
public Optional header(CharSequence name) {
return headers.get(name);
}
@Override
public List headers(CharSequence name) {
return headers.getAll(name);
}
@Override
public HttpHeaders headers() {
return headers;
}
@Override
public List cookies() {
return cookies;
}
/**
* Returns the body of this message in its unencoded form.
*
* @return the body
*/
@Override
public byte[] body() {
return body.clone();
}
/**
* Returns the message body as a String decoded with provided character set.
*
* Decodes the message body into a Java String object with a provided charset.
* The caller must ensure the provided charset is compatible with message content
* type and encoding.
*
* @param charset Charset used to decode message body.
* @return Message body as a String.
*/
@Override
public String bodyAs(Charset charset) {
// CHECKSTYLE:OFF
return new String(body, charset);
// CHECKSTYLE:ON
}
@Override
public HttpVersion version() {
return version;
}
public Builder newBuilder() {
return new Builder(this);
}
public HttpResponseStatus status() {
return status;
}
public boolean isRedirect() {
return status.code() >= 300 && status.code() < 400;
}
/**
* Converts this response to a streaming form (HttpResponse).
*
* Converts this response to a HttpResponse object which represents the HTTP response as a
* stream of bytes.
*
* @return A streaming HttpResponse object.
*/
public HttpResponse toStreamingResponse() {
if (this.body.length == 0) {
return new HttpResponse.Builder(this, Observable.empty()).build();
} else {
return new HttpResponse.Builder(this, just(Unpooled.copiedBuffer(this.body))).build();
}
}
@Override
public String toString() {
return toStringHelper(this)
.add("version", version)
.add("status", status)
.add("headers", headers)
.add("cookies", cookies)
.toString();
}
@Override
public int hashCode() {
return Objects.hash(version, status, headers, cookies);
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null || getClass() != obj.getClass()) {
return false;
}
FullHttpResponse other = (FullHttpResponse) obj;
return Objects.equals(this.version, other.version)
&& Objects.equals(this.status, other.status)
&& Objects.equals(this.headers, other.headers)
&& Objects.equals(this.cookies, other.cookies);
}
/**
* Builder.
*/
public static final class Builder {
private HttpResponseStatus status = OK;
private HttpHeaders.Builder headers;
private HttpVersion version = HTTP_1_1;
private boolean validate = true;
private byte[] body;
private final List cookies;
public Builder() {
this.headers = new HttpHeaders.Builder();
this.body = new byte[0];
this.cookies = new ArrayList<>();
}
public Builder(HttpResponseStatus status) {
this();
this.status = status;
}
public Builder(FullHttpResponse response) {
this.status = response.status();
this.version = response.version();
this.headers = response.headers().newBuilder();
this.body = response.body();
this.cookies = new ArrayList<>(response.cookies());
}
public Builder(HttpResponse response, byte[] encodedBody) {
this.status = statusWithCode(response.status().code());
this.version = httpVersion(response.version().toString());
this.headers = response.headers().newBuilder();
this.body = encodedBody;
this.cookies = new ArrayList<>(response.cookies());
}
public Builder(StreamingHttpResponse response, byte[] decoded) {
this.status = response.status();
this.version = response.version();
this.headers = response.headers().newBuilder();
this.body = decoded;
this.cookies = new ArrayList<>(response.cookies());
}
/**
* Sets the response status.
*
* @param status response status
* @return {@code this}
*/
public Builder status(HttpResponseStatus status) {
this.status = status;
return this;
}
/**
* Sets the request body.
*
* This method encodes a String content to a byte array using the specified
* charset, and sets the Content-Length header accordingly.
*
* @param content request body
* @param charset Charset for string encoding.
* @return {@code this}
*/
public Builder body(String content, Charset charset) {
return body(content, charset, true);
}
/**
* Sets the response body.
*
* This method encodes the content to a byte array using the specified
* charset, and sets the Content-Length header *if* the setContentLength
* argument is true.
*
* @param content response body
* @param charset Charset used for encoding response body.
* @param setContentLength If true, Content-Length header is set, otherwise it is not set.
* @return {@code this}
*/
public Builder body(String content, Charset charset, boolean setContentLength) {
requireNonNull(charset, "Charset is not provided.");
String sanitised = content == null ? "" : content;
return body(sanitised.getBytes(charset), setContentLength);
}
/**
* Sets the response body.
*
* This method encodes the content to a byte array provided, and
* sets the Content-Length header *if* the setContentLength
* argument is true.
*
* @param content response body
* @param setContentLength If true, Content-Length header is set, otherwise it is not set.
* @return {@code this}
*/
public Builder body(byte[] content, boolean setContentLength) {
this.body = content == null ? new byte[0] : content.clone();
if (setContentLength) {
header(CONTENT_LENGTH, this.body.length);
}
return this;
}
/**
* Sets the HTTP version.
*
* @param version HTTP version
* @return {@code this}
*/
public Builder version(HttpVersion version) {
this.version = requireNonNull(version);
return this;
}
/**
* Disables client-side caching of this response.
*
* @return {@code this}
*/
public Builder disableCaching() {
header("Pragma", "no-cache");
header("Expires", "Mon, 1 Jan 2007 08:00:00 GMT");
header("Cache-Control", "no-cache,must-revalidate,no-store");
return this;
}
/**
* Makes this response chunked.
*
* @return {@code this}
*/
public Builder setChunked() {
headers.add(TRANSFER_ENCODING, CHUNKED);
headers.remove(CONTENT_LENGTH);
return this;
}
/**
* Adds a response cookie (adds a new Set-Cookie header).
*
* @param cookie cookie to add
* @return {@code this}
*/
public Builder addCookie(HttpCookie cookie) {
cookies.add(requireNonNull(cookie));
return this;
}
/**
* Adds a response cookie (adds a new Set-Cookie header).
*
* @param name cookie name
* @param value cookie value
* @return {@code this}
*/
public Builder addCookie(String name, String value) {
return addCookie(HttpCookie.cookie(name, value));
}
/**
* Removes a cookie if present (removes its Set-Cookie header).
*
* @param name name of the cookie
* @return {@code this}
*/
public Builder removeCookie(String name) {
findCookie(cookies, name)
.ifPresent(cookies::remove);
return this;
}
/**
* Sets the (only) value for the header with the specified name.
*
* All existing values for the same header will be removed.
*
* @param name The name of the header
* @param value The value of the header
* @return {@code this}
*/
public Builder header(CharSequence name, Object value) {
this.headers.set(name, value);
return this;
}
/**
* Adds a new header with the specified {@code name} and {@code value}.
*
* Will not replace any existing values for the header.
*
* @param name The name of the header
* @param value The value of the header
* @return {@code this}
*/
public Builder addHeader(CharSequence name, Object value) {
headers.add(name, value);
return this;
}
/**
* Removes the header with the specified name.
*
* @param name The name of the header to remove
* @return {@code this}
*/
public Builder removeHeader(CharSequence name) {
headers.remove(name);
return this;
}
/**
* Sets the headers.
*
* @param headers headers
* @return {@code this}
*/
public Builder headers(HttpHeaders headers) {
this.headers = headers.newBuilder();
return this;
}
/**
* Enable validation of uri and some headers.
*
* @return {@code this}
*/
public Builder disableValidation() {
this.validate = false;
return this;
}
/**
* Builds a new full response based on the settings configured in this builder.
* If {@code validate} is set to true:
*
*
an exception will be thrown if the content length is not an integer, or more than one content length exists
*
*
* @return a new full response
*/
public FullHttpResponse build() {
if (validate) {
ensureContentLengthIsValid();
}
return new FullHttpResponse(this);
}
Builder ensureContentLengthIsValid() {
List contentLengths = headers.build().getAll(CONTENT_LENGTH);
checkArgument(contentLengths.size() <= 1, "Duplicate Content-Length found. %s", contentLengths);
if (contentLengths.size() == 1) {
checkArgument(isInteger(contentLengths.get(0)), "Invalid Content-Length found. %s", contentLengths.get(0));
}
return this;
}
private static boolean isInteger(String contentLength) {
try {
parseInt(contentLength);
return true;
} catch (NumberFormatException e) {
return false;
}
}
}
}
