services.moleculer.web.middleware

Class CorsHeaders

java.lang.Object

services.moleculer.service.MoleculerComponent

services.moleculer.service.Service

services.moleculer.web.middleware.HttpMiddleware

services.moleculer.web.middleware.CorsHeaders

All Implemented Interfaces:

services.moleculer.service.MoleculerLifecycle

public class CorsHeaders
extends HttpMiddleware

Implements server side https://www.w3.org/wiki/CORS support for Moleculer. Sample:

 restRoute.use(new CorsHeaders());
 

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	allowedHeaders The Access-Control-Allow-Headers CORS header
protected boolean	applyForAll Add CORS headers to all responses?
protected boolean	credentials The Access-Control-Allow-Credentials CORS header
protected java.lang.String	exposedHeaders The Access-Control-Expose-Headers CORS header
protected int	maxAge The Access-Control-Max-Age CORS header
protected java.lang.String	methods The Access-Control-Allow-Methods CORS header
protected java.lang.String	origin The Access-Control-Allow-Origin CORS header

Fields inherited from class services.moleculer.service.MoleculerComponent

broker, logger, name

Constructor Summary

Constructors

Constructor and Description
CorsHeaders()
CorsHeaders(java.lang.String origin)
CorsHeaders(java.lang.String origin, java.lang.String methods)
CorsHeaders(java.lang.String origin, java.lang.String methods, int maxAge)
CorsHeaders(java.lang.String origin, java.lang.String methods, java.lang.String allowedHeaders, java.lang.String exposedHeaders, boolean credentials, int maxAge)

Method Summary

Modifier and Type	Method and Description
protected void	addHeaders(WebResponse rsp)
java.lang.String	getAllowedHeaders()
java.lang.String	getExposedHeaders()
int	getMaxAge()
java.lang.String	getMethods()
java.lang.String	getOrigin()
RequestProcessor	install(RequestProcessor next, io.datatree.Tree config)
boolean	isApplyForAll()
boolean	isCredentials()
void	setAllowedHeaders(java.lang.String allowedHeaders)
void	setApplyForAll(boolean addToAll)
void	setCredentials(boolean credentials)
void	setExposedHeaders(java.lang.String exposedHeaders)
void	setMaxAge(int maxAge)
void	setMethods(java.lang.String methods)
void	setOrigin(java.lang.String origin)

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

origin

protected java.lang.String origin

The Access-Control-Allow-Origin CORS header

methods

protected java.lang.String methods

The Access-Control-Allow-Methods CORS header

allowedHeaders

protected java.lang.String allowedHeaders

The Access-Control-Allow-Headers CORS header

exposedHeaders

protected java.lang.String exposedHeaders

The Access-Control-Expose-Headers CORS header

credentials

protected boolean credentials

The Access-Control-Allow-Credentials CORS header

maxAge

protected int maxAge

The Access-Control-Max-Age CORS header

applyForAll

protected boolean applyForAll

Add CORS headers to all responses? (false = add to REST responses only)

Constructor Detail

CorsHeaders

public CorsHeaders()

CorsHeaders

public CorsHeaders(java.lang.String origin)

CorsHeaders

public CorsHeaders(java.lang.String origin,
                   java.lang.String methods)

CorsHeaders

public CorsHeaders(java.lang.String origin,
                   java.lang.String methods,
                   int maxAge)

CorsHeaders

public CorsHeaders(java.lang.String origin,
                   java.lang.String methods,
                   java.lang.String allowedHeaders,
                   java.lang.String exposedHeaders,
                   boolean credentials,
                   int maxAge)

Method Detail

install

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

Specified by:

install in class HttpMiddleware

addHeaders

protected void addHeaders(WebResponse rsp)

getOrigin

public java.lang.String getOrigin()

setOrigin

public void setOrigin(java.lang.String origin)

getMethods

public java.lang.String getMethods()

setMethods

public void setMethods(java.lang.String methods)

getAllowedHeaders

public java.lang.String getAllowedHeaders()

setAllowedHeaders

public void setAllowedHeaders(java.lang.String allowedHeaders)

getExposedHeaders

public java.lang.String getExposedHeaders()

setExposedHeaders

public void setExposedHeaders(java.lang.String exposedHeaders)

isCredentials

public boolean isCredentials()

setCredentials

public void setCredentials(boolean credentials)

getMaxAge

public int getMaxAge()

setMaxAge

public void setMaxAge(int maxAge)

isApplyForAll

public boolean isApplyForAll()

setApplyForAll

public void setApplyForAll(boolean addToAll)