Package io.undertow.server.handlers.resource

Class CachedResource

java.lang.Object
io.undertow.server.handlers.resource.CachedResource
All Implemented Interfaces:
RangeAwareResource, Resource
public class CachedResource extends Object implements Resource, RangeAwareResource
Author:
Stuart Douglas

  • Constructor Details

  • Method Details

    • getPath

      public String getPath()
      Specified by:
      getPath in interface Resource
      Returns:
      The path from the resource manager root

    • getLastModified

      public Date getLastModified()
      Specified by:
      getLastModified in interface Resource
      Returns:
      The last modified date of this resource, or null if this cannot be determined

    • getLastModifiedString

      public String getLastModifiedString()
      Specified by:
      getLastModifiedString in interface Resource
      Returns:
      A string representation of the last modified date, or null if this cannot be determined

    • getETag

      public ETag getETag()
      Specified by:
      getETag in interface Resource
      Returns:
      The resources etags

    • getName

      public String getName()
      Specified by:
      getName in interface Resource
      Returns:
      The name of the resource

    • isDirectory

      public boolean isDirectory()
      Specified by:
      isDirectory in interface Resource
      Returns:
      true if this resource represents a directory

    • list

      public List<Resource> list()
      Specified by:
      list in interface Resource
      Returns:
      a list of resources in this directory

    • getContentType

      public String getContentType(MimeMappings mimeMappings)
      Description copied from interface: Resource
      Return the resources content type. In most cases this will simply use the provided mime mappings, however in some cases the resource may have additional information as to the actual content type.
      Specified by:
      getContentType in interface Resource

    • serveBlocking

      public void serveBlocking(OutputStream outputStream, HttpServerExchange exchange) throws IOException
      Specified by:
      serveBlocking in interface Resource
      exchange - The exchange
      Throws:
      IOException

    • serveAsync

      public void serveAsync(io.undertow.httpcore.OutputChannel stream, HttpServerExchange exchange)
      Specified by:
      serveAsync in interface Resource
      exchange - The exchange

    • invalidate

      public void invalidate()

    • checkStillValid

      public boolean checkStillValid()

    • getContentLength

      public Long getContentLength()
      Specified by:
      getContentLength in interface Resource
      Returns:
      The content length, or null if it is unknown

    • getCacheKey

      public String getCacheKey()
      Specified by:
      getCacheKey in interface Resource
      Returns:
      A string that uniquely identifies this resource

    • getFile

      public File getFile()
      Specified by:
      getFile in interface Resource
      Returns:
      The underlying file that matches the resource. This may return null if the resource does not map to a file

    • getFilePath

      public Path getFilePath()
      Specified by:
      getFilePath in interface Resource
      Returns:
      The underlying file that matches the resource. This may return null if the resource does not map to a file

    • getResourceManagerRoot

      public File getResourceManagerRoot()
      Description copied from interface: Resource
      Returns the resource manager root. If the resource manager has multiple roots then this returns the one that is the parent of this resource.
      Specified by:
      getResourceManagerRoot in interface Resource
      Returns:
      a file representing the resource manager root. This may return null if the resource does not map to a file

    • getResourceManagerRootPath

      public Path getResourceManagerRootPath()
      Description copied from interface: Resource
      Returns the resource manager root. If the resource manager has multiple roots then this returns the one that is the parent of this resource.
      Specified by:
      getResourceManagerRootPath in interface Resource
      Returns:
      a path representing the resource manager root. This may return null if the resource does not map to a file

    • getUrl

      public URL getUrl()
      Specified by:
      getUrl in interface Resource
      Returns:
      The URL of the resource

    • serveRangeBlocking

      public void serveRangeBlocking(OutputStream outputStream, HttpServerExchange exchange, long start, long end) throws IOException
      Description copied from interface: RangeAwareResource
      Serve the resource, and call the provided callback when complete.
      Specified by:
      serveRangeBlocking in interface RangeAwareResource
      Parameters:
      outputStream - The sender to use.
      exchange - The exchange
      Throws:
      IOException

    • serveRangeAsync

      public void serveRangeAsync(io.undertow.httpcore.OutputChannel sender, HttpServerExchange exchange, long start, long end)
      Description copied from interface: RangeAwareResource
      Serve the resource, and call the provided callback when complete.
      Specified by:
      serveRangeAsync in interface RangeAwareResource
      Parameters:
      sender - The sender to use.
      exchange - The exchange

    • isRangeSupported

      public boolean isRangeSupported()
      Description copied from interface: RangeAwareResource
      It is possible that some resources managers may only support range requests on a subset of their resources,
      Specified by:
      isRangeSupported in interface RangeAwareResource
      Returns:
      true if this resource supports range requests