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 Summary

Constructors

Constructor and Description
RangeResults()

Method Summary

Modifier and Type	Method and Description
static Result	ofFile(File file) Returns the file as a result considering "Range" header.
static Result	ofFile(File file, String fileName) Returns the file as a result considering "Range" header.
static Result	ofPath(Path path) Returns the path as a result considering "Range" header.
static Result	ofPath(Path path, String fileName) Returns the path as a result considering "Range" header.
static Result	ofSource(Long entityLength, Source<ByteString,?> source, String fileName, String contentType) Returns the stream as a result considering "Range" header.
static Result	ofStream(InputStream stream) Returns the stream as a result considering "Range" header.
static Result	ofStream(InputStream stream, long contentLength) Returns the stream as a result considering "Range" header.
static Result	ofStream(InputStream stream, long contentLength, String filename) Returns the stream as a result considering "Range" header.
static Result	ofStream(InputStream stream, long contentLength, String filename, String contentType) Returns the stream as a result considering "Range" header.

Methods inherited from class java.lang.Object

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

Constructor Detail

RangeResults

public RangeResults()

Method Detail

ofStream

public static Result ofStream(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:

stream - the content stream

Returns:

range result if "Range" header is present and regular result if not

ofStream

public static Result ofStream(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:

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(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:

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(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:

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(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:

path - the content path

Returns:

range result if "Range" header is present and regular result if not

ofPath

public static Result ofPath(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:

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

ofFile

public static Result ofFile(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:

file - the content file

Returns:

range result if "Range" header is present and regular result if not

ofFile

public static Result ofFile(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:

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

ofSource

public static Result ofSource(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:

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