services.moleculer.web

Class ApiGateway

java.lang.Object

services.moleculer.service.MoleculerComponent

services.moleculer.service.Service

services.moleculer.web.ApiGateway

All Implemented Interfaces:

services.moleculer.service.MoleculerLifecycle, RequestProcessor

public class ApiGateway
extends services.moleculer.service.Service
implements RequestProcessor

Field Summary

Fields

Modifier and Type	Field and Description
protected CallProcessor	afterCall Custom message post-processor.
protected CallProcessor	beforeCall Custom message pre-processor.
protected int	cachedRoutes Maximum number of cached routes.
protected java.util.Set<java.lang.String>	checkedNames Checked services with @HttpAlias annotations.
protected boolean	debug Print more debug messages.
protected java.util.LinkedList<Mapping>	dynamicMappings Dynamic mappings.
protected java.util.concurrent.ExecutorService	executor Custom Action Executor (null = use the shared ExecutorService of the MessageBroker).
protected java.util.Set<HttpMiddleware>	globalMiddlewares Global middlewares.
protected HttpMiddleware	lastMiddleware Last middleware (custom error pages, HTTP-redirector, etc.)
protected Route	lastRoute Last route (for the last middleware)
protected java.util.concurrent.locks.ReentrantReadWriteLock.ReadLock	readLock
protected Route[]	routes
protected java.util.LinkedHashMap<java.lang.String,Mapping>	staticMappings Static mappings.
protected AbstractTemplateEngine	templateEngine HTML template engine.
protected WebSocketFilter	webSocketFilter WebSocket filter (access control)
services.moleculer.eventbus.Listener	webSocketListener Send WebSocket via broadcasted Moleculer Event.
protected WebSocketRegistry	webSocketRegistry WebSocket registry (Netty or J2EE)
protected java.util.concurrent.locks.ReentrantReadWriteLock.WriteLock	writeLock

Fields inherited from class services.moleculer.service.MoleculerComponent

broker, logger, name

Constructor Summary

Constructors

Constructor and Description
ApiGateway()
ApiGateway(java.lang.String... whiteListEntries)

Method Summary

Modifier and Type	Method and Description
Route	addRoute()
Route	addRoute(Route route) Adds a route to the list of routes.
Route	addRoute(java.lang.String path, java.lang.String serviceList, HttpMiddleware... middlewares) Define a route for a list of Service (eg. in the "service" the service's "action" action will available on "http://host:port/path/service/action").
protected void	clearMappings()
CallProcessor	getAfterCall()
CallProcessor	getBeforeCall()
int	getCachedRoutes()
java.util.concurrent.ExecutorService	getExecutor()
HttpMiddleware	getLastMiddleware()
RequestProcessor	getParent() Returns the next RequestProcessor in the invocation chain.
Route[]	getRoutes()
AbstractTemplateEngine	getTemplateEngine()
WebSocketFilter	getWebSocketFilter()
WebSocketRegistry	getWebSocketRegistry()
boolean	isDebug()
protected void	logAlias(java.lang.StringBuilder msg, Route route, Alias alias)
protected void	logRoute(Route route)
void	service(WebRequest req, WebResponse rsp) Handles request of the HTTP client.
void	setAfterCall(CallProcessor afterCall)
void	setBeforeCall(CallProcessor beforeCall)
void	setCachedRoutes(int cacheSize)
void	setDebug(boolean debug)
void	setExecutor(java.util.concurrent.ExecutorService executor)
void	setLastMiddleware(HttpMiddleware lastMiddleware)
void	setRoutes(Route[] routes)
void	setTemplateEngine(AbstractTemplateEngine templateEngine)
void	setWebSocketFilter(WebSocketFilter webSocketFilter)
void	setWebSocketRegistry(WebSocketRegistry webSocketRegistry)
void	started(services.moleculer.ServiceBroker broker) Initializes gateway instance.
void	stopped() Closes gateway.
void	use(java.util.Collection<HttpMiddleware> middlewares)
void	use(HttpMiddleware... middlewares)

Methods inherited from class services.moleculer.service.MoleculerComponent

getBroker, getLogger, getName

Methods inherited from class java.lang.Object

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

Field Detail

routes

protected Route[] routes

lastRoute

protected Route lastRoute

Last route (for the last middleware)

lastMiddleware

protected HttpMiddleware lastMiddleware

Last middleware (custom error pages, HTTP-redirector, etc.)

debug

protected boolean debug

Print more debug messages.

cachedRoutes

protected int cachedRoutes

Maximum number of cached routes.

staticMappings

protected java.util.LinkedHashMap<java.lang.String,Mapping> staticMappings

Static mappings.

dynamicMappings

protected final java.util.LinkedList<Mapping> dynamicMappings

Dynamic mappings.

globalMiddlewares

protected java.util.Set<HttpMiddleware> globalMiddlewares

Global middlewares.

checkedNames

protected java.util.Set<java.lang.String> checkedNames

Checked services with @HttpAlias annotations.

templateEngine

protected AbstractTemplateEngine templateEngine

HTML template engine.

webSocketRegistry

protected WebSocketRegistry webSocketRegistry

WebSocket registry (Netty or J2EE)

webSocketFilter

protected WebSocketFilter webSocketFilter

WebSocket filter (access control)

beforeCall

protected CallProcessor beforeCall

Custom message pre-processor.

afterCall

protected CallProcessor afterCall

Custom message post-processor.

executor

protected java.util.concurrent.ExecutorService executor

Custom Action Executor (null = use the shared ExecutorService of the MessageBroker).

readLock

protected final java.util.concurrent.locks.ReentrantReadWriteLock.ReadLock readLock

writeLock

protected final java.util.concurrent.locks.ReentrantReadWriteLock.WriteLock writeLock

webSocketListener

public services.moleculer.eventbus.Listener webSocketListener

Send WebSocket via broadcasted Moleculer Event.

Constructor Detail

ApiGateway

public ApiGateway()

ApiGateway

public ApiGateway(java.lang.String... whiteListEntries)

Method Detail

started

public void started(services.moleculer.ServiceBroker broker)
             throws java.lang.Exception

Initializes gateway instance.

Specified by:

started in interface services.moleculer.service.MoleculerLifecycle

Overrides:

started in class services.moleculer.service.MoleculerComponent

Parameters:

broker - parent ServiceBroker

Throws:

java.lang.Exception

logRoute

protected void logRoute(Route route)

logAlias

protected void logAlias(java.lang.StringBuilder msg,
                        Route route,
                        Alias alias)

stopped

public void stopped()

Closes gateway.

Specified by:

stopped in interface services.moleculer.service.MoleculerLifecycle

Overrides:

stopped in class services.moleculer.service.MoleculerComponent

clearMappings

protected void clearMappings()

service

public void service(WebRequest req,
                    WebResponse rsp)
             throws java.lang.Exception

Handles request of the HTTP client.

Specified by:

service in interface RequestProcessor

Parameters:

req - WebRequest object that contains the request the client made of the ApiGateway

rsp - WebResponse object that contains the response the ApiGateway returns to the client

Throws:

java.lang.Exception - if an input or output error occurs while the ApiGateway is handling the HTTP request

use

public void use(HttpMiddleware... middlewares)

use

public void use(java.util.Collection<HttpMiddleware> middlewares)

addRoute

public Route addRoute()

addRoute

public Route addRoute(java.lang.String path,
                      java.lang.String serviceList,
                      HttpMiddleware... middlewares)

Define a route for a list of Service (eg. in the "service" the service's "action" action will available on "http://host:port/path/service/action").

Parameters:

path - root path to services (can be null or empty)

serviceList - list of services and/or actions (eg. "service1, service2.action, service3, service4.action")

middlewares - optional middlewares (eg. CorsHeaders)

Returns:

route the new route

addRoute

public Route addRoute(Route route)

Adds a route to the list of routes.

Parameters:

route - the new route

Returns:

route the new route

getRoutes

public Route[] getRoutes()

setRoutes

public void setRoutes(Route[] routes)

getCachedRoutes

public int getCachedRoutes()

setCachedRoutes

public void setCachedRoutes(int cacheSize)

getLastMiddleware

public HttpMiddleware getLastMiddleware()

setLastMiddleware

public void setLastMiddleware(HttpMiddleware lastMiddleware)

isDebug

public boolean isDebug()

setDebug

public void setDebug(boolean debug)

getTemplateEngine

public AbstractTemplateEngine getTemplateEngine()

setTemplateEngine

public void setTemplateEngine(AbstractTemplateEngine templateEngine)

getBeforeCall

public CallProcessor getBeforeCall()

setBeforeCall

public void setBeforeCall(CallProcessor beforeCall)

getAfterCall

public CallProcessor getAfterCall()

setAfterCall

public void setAfterCall(CallProcessor afterCall)

getWebSocketRegistry

public WebSocketRegistry getWebSocketRegistry()

setWebSocketRegistry

public void setWebSocketRegistry(WebSocketRegistry webSocketRegistry)

getWebSocketFilter

public WebSocketFilter getWebSocketFilter()

setWebSocketFilter

public void setWebSocketFilter(WebSocketFilter webSocketFilter)

getExecutor

public java.util.concurrent.ExecutorService getExecutor()

setExecutor

public void setExecutor(java.util.concurrent.ExecutorService executor)

getParent

public RequestProcessor getParent()

Description copied from interface: RequestProcessor

Returns the next RequestProcessor in the invocation chain.

Specified by:

getParent in interface RequestProcessor

Returns:

parent processor