Package net.lenni0451.commons.httpclient

Class HttpResponse

java.lang.Object

net.lenni0451.commons.httpclient.HeaderStore<HttpResponse>

net.lenni0451.commons.httpclient.HttpResponse

public class HttpResponse
extends HeaderStore<HttpResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HttpResponse.DecoderProvider	A provider for decoders based on the encoding name.
static interface	HttpResponse.InputStreamMapper	A function that maps an input stream to another input stream, e.g., for decompression.

Constructor Summary

Constructors

Constructor	Description
HttpResponse(java.net.URL url, int statusCode, byte[] content, java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers)
HttpResponse(java.net.URL url, int statusCode, java.io.InputStream inputStream, java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers)
HttpResponse(java.net.URL url, int statusCode, HttpContent content, java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers)

Method Summary

Modifier and Type	Method	Description
HttpContent	getContent()
java.lang.String	getContentAsString()	Deprecated.
java.lang.String	getContentAsString(java.nio.charset.Charset charset)	Deprecated.
java.util.Optional<ContentType>	getContentType()	Deprecated.
HttpContent	getDecodedContent()	Get the decoded content of the response. Supported encodings are: identify (no encoding) gzip (also x-gzip) deflate Library support for the following encodings is also included, if the respective library is available on the classpath: brotli com.aayushatharva.brotli4j:brotli4j org.brotli:dec zstd io.airlift:aircompressor io.airlift:aircompressor-v3 com.github.luben:zstd-jni
HttpContent	getDecodedContent(HttpResponse.DecoderProvider decoderProvider)	Get the decoded content of the response. Closing the returned content will also close the original content. If the content is not encoded, or uses an unsupported encoding, the original content will be returned. The HttpHeaders.CONTENT_ENCODING header is renamed to Original-Content-Encoding if the content has been decoded.
java.io.InputStream	getInputStream()	Deprecated.
int	getStatusCode()
java.lang.String	getStatusMessage()
java.net.URL	getURL()

Methods inherited from class net.lenni0451.commons.httpclient.HeaderStore

appendHeader, appendHeader, appendHeader, clearHeaders, forEachHeader, getFirstHeader, getHeader, getHeaders, getLastHeader, hasHeader, hasHeader, hasHeader, removeHeader, setHeader, setHeader, setHeader

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpResponse

public HttpResponse(java.net.URL url,
                    int statusCode,
                    byte[] content,
                    java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers)

HttpResponse

public HttpResponse(java.net.URL url,
                    int statusCode,
                    java.io.InputStream inputStream,
                    java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers)

HttpResponse

public HttpResponse(java.net.URL url,
                    int statusCode,
                    HttpContent content,
                    java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers)

Method Detail

getURL

public java.net.URL getURL()

Returns:

The request url

getStatusCode

public int getStatusCode()

Returns:

The status code of the response

getStatusMessage

public java.lang.String getStatusMessage()

Returns:

The message of the status code

getContent

public HttpContent getContent()

Returns:

The content of the response

getDecodedContent

public HttpContent getDecodedContent()

Get the decoded content of the response.
Supported encodings are:

• identify (no encoding)
• gzip (also x-gzip)
• deflate

Library support for the following encodings is also included, if the respective library is available on the classpath:

• brotli
  • com.aayushatharva.brotli4j:brotli4j
  • org.brotli:dec
• zstd
  • io.airlift:aircompressor
  • io.airlift:aircompressor-v3
  • com.github.luben:zstd-jni

Returns:

The decoded content

See Also:

getDecodedContent(DecoderProvider)

getDecodedContent

public HttpContent getDecodedContent(HttpResponse.DecoderProvider decoderProvider)

Get the decoded content of the response.
Closing the returned content will also close the original content.
If the content is not encoded, or uses an unsupported encoding, the original content will be returned.
The HttpHeaders.CONTENT_ENCODING header is renamed to Original-Content-Encoding if the content has been decoded.

Parameters:

decoderProvider - The provider for content decoders

Returns:

The decoded content

getInputStream

@Deprecated
@ScheduledForRemoval
public java.io.InputStream getInputStream()

Deprecated.

Use getContent() and HttpContent.getAsStream() instead.

getContentAsString

@Deprecated
@ScheduledForRemoval
public java.lang.String getContentAsString()

Deprecated.

Use getContent() and HttpContent.getAsString() instead.

getContentAsString

@Deprecated
@ScheduledForRemoval
public java.lang.String getContentAsString(java.nio.charset.Charset charset)

Deprecated.

Use getContent() and HttpContent.getAsString(Charset) instead.

getContentType

@Deprecated
@ScheduledForRemoval
public java.util.Optional<ContentType> getContentType()

Deprecated.

Use getContent() and HttpContent.getType() instead.