services.moleculer.web.router

Class StaticRoute

java.lang.Object

services.moleculer.web.router.Route

services.moleculer.web.router.StaticRoute

public class StaticRoute
extends Route

Prepared route for simple static file service. Usage (with REST services):

 // First route (REST services)
 RestRoute restServices = new RestRoute();
 restServices.addAlias("/rest1", "service.action1");
 restServices.addAlias("GET", "/rest2/:a/:b", "service.action2");
 restServices.use(new CorsHeaders());
 apiGateway.addRoute(restServices);
 
 // Last route (HTML pages, CSS and images)
 StaticRoute webContent = new StaticRoute("/htdocs");
 webContent.setReloadable(true);
 apiGateway.addRoute(webContent);
 

Field Summary

Fields

Modifier and Type	Field and Description
protected Favicon	favicon Second middleware is the "favicon" handler.
protected NotFound	notFound Last middleware produces "Error 404" responses
protected Redirector	redirector First middleware redirects "/" to "/index.html"
protected ServeStatic	serveStatic Third middleware is static file handler.

Fields inherited from class services.moleculer.web.router.Route

afterCall, aliases, beforeCall, broker, logger, mappingPolicy, opts, path, routeMiddlewares, templateEngine, whiteList

Constructor Summary

Constructors

Constructor and Description
StaticRoute()
StaticRoute(java.lang.String wwwRootDirectory)

Method Summary

Modifier and Type	Method and Description
Favicon	getFavicon()
java.lang.String	getFaviconPath()
java.lang.String	getIndexPage()
NotFound	getNotFound()
java.lang.String	getNotFoundTemplatePath()
Redirector	getRedirector()
ServeStatic	getServeStatic()
java.lang.String	getWebPageDirectory()
boolean	isEnableReloading()
void	setEnableReloading(boolean enableReloading)
void	setFaviconPath(java.lang.String iconPath)
void	setIndexPage(java.lang.String location)
void	setNotFoundTemplatePath(java.lang.String htmlTemplatePath)
void	setWebPageDirectory(java.lang.String wwwRootDirectory)

Methods inherited from class services.moleculer.web.router.Route

addAlias, addAlias, addAlias, addToWhiteList, findMapping, getAfterCall, getAliases, getBeforeCall, getBroker, getMappingPolicy, getMiddlewares, getOpts, getPath, getTemplateEngine, getWhiteList, setAfterCall, setAliases, setBeforeCall, setMappingPolicy, setOpts, setPath, setTemplateEngine, setWhiteList, started, stopped, toTree, use, use

Methods inherited from class java.lang.Object

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

Field Detail

redirector

protected Redirector redirector

First middleware redirects "/" to "/index.html"

favicon

protected Favicon favicon

Second middleware is the "favicon" handler.

serveStatic

protected ServeStatic serveStatic

Third middleware is static file handler.

notFound

protected NotFound notFound

Last middleware produces "Error 404" responses

Constructor Detail

StaticRoute

public StaticRoute()

StaticRoute

public StaticRoute(java.lang.String wwwRootDirectory)

Method Detail

getIndexPage

public java.lang.String getIndexPage()

setIndexPage

public void setIndexPage(java.lang.String location)

getFaviconPath

public java.lang.String getFaviconPath()

setFaviconPath

public void setFaviconPath(java.lang.String iconPath)

getWebPageDirectory

public java.lang.String getWebPageDirectory()

setWebPageDirectory

public void setWebPageDirectory(java.lang.String wwwRootDirectory)

isEnableReloading

public boolean isEnableReloading()

setEnableReloading

public void setEnableReloading(boolean enableReloading)

getNotFoundTemplatePath

public java.lang.String getNotFoundTemplatePath()

setNotFoundTemplatePath

public void setNotFoundTemplatePath(java.lang.String htmlTemplatePath)

getRedirector

public Redirector getRedirector()

getFavicon

public Favicon getFavicon()

getServeStatic

public ServeStatic getServeStatic()

getNotFound

public NotFound getNotFound()