Package org.swisspush.gateleen.hook

Class HookHandler

java.lang.Object

org.swisspush.gateleen.hook.HookHandler

All Implemented Interfaces:

org.swisspush.gateleen.core.logging.LoggableResource

public class HookHandler
extends Object
implements org.swisspush.gateleen.core.logging.LoggableResource

The HookHandler is responsible for un- and registering hooks (listener, as well as routes). He also handles forwarding requests to listeners / routes.

Author:

https://github.com/ljucam [Mario Ljuca]

Field Summary

Fields

Modifier and Type	Field	Description
static String	COLLECTION
static String	DESTINATION
static String	DISCARD_PAYLOAD
static String	EXPIRATION_TIME
static String	FILTER
static String	FULL_URL
static String	HEADERS_FILTER
static String	HOOK
static String	HOOK_ROUTES_LISTED
static String	HOOK_TRIGGER_TYPE
static String	HOOKED_HEADER
static String	HOOKS_LISTENERS_URI_PART
static String	HOOKS_ROUTE_URI_PART
static String	LISTABLE
static String	LISTENER_QUEUE_PREFIX
static String	METHODS
static String	QUEUE_EXPIRE_AFTER
static String	REQUESTURL
static String	STATIC_HEADERS
static String	TRANSLATE_STATUS

Constructor Summary

Constructors

Constructor	Description
HookHandler(io.vertx.core.Vertx vertx, io.vertx.core.http.HttpClient selfClient, org.swisspush.gateleen.core.storage.ResourceStorage storage, org.swisspush.gateleen.logging.LoggingResourceManager loggingResourceManager, org.swisspush.gateleen.logging.LogAppenderRepository logAppenderRepository, org.swisspush.gateleen.monitoring.MonitoringHandler monitoringHandler, String userProfilePath, String hookRootUri)	Creates a new HookHandler.
HookHandler(io.vertx.core.Vertx vertx, io.vertx.core.http.HttpClient selfClient, org.swisspush.gateleen.core.storage.ResourceStorage storage, org.swisspush.gateleen.logging.LoggingResourceManager loggingResourceManager, org.swisspush.gateleen.logging.LogAppenderRepository logAppenderRepository, org.swisspush.gateleen.monitoring.MonitoringHandler monitoringHandler, String userProfilePath, String hookRootUri, RequestQueue requestQueue)	Creates a new HookHandler.
HookHandler(io.vertx.core.Vertx vertx, io.vertx.core.http.HttpClient selfClient, org.swisspush.gateleen.core.storage.ResourceStorage storage, org.swisspush.gateleen.logging.LoggingResourceManager loggingResourceManager, org.swisspush.gateleen.logging.LogAppenderRepository logAppenderRepository, org.swisspush.gateleen.monitoring.MonitoringHandler monitoringHandler, String userProfilePath, String hookRootUri, RequestQueue requestQueue, boolean listableRoutes)
HookHandler(io.vertx.core.Vertx vertx, io.vertx.core.http.HttpClient selfClient, org.swisspush.gateleen.core.storage.ResourceStorage storage, org.swisspush.gateleen.logging.LoggingResourceManager loggingResourceManager, org.swisspush.gateleen.logging.LogAppenderRepository logAppenderRepository, org.swisspush.gateleen.monitoring.MonitoringHandler monitoringHandler, String userProfilePath, String hookRootUri, RequestQueue requestQueue, boolean listableRoutes, ReducedPropagationManager reducedPropagationManager)	Creates a new HookHandler.
HookHandler(io.vertx.core.Vertx vertx, io.vertx.core.http.HttpClient selfClient, org.swisspush.gateleen.core.storage.ResourceStorage userProfileStorage, org.swisspush.gateleen.logging.LoggingResourceManager loggingResourceManager, org.swisspush.gateleen.logging.LogAppenderRepository logAppenderRepository, org.swisspush.gateleen.monitoring.MonitoringHandler monitoringHandler, String userProfilePath, String hookRootUri, RequestQueue requestQueue, boolean listableRoutes, ReducedPropagationManager reducedPropagationManager, io.vertx.core.Handler doneHandler, org.swisspush.gateleen.core.storage.ResourceStorage hookStorage)
HookHandler(io.vertx.core.Vertx vertx, io.vertx.core.http.HttpClient selfClient, org.swisspush.gateleen.core.storage.ResourceStorage userProfileStorage, org.swisspush.gateleen.logging.LoggingResourceManager loggingResourceManager, org.swisspush.gateleen.logging.LogAppenderRepository logAppenderRepository, org.swisspush.gateleen.monitoring.MonitoringHandler monitoringHandler, String userProfilePath, String hookRootUri, RequestQueue requestQueue, boolean listableRoutes, ReducedPropagationManager reducedPropagationManager, io.vertx.core.Handler doneHandler, org.swisspush.gateleen.core.storage.ResourceStorage hookStorage, int routeMultiplier)
HookHandler(io.vertx.core.Vertx vertx, io.vertx.core.http.HttpClient selfClient, org.swisspush.gateleen.core.storage.ResourceStorage userProfileStorage, org.swisspush.gateleen.logging.LoggingResourceManager loggingResourceManager, org.swisspush.gateleen.logging.LogAppenderRepository logAppenderRepository, org.swisspush.gateleen.monitoring.MonitoringHandler monitoringHandler, String userProfilePath, String hookRootUri, RequestQueue requestQueue, boolean listableRoutes, ReducedPropagationManager reducedPropagationManager, io.vertx.core.Handler doneHandler, org.swisspush.gateleen.core.storage.ResourceStorage hookStorage, int routeMultiplier, QueueSplitter queueSplitter)	Creates a new HookHandler.

Method Summary

Modifier and Type	Method	Description
void	enableResourceLogging(boolean resourceLoggingEnabled)
protected String	getUniqueListenerId(String requestUrl)	Creates a listener id, which is unique for the given service, and the monitored url.
boolean	handle(io.vertx.ext.web.RoutingContext ctx)	Handles requests, which are either listener or route related.
void	init()
boolean	isHookJsonInvalid(io.vertx.core.http.HttpServerRequest request, io.vertx.core.buffer.Buffer hookData)
boolean	isRequestAlreadyHooked(io.vertx.core.http.HttpServerRequest request)	Checks if the original Request was already hooked.
void	registerListenerRegistrationHandler(io.vertx.core.Handler<Void> readyHandler)	Registers all needed handlers for the listener registration / unregistration.
void	setMeterRegistry(io.micrometer.core.instrument.MeterRegistry meterRegistry)

Methods inherited from class java.lang.Object

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

Field Detail

HOOKED_HEADER

public static final String HOOKED_HEADER

See Also:

Constant Field Values

HOOK_ROUTES_LISTED

public static final String HOOK_ROUTES_LISTED

See Also:

Constant Field Values

HOOKS_LISTENERS_URI_PART

public static final String HOOKS_LISTENERS_URI_PART

See Also:

Constant Field Values

LISTENER_QUEUE_PREFIX

public static final String LISTENER_QUEUE_PREFIX

See Also:

Constant Field Values

HOOKS_ROUTE_URI_PART

public static final String HOOKS_ROUTE_URI_PART

See Also:

Constant Field Values

REQUESTURL

public static final String REQUESTURL

See Also:

Constant Field Values

EXPIRATION_TIME

public static final String EXPIRATION_TIME

See Also:

Constant Field Values

HOOK

public static final String HOOK

See Also:

Constant Field Values

TRANSLATE_STATUS

public static final String TRANSLATE_STATUS

See Also:

Constant Field Values

METHODS

public static final String METHODS

See Also:

Constant Field Values

HEADERS_FILTER

public static final String HEADERS_FILTER

See Also:

Constant Field Values

DESTINATION

public static final String DESTINATION

See Also:

Constant Field Values

FILTER

public static final String FILTER

See Also:

Constant Field Values

QUEUE_EXPIRE_AFTER

public static final String QUEUE_EXPIRE_AFTER

See Also:

Constant Field Values

STATIC_HEADERS

public static final String STATIC_HEADERS

See Also:

Constant Field Values

FULL_URL

public static final String FULL_URL

See Also:

Constant Field Values

DISCARD_PAYLOAD

public static final String DISCARD_PAYLOAD

See Also:

Constant Field Values

HOOK_TRIGGER_TYPE

public static final String HOOK_TRIGGER_TYPE

See Also:

Constant Field Values

LISTABLE

public static final String LISTABLE

See Also:

Constant Field Values

COLLECTION

public static final String COLLECTION

See Also:

Constant Field Values

Constructor Detail

HookHandler

public HookHandler(io.vertx.core.Vertx vertx,
                   io.vertx.core.http.HttpClient selfClient,
                   org.swisspush.gateleen.core.storage.ResourceStorage storage,
                   org.swisspush.gateleen.logging.LoggingResourceManager loggingResourceManager,
                   org.swisspush.gateleen.logging.LogAppenderRepository logAppenderRepository,
                   @Nullable
                   org.swisspush.gateleen.monitoring.MonitoringHandler monitoringHandler,
                   String userProfilePath,
                   String hookRootUri)

Creates a new HookHandler.

Parameters:

vertx - vertx

selfClient - selfClient

storage - storage

loggingResourceManager - loggingResourceManager

monitoringHandler - monitoringHandler

userProfilePath - userProfilePath

hookRootUri - hookRootUri

HookHandler

public HookHandler(io.vertx.core.Vertx vertx,
                   io.vertx.core.http.HttpClient selfClient,
                   org.swisspush.gateleen.core.storage.ResourceStorage storage,
                   org.swisspush.gateleen.logging.LoggingResourceManager loggingResourceManager,
                   org.swisspush.gateleen.logging.LogAppenderRepository logAppenderRepository,
                   @Nullable
                   org.swisspush.gateleen.monitoring.MonitoringHandler monitoringHandler,
                   String userProfilePath,
                   String hookRootUri,
                   RequestQueue requestQueue)

Creates a new HookHandler.

Parameters:

vertx - vertx

selfClient - selfClient

storage - storage

loggingResourceManager - loggingResourceManager

monitoringHandler - monitoringHandler

userProfilePath - userProfilePath

hookRootUri - hookRootUri

requestQueue - requestQueue

HookHandler

public HookHandler(io.vertx.core.Vertx vertx,
                   io.vertx.core.http.HttpClient selfClient,
                   org.swisspush.gateleen.core.storage.ResourceStorage storage,
                   org.swisspush.gateleen.logging.LoggingResourceManager loggingResourceManager,
                   org.swisspush.gateleen.logging.LogAppenderRepository logAppenderRepository,
                   @Nullable
                   org.swisspush.gateleen.monitoring.MonitoringHandler monitoringHandler,
                   String userProfilePath,
                   String hookRootUri,
                   RequestQueue requestQueue,
                   boolean listableRoutes)

HookHandler

public HookHandler(io.vertx.core.Vertx vertx,
                   io.vertx.core.http.HttpClient selfClient,
                   org.swisspush.gateleen.core.storage.ResourceStorage storage,
                   org.swisspush.gateleen.logging.LoggingResourceManager loggingResourceManager,
                   org.swisspush.gateleen.logging.LogAppenderRepository logAppenderRepository,
                   @Nullable
                   org.swisspush.gateleen.monitoring.MonitoringHandler monitoringHandler,
                   String userProfilePath,
                   String hookRootUri,
                   RequestQueue requestQueue,
                   boolean listableRoutes,
                   @Nullable
                   ReducedPropagationManager reducedPropagationManager)

Creates a new HookHandler.

Parameters:

vertx - vertx

selfClient - selfClient

storage - storage

loggingResourceManager - loggingResourceManager

monitoringHandler - monitoringHandler

userProfilePath - userProfilePath

hookRootUri - hookRootUri

requestQueue - requestQueue

listableRoutes - listableRoutes

reducedPropagationManager - reducedPropagationManager

HookHandler

public HookHandler(io.vertx.core.Vertx vertx,
                   io.vertx.core.http.HttpClient selfClient,
                   org.swisspush.gateleen.core.storage.ResourceStorage userProfileStorage,
                   org.swisspush.gateleen.logging.LoggingResourceManager loggingResourceManager,
                   org.swisspush.gateleen.logging.LogAppenderRepository logAppenderRepository,
                   @Nullable
                   org.swisspush.gateleen.monitoring.MonitoringHandler monitoringHandler,
                   String userProfilePath,
                   String hookRootUri,
                   RequestQueue requestQueue,
                   boolean listableRoutes,
                   ReducedPropagationManager reducedPropagationManager,
                   @Nullable
                   io.vertx.core.Handler doneHandler,
                   org.swisspush.gateleen.core.storage.ResourceStorage hookStorage)

HookHandler

public HookHandler(io.vertx.core.Vertx vertx,
                   io.vertx.core.http.HttpClient selfClient,
                   org.swisspush.gateleen.core.storage.ResourceStorage userProfileStorage,
                   org.swisspush.gateleen.logging.LoggingResourceManager loggingResourceManager,
                   org.swisspush.gateleen.logging.LogAppenderRepository logAppenderRepository,
                   @Nullable
                   org.swisspush.gateleen.monitoring.MonitoringHandler monitoringHandler,
                   String userProfilePath,
                   String hookRootUri,
                   RequestQueue requestQueue,
                   boolean listableRoutes,
                   ReducedPropagationManager reducedPropagationManager,
                   @Nullable
                   io.vertx.core.Handler doneHandler,
                   org.swisspush.gateleen.core.storage.ResourceStorage hookStorage,
                   int routeMultiplier)

HookHandler

public HookHandler(io.vertx.core.Vertx vertx,
                   io.vertx.core.http.HttpClient selfClient,
                   org.swisspush.gateleen.core.storage.ResourceStorage userProfileStorage,
                   org.swisspush.gateleen.logging.LoggingResourceManager loggingResourceManager,
                   org.swisspush.gateleen.logging.LogAppenderRepository logAppenderRepository,
                   @Nullable
                   org.swisspush.gateleen.monitoring.MonitoringHandler monitoringHandler,
                   String userProfilePath,
                   String hookRootUri,
                   RequestQueue requestQueue,
                   boolean listableRoutes,
                   ReducedPropagationManager reducedPropagationManager,
                   @Nullable
                   io.vertx.core.Handler doneHandler,
                   org.swisspush.gateleen.core.storage.ResourceStorage hookStorage,
                   int routeMultiplier,
                   @Nonnull
                   QueueSplitter queueSplitter)

Creates a new HookHandler.

Parameters:

vertx - vertx

selfClient - selfClient

userProfileStorage - userProfileStorage - where the user profiles are stored

loggingResourceManager - loggingResourceManager

monitoringHandler - monitoringHandler

userProfilePath - userProfilePath

hookRootUri - hookRootUri

requestQueue - requestQueue

listableRoutes - listableRoutes

reducedPropagationManager - reducedPropagationManager

doneHandler - doneHandler

hookStorage - hookStorage - where the hooks are stored

routeMultiplier - the multiplier that is applied to routes, this is typically the number of nodes in a cluster multiplied by the number of router instances within a node. Or in other words the number of Router instances within a cluster

queueSplitter - Configured QueueSplitter or NoOpQueueSplitter which dispatches to subqueues for parallel operation.

Method Detail

init

public void init()

setMeterRegistry

public void setMeterRegistry(io.micrometer.core.instrument.MeterRegistry meterRegistry)

enableResourceLogging

public void enableResourceLogging(boolean resourceLoggingEnabled)

Specified by:

enableResourceLogging in interface org.swisspush.gateleen.core.logging.LoggableResource

registerListenerRegistrationHandler

public void registerListenerRegistrationHandler(io.vertx.core.Handler<Void> readyHandler)

Registers all needed handlers for the listener registration / unregistration.

handle

public boolean handle(io.vertx.ext.web.RoutingContext ctx)

Handles requests, which are either listener or route related. Takes on:

• hook un-/registration
• enqueueing a request for the registered listeners
• forwarding a request to the reistered listeners
• creating a self request for the original request (if necessary)

Parameters:

ctx - routing context

Returns:

true if a request is processed by the handler, otherwise false

isHookJsonInvalid

public boolean isHookJsonInvalid(io.vertx.core.http.HttpServerRequest request,
                                 io.vertx.core.buffer.Buffer hookData)

isRequestAlreadyHooked

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

Checks if the original Request was already hooked. Eg. After a request is processed by the hook handler (register), the handler creates a self request with a copy of the original request. Therefore it's necessary to mark the request as already hooked.

Parameters:

request - request

Returns:

true if the original request was already hooked.

getUniqueListenerId

protected String getUniqueListenerId(String requestUrl)

Creates a listener id, which is unique for the given service, and the monitored url.

Parameters:

requestUrl - requestUrl

Returns:

String