org.osgl.mvc.result

Class RenderBinary

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.osgl.exception.FastRuntimeException

org.osgl.mvc.result.Result

org.osgl.mvc.result.RenderBinary

All Implemented Interfaces:

Serializable

public class RenderBinary
extends Result

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.osgl.mvc.result.Result

Result.Payload

Constructor Summary

Constructors

Constructor and Description
RenderBinary(byte[] bytes) Construct an inline binary response with a byte array
RenderBinary(byte[] bytes, String attachmentName) Construct a binary response with a byte array.
RenderBinary(File file) Send a file as the response.
RenderBinary(File file, String name) Send a file as the response.
RenderBinary(File file, String name, boolean inline) Send a file as the response.
RenderBinary(InputStream is, String name) send a binary stream as the response
RenderBinary(InputStream is, String name, boolean inline) send a binary stream as the response
RenderBinary(InputStream is, String name, long length)
RenderBinary(InputStream is, String name, long length, boolean inline)
RenderBinary(InputStream is, String name, long length, String contentType, boolean inline)
RenderBinary(InputStream is, String name, String contentType, boolean inline) send a binary stream as the response
RenderBinary(org.osgl.Lang.Visitor<org.osgl.util.Output> contentWriter)

Method Summary

Modifier and Type	Method and Description
void	apply(org.osgl.http.H.Request req, org.osgl.http.H.Response resp)
RenderBinary	contentType(org.osgl.http.H.Format contentType)
RenderBinary	contentType(String contentType)
RenderBinary	name(String attachmentName) Set the attachment name.

Methods inherited from class org.osgl.mvc.result.Result

addCookie, addHeader, applyAfterCommitHandler, applyBeforeCommitHandler, applyCookies, applyHeaders, applyMessage, applyStatus, clearThreadLocals, header, payload, status, status, statusCode, timestamp, touchPayload

Methods inherited from class org.osgl.exception.FastRuntimeException

doFillInStackTrace, fillInStackTrace

Methods inherited from class java.lang.Throwable

addSuppressed, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RenderBinary

public RenderBinary(byte[] bytes)

Construct an inline binary response with a byte array

Parameters:

bytes - the byte array

RenderBinary

public RenderBinary(byte[] bytes,
                    String attachmentName)

Construct a binary response with a byte array.

Parameters:

bytes - the byte array

attachmentName - the attachment name. If not null the disposition will be attachment; otherwise inline

RenderBinary

public RenderBinary(InputStream is,
                    String name)

send a binary stream as the response

Parameters:

is - the stream to read from

name - the name to use as Content-Diposition attachement filename

RenderBinary

public RenderBinary(InputStream is,
                    String name,
                    long length)

RenderBinary

public RenderBinary(InputStream is,
                    String name,
                    boolean inline)

send a binary stream as the response

Parameters:

is - the stream to read from

name - the name to use as Content-Diposition attachement filename

inline - true to set the response Content-Disposition to inline

RenderBinary

public RenderBinary(InputStream is,
                    String name,
                    String contentType,
                    boolean inline)

send a binary stream as the response

Parameters:

is - the stream to read from

name - the name to use as Content-Diposition attachement filename

contentType - the content type of the binary stream

inline - true to set the response Content-Disposition to inline

RenderBinary

public RenderBinary(InputStream is,
                    String name,
                    long length,
                    String contentType,
                    boolean inline)

RenderBinary

public RenderBinary(InputStream is,
                    String name,
                    long length,
                    boolean inline)

RenderBinary

public RenderBinary(File file,
                    String name)

Send a file as the response. Content-disposion is set to attachment.

Parameters:

file - readable file to send back

name - a name to use as Content-disposion’s filename

RenderBinary

public RenderBinary(File file)

Send a file as the response. Content-disposion is set to attachment, name is taken from file’s name

Parameters:

file - readable file to send back

RenderBinary

public RenderBinary(File file,
                    String name,
                    boolean inline)

Send a file as the response. Content-disposition is set to attachment, name is taken from file’s name

Parameters:

file - readable file to send back

RenderBinary

public RenderBinary(org.osgl.Lang.Visitor<org.osgl.util.Output> contentWriter)

Method Detail

contentType

public RenderBinary contentType(org.osgl.http.H.Format contentType)

contentType

public RenderBinary contentType(String contentType)

name

public RenderBinary name(String attachmentName)

Set the attachment name.

If the attachment name is not null and not empty, then it will set the disposition to attachment; otherwise it will set the disposition to inline

Parameters:

attachmentName - the attachment name

Returns:

this RenderBinary instance

apply

public void apply(org.osgl.http.H.Request req,
                  org.osgl.http.H.Response resp)

Overrides:

apply in class Result