Package org.apache.hc.client5.http.cache

Interface ResourceFactory

All Known Implementing Classes:

FileResourceFactory, HeapResourceFactory

@Contract(threading=STATELESS)
public interface ResourceFactory

Generates Resource instances for handling cached HTTP response bodies.

Since:

4.1

Method Summary

Modifier and Type	Method	Description
Resource	copy(java.lang.String requestId, Resource resource)	Deprecated. Do not use.
Resource	generate(java.lang.String requestId, byte[] content)	Creates a Resource from a given response body.
Resource	generate(java.lang.String requestId, byte[] content, int off, int len)	Creates a Resource from a given response body.
default Resource	generate(java.lang.String requestId, java.lang.String eTag, byte[] content, int off, int len)	Creates a Resource from a given response body.

Method Detail

generate

Resource generate(java.lang.String requestId,
                  byte[] content)
           throws ResourceIOException

Creates a Resource from a given response body.

Parameters:

requestId - a unique identifier for this particular response body.

content - byte array that represents the origin HTTP response body.

Returns:

a Resource containing however much of the response body was successfully read.

Throws:

ResourceIOException

generate

Resource generate(java.lang.String requestId,
                  byte[] content,
                  int off,
                  int len)
           throws ResourceIOException

Creates a Resource from a given response body.

Parameters:

requestId - a unique identifier for this particular response body.

content - byte array that represents the origin HTTP response body.

off - the start offset in the array.

len - the number of bytes to read from the array.

Returns:

a Resource containing however much of the response body was successfully read.

Throws:

ResourceIOException

generate

default Resource generate(java.lang.String requestId,
                          java.lang.String eTag,
                          byte[] content,
                          int off,
                          int len)
                   throws ResourceIOException

Creates a Resource from a given response body.

Parameters:

requestId - a unique identifier for this particular response body.

eTag - eTag Strong (unique) identifier for the resource entity with the given requestId, or null when not given or is weak (non-unique).

content - byte array that represents the origin HTTP response body.

off - the start offset in the array.

len - the number of bytes to read from the array.

Returns:

a Resource containing however much of the response body was successfully read.

Throws:

ResourceIOException

copy

@Deprecated
Resource copy(java.lang.String requestId,
              Resource resource)
       throws ResourceIOException

Deprecated.

Do not use.

Throws:

ResourceIOException