Package 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 @EndpointWebExtension to provide additional, web-specific information such as the HTTP status code.
Since:
2.0.0
Author:
Stephane Nicoll, Andy Wilkinson, Vedran Pavic

  • Field Details

    • STATUS_OK

      public static final int STATUS_OK
      200 OK.
      See Also:

    • STATUS_NO_CONTENT

      public static final int STATUS_NO_CONTENT
      204 No Content.
      See Also:

    • STATUS_BAD_REQUEST

      public static final int STATUS_BAD_REQUEST
      400 Bad Request.
      See Also:

    • STATUS_NOT_FOUND

      public static final int STATUS_NOT_FOUND
      404 Not Found.
      See Also:

    • STATUS_TOO_MANY_REQUESTS

      public static final int STATUS_TOO_MANY_REQUESTS
      429 Too Many Requests.
      See Also:

    • STATUS_INTERNAL_SERVER_ERROR

      public static final int STATUS_INTERNAL_SERVER_ERROR
      500 Internal Server Error.
      See Also:

    • STATUS_SERVICE_UNAVAILABLE

      public static final int STATUS_SERVICE_UNAVAILABLE
      503 Service Unavailable.
      See Also:

  • Constructor Details

    • 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 the given body and a 200 (OK) status.
      Parameters:
      body - the body

    • WebEndpointResponse

      public WebEndpointResponse(T body, Producible<?> producible)
      Creates a new WebEndpointResponse with the given body and content type and a 200 (OK) status.
      Parameters:
      body - the body
      producible - the producible providing the content type
      Since:
      2.5.0

    • WebEndpointResponse

      public WebEndpointResponse(T body, MimeType contentType)
      Creates a new WebEndpointResponse with the given body and content type and a 200 (OK) status.
      Parameters:
      body - the body
      contentType - the content type of the response
      Since:
      2.5.0

    • WebEndpointResponse

      public WebEndpointResponse(T body, int status)
      Creates a new WebEndpointResponse with the given body and status.
      Parameters:
      body - the body
      status - the HTTP status

    • WebEndpointResponse

      public WebEndpointResponse(T body, int status, MimeType contentType)
      Creates a new WebEndpointResponse with the given body and status.
      Parameters:
      body - the body
      status - the HTTP status
      contentType - the content type of the response
      Since:
      2.5.0

  • Method Details

    • getContentType

      public MimeType getContentType()
      Returns the content type of the response.
      Returns:
      the content type;

    • 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