services.moleculer.web.middleware

Class HostNameFilter

java.lang.Object

services.moleculer.service.MoleculerComponent

services.moleculer.service.Service

services.moleculer.web.middleware.HttpMiddleware

services.moleculer.web.middleware.IpFilter

services.moleculer.web.middleware.HostNameFilter

All Implemented Interfaces:

java.lang.Runnable, services.moleculer.service.MoleculerLifecycle, HttpConstants

public class HostNameFilter
extends IpFilter
implements java.lang.Runnable

The HostNameFilter adds the ability to allow or block requests based on the host name of the client. Sample:

 HostNameFilter filter = new HostNameFilter();
 filter.allow("domain.server**");
 route.use(filter);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	HostNameFilter.CachedHostname

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.ConcurrentHashMap<java.lang.String,HostNameFilter.CachedHostname>	cache
protected int	cleanup Cleanup period in SECONDS (default = 1 minute)
protected int	timeout Cache entry timeout in SECONDS (default = 10 minute).
protected java.util.concurrent.ScheduledFuture<?>	timer

Fields inherited from class services.moleculer.web.middleware.IpFilter

allow, deny, htmlTemplate, htmlTemplateBytes, htmlTemplatePath, 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
HostNameFilter()
HostNameFilter(java.lang.String... allow)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getAddress(WebRequest req)
int	getCleanup()
int	getTimeout()
void	run()
void	setCleanup(int cleanup)
void	setTimeout(int timeout)
void	started(services.moleculer.ServiceBroker broker)
void	stopped()

Methods inherited from class services.moleculer.web.middleware.IpFilter

allow, deny, getHtmlTemplate, getHtmlTemplatePath, install, mergeFilters, sendForbidden, setHtmlTemplate, setHtmlTemplatePath

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

cleanup

protected int cleanup

Cleanup period in SECONDS (default = 1 minute)

timeout

protected int timeout

Cache entry timeout in SECONDS (default = 10 minute).

cache

protected java.util.concurrent.ConcurrentHashMap<java.lang.String,HostNameFilter.CachedHostname> cache

timer

protected java.util.concurrent.ScheduledFuture<?> timer

Constructor Detail

HostNameFilter

public HostNameFilter()

HostNameFilter

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

Method Detail

getAddress

protected java.lang.String getAddress(WebRequest req)

Overrides:

getAddress in class IpFilter

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

stopped

public void stopped()

Specified by:

stopped in interface services.moleculer.service.MoleculerLifecycle

Overrides:

stopped in class services.moleculer.service.MoleculerComponent

run

public void run()

Specified by:

run in interface java.lang.Runnable

getCleanup

public int getCleanup()

Returns:

the cleanup

setCleanup

public void setCleanup(int cleanup)

Parameters:

cleanup - the cleanup to set

getTimeout

public int getTimeout()

Returns:

the timeout

setTimeout

public void setTimeout(int timeout)

Parameters:

timeout - the timeout to set