services.moleculer.web.middleware

Class ResponseDeflater

java.lang.Object

services.moleculer.service.MoleculerComponent

services.moleculer.service.Service

services.moleculer.web.middleware.HttpMiddleware

services.moleculer.web.middleware.ResponseDeflater

All Implemented Interfaces:

services.moleculer.service.MoleculerLifecycle, HttpConstants

public class ResponseDeflater
extends HttpMiddleware
implements HttpConstants

Compresses body of REST responses. Do not use it with ServeStatic middleware; ServeStatic also compresses the data. Use it to compress the response of REST services. Using this middleware reduces the performance, so use it only on slow networks. Sample:

 restRoute.use(new ResponseDeflater(Deflater.BEST_SPEED));
 

Field Summary

Fields

Modifier and Type	Field and Description
protected int	bufferSize
protected java.util.Set<java.lang.String>	compressedTypes
protected int	compressionLevel
protected static org.slf4j.Logger	logger

Fields inherited from class services.moleculer.service.MoleculerComponent

broker, name

Fields inherited from interface services.moleculer.web.common.HttpConstants

ACCEPT, ACCEPT_ENCODING, AUTHORIZATION, CACHE_CONTROL, CHUNKED, CLOSE, CONNECT, CONNECTION, CONTENT_ENCODING, CONTENT_LENGTH, CONTENT_TYPE, CONTENT_TYPE_HTML, CONTENT_TYPE_JSON, COOKIE, DEFLATE, DELETE, ETAG, GET, GZIP, HEAD, IF_NONE_MATCH, KEEP_ALIVE, LOCATION, META_CONTENT_TYPE, META_HEADERS, META_LOCALE, META_LOCATION, META_SESSION, META_STATUS, META_TEMPLATE, NO_CACHE, OPTIONS, PATCH, POST, PROPERTY_COOKIES, PROPERTY_SESSION_ID, PROPERTY_USER, PUT, SET_COOKIE, TRACE, TRANSFER_ENCODING, WWW_AUTHENTICATE, X_FORWARDED_FOR

Constructor Summary

Constructors

Constructor and Description
ResponseDeflater()
ResponseDeflater(int compressionLevel)
ResponseDeflater(int compressionLevel, int bufferSize)

Method Summary

Modifier and Type	Method and Description
ResponseDeflater	addCompressedType(java.lang.String compressedMimeTypePart)
int	getBufferSize()
java.util.Set<java.lang.String>	getCompressedTypes()
int	getCompressionLevel()
RequestProcessor	install(RequestProcessor next, io.datatree.Tree config)
void	setBufferSize(int bufferSize)
void	setCompressedTypes(java.util.Set<java.lang.String> compressedMimeTypeParts)
void	setCompressedTypes(java.lang.String... compressedMimeTypeParts)
void	setCompressionLevel(int compressionLevel)

Methods inherited from class services.moleculer.service.MoleculerComponent

getBroker, getLogger, getName, started, stopped

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

compressionLevel

protected int compressionLevel

bufferSize

protected int bufferSize

compressedTypes

protected java.util.Set<java.lang.String> compressedTypes

Constructor Detail

ResponseDeflater

public ResponseDeflater()

ResponseDeflater

public ResponseDeflater(int compressionLevel)

ResponseDeflater

public ResponseDeflater(int compressionLevel,
                        int bufferSize)

Method Detail

install

public RequestProcessor install(RequestProcessor next,
                                io.datatree.Tree config)

Specified by:

install in class HttpMiddleware

addCompressedType

public ResponseDeflater addCompressedType(java.lang.String compressedMimeTypePart)

getCompressionLevel

public int getCompressionLevel()

Returns:

the compressionLevel

setCompressionLevel

public void setCompressionLevel(int compressionLevel)

Parameters:

compressionLevel - the compressionLevel to set

getBufferSize

public int getBufferSize()

Returns:

the bufferSize

setBufferSize

public void setBufferSize(int bufferSize)

Parameters:

bufferSize - the bufferSize to set

getCompressedTypes

public java.util.Set<java.lang.String> getCompressedTypes()

Returns:

the compressedTypes

setCompressedTypes

public void setCompressedTypes(java.util.Set<java.lang.String> compressedMimeTypeParts)

Parameters:

compressedMimeTypeParts - the compressedTypes to set

setCompressedTypes

public void setCompressedTypes(java.lang.String... compressedMimeTypeParts)

Parameters:

compressedMimeTypeParts - the compressedTypes to set