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	Description
protected 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 String	exposedHeaders	The Access-Control-Expose-Headers CORS header
protected int	maxAge	The Access-Control-Max-Age CORS header
protected String	methods	The Access-Control-Allow-Methods CORS header
protected String	origin	The Access-Control-Allow-Origin CORS header

Fields inherited from class services.moleculer.service.MoleculerComponent

broker, logger, name

Constructor Summary

Constructors

Constructor	Description
CorsHeaders()
CorsHeaders(String origin)
CorsHeaders(String origin, String methods)
CorsHeaders(String origin, String methods, int maxAge)
CorsHeaders(String origin, String methods, String allowedHeaders, String exposedHeaders, boolean credentials, int maxAge)

Method Summary

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

Methods inherited from class services.moleculer.service.MoleculerComponent

getBroker, getLogger, getName, started, stopped

Methods inherited from class Object

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

Field Details

origin

protected String origin

The Access-Control-Allow-Origin CORS header

methods

protected String methods

The Access-Control-Allow-Methods CORS header

allowedHeaders

protected String allowedHeaders

The Access-Control-Allow-Headers CORS header

exposedHeaders

protected 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 Details

CorsHeaders

public CorsHeaders()

CorsHeaders

public CorsHeaders(String origin)

CorsHeaders

public CorsHeaders(String origin,
 String methods)

CorsHeaders

public CorsHeaders(String origin,
 String methods,
 int maxAge)

CorsHeaders

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

Method Details

install

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

Specified by:

install in class HttpMiddleware

addHeaders

protected void addHeaders(WebResponse rsp)

getOrigin

public String getOrigin()

setOrigin

public void setOrigin(String origin)

getMethods

public String getMethods()

setMethods

public void setMethods(String methods)

getAllowedHeaders

public String getAllowedHeaders()

setAllowedHeaders

public void setAllowedHeaders(String allowedHeaders)

getExposedHeaders

public String getExposedHeaders()

setExposedHeaders

public void setExposedHeaders(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)