Class HttpExchange

java.lang.Object

org.springframework.boot.actuate.web.exchanges.HttpExchange

public final class HttpExchange
extends Object

An HTTP request and response exchange. Can be used for analyzing contextual information such as HTTP headers. Data from this class will be exposed by the HttpExchangesEndpoint, usually as JSON.

Since:

3.0.0

Author:

Dave Syer, Andy Wilkinson, Phillip Webb

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	HttpExchange.Principal	Principal associated with an HTTP request-response exchange.
static final class	HttpExchange.Request	The request that started the exchange.
static final class	HttpExchange.Response	The response that finished the exchange.
static final class	HttpExchange.Session	The session associated with the exchange.
static final class	HttpExchange.Started	A started request that when finished will return a new HttpExchange instance.

Constructor Summary

Constructors

Constructor	Description
HttpExchange(Instant timestamp, HttpExchange.Request request, HttpExchange.Response response, @Nullable HttpExchange.Principal principal, @Nullable HttpExchange.Session session, @Nullable Duration timeTaken)	Primarily for use by HttpExchangeRepository implementations when recreating an exchange from a persistent store.

Method Summary

Modifier and Type	Method	Description
@Nullable HttpExchange.Principal	getPrincipal()	Returns the principal.
HttpExchange.Request	getRequest()	Returns the request that started the exchange.
HttpExchange.Response	getResponse()	Returns the response that completed the exchange.
@Nullable HttpExchange.Session	getSession()	Returns the session details.
Instant	getTimestamp()	Returns the instant that the exchange started.
@Nullable Duration	getTimeTaken()	Returns the total time taken for the exchange.
static HttpExchange.Started	start(Clock clock, RecordableHttpRequest request)	Start a new HttpExchange.Started from the given source request.
static HttpExchange.Started	start(RecordableHttpRequest request)	Start a new HttpExchange.Started from the given source request.

Methods inherited from class Object

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

Constructor Details

HttpExchange

public HttpExchange(Instant timestamp,
 HttpExchange.Request request,
 HttpExchange.Response response,
 @Nullable HttpExchange.Principal principal,
 @Nullable HttpExchange.Session session,
 @Nullable Duration timeTaken)

Primarily for use by HttpExchangeRepository implementations when recreating an exchange from a persistent store.

Parameters:

timestamp - the instant that the exchange started

request - the request

response - the response

principal - the principal

session - the session

timeTaken - the total time taken

Method Details

getTimestamp

public Instant getTimestamp()

Returns the instant that the exchange started.

Returns:

the start timestamp

getRequest

public HttpExchange.Request getRequest()

Returns the request that started the exchange.

Returns:

the request.

getResponse

public HttpExchange.Response getResponse()

Returns the response that completed the exchange.

Returns:

the response.

getPrincipal

public @Nullable HttpExchange.Principal getPrincipal()

Returns the principal.

Returns:

the request

getSession

public @Nullable HttpExchange.Session getSession()

Returns the session details.

Returns:

the session

getTimeTaken

public @Nullable Duration getTimeTaken()

Returns the total time taken for the exchange.

Returns:

the total time taken

start

public static HttpExchange.Started start(RecordableHttpRequest request)

Start a new HttpExchange.Started from the given source request.

Parameters:

request - the recordable HTTP request

Returns:

an in-progress request

start

public static HttpExchange.Started start(Clock clock,
 RecordableHttpRequest request)

Start a new HttpExchange.Started from the given source request.

Parameters:

clock - the clock to use

request - the recordable HTTP request

Returns:

an in-progress request