services.moleculer.web.middleware

Class ErrorPage

java.lang.Object

services.moleculer.service.MoleculerComponent

services.moleculer.service.Service

services.moleculer.web.middleware.HttpMiddleware

services.moleculer.web.middleware.ErrorPage

All Implemented Interfaces:

services.moleculer.service.MoleculerLifecycle, HttpConstants

public class ErrorPage
extends HttpMiddleware
implements HttpConstants

Custom error page (Error 404, 500, etc.) handler. Sample:

 ErrorPage errors = new ErrorPage("error-default.html");
 errors.setTemplate(404, "error-404.html");
 errors.setTemplate(500, "error-500.html");
 route.use(errors);
 

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	htmlTemplate Template of the HTML response.
protected java.lang.String	htmlTemplatePath Template path of the HTML response.
protected java.util.HashMap<java.lang.Integer,java.lang.String>	statusSpecificTemplates Optional status-specific templates (eg. 404 -> 404.html, 500 -> 500.html)

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
ErrorPage()
ErrorPage(java.lang.String htmlTemplateOrPath)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getHtmlTemplate()
java.lang.String	getHtmlTemplatePath()
java.util.HashMap<java.lang.Integer,java.lang.String>	getStatusSpecificTemplates()
RequestProcessor	install(RequestProcessor next, io.datatree.Tree config)
void	setHtmlTemplate(java.lang.String htmlTemplate)
void	setHtmlTemplatePath(java.lang.String htmlTemplatePath)
void	setStatusSpecificTemplates(java.util.HashMap<java.lang.Integer,java.lang.String> statusSpecificTemplates)
ErrorPage	setTemplate(int statusCode, java.lang.String htmlTemplateOrPath)

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

htmlTemplate

protected java.lang.String htmlTemplate

Template of the HTML response.

htmlTemplatePath

protected java.lang.String htmlTemplatePath

Template path of the HTML response.

statusSpecificTemplates

protected java.util.HashMap<java.lang.Integer,java.lang.String> statusSpecificTemplates

Optional status-specific templates (eg. 404 -> 404.html, 500 -> 500.html)

Constructor Detail

ErrorPage

public ErrorPage()

ErrorPage

public ErrorPage(java.lang.String htmlTemplateOrPath)

Method Detail

install

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

Specified by:

install in class HttpMiddleware

setTemplate

public ErrorPage setTemplate(int statusCode,
                             java.lang.String htmlTemplateOrPath)

getStatusSpecificTemplates

public java.util.HashMap<java.lang.Integer,java.lang.String> getStatusSpecificTemplates()

setStatusSpecificTemplates

public void setStatusSpecificTemplates(java.util.HashMap<java.lang.Integer,java.lang.String> statusSpecificTemplates)

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