play.mvc

Class StatusHeader

java.lang.Object

play.mvc.Result

play.mvc.StatusHeader

public class StatusHeader
extends Result

A status with no body

Constructor Summary

Constructors

Constructor and Description
StatusHeader(int status)

Method Summary

Modifier and Type	Method and Description
Result	chunked(akka.stream.javadsl.Source<akka.util.ByteString,?> chunks) Send a chunked response with the given chunks.
Result	sendEntity(HttpEntity entity)
Result	sendFile(java.io.File file) Sends the given file using the default inline mode.
Result	sendFile(java.io.File file, boolean inline) Sends the given file.
Result	sendFile(java.io.File file, boolean inline, java.lang.String fileName) Send the given file.
Result	sendFile(java.io.File file, java.lang.String fileName) Send the given file.
Result	sendInputStream(java.io.InputStream stream) Send the given input stream.
Result	sendInputStream(java.io.InputStream stream, long contentLength) Send the given input stream.
Result	sendJson(com.fasterxml.jackson.databind.JsonNode json) Send a json result.
Result	sendJson(com.fasterxml.jackson.databind.JsonNode json, com.fasterxml.jackson.core.JsonEncoding encoding) Send a json result.
Result	sendJson(com.fasterxml.jackson.databind.JsonNode json, java.lang.String charset) Deprecated. As of 2.6.0, use sendJson(JsonNode, JsonEncoding)
Result	sendPath(java.nio.file.Path path) Sends the given path if it is a valid file.
Result	sendPath(java.nio.file.Path path, boolean inline) Sends the given path if it is a valid file.
Result	sendPath(java.nio.file.Path path, boolean inline, java.lang.String filename) Sends the given path if it is a valid file.
Result	sendPath(java.nio.file.Path path, java.lang.String filename) Sends the given path if it is a valid file.
Result	sendResource(java.lang.String resourceName) Send the given resource.
Result	sendResource(java.lang.String resourceName, boolean inline) Send the given resource.
Result	sendResource(java.lang.String resourceName, boolean inline, java.lang.String filename) Send the given resource.
Result	sendResource(java.lang.String resourceName, java.lang.ClassLoader classLoader) Send the given resource from the given classloader.
Result	sendResource(java.lang.String resourceName, java.lang.ClassLoader classLoader, boolean inline) Send the given resource from the given classloader.
Result	sendResource(java.lang.String resourceName, java.lang.ClassLoader classLoader, boolean inline, java.lang.String filename) Send the given resource from the given classloader.

Methods inherited from class play.mvc.Result

as, asScala, body, charset, contentType, cookie, cookies, discardHeader, flash, getHeader, header, header, headers, reasonPhrase, redirectLocation, session, status, withCookies, withHeader, withHeaders

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusHeader

public StatusHeader(int status)

Method Detail

sendInputStream

public Result sendInputStream(java.io.InputStream stream)

Send the given input stream. The input stream will be sent chunked since there is no specified content length.

Parameters:

stream - The input stream to send.

Returns:

The result.

sendInputStream

public Result sendInputStream(java.io.InputStream stream,
                              long contentLength)

Send the given input stream.

Parameters:

stream - The input stream to send.

contentLength - The length of the content in the stream.

Returns:

The result.

sendResource

public Result sendResource(java.lang.String resourceName)

Send the given resource.

The resource will be loaded from the same classloader that this class comes from.

Parameters:

resourceName - The path of the resource to load.

Returns:

a '200 OK' result containing the resource in the body with in-line content disposition.

sendResource

public Result sendResource(java.lang.String resourceName,
                           java.lang.ClassLoader classLoader)

Send the given resource from the given classloader.

Parameters:

resourceName - The path of the resource to load.

classLoader - The classloader to load it from.

Returns:

a '200 OK' result containing the resource in the body with in-line content disposition.

sendResource

public Result sendResource(java.lang.String resourceName,
                           boolean inline)

Send the given resource.

The resource will be loaded from the same classloader that this class comes from.

Parameters:

resourceName - The path of the resource to load.

inline - Whether it should be served as an inline file, or as an attachment.

Returns:

a '200 OK' result containing the resource in the body with in-line content disposition.

sendResource

public Result sendResource(java.lang.String resourceName,
                           java.lang.ClassLoader classLoader,
                           boolean inline)

Send the given resource from the given classloader.

Parameters:

resourceName - The path of the resource to load.

classLoader - The classloader to load it from.

inline - Whether it should be served as an inline file, or as an attachment.

Returns:

a '200 OK' result containing the resource in the body.

sendResource

public Result sendResource(java.lang.String resourceName,
                           boolean inline,
                           java.lang.String filename)

Send the given resource.

The resource will be loaded from the same classloader that this class comes from.

Parameters:

resourceName - The path of the resource to load.

inline - Whether it should be served as an inline file, or as an attachment.

filename - The file name of the resource.

Returns:

a '200 OK' result containing the resource in the body.

sendResource

public Result sendResource(java.lang.String resourceName,
                           java.lang.ClassLoader classLoader,
                           boolean inline,
                           java.lang.String filename)

Send the given resource from the given classloader.

Parameters:

resourceName - The path of the resource to load.

classLoader - The classloader to load it from.

inline - Whether it should be served as an inline file, or as an attachment.

filename - The file name of the resource.

Returns:

a '200 OK' result containing the resource in the body.

sendPath

public Result sendPath(java.nio.file.Path path)

Sends the given path if it is a valid file. Otherwise throws RuntimeExceptions.

Parameters:

path - The path to send.

Returns:

a '200 OK' result containing the file at the provided path with inline content disposition.

sendPath

public Result sendPath(java.nio.file.Path path,
                       boolean inline)

Sends the given path if it is a valid file. Otherwise throws RuntimeExceptions.

Parameters:

path - The path to send.

inline - Whether it should be served as an inline file, or as an attachment.

Returns:

a '200 OK' result containing the file at the provided path

sendPath

public Result sendPath(java.nio.file.Path path,
                       java.lang.String filename)

Sends the given path if it is a valid file. Otherwise throws RuntimeExceptions.

Parameters:

path - The path to send.

filename - The file name of the path.

Returns:

a '200 OK' result containing the file at the provided path

sendPath

public Result sendPath(java.nio.file.Path path,
                       boolean inline,
                       java.lang.String filename)

Sends the given path if it is a valid file. Otherwise throws RuntimeExceptions

Parameters:

path - The path to send.

inline - Whether it should be served as an inline file, or as an attachment.

filename - The file name of the path.

Returns:

a '200 OK' result containing the file at the provided path

sendFile

public Result sendFile(java.io.File file)

Sends the given file using the default inline mode.

Parameters:

file - The file to send.

Returns:

a '200 OK' result containing the file.

sendFile

public Result sendFile(java.io.File file,
                       boolean inline)

Sends the given file.

Parameters:

file - The file to send.

inline - True if the file should be sent inline, false if it should be sent as an attachment.

Returns:

a '200 OK' result containing the file

sendFile

public Result sendFile(java.io.File file,
                       java.lang.String fileName)

Send the given file.

Parameters:

file - The file to send.

fileName - The name of the attachment

Returns:

a '200 OK' result containing the file

sendFile

public Result sendFile(java.io.File file,
                       boolean inline,
                       java.lang.String fileName)

Send the given file.

Parameters:

file - The file to send.

fileName - The name of the attachment

inline - True if the file should be sent inline, false if it should be sent as an attachment.

Returns:

a '200 OK' result containing the file

chunked

public Result chunked(akka.stream.javadsl.Source<akka.util.ByteString,?> chunks)

Send a chunked response with the given chunks.

Parameters:

chunks - the chunks to send

Returns:

a '200 OK' response with the given chunks.

sendJson

public Result sendJson(com.fasterxml.jackson.databind.JsonNode json)

Send a json result.

Parameters:

json - the json node to send

Returns:

a '200 OK' result containing the json encoded as UTF-8.

sendJson

@Deprecated
public Result sendJson(com.fasterxml.jackson.databind.JsonNode json,
                                   java.lang.String charset)

Deprecated. As of 2.6.0, use sendJson(JsonNode, JsonEncoding)

Send a json result.

Parameters:

json - the json to send

charset - the charset in which to encode the json (e.g. "UTF-8")

Returns:

a '200 OK' result containing the json encoded with the given charset

sendJson

public Result sendJson(com.fasterxml.jackson.databind.JsonNode json,
                       com.fasterxml.jackson.core.JsonEncoding encoding)

Send a json result.

Parameters:

json - the json to send

encoding - the encoding in which to encode the json (e.g. "UTF-8")

Returns:

a '200 OK' result containing the json encoded with the given charset

sendEntity

public Result sendEntity(HttpEntity entity)