Package org.apache.juneau.rest.client

Class TransportResponse

java.lang.Object

org.apache.juneau.rest.client.TransportResponse

All Implemented Interfaces:

Closeable, AutoCloseable

public final class TransportResponse
extends Object
implements Closeable

A transport-layer HTTP response.

Produced by HttpTransport.execute(TransportRequest) and consumed by the higher-level RestResponse.

Callers must close this object (it implements Closeable) after consuming the response body; transport implementations use the close callback to release connection-pool resources.

Since:

9.2.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TransportResponse.Builder	Fluent builder for TransportResponse.

Method Summary

Modifier and Type	Method	Description
static TransportResponse.Builder	builder()	Returns a new TransportResponse.Builder.
void	close()
InputStream	getBody()	Returns the response body stream, or null if the response has no body.
TransportHeader	getFirstHeader(String name)	Returns the first header with the given name (case-insensitive), or null if absent.
List<TransportHeader>	getHeaders()	Returns all response headers.
String	getReasonPhrase()	Returns the reason phrase (e.g.
int	getStatusCode()	Returns the HTTP status code.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static TransportResponse.Builder builder()

Returns a new TransportResponse.Builder.

getStatusCode

public int getStatusCode()

Returns the HTTP status code.

Returns:

The status code (e.g. 200).

getReasonPhrase

public String getReasonPhrase()

Returns the reason phrase (e.g. "OK"), or null if absent.

Returns:

The reason phrase, possibly null.

getHeaders

public List<TransportHeader> getHeaders()

Returns all response headers.

Returns:

An unmodifiable list. Never null.

getFirstHeader

public TransportHeader getFirstHeader(String name)

Returns the first header with the given name (case-insensitive), or null if absent.

Parameters:

name - The header name. Must not be null.

Returns:

The first matching header, or null if absent.

getBody

public InputStream getBody()

Returns the response body stream, or null if the response has no body.

Callers must not close this stream directly — close the TransportResponse instead.

Returns:

The body stream, possibly null.

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException