services.moleculer.web.middleware

Class ResponseTimeout

java.lang.Object

services.moleculer.service.MoleculerComponent

services.moleculer.service.Service

services.moleculer.web.middleware.HttpMiddleware

services.moleculer.web.middleware.ResponseTimeout

All Implemented Interfaces:

services.moleculer.service.MoleculerLifecycle, HttpConstants

public class ResponseTimeout
extends HttpMiddleware
implements HttpConstants

Middleware that will timeout requests if the response has not been written after the specified time. HTTP response code will be "408". Sample:

 route.use(new ResponseTimeout(1000L * 30));
 

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	cachedHTML
protected byte[]	cachedJSON
protected java.lang.String	htmlTemplate Template of the HTML response.
protected java.lang.String	htmlTemplatePath Template path of the HTML response.
protected java.util.concurrent.ScheduledExecutorService	scheduler
protected int	status Response status (408 = Request Timeout).
protected long	timeout Request timeout in MILLISECONDS (0 = no timeout / disable timer).

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
ResponseTimeout()
ResponseTimeout(long timeoutMillis)
ResponseTimeout(long timeoutMillis, int status, java.lang.String htmlTemplateOrPath)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getHtmlTemplate()
java.lang.String	getHtmlTemplatePath()
int	getStatus()
long	getTimeout()
RequestProcessor	install(RequestProcessor next, io.datatree.Tree config)
protected void	refreshCaches()
void	setHtmlTemplate(java.lang.String htmlTemplate)
void	setHtmlTemplatePath(java.lang.String htmlTemplatePath)
void	setStatus(int status)
void	setTimeout(long timeout)
void	started(services.moleculer.ServiceBroker broker)

Methods inherited from class services.moleculer.service.MoleculerComponent

getBroker, getLogger, getName, stopped

Methods inherited from class java.lang.Object

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

Field Detail

timeout

protected long timeout

Request timeout in MILLISECONDS (0 = no timeout / disable timer).

status

protected int status

Response status (408 = Request Timeout).

htmlTemplate

protected java.lang.String htmlTemplate

Template of the HTML response.

htmlTemplatePath

protected java.lang.String htmlTemplatePath

Template path of the HTML response.

scheduler

protected java.util.concurrent.ScheduledExecutorService scheduler

cachedHTML

protected byte[] cachedHTML

cachedJSON

protected byte[] cachedJSON

Constructor Detail

ResponseTimeout

public ResponseTimeout()

ResponseTimeout

public ResponseTimeout(long timeoutMillis)

ResponseTimeout

public ResponseTimeout(long timeoutMillis,
                       int status,
                       java.lang.String htmlTemplateOrPath)

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

refreshCaches

protected void refreshCaches()

getTimeout

public long getTimeout()

setTimeout

public void setTimeout(long timeout)

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

getStatus

public int getStatus()

Returns:

the status

setStatus

public void setStatus(int status)

Parameters:

status - the status to set