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

Class FileResourceFactory

  • All Implemented Interfaces:
    ResourceFactory
    @Contract(threading=STATELESS)
public class FileResourceFactory
extends java.lang.Object
implements ResourceFactory
    Generates Resource instances whose body is stored in a temporary file.
    Since:
    4.1

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.io.File cacheDir  

    • Constructor Summary

      Constructors 
      Constructor Description
      FileResourceFactory​(java.io.File cacheDir)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      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.
      Resource generate​(java.lang.String requestId, java.lang.String eTag, byte[] content, int off, int len)
      Creates a Resource from a given response body.
      (package private) static java.lang.String generateUniqueCacheFileName​(java.lang.String requestId, java.lang.String eTag, byte[] content, int off, int len)  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • cacheDir

        private final java.io.File cacheDir

    • Constructor Detail

      • FileResourceFactory

        public FileResourceFactory​(java.io.File cacheDir)

    • Method Detail

      • generateUniqueCacheFileName

        static java.lang.String generateUniqueCacheFileName​(java.lang.String requestId,
                                                    java.lang.String eTag,
                                                    byte[] content,
                                                    int off,
                                                    int len)

      • generate

        public Resource generate​(java.lang.String requestId,
                         java.lang.String eTag,
                         byte[] content,
                         int off,
                         int len)
                  throws ResourceIOException
        Description copied from interface: ResourceFactory
        Creates a Resource from a given response body.
        Specified by:
        generate in interface ResourceFactory
        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
        Since:
        5.4

      • generate

        public Resource generate​(java.lang.String requestId,
                         byte[] content,
                         int off,
                         int len)
                  throws ResourceIOException
        Description copied from interface: ResourceFactory
        Creates a Resource from a given response body.
        Specified by:
        generate in interface ResourceFactory
        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

        public Resource generate​(java.lang.String requestId,
                         byte[] content)
                  throws ResourceIOException
        Description copied from interface: ResourceFactory
        Creates a Resource from a given response body.
        Specified by:
        generate in interface ResourceFactory
        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