Package io.varhttp

Class VarResponseStream

java.lang.Object

io.varhttp.VarResponseStream

All Implemented Interfaces:

ResponseStream

public class VarResponseStream
extends Object
implements ResponseStream

Constructor Summary

Constructors

Constructor	Description
VarResponseStream(ControllerContext controllerContext, Serializer serializer)

Method Summary

Modifier and Type	Method	Description
BufferedWriter	getContentWriter(String fileName, String contentType, Charset charset)	Get writer that writes to response body in streaming way.
OutputStream	getOutputStream(String contentType, Charset charset)	Get the output-stream of the response.
void	write(Object object)
void	write(Object object, String forcedContentType)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.varhttp.ResponseStream

getOutputStream

Constructor Details

VarResponseStream

public VarResponseStream(ControllerContext controllerContext,
 Serializer serializer)

Method Details

getContentWriter

public BufferedWriter getContentWriter(String fileName,
 String contentType,
 Charset charset)

Description copied from interface: ResponseStream

Get writer that writes to response body in streaming way. This should trigger file download in browser.

Specified by:

getContentWriter in interface ResponseStream

Parameters:

fileName - Name of file for download eg. name.csv

contentType - File format eg. text/csv for csv files

charset - Character encoding of the file content eg. StandardCharsets.UTF-8 for UTF-8 encoding

Returns:

writer that writes to response body

getOutputStream

public OutputStream getOutputStream(String contentType,
 Charset charset)

Description copied from interface: ResponseStream

Get the output-stream of the response. Used to write non-string content.

Specified by:

getOutputStream in interface ResponseStream

Parameters:

contentType - Content format eg. image/png for PNG files

charset - Character encoding of the file content eg. StandardCharsets.UTF-8 for UTF-8 encoding

Returns:

the output stream of the response.

write

public void write(Object object)

Specified by:

write in interface ResponseStream

write

public void write(Object object,
 String forcedContentType)

Specified by:

write in interface ResponseStream