org.springframework.boot.actuate.endpoint.web

Class WebEndpointResponse<T>

java.lang.Object

org.springframework.boot.actuate.endpoint.web.WebEndpointResponse<T>

Type Parameters:

T - the type of the response body

public final class WebEndpointResponse<T>
extends Object

A WebEndpointResponse can be returned by an operation on a WebEndpointExtension to provide additional, web-specific information such as the HTTP status code.

Since:

2.0.0

Author:

Stephane Nicoll, Andy Wilkinson

Constructor Summary

Constructors

Constructor and Description
WebEndpointResponse() Creates a new WebEndpointResponse with no body and a 200 (OK) status.
WebEndpointResponse(int status) Creates a new WebEndpointResponse with no body and the given status.
WebEndpointResponse(T body) Creates a new WebEndpointResponse with then given body and a 200 (OK) status.
WebEndpointResponse(T body, int status) Creates a new WebEndpointResponse with then given body and status.

Method Summary

Modifier and Type	Method and Description
T	getBody() Returns the body for the response.
int	getStatus() Returns the status for the response.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebEndpointResponse

public WebEndpointResponse()

Creates a new WebEndpointResponse with no body and a 200 (OK) status.

WebEndpointResponse

public WebEndpointResponse(int status)

Creates a new WebEndpointResponse with no body and the given status.

Parameters:

status - the HTTP status

WebEndpointResponse

public WebEndpointResponse(T body)

Creates a new WebEndpointResponse with then given body and a 200 (OK) status.

Parameters:

body - the body

WebEndpointResponse

public WebEndpointResponse(T body,
                           int status)

Creates a new WebEndpointResponse with then given body and status.

Parameters:

body - the body

status - the HTTP status

Method Detail

getBody

public T getBody()

Returns the body for the response.

Returns:

the body

getStatus

public int getStatus()

Returns the status for the response.

Returns:

the status