Package io.micronaut.http.cookie

Interface ClientCookieEncoder

All Known Implementing Classes:

DefaultClientCookieEncoder, NettyLaxClientCookieEncoder

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 ClientCookieEncoder

Encodes a Cookie into a String. Typically used to set the HttpHeaders.COOKIE value for example in an HTTP Client. The cookie gets serialized by concatenating the cookie's name, the %x3D ("=") character, and the cookie's value.

Since:

4.3.0

Author:

Sergio del Amo

See Also:

• Cookie Header.

Field Summary

Fields

Modifier and Type	Field	Description
static final ClientCookieEncoder	INSTANCE	The default ServerCookieEncoder instance.

Method Summary

Modifier and Type	Method	Description
@NonNull String	encode(@NonNull Cookie cookie)	Encodes a Cookie into a String.

Field Details

INSTANCE

static final ClientCookieEncoder INSTANCE

The default ServerCookieEncoder instance.

Method Details

encode

@NonNull
@NonNull String encode(@NonNull
 @NonNull Cookie cookie)

Encodes a Cookie into a String. Typically used to set the HttpHeaders.COOKIE value for example in an HTTP Client. The cookie gets serialized by concatenating the cookie's name, the %x3D ("=") character, and the cookie's value.

Parameters:

cookie - Cookie to encode

Returns:

The cookie serialized into a string by concatenating the cookie's name, the %x3D ("=") character, and the cookie's value.

See Also:

• Cookie Header.