services.moleculer.web.middleware

Class ServeStatic

java.lang.Object

services.moleculer.service.MoleculerComponent

services.moleculer.service.Service

services.moleculer.web.middleware.HttpMiddleware

services.moleculer.web.middleware.ServeStatic

All Implemented Interfaces:

services.moleculer.service.MoleculerLifecycle, HttpConstants

public class ServeStatic
extends HttpMiddleware
implements HttpConstants

Service to serve files from within a given root directory. When a file is not found, instead of sending a 404 response. Supports content compression, automatic "Content-Type" detection, and ETAGs. Sample:

 ServeStatic staticHandler = new ServeStatic("/", "/www");
 staticHandler.setEnableReloading(true) // During the development
 route.use(staticHandler);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ServeStatic.CachedFile

Field Summary

Fields

Modifier and Type	Field and Description
protected long	cacheDelay Do not reload cache until...
protected int	compressAbove Compress key and/or value above this size (BYTES), 0 = disable compression
protected int	compressionLevel Compression level (best speed = 1, best compression = 9).
protected java.util.HashMap<java.lang.String,java.lang.String>	contentTypes
protected static java.util.HashMap<java.lang.String,java.lang.String>	defaultContentTypes
protected boolean	enableReloading Enables content reloading (in production mode set it to "false" for the better performance)
protected io.datatree.dom.Cache<java.lang.String,ServeStatic.CachedFile>	fileCache
protected java.lang.String	formattedLocalDirectory Formatted local directory prefix (eg.
protected java.lang.String	localDirectory Local directory prefix (eg.
protected int	maxCachedFileSize Enable caching for smaller files only (BYTES)
protected int	numberOfCachedFiles Maximum number of cached files
protected java.lang.String	path URL prefix (eg.
protected boolean	useETags Use ETag headers

Fields inherited from class services.moleculer.service.MoleculerComponent

broker, logger, 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
ServeStatic()
ServeStatic(java.lang.String path)
ServeStatic(java.lang.String path, java.lang.String rootDirectory)

Method Summary

Modifier and Type	Method and Description
long	getCacheDelay()
int	getCompressAbove()
int	getCompressionLevel()
java.lang.String	getContentType(java.lang.String extension)
java.lang.String	getLocalDirectory()
int	getMaxCachedFileSize()
int	getNumberOfCachedFiles()
RequestProcessor	install(RequestProcessor next, io.datatree.Tree config)
boolean	isEnableReloading()
boolean	isUseETags()
void	setCacheDelay(long cacheDelay)
void	setCompressAbove(int compressAbove)
void	setCompressionLevel(int compressionLevel)
void	setContentType(java.lang.String extension, java.lang.String contentType)
void	setEnableReloading(boolean enableReloading)
void	setLocalDirectory(java.lang.String localDirectory)
void	setMaxCachedFileSize(int maxCachedFileSize)
void	setNumberOfCachedFiles(int numberOfCachedFiles)
void	setUseETags(boolean useETags)
void	started(services.moleculer.ServiceBroker broker)
void	stopped()

Methods inherited from class services.moleculer.service.MoleculerComponent

getBroker, getLogger, getName

Methods inherited from class java.lang.Object

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

Field Detail

defaultContentTypes

protected static final java.util.HashMap<java.lang.String,java.lang.String> defaultContentTypes

path

protected java.lang.String path

URL prefix (eg. "/files" or "/static")

localDirectory

protected java.lang.String localDirectory

Local directory prefix (eg. "C:\content" or "www" or "WEB-INF\static")

formattedLocalDirectory

protected java.lang.String formattedLocalDirectory

Formatted local directory prefix (eg. "C:/content" or "/www" or "/WEB-INF/static")

enableReloading

protected boolean enableReloading

Enables content reloading (in production mode set it to "false" for the better performance)

numberOfCachedFiles

protected int numberOfCachedFiles

Maximum number of cached files

cacheDelay

protected long cacheDelay

Do not reload cache until... (MILLISECONDS)

maxCachedFileSize

protected int maxCachedFileSize

Enable caching for smaller files only (BYTES)

useETags

protected boolean useETags

Use ETag headers

compressAbove

protected int compressAbove

Compress key and/or value above this size (BYTES), 0 = disable compression

compressionLevel

protected int compressionLevel

Compression level (best speed = 1, best compression = 9).

contentTypes

protected final java.util.HashMap<java.lang.String,java.lang.String> contentTypes

fileCache

protected io.datatree.dom.Cache<java.lang.String,ServeStatic.CachedFile> fileCache

Constructor Detail

ServeStatic

public ServeStatic()

ServeStatic

public ServeStatic(java.lang.String path)

ServeStatic

public ServeStatic(java.lang.String path,
                   java.lang.String rootDirectory)

Method Detail

started

public void started(services.moleculer.ServiceBroker broker)
             throws java.lang.Exception

Specified by:

started in interface services.moleculer.service.MoleculerLifecycle

Overrides:

started in class services.moleculer.service.MoleculerComponent

Throws:

java.lang.Exception

install

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

Specified by:

install in class HttpMiddleware

stopped

public void stopped()

Specified by:

stopped in interface services.moleculer.service.MoleculerLifecycle

Overrides:

stopped in class services.moleculer.service.MoleculerComponent

getLocalDirectory

public java.lang.String getLocalDirectory()

setLocalDirectory

public void setLocalDirectory(java.lang.String localDirectory)

setContentType

public void setContentType(java.lang.String extension,
                           java.lang.String contentType)

getContentType

public java.lang.String getContentType(java.lang.String extension)

getNumberOfCachedFiles

public int getNumberOfCachedFiles()

setNumberOfCachedFiles

public void setNumberOfCachedFiles(int numberOfCachedFiles)

isEnableReloading

public boolean isEnableReloading()

setEnableReloading

public void setEnableReloading(boolean enableReloading)

getCacheDelay

public long getCacheDelay()

setCacheDelay

public void setCacheDelay(long cacheDelay)

getMaxCachedFileSize

public int getMaxCachedFileSize()

setMaxCachedFileSize

public void setMaxCachedFileSize(int maxCachedFileSize)

getCompressAbove

public int getCompressAbove()

setCompressAbove

public void setCompressAbove(int compressAbove)

isUseETags

public boolean isUseETags()

setUseETags

public void setUseETags(boolean useETags)

getCompressionLevel

public int getCompressionLevel()

setCompressionLevel

public void setCompressionLevel(int compressionLevel)