play.mvc

Class RangeResults

java.lang.Object

play.mvc.RangeResults

public class RangeResults
extends java.lang.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(java.io.File file) Deprecated. Deprecated as of 2.7.0. Use ofFile(Http.Request, File) instead.
static Result	ofFile(java.io.File file, java.lang.String fileName) Deprecated. Deprecated as of 2.7.0. Use ofFile(Http.Request, File, String) instead.
static Result	ofFile(Http.Request request, java.io.File file) Returns the file as a result considering "Range" header.
static Result	ofFile(Http.Request request, java.io.File file, FileMimeTypes fileMimeTypes) Returns the file as a result considering "Range" header.
static Result	ofFile(Http.Request request, java.io.File file, java.lang.String fileName) Returns the file as a result considering "Range" header.
static Result	ofFile(Http.Request request, java.io.File file, java.lang.String fileName, FileMimeTypes fileMimeTypes) Returns the file as a result considering "Range" header.
static Result	ofPath(Http.Request request, java.nio.file.Path path) Returns the path as a result considering "Range" header.
static Result	ofPath(Http.Request request, java.nio.file.Path path, FileMimeTypes fileMimeTypes) Returns the path as a result considering "Range" header.
static Result	ofPath(Http.Request request, java.nio.file.Path path, java.lang.String fileName) Returns the path as a result considering "Range" header.
static Result	ofPath(Http.Request request, java.nio.file.Path path, java.lang.String fileName, FileMimeTypes fileMimeTypes) Returns the path as a result considering "Range" header.
static Result	ofPath(java.nio.file.Path path) Deprecated. Deprecated as of 2.7.0. Use ofPath(Http.Request, Path) instead.
static Result	ofPath(java.nio.file.Path path, java.lang.String fileName) Deprecated. Deprecated as of 2.7.0. Use {link ofPath(Http.Request, Path, String) instead.
static Result	ofSource(Http.Request request, java.lang.Long entityLength, akka.stream.javadsl.Source<akka.util.ByteString,?> source, java.lang.String fileName, java.lang.String contentType) Returns the stream as a result considering "Range" header.
static Result	ofSource(java.lang.Long entityLength, akka.stream.javadsl.Source<akka.util.ByteString,?> source, java.lang.String fileName, java.lang.String contentType) Deprecated. Deprecated as of 2.7.0. Use ofSource(Http.Request, Long, Source, String, String) instead.
static Result	ofStream(Http.Request request, java.io.InputStream stream) Returns the stream as a result considering "Range" header.
static Result	ofStream(Http.Request request, java.io.InputStream stream, long contentLength) Returns the stream as a result considering "Range" header.
static Result	ofStream(Http.Request request, java.io.InputStream stream, long contentLength, java.lang.String filename) Returns the stream as a result considering "Range" header.
static Result	ofStream(Http.Request request, java.io.InputStream stream, long contentLength, java.lang.String filename, java.lang.String contentType) Returns the stream as a result considering "Range" header.
static Result	ofStream(java.io.InputStream stream) Deprecated. Deprecated as of 2.7.0. Use ofStream(Http.Request, InputStream) instead.
static Result	ofStream(java.io.InputStream stream, long contentLength) Deprecated. Deprecated as of 2.7.0. Use ofStream(Http.Request, InputStream, long) instead.
static Result	ofStream(java.io.InputStream stream, long contentLength, java.lang.String filename) Deprecated. Deprecated as of 2.7.0. Use ofStream(Http.Request, InputStream, long, String) instead.
static Result	ofStream(java.io.InputStream stream, long contentLength, java.lang.String filename, java.lang.String contentType) Deprecated. Deprecated as of 2.7.0. Use ofStream(Http.Request, InputStream, long, String, String) instead.

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

@Deprecated
public static Result ofStream(java.io.InputStream stream)

Deprecated. Deprecated as of 2.7.0. Use ofStream(Http.Request, InputStream) instead.

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(Http.Request request,
                              java.io.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

@Deprecated
public static Result ofStream(java.io.InputStream stream,
                                          long contentLength)

Deprecated. Deprecated as of 2.7.0. Use ofStream(Http.Request, InputStream, long) instead.

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(Http.Request request,
                              java.io.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

@Deprecated
public static Result ofStream(java.io.InputStream stream,
                                          long contentLength,
                                          java.lang.String filename)

Deprecated. Deprecated as of 2.7.0. Use ofStream(Http.Request, InputStream, long, String) instead.

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(Http.Request request,
                              java.io.InputStream stream,
                              long contentLength,
                              java.lang.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

@Deprecated
public static Result ofStream(java.io.InputStream stream,
                                          long contentLength,
                                          java.lang.String filename,
                                          java.lang.String contentType)

Deprecated. Deprecated as of 2.7.0. Use ofStream(Http.Request, InputStream, long, String, String) instead.

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

ofStream

public static Result ofStream(Http.Request request,
                              java.io.InputStream stream,
                              long contentLength,
                              java.lang.String filename,
                              java.lang.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

@Deprecated
public static Result ofPath(java.nio.file.Path path)

Deprecated. Deprecated as of 2.7.0. Use ofPath(Http.Request, Path) instead.

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(Http.Request request,
                            java.nio.file.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,
                            java.nio.file.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

@Deprecated
public static Result ofPath(java.nio.file.Path path,
                                        java.lang.String fileName)

Deprecated. Deprecated as of 2.7.0. Use {link ofPath(Http.Request, Path, String) instead.

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

ofPath

public static Result ofPath(Http.Request request,
                            java.nio.file.Path path,
                            java.lang.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,
                            java.nio.file.Path path,
                            java.lang.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

@Deprecated
public static Result ofFile(java.io.File file)

Deprecated. Deprecated as of 2.7.0. Use ofFile(Http.Request, File) instead.

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(Http.Request request,
                            java.io.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,
                            java.io.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

@Deprecated
public static Result ofFile(java.io.File file,
                                        java.lang.String fileName)

Deprecated. Deprecated as of 2.7.0. Use ofFile(Http.Request, File, String) instead.

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

ofFile

public static Result ofFile(Http.Request request,
                            java.io.File file,
                            java.lang.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,
                            java.io.File file,
                            java.lang.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

@Deprecated
public static Result ofSource(java.lang.Long entityLength,
                                          akka.stream.javadsl.Source<akka.util.ByteString,?> source,
                                          java.lang.String fileName,
                                          java.lang.String contentType)

Deprecated. Deprecated as of 2.7.0. Use ofSource(Http.Request, Long, Source, String, String) instead.

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

ofSource

public static Result ofSource(Http.Request request,
                              java.lang.Long entityLength,
                              akka.stream.javadsl.Source<akka.util.ByteString,?> source,
                              java.lang.String fileName,
                              java.lang.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