services.moleculer.web.middleware

Class IpFilter

java.lang.Object

services.moleculer.service.MoleculerComponent

services.moleculer.service.Service

services.moleculer.web.middleware.HttpMiddleware

services.moleculer.web.middleware.IpFilter

All Implemented Interfaces:

services.moleculer.service.MoleculerLifecycle, HttpConstants

Direct Known Subclasses:

HostNameFilter

public class IpFilter
extends HttpMiddleware
implements HttpConstants

The IpFilter Middleware adds the ability to allow or block requests based on the IP address of the client. Sample:

 IpFilter filter = new IpFilter();
 filter.allow("150.10.**");
 route.use(filter);
 

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String[]	allow Masks (allowed addresses, eg "255.12.34.*").
protected java.lang.String[]	deny Masks (denied addresses, eg "255.10.**").
protected java.lang.String	htmlTemplate Template of the HTML response.
protected byte[]	htmlTemplateBytes Cached response bytes.
protected java.lang.String	htmlTemplatePath Template path of the HTML response.
protected 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
IpFilter()
IpFilter(java.lang.String... allow)

Method Summary

Modifier and Type	Method and Description
IpFilter	allow(java.lang.String... filters) Adds "allow" filters (eg "255.10.**", "230.110.10.*" or regular expression).
IpFilter	deny(java.lang.String... filters) Adds "deny" filters (eg "255.10.**", "130.30.12.*" or regular expression).
protected java.lang.String	getAddress(WebRequest req)
java.lang.String	getHtmlTemplate()
java.lang.String	getHtmlTemplatePath()
RequestProcessor	install(RequestProcessor next, io.datatree.Tree config)
protected java.lang.String[]	mergeFilters(java.lang.String[] previous, java.lang.String[] filters)
protected void	sendForbidden(WebRequest req, WebResponse rsp, java.lang.String address)
void	setHtmlTemplate(java.lang.String htmlTemplate)
void	setHtmlTemplatePath(java.lang.String htmlTemplatePath)

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 final org.slf4j.Logger logger

htmlTemplatePath

protected java.lang.String htmlTemplatePath

Template path of the HTML response.

htmlTemplate

protected java.lang.String htmlTemplate

Template of the HTML response.

htmlTemplateBytes

protected byte[] htmlTemplateBytes

Cached response bytes.

allow

protected java.lang.String[] allow

Masks (allowed addresses, eg "255.12.34.*").

deny

protected java.lang.String[] deny

Masks (denied addresses, eg "255.10.**").

Constructor Detail

IpFilter

public IpFilter()

IpFilter

public IpFilter(java.lang.String... allow)

Method Detail

install

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

Specified by:

install in class HttpMiddleware

getAddress

protected java.lang.String getAddress(WebRequest req)

sendForbidden

protected void sendForbidden(WebRequest req,
                             WebResponse rsp,
                             java.lang.String address)

allow

public IpFilter allow(java.lang.String... filters)

Adds "allow" filters (eg "255.10.**", "230.110.10.*" or regular expression).

Parameters:

filters - array of filters

Returns:

this IpFilter instance

deny

public IpFilter deny(java.lang.String... filters)

Adds "deny" filters (eg "255.10.**", "130.30.12.*" or regular expression).

Parameters:

filters - array of filters

Returns:

this IpFilter instance

mergeFilters

protected java.lang.String[] mergeFilters(java.lang.String[] previous,
                                          java.lang.String[] filters)

getHtmlTemplate

public java.lang.String getHtmlTemplate()

Returns:

the htmlTemplate

setHtmlTemplate

public void setHtmlTemplate(java.lang.String htmlTemplate)

Parameters:

htmlTemplate - the htmlTemplate to set

getHtmlTemplatePath

public java.lang.String getHtmlTemplatePath()

Returns:

the htmlTemplatePath

setHtmlTemplatePath

public void setHtmlTemplatePath(java.lang.String htmlTemplatePath)

Parameters:

htmlTemplatePath - the htmlTemplatePath to set