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	Description
protected byte[]	cachedHTML
protected byte[]	cachedJSON
protected String	htmlTemplate	Template of the HTML response.
protected String	htmlTemplatePath	Template path of the HTML response.
protected 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 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	Description
ResponseTimeout()
ResponseTimeout(long timeoutMillis)
ResponseTimeout(long timeoutMillis, int status, String htmlTemplateOrPath)

Method Summary

Modifier and Type	Method	Description
String	getHtmlTemplate()
String	getHtmlTemplatePath()
int	getStatus()
long	getTimeout()
RequestProcessor	install(RequestProcessor next, io.datatree.Tree config)
protected void	refreshCaches()
void	setHtmlTemplate(String htmlTemplate)
void	setHtmlTemplatePath(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 Object

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

Field Details

timeout

protected long timeout

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

status

protected int status

Response status (408 = Request Timeout).

htmlTemplate

protected String htmlTemplate

Template of the HTML response.

htmlTemplatePath

protected String htmlTemplatePath

Template path of the HTML response.

scheduler

protected ScheduledExecutorService scheduler

cachedHTML

protected byte[] cachedHTML

cachedJSON

protected byte[] cachedJSON

Constructor Details

ResponseTimeout

public ResponseTimeout()

ResponseTimeout

public ResponseTimeout(long timeoutMillis)

ResponseTimeout

public ResponseTimeout(long timeoutMillis,
 int status,
 String htmlTemplateOrPath)

Method Details

started

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

Specified by:

started in interface services.moleculer.service.MoleculerLifecycle

Overrides:

started in class services.moleculer.service.MoleculerComponent

Throws:

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 String getHtmlTemplate()

Returns:

the htmlTemplate

setHtmlTemplate

public void setHtmlTemplate(String htmlTemplate)

Parameters:

htmlTemplate - the htmlTemplate to set

getHtmlTemplatePath

public String getHtmlTemplatePath()

Returns:

the htmlTemplatePath

setHtmlTemplatePath

public void setHtmlTemplatePath(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