org.swisspush.gateleen.core.event

Class EventBusHandler

java.lang.Object

org.swisspush.gateleen.core.event.EventBusHandler

All Implemented Interfaces:

ConfigurationResourceObserver

public class EventBusHandler
extends Object
implements ConfigurationResourceObserver

Delivers a request on the event bus.

If the header "x-sync" is set to "true", then the handler waits for an event reply before returning the response. In this case, the response contains the replied JSON, if any.

Requests are forwarded in the form:

 {
     "uri": "http://...",
     "method": "PUT",
     "headers": [
          [ "name", "value" ],
          [ "name", "value" ]
     ],
     "payload": {
         "hello": "world"
     }
 }
 

Payload is a JsonObject in case of application/json content type, a string in case of text/* content type, a base64 binary string otherwise.

Replies from clients have the same structure, without the uri.1

Author:

https://github.com/lbovet [Laurent Bovet]

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACCEPTED
static String	APPLICATION_JSON
static int	BAD_REQUEST
static String	CONTENT_TYPE
static int	GATEWAY_TIMEOUT
static String	HEADERS
static String	METHOD
static String	PAYLOAD
static String	SYNC
static String	TEXT
static int	TIMEOUT
static String	URI

Constructor Summary

Constructors

Constructor and Description
EventBusHandler(io.vertx.core.Vertx vertx, String apiPath, String sockPath, String addressPrefix, String addressPathPattern)
EventBusHandler(io.vertx.core.Vertx vertx, String apiPath, String sockPath, String addressPrefix, String addressPathPattern, ConfigurationResourceManager configurationResourceManager, String configResourceUri) Constructs and configures the handler.

Method Summary

Modifier and Type	Method and Description
io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions	getSockJSHandlerOptions()
boolean	handle(io.vertx.core.http.HttpServerRequest request)
void	install(io.vertx.ext.web.Router router) Configures and binds the SockJS bridge to an HttpServer.
void	resourceChanged(String resourceUri, String resource) Gets called when the resource with uri resourceUri has been changed.
void	resourceRemoved(String resourceUri) Gets called when the resource with uri resourceUri has been removed.
void	setEventbusBridgeMaxAddressLength(Integer eventbusBridgeMaxAddressLength) Sets the maximum address length passed to the eventbus bridge.
void	setEventbusBridgeMaxHandlersPerSocket(Integer eventbusBridgeMaxHandlersPerSocket) Sets the max handlers per socket passed to the eventbus bridge.
void	setEventbusBridgePingInterval(Long eventbusBridgePingInterval) Sets the ping_interval passed to the eventbus bridge.
void	setEventbusBridgeReplyTimeout(Long eventbusBridgeReplyTimeout) Sets the reply timeout passed to the eventbus bridge.
void	setSockJSHandlerOptions(io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions sockJSHandlerOptions) Sets the SockJSHandlerOptions to be used for the websocket connections.

Methods inherited from class java.lang.Object

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

Field Detail

ACCEPTED

public static final int ACCEPTED

See Also:

Constant Field Values

SYNC

public static final String SYNC

See Also:

Constant Field Values

TEXT

public static final String TEXT

See Also:

Constant Field Values

METHOD

public static final String METHOD

See Also:

Constant Field Values

BAD_REQUEST

public static final int BAD_REQUEST

See Also:

Constant Field Values

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

Constant Field Values

APPLICATION_JSON

public static final String APPLICATION_JSON

See Also:

Constant Field Values

PAYLOAD

public static final String PAYLOAD

See Also:

Constant Field Values

URI

public static final String URI

See Also:

Constant Field Values

HEADERS

public static final String HEADERS

See Also:

Constant Field Values

TIMEOUT

public static final int TIMEOUT

See Also:

Constant Field Values

GATEWAY_TIMEOUT

public static final int GATEWAY_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

EventBusHandler

public EventBusHandler(io.vertx.core.Vertx vertx,
                       String apiPath,
                       String sockPath,
                       String addressPrefix,
                       String addressPathPattern)

EventBusHandler

public EventBusHandler(io.vertx.core.Vertx vertx,
                       String apiPath,
                       String sockPath,
                       String addressPrefix,
                       String addressPathPattern,
                       ConfigurationResourceManager configurationResourceManager,
                       String configResourceUri)

Constructs and configures the handler.

Parameters:

vertx - vertx

apiPath - The full URI path where to access the event api. E.g. /context/server/event/v1/.

sockPath - The full URI path of the SockJS endpoint to configure.

addressPrefix - The prefix used for the event bus addresses the handlers sends requests to. E.g. event/

addressPathPattern - A pattern to extract the address from the URI. This pattern is appended to the apiPath and must have a group. For example, a pattern hello/(world/[^/]+)/.* will forward requests on /context/server/event/v1/hello/world/foo/bar to address event/world/foo.

configurationResourceManager - The ConfigurationResourceManager used to get notifications on resource updates

configResourceUri - The full URI path of the configuration resource

Method Detail

handle

public boolean handle(io.vertx.core.http.HttpServerRequest request)

install

public void install(io.vertx.ext.web.Router router)

Configures and binds the SockJS bridge to an HttpServer.

Parameters:

router - router

resourceChanged

public void resourceChanged(String resourceUri,
                            String resource)

Description copied from interface: ConfigurationResourceObserver

Gets called when the resource with uri resourceUri has been changed. The changed resource is provided in the resource parameter.

Specified by:

resourceChanged in interface ConfigurationResourceObserver

Parameters:

resourceUri - the uri of the resource that has been changed

resource - the resource including the changes

resourceRemoved

public void resourceRemoved(String resourceUri)

Description copied from interface: ConfigurationResourceObserver

Gets called when the resource with uri resourceUri has been removed.

Specified by:

resourceRemoved in interface ConfigurationResourceObserver

Parameters:

resourceUri - the uri of the resource that has been removed

setEventbusBridgePingInterval

public void setEventbusBridgePingInterval(Long eventbusBridgePingInterval)

Sets the ping_interval passed to the eventbus bridge. Defines the interval before a websocket connection is closed if no interaction with client happens in the meantime. Set the interval before calling install(io.vertx.ext.web.Router)

Parameters:

eventbusBridgePingInterval - Interval in milliseconds or null to use the default interval of the eventbus bridge (10 seconds)

setEventbusBridgeReplyTimeout

public void setEventbusBridgeReplyTimeout(Long eventbusBridgeReplyTimeout)

Sets the reply timeout passed to the eventbus bridge. Set the interval before calling install(io.vertx.ext.web.Router)

Parameters:

eventbusBridgeReplyTimeout - Timeout in milliseconds or null to use the default reply timeout of the eventbus bridge (30 seconds)

setEventbusBridgeMaxAddressLength

public void setEventbusBridgeMaxAddressLength(Integer eventbusBridgeMaxAddressLength)

Sets the maximum address length passed to the eventbus bridge. Set the interval before calling install(io.vertx.ext.web.Router)

Parameters:

eventbusBridgeMaxAddressLength - Maximum address length or null to use the default value of the eventbus bridge (200)

setEventbusBridgeMaxHandlersPerSocket

public void setEventbusBridgeMaxHandlersPerSocket(Integer eventbusBridgeMaxHandlersPerSocket)

Sets the max handlers per socket passed to the eventbus bridge. Set the interval before calling install(io.vertx.ext.web.Router)

Parameters:

eventbusBridgeMaxHandlersPerSocket - Maximum handlers per socket or null to use the default value of the eventbus bridge (1000)

setSockJSHandlerOptions

public void setSockJSHandlerOptions(io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions sockJSHandlerOptions)

Sets the SockJSHandlerOptions to be used for the websocket connections. Set these options before calling install(io.vertx.ext.web.Router)

Parameters:

sockJSHandlerOptions - SockJSHandlerOptions to be used. Default SockJSHandlerOptions are used when null provided

getSockJSHandlerOptions

public io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions getSockJSHandlerOptions()