Package io.vertx.mutiny.ext.web.client

Class CachingWebClient

java.lang.Object

io.vertx.mutiny.ext.web.client.CachingWebClient

All Implemented Interfaces:

MutinyDelegate

public class CachingWebClient
extends Object
implements MutinyDelegate

An asynchronous cache aware HTTP / HTTP/2 client called CachingWebClient.

This client wraps a WebClient and makes it cache aware by adding features to it:

• Cache-Control header parsing
• Freshness checking

The client honors the following cache headers:

• Cache-Control with the following properties understood:
  • public
  • private
  • no-cache
  • no-store
  • max-age
  • s-maxage
  • stale-if-error
  • staile-while-revalidate
  • must-revalidate
• Expires
• ETag
• Vary

NOTE: This class has been automatically generated from the original non Mutiny-ified interface.

Author:

Craig Day

See Also:

• CachingWebClient

Field Summary

Fields

Modifier and Type	Field	Description
static final TypeArg<CachingWebClient>	__TYPE_ARG

Constructor Summary

Constructors

Constructor	Description
CachingWebClient(io.vertx.ext.web.client.CachingWebClient delegate)	Create a new instance of CachingWebClient delegating to the given (non-null) instance of CachingWebClient.
CachingWebClient(Object delegate)

Method Summary

Modifier and Type	Method	Description
static WebClient	create(WebClient webClient)	Create a cache aware web client using the provided WebClient.
static WebClient	create(WebClient webClient, io.vertx.ext.web.client.CachingWebClientOptions options)	Create a cache aware web client using the provided WebClient.
static WebClient	create(WebClient webClient, io.vertx.ext.web.client.spi.CacheStore cacheStore)	Create a cache aware web client using the provided WebClient.
static WebClient	create(WebClient webClient, io.vertx.ext.web.client.spi.CacheStore cacheStore, io.vertx.ext.web.client.CachingWebClientConfig options)	Create a cache aware web client using the provided WebClient.
static WebClient	create(WebClient webClient, io.vertx.ext.web.client.spi.CacheStore cacheStore, io.vertx.ext.web.client.CachingWebClientOptions options)	Create a cache aware web client using the provided WebClient.
boolean	equals(Object o)
io.vertx.ext.web.client.CachingWebClient	getDelegate()	Get the delegate instance.
int	hashCode()
static CachingWebClient	newInstance(io.vertx.ext.web.client.CachingWebClient delegate)	Creates a new instance of the CachingWebClient.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

__TYPE_ARG

public static final TypeArg<CachingWebClient> __TYPE_ARG

Constructor Details

CachingWebClient

public CachingWebClient(io.vertx.ext.web.client.CachingWebClient delegate)

Create a new instance of CachingWebClient delegating to the given (non-null) instance of CachingWebClient.

CachingWebClient

public CachingWebClient(Object delegate)

Method Details

getDelegate

public io.vertx.ext.web.client.CachingWebClient getDelegate()

Get the delegate instance.

This method returns the instance on which this shim is delegating the calls. And so, give you access to the bare API.

Specified by:

getDelegate in interface MutinyDelegate

Returns:

the delegate instance

create

public static WebClient create(WebClient webClient)

Create a cache aware web client using the provided WebClient.

Parameters:

webClient - the web client instance

Returns:

the created web client

create

public static WebClient create(WebClient webClient,
 io.vertx.ext.web.client.spi.CacheStore cacheStore)

Create a cache aware web client using the provided WebClient.

Parameters:

webClient - the web client instance

cacheStore - the cache adapter

Returns:

the created web client

create

public static WebClient create(WebClient webClient,
 io.vertx.ext.web.client.CachingWebClientOptions options)

Create a cache aware web client using the provided WebClient.

Parameters:

webClient - the web client instance

options - the caching web client options

Returns:

the created web client

create

public static WebClient create(WebClient webClient,
 io.vertx.ext.web.client.spi.CacheStore cacheStore,
 io.vertx.ext.web.client.CachingWebClientOptions options)

Create a cache aware web client using the provided WebClient.

Parameters:

webClient - the web client instance

cacheStore - the cache adapter

options - the caching web client options

Returns:

the created web client

create

public static WebClient create(WebClient webClient,
 io.vertx.ext.web.client.spi.CacheStore cacheStore,
 io.vertx.ext.web.client.CachingWebClientConfig options)

Create a cache aware web client using the provided WebClient.

Parameters:

webClient - the web client instance

cacheStore - the cache adapter

options - the caching web client options

Returns:

the created web client

newInstance

public static CachingWebClient newInstance(io.vertx.ext.web.client.CachingWebClient delegate)

Creates a new instance of the CachingWebClient.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object