Package com.linecorp.armeria.client.cookie

Class CookieClient

java.lang.Object

com.linecorp.armeria.common.util.AbstractUnwrappable<Client<T_I,T_O>>

com.linecorp.armeria.client.DecoratingClient<I,O,I,O>

com.linecorp.armeria.client.SimpleDecoratingClient<HttpRequest,HttpResponse>

com.linecorp.armeria.client.SimpleDecoratingHttpClient

com.linecorp.armeria.client.cookie.CookieClient

All Implemented Interfaces:

Client<HttpRequest,HttpResponse>, HttpClient, Unwrappable

public final class CookieClient
extends SimpleDecoratingHttpClient

Decorates an HttpClient to set cookies to Cookie header of outgoing HttpRequest and store cookies from Set-Cookie headers of incoming HttpResponse.

Method Summary

Modifier and Type	Method	Description
HttpResponse	execute(ClientRequestContext ctx, HttpRequest req)	Sends a Request to a remote Endpoint, as specified in ClientRequestContext.endpoint().
static Function<? super HttpClient,CookieClient>	newDecorator()	Creates a new CookieClient decorator.
static Function<? super HttpClient,CookieClient>	newDecorator(CookieJar cookieJar)	Creates a new CookieClient decorator with a CookieJar implementation.
static Function<? super HttpClient,CookieClient>	newDecorator(CookiePolicy cookiePolicy)	Creates a new CookieClient decorator with a specified CookiePolicy.

Methods inherited from class com.linecorp.armeria.common.util.AbstractUnwrappable

as, toString, unwrap, unwrapAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.client.Client

as, unwrap

Methods inherited from interface com.linecorp.armeria.common.util.Unwrappable

equalsIgnoreWrapper, unwrapAll

Method Details

newDecorator

public static Function<? super HttpClient,CookieClient> newDecorator()

Creates a new CookieClient decorator.

newDecorator

public static Function<? super HttpClient,CookieClient> newDecorator(CookiePolicy cookiePolicy)

Creates a new CookieClient decorator with a specified CookiePolicy.

newDecorator

public static Function<? super HttpClient,CookieClient> newDecorator(CookieJar cookieJar)

Creates a new CookieClient decorator with a CookieJar implementation.

execute

public HttpResponse execute(ClientRequestContext ctx,
 HttpRequest req)
                     throws Exception

Description copied from interface: Client

Sends a Request to a remote Endpoint, as specified in ClientRequestContext.endpoint().

Returns:

the Response to the specified Request

Throws:

Exception