com.flowable.core.common.rest.response

Class ResponseEntityHelper

java.lang.Object

com.flowable.core.common.rest.response.ResponseEntityHelper

public class ResponseEntityHelper
extends Object

Helper class for working with ResponseEntity.

Author:

Filip Hrisafov

Field Summary

Fields

Modifier and Type	Field and Description
protected Collection<MediaType>	autoInlineMediaTypes
protected Charset	charset

Constructor Summary

Constructors

Constructor and Description
ResponseEntityHelper(Collection<MediaType> autoInlineMediaTypes)

Method Summary

Modifier and Type	Method and Description
ResponseEntity<byte[]>	asByteArrayResponseEntity(InputStream inputStream, String mimeType, String name, Boolean download) Create a ResponseEntity with a byte[] body based on the inputStream.
protected String	dispositionType(Boolean download, MediaType mediaType)
void	setCharset(Charset charset)

Methods inherited from class java.lang.Object

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

Field Detail

autoInlineMediaTypes

protected Collection<MediaType> autoInlineMediaTypes

charset

protected Charset charset

Constructor Detail

ResponseEntityHelper

public ResponseEntityHelper(Collection<MediaType> autoInlineMediaTypes)

Method Detail

asByteArrayResponseEntity

public ResponseEntity<byte[]> asByteArrayResponseEntity(InputStream inputStream,
                                                        String mimeType,
                                                        String name,
                                                        Boolean download)
                                                 throws IOException

Create a ResponseEntity with a byte[] body based on the inputStream.

When the mimeType is provided and is a known MediaType then it would be used as the Content-Type header for the ResponseEntity. Otherwise, application/octet-stream would be used.

If the name is provided then a Content-Disposition header would be added with that as a file name.

The download flag is used to indicate whether the inputStream should be displayed inside the Web page (inline when download is false) or downloaded (attachment when download is true). In case it is null the value would be created based on the mimeType.

NB: Callers of this method are responsible for appropriately closing the inputStream

Parameters:

inputStream - The input stream that should be used as the body (the caller is responsible for closing it)

mimeType - the mime type for the Content-Type header

name - the filename for the Content-Disposition header

download - flag indicating the type for the Content-Disposition header

Returns:

the ResponseEntity with a status HttpStatus.OK

Throws:

IOException - in case of I/O errors

dispositionType

protected String dispositionType(Boolean download,
                                 MediaType mediaType)

setCharset

public void setCharset(Charset charset)