Package play.mvc

Class RangeResults

java.lang.Object
play.mvc.RangeResults
public class RangeResults extends Object
Java API for Range results.

For reference, see RFC 7233.

  • Constructor Details

    • RangeResults

      public RangeResults()

  • Method Details

    • ofStream

      public static Result ofStream(Http.Request request, InputStream stream)
      Returns the stream as a result considering "Range" header. If the header is present and it is satisfiable, then a Result containing just the requested part will be returned. If the header is not present or is unsatisfiable, then a regular Result will be returned.
      Parameters:
      request - the request from which to retrieve the range header.
      stream - the content stream
      Returns:
      range result if "Range" header is present and regular result if not

    • ofStream

      public static Result ofStream(Http.Request request, InputStream stream, long contentLength)
      Returns the stream as a result considering "Range" header. If the header is present and it is satisfiable, then a Result containing just the requested part will be returned. If the header is not present or is unsatisfiable, then a regular Result will be returned.
      Parameters:
      request - the request from which to retrieve the range header.
      stream - the content stream
      contentLength - the entity length
      Returns:
      range result if "Range" header is present and regular result if not

    • ofStream

      public static Result ofStream(Http.Request request, InputStream stream, long contentLength, String filename)
      Returns the stream as a result considering "Range" header. If the header is present and it is satisfiable, then a Result containing just the requested part will be returned. If the header is not present or is unsatisfiable, then a regular Result will be returned.
      Parameters:
      request - the request from which to retrieve the range header.
      stream - the content stream
      contentLength - the entity length
      filename - filename used at the Content-Disposition header
      Returns:
      range result if "Range" header is present and regular result if not

    • ofStream

      public static Result ofStream(Http.Request request, InputStream stream, long contentLength, String filename, String contentType)
      Returns the stream as a result considering "Range" header. If the header is present and it is satisfiable, then a Result containing just the requested part will be returned. If the header is not present or is unsatisfiable, then a regular Result will be returned.
      Parameters:
      request - the request from which to retrieve the range header.
      stream - the content stream
      contentLength - the entity length
      filename - filename used at the Content-Disposition header
      contentType - the content type for this stream
      Returns:
      range result if "Range" header is present and regular result if not

    • ofPath

      public static Result ofPath(Http.Request request, Path path)
      Returns the path as a result considering "Range" header. If the header is present and it is satisfiable, then a Result containing just the requested part will be returned. If the header is not present or is unsatisfiable, then a regular Result will be returned.
      Parameters:
      request - the request from which to retrieve the range header.
      path - the content path
      Returns:
      range result if "Range" header is present and regular result if not

    • ofPath

      public static Result ofPath(Http.Request request, Path path, FileMimeTypes fileMimeTypes)
      Returns the path as a result considering "Range" header. If the header is present and it is satisfiable, then a Result containing just the requested part will be returned. If the header is not present or is unsatisfiable, then a regular Result will be returned.
      Parameters:
      request - the request from which to retrieve the range header.
      path - the content path
      fileMimeTypes - Used for file type mapping.
      Returns:
      range result if "Range" header is present and regular result if not

    • ofPath

      public static Result ofPath(Http.Request request, Path path, String fileName)
      Returns the path as a result considering "Range" header. If the header is present and it is satisfiable, then a Result containing just the requested part will be returned. If the header is not present or is unsatisfiable, then a regular Result will be returned.
      Parameters:
      request - the request from which to retrieve the range header.
      path - the content path
      fileName - filename used at the Content-Disposition header.
      Returns:
      range result if "Range" header is present and regular result if not

    • ofPath

      public static Result ofPath(Http.Request request, Path path, String fileName, FileMimeTypes fileMimeTypes)
      Returns the path as a result considering "Range" header. If the header is present and it is satisfiable, then a Result containing just the requested part will be returned. If the header is not present or is unsatisfiable, then a regular Result will be returned.
      Parameters:
      request - the request from which to retrieve the range header.
      path - the content path
      fileName - filename used at the Content-Disposition header.
      fileMimeTypes - Used for file type mapping.
      Returns:
      range result if "Range" header is present and regular result if not

    • ofFile

      public static Result ofFile(Http.Request request, File file)
      Returns the file as a result considering "Range" header. If the header is present and it is satisfiable, then a Result containing just the requested part will be returned. If the header is not present or is unsatisfiable, then a regular Result will be returned.
      Parameters:
      request - the request from which to retrieve the range header.
      file - the content file
      Returns:
      range result if "Range" header is present and regular result if not

    • ofFile

      public static Result ofFile(Http.Request request, File file, FileMimeTypes fileMimeTypes)
      Returns the file as a result considering "Range" header. If the header is present and it is satisfiable, then a Result containing just the requested part will be returned. If the header is not present or is unsatisfiable, then a regular Result will be returned.
      Parameters:
      request - the request from which to retrieve the range header.
      file - the content file
      fileMimeTypes - Used for file type mapping.
      Returns:
      range result if "Range" header is present and regular result if not

    • ofFile

      public static Result ofFile(Http.Request request, File file, String fileName)
      Returns the file as a result considering "Range" header. If the header is present and it is satisfiable, then a Result containing just the requested part will be returned. If the header is not present or is unsatisfiable, then a regular Result will be returned.
      Parameters:
      request - the request from which to retrieve the range header.
      file - the content file
      fileName - filename used at the Content-Disposition header
      Returns:
      range result if "Range" header is present and regular result if not

    • ofFile

      public static Result ofFile(Http.Request request, File file, String fileName, FileMimeTypes fileMimeTypes)
      Returns the file as a result considering "Range" header. If the header is present and it is satisfiable, then a Result containing just the requested part will be returned. If the header is not present or is unsatisfiable, then a regular Result will be returned.
      Parameters:
      request - the request from which to retrieve the range header.
      file - the content file
      fileName - filename used at the Content-Disposition header
      fileMimeTypes - Used for file type mapping.
      Returns:
      range result if "Range" header is present and regular result if not

    • ofSource

      public static Result ofSource(Http.Request request, Long entityLength, Source<ByteString,?> source, String fileName, String contentType)
      Returns the stream as a result considering "Range" header. If the header is present and it is satisfiable, then a Result containing just the requested part will be returned. If the header is not present or is unsatisfiable, then a regular Result will be returned.
      Parameters:
      request - the request from which to retrieve the range header.
      entityLength - the entityLength
      source - source of the entity
      fileName - filename used at the Content-Disposition header
      contentType - the content type for this stream
      Returns:
      range result if "Range" header is present and regular result if not

    • ofSource

      @ApiMayChange public static Result ofSource(Http.Request request, Long entityLength, RangeResults.SourceFunction getSource, String fileName, String contentType)