Interface HttpCodeStatusMapper

All Known Implementing Classes:

SimpleHttpCodeStatusMapper

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface HttpCodeStatusMapper

Strategy used to map a health status to an HTTP status code.

Since:

4.0.0

Author:

Stephane Nicoll, Phillip Webb

Field Summary

Fields

Modifier and Type	Field	Description
static final HttpCodeStatusMapper	DEFAULT	Deprecated, for removal: This API element is subject to removal in a future version. since 4.1.0 for removal in 4.3.0 in favor of #getDefault()

Method Summary

Modifier and Type	Method	Description
static HttpCodeStatusMapper	getDefault()	Return an HttpCodeStatusMapper instance using default mappings.
int	getStatusCode(Status status)	Return the HTTP status code that corresponds to the given health status.
static HttpCodeStatusMapper	of(@Nullable Map<String,Integer> mappings)	Create a new HttpCodeStatusMapper with the specified mappings.

Field Details

DEFAULT

@Deprecated(since="4.1.0",
            forRemoval=true)
static final HttpCodeStatusMapper DEFAULT

Deprecated, for removal: This API element is subject to removal in a future version.

since 4.1.0 for removal in 4.3.0 in favor of #getDefault()

An HttpCodeStatusMapper instance using default mappings.

Method Details

getStatusCode

int getStatusCode(Status status)

Return the HTTP status code that corresponds to the given health status.

Parameters:

status - the health status to map

Returns:

the corresponding HTTP status code

of

static HttpCodeStatusMapper of(@Nullable Map<String,Integer> mappings)

Create a new HttpCodeStatusMapper with the specified mappings.

Parameters:

mappings - the mappings to use or null to use the default mappings

Returns:

a HttpCodeStatusMapper or getDefault()

Since:

4.1.0

getDefault

static HttpCodeStatusMapper getDefault()

Return an HttpCodeStatusMapper instance using default mappings.

Returns:

a mapper using default mappings

Since:

4.1.0