com.arangodb.shaded.vertx.ext.web.client.WebClientSession Maven / Gradle / Ivy
/*
* Copyright (c) 2011-2018 Contributors to the Eclipse Foundation
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
* which is available at https://www.apache.org/licenses/LICENSE-2.0.
*
* SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
*/
package com.arangodb.shaded.vertx.ext.web.client;
import com.arangodb.shaded.vertx.codegen.annotations.Fluent;
import com.arangodb.shaded.vertx.codegen.annotations.GenIgnore;
import com.arangodb.shaded.vertx.codegen.annotations.VertxGen;
import com.arangodb.shaded.vertx.ext.web.client.impl.WebClientSessionAware;
import com.arangodb.shaded.vertx.ext.web.client.spi.CookieStore;
import static com.arangodb.shaded.vertx.codegen.annotations.GenIgnore.PERMITTED_TYPE;
/**
* An asynchronous sessions aware HTTP / HTTP/2 client called {@code WebClientSession}.
*
* This client wraps a {@link WebClient} and makes it session aware adding features to it:
*
* - Per client headers, to be send with every request
* - Per client cookies, to be send with every request
* - Automatic storage and sending of cookies received from the server(s)
*
*
* The client honors the cookies attributes:
*
* - domain
* - path
* - secure
* - max-age and expires
*
*
*
* @author Tommaso Nolli
*/
@VertxGen
public interface WebClientSession extends WebClient {
/**
* Create a session aware web client using the provided {@code webClient} instance.
*
* @param webClient the web client instance
* @return the created client
*/
static WebClientSession create(WebClient webClient) {
return create(webClient, CookieStore.build());
}
/**
* Create a session aware web client using the provided {@code webClient} instance.
*
* @param webClient the web client instance
* @return the created client
*/
@GenIgnore(PERMITTED_TYPE)
static WebClientSession create(WebClient webClient, CookieStore cookieStore) {
return new WebClientSessionAware(webClient, cookieStore);
}
/**
* Configure the client to add an HTTP header to every request.
*
* @param name the header name
* @param value the header value
* @return a reference to this, so the API can be used fluently
*/
@Fluent
@GenIgnore(PERMITTED_TYPE)
WebClientSession addHeader(CharSequence name, CharSequence value);
/**
* Configure the client to add an HTTP header to every request.
*
* @param name the header name
* @param value the header value
* @return a reference to this, so the API can be used fluently
*/
@Fluent
WebClientSession addHeader(String name, String value);
/**
* Configure the client to add an HTTP header to every request.
*
* @param name the header name
* @param values the header value
* @return a reference to this, so the API can be used fluently
*/
@Fluent
@GenIgnore(PERMITTED_TYPE)
WebClientSession addHeader(CharSequence name, Iterable values);
/**
* Configure the client to add an HTTP header to every request.
*
* @param name the header name
* @param values the header value
* @return a reference to this, so the API can be used fluently
*/
@Fluent
@GenIgnore(PERMITTED_TYPE)
WebClientSession addHeader(String name, Iterable values);
/**
* Removes a previously added header.
*
* @param name the header name
* @return a reference to this, so the API can be used fluently
*/
@Fluent
@GenIgnore(PERMITTED_TYPE)
WebClientSession removeHeader(CharSequence name);
/**
* Removes a previously added header.
*
* @param name the header name
* @return a reference to this, so the API can be used fluently
*/
@Fluent
WebClientSession removeHeader(String name);
/**
* Returns this client's {@code CookieStore}
*
* All cookies added to this store will be sent with every request.
* The CookieStore honors the domain, path, secure and max-age properties of received cookies
* and is automatically updated with cookies present in responses received by this client.
* @return this client's cookie store
*/
@GenIgnore(PERMITTED_TYPE)
CookieStore cookieStore();
}