services.moleculer.web.middleware

Class Redirector

java.lang.Object

services.moleculer.service.MoleculerComponent

services.moleculer.service.Service

services.moleculer.web.middleware.HttpMiddleware

services.moleculer.web.middleware.Redirector

All Implemented Interfaces:

services.moleculer.service.MoleculerLifecycle, HttpConstants

public class Redirector
extends HttpMiddleware
implements HttpConstants

Redirects all requests to the specified URL / location. Sample:

 // This middleware redirects "/" path to "index.html"
 route.use(new Redirector("/", "index.html", 307));
 

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	formattedPath Path to redirect (formatted and checked).
protected java.lang.String	htmlTemplate Template of the HTML response.
protected java.lang.String	location URL of the redirection.
protected java.lang.String	path Path to redirect (null = redirects all requests).
protected int	status 307 = Temporary Redirect.

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
Redirector()
Redirector(java.lang.String path) Redirects browser from "path" to "index.html".
Redirector(java.lang.String path, java.lang.String location) Redirects browser from "path" to "location" URI.
Redirector(java.lang.String path, java.lang.String location, int status) Redirects browser from "path" to "location" URI.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getHtmlTemplate()
java.lang.String	getLocation()
java.lang.String	getPath()
int	getStatus()
RequestProcessor	install(RequestProcessor next, io.datatree.Tree config)
void	setHtmlTemplate(java.lang.String htmlTemplate)
void	setLocation(java.lang.String location)
void	setPath(java.lang.String path)
void	setStatus(int status)

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

status

protected int status

307 = Temporary Redirect.

path

protected java.lang.String path

Path to redirect (null = redirects all requests).

formattedPath

protected java.lang.String formattedPath

Path to redirect (formatted and checked).

location

protected java.lang.String location

URL of the redirection.

htmlTemplate

protected java.lang.String htmlTemplate

Template of the HTML response.

Constructor Detail

Redirector

public Redirector()

Redirector

public Redirector(java.lang.String path)

Redirects browser from "path" to "index.html".

Parameters:

path - redirect FROM (eg. "/deleted-page.html")

Redirector

public Redirector(java.lang.String path,
                  java.lang.String location)

Redirects browser from "path" to "location" URI.

Parameters:

path - redirect FROM (eg. "/deleted-page.html")

location - redirect TO (eg. "new-page.html")

Redirector

public Redirector(java.lang.String path,
                  java.lang.String location,
                  int status)

Redirects browser from "path" to "location" URI.

Parameters:

path - redirect FROM (eg. "/deleted-page.html")

location - redirect TO (eg. "new-page.html")

status - status code (eg. 307 = Temporary Redirect)

Method Detail

install

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

Specified by:

install in class HttpMiddleware

getHtmlTemplate

public java.lang.String getHtmlTemplate()

Returns:

the htmlTemplate

setHtmlTemplate

public void setHtmlTemplate(java.lang.String htmlTemplate)

Parameters:

htmlTemplate - the htmlTemplate to set

getLocation

public java.lang.String getLocation()

Returns:

the location

setLocation

public void setLocation(java.lang.String location)

Parameters:

location - the location to set

getStatus

public int getStatus()

Returns:

the status

setStatus

public void setStatus(int status)

Parameters:

status - the status to set

getPath

public java.lang.String getPath()

Returns:

the path

setPath

public void setPath(java.lang.String path)

Parameters:

path - the path to set