services.moleculer.web.middleware

Class Favicon

java.lang.Object

services.moleculer.service.MoleculerComponent

services.moleculer.service.Service

services.moleculer.web.middleware.HttpMiddleware

services.moleculer.web.middleware.Favicon

All Implemented Interfaces:

services.moleculer.service.MoleculerLifecycle, HttpConstants

public class Favicon
extends HttpMiddleware
implements HttpConstants

Server "/favicon.ico" HTTP requests. Sample:

 route.use(new Favicon("custom.ico"));
 

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	iconPath Relative icon file path.
protected java.lang.String	iconURL Relative URL of the Favicon.
protected byte[]	image
protected int	maxAge Max-age header's value (0 = no max-age header).
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
Favicon()
Favicon(java.lang.String pathToIcon)
Favicon(java.lang.String pathToIcon, int maxAge)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getIconPath()
java.lang.String	getIconURL()
int	getMaxAge()
RequestProcessor	install(RequestProcessor next, io.datatree.Tree config)
boolean	isUseETags()
void	setIconPath(java.lang.String iconPath)
void	setIconURL(java.lang.String iconURL)
void	setMaxAge(int maxAge)
void	setUseETags(boolean useETags)

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

iconPath

protected java.lang.String iconPath

Relative icon file path.

maxAge

protected int maxAge

Max-age header's value (0 = no max-age header).

iconURL

protected java.lang.String iconURL

Relative URL of the Favicon.

useETags

protected boolean useETags

Use ETag headers

image

protected byte[] image

Constructor Detail

Favicon

public Favicon()

Favicon

public Favicon(java.lang.String pathToIcon)

Favicon

public Favicon(java.lang.String pathToIcon,
               int maxAge)

Method Detail

install

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

Specified by:

install in class HttpMiddleware

getIconPath

public java.lang.String getIconPath()

setIconPath

public void setIconPath(java.lang.String iconPath)

getMaxAge

public int getMaxAge()

setMaxAge

public void setMaxAge(int maxAge)

getIconURL

public java.lang.String getIconURL()

setIconURL

public void setIconURL(java.lang.String iconURL)

isUseETags

public boolean isUseETags()

setUseETags

public void setUseETags(boolean useETags)