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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RangeResults.SourceAndOffset
static interface	RangeResults.SourceFunction

Constructor Summary

Constructors

Constructor and Description
RangeResults()

Method Summary

Modifier and Type	Method and Description
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	ofSource(Http.Request request, java.lang.Long entityLength, RangeResults.SourceFunction getSource, java.lang.String fileName, java.lang.String contentType)
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	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.

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

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

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

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

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

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

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

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

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

ofSource

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