com.hcl.domino.keep.handlers.core

Class AbstractAPIHandler<T>

java.lang.Object

io.vertx.ext.web.handler.impl.BodyHandlerImpl

com.hcl.domino.keep.handlers.core.AbstractAPIHandler<T>

Type Parameters:

T -

All Implemented Interfaces:

io.vertx.core.Handler<io.vertx.ext.web.RoutingContext>, io.vertx.ext.web.handler.BodyHandler

Direct Known Subclasses:

CreateDocumentAttachment, CreateMimeMessage, DefaultJsonHandler, DefaultPimHandler, FetchOdata, FetchOdataList, GetDocumentAttachment, GetDxl, GetMailAttachment, GetMessageBody, GetMimeMessage, GetOdataMetadata, GetOdataServiceInfo

public abstract class AbstractAPIHandler<T>
extends io.vertx.ext.web.handler.impl.BodyHandlerImpl

The AbstractAPIHandler implements convenience methods to minimize the code required in an actual handler. A handler only needs to provide

Field Summary

Fields

Modifier and Type	Field and Description
protected KeepApiInfo	apiInfo
protected io.vertx.core.json.JsonObject	config
protected java.lang.String	eventBusId
protected static org.slf4j.Logger	logger
protected java.lang.String	operationId
protected io.vertx.core.Vertx	vertx

Fields inherited from interface io.vertx.ext.web.handler.BodyHandler

DEFAULT_BODY_LIMIT, DEFAULT_DELETE_UPLOADED_FILES_ON_END, DEFAULT_MERGE_FORM_ATTRIBUTES, DEFAULT_PREALLOCATE_BODY_BUFFER, DEFAULT_UPLOADS_DIRECTORY

Constructor Summary

Constructors

Constructor and Description
AbstractAPIHandler()

Method Summary

Modifier and Type	Method and Description
protected void	endWithError(io.vertx.ext.web.RoutingContext ctx, ErrorMessage errorMessage) Ends a request by sending an error code
protected void	endWithError(io.vertx.ext.web.RoutingContext ctx, ErrorMessage errorMessage, boolean closeArray) Ends a request by sending an error code
protected void	endWithError(io.vertx.ext.web.RoutingContext ctx, java.lang.Exception exception)
protected void	endWithError(io.vertx.ext.web.RoutingContext ctx, java.lang.Exception exception, boolean closeArray)
EventBusRequestObservable	getObservable(java.lang.String address, io.vertx.core.MultiMap headers, io.vertx.core.json.JsonObject incoming)
protected java.util.EnumSet<RequestOptionFlags>	getReqOptions() Options to check when looking at header and parameters
void	handle(io.vertx.ext.web.RoutingContext ctx)
protected void	handleErrorWhileListening(io.vertx.ext.web.RoutingContext ctx, java.lang.Throwable error, boolean happenedMidFlight) Standard Error when things go wrong.
protected static void	incrementRequestCounter(java.lang.String counterName, java.lang.String apiInfoName)
void	initHandler(io.vertx.core.Vertx newVertx, io.vertx.core.json.JsonObject newConfig, KeepApiInfo newApiInfo)
protected io.vertx.core.json.JsonArray	injectIntoObservableValue(io.vertx.core.json.JsonArray value) Allows us to modify the response value based on the handler.
protected void	listenForBufferResponse(EventBusRequestObservable<io.vertx.core.buffer.Buffer> incomingObservable, io.vertx.ext.web.RoutingContext ctx) Default implementation of a Buffer listener -> usable for any type of binary data
protected void	listenForJsonResponse(EventBusRequestObservable<io.vertx.core.json.JsonArray> incomingObservable, io.vertx.ext.web.RoutingContext ctx) Default implementation of a JSON listener allows multiple packages delivered
protected abstract void	listenForResponse(EventBusRequestObservable<T> incomingObservable, io.vertx.ext.web.RoutingContext ctx)
protected abstract io.vertx.core.Future<io.vertx.core.json.JsonObject>	prepareRequestBody(io.vertx.ext.web.RoutingContext ctx, io.vertx.core.MultiMap header)
protected io.vertx.core.Future<io.vertx.core.json.JsonObject>	requestBodyFromAllParams(io.vertx.ext.web.RoutingContext ctx, io.vertx.core.MultiMap headers) Copies all parameters into the JsonObject for processing
void	setObservable(EventBusRequestObservable<T> observable)

Methods inherited from class io.vertx.ext.web.handler.impl.BodyHandlerImpl

setBodyLimit, setDeleteUploadedFilesOnEnd, setHandleFileUploads, setMergeFormAttributes, setPreallocateBodyBuffer, setUploadsDirectory

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.vertx.ext.web.handler.BodyHandler

create, create, create

Field Detail

logger

protected static final org.slf4j.Logger logger

vertx

protected io.vertx.core.Vertx vertx

config

protected io.vertx.core.json.JsonObject config

operationId

protected java.lang.String operationId

eventBusId

protected java.lang.String eventBusId

apiInfo

protected KeepApiInfo apiInfo

Constructor Detail

AbstractAPIHandler

public AbstractAPIHandler()

Method Detail

getObservable

public EventBusRequestObservable getObservable(java.lang.String address,
                                               io.vertx.core.MultiMap headers,
                                               io.vertx.core.json.JsonObject incoming)

Parameters:

address -

• vert.x Eventbus address - randomly created

headers -

• Message headers with actions and JWT claim

incoming -

• actual incoming with query, path parameters and body

Returns:

the observable

handle

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

Specified by:

handle in interface io.vertx.core.Handler<io.vertx.ext.web.RoutingContext>

Overrides:

handle in class io.vertx.ext.web.handler.impl.BodyHandlerImpl

initHandler

public void initHandler(@Nonnull
                        io.vertx.core.Vertx newVertx,
                        @Nonnull
                        io.vertx.core.json.JsonObject newConfig,
                        @Nonnull
                        KeepApiInfo newApiInfo)
                 throws KeepExceptionMissingParameters

Parameters:

newVertx -

newConfig -

newApiInfo -

Throws:

KeepExceptionMissingParameters

setObservable

public void setObservable(EventBusRequestObservable<T> observable)

Parameters:

observable - the observable to set

endWithError

protected void endWithError(io.vertx.ext.web.RoutingContext ctx,
                            ErrorMessage errorMessage)

Ends a request by sending an error code

Parameters:

ctx - Context

errorMessage - Statuscode 50x, 40x

endWithError

protected void endWithError(io.vertx.ext.web.RoutingContext ctx,
                            ErrorMessage errorMessage,
                            boolean closeArray)

Ends a request by sending an error code

Parameters:

ctx - Context

errorMessage -

• The error message

closeArray -

• was there already an array open

endWithError

protected void endWithError(io.vertx.ext.web.RoutingContext ctx,
                            java.lang.Exception exception)

endWithError

protected void endWithError(io.vertx.ext.web.RoutingContext ctx,
                            java.lang.Exception exception,
                            boolean closeArray)

getReqOptions

protected java.util.EnumSet<RequestOptionFlags> getReqOptions()

Options to check when looking at header and parameters

Returns:

the reqOptions

handleErrorWhileListening

protected void handleErrorWhileListening(io.vertx.ext.web.RoutingContext ctx,
                                         java.lang.Throwable error,
                                         boolean happenedMidFlight)

Standard Error when things go wrong. If a KeepException is thrown, We get the HTTP error code type, to forward Error classes 4xx, 5xx

Parameters:

ctx -

error -

happenedMidFlight -

incrementRequestCounter

protected static void incrementRequestCounter(java.lang.String counterName,
                                              java.lang.String apiInfoName)

injectIntoObservableValue

protected io.vertx.core.json.JsonArray injectIntoObservableValue(io.vertx.core.json.JsonArray value)

Allows us to modify the response value based on the handler. This enables generating content in the handler, not passing it over the event bus, but including it in the response.

Parameters:

value -

Returns:

merged response

listenForBufferResponse

protected void listenForBufferResponse(EventBusRequestObservable<io.vertx.core.buffer.Buffer> incomingObservable,
                                       io.vertx.ext.web.RoutingContext ctx)

Default implementation of a Buffer listener -> usable for any type of binary data

Parameters:

incomingObservable - The observable that comes with JsonObject

ctx - Request context

listenForJsonResponse

protected void listenForJsonResponse(EventBusRequestObservable<io.vertx.core.json.JsonArray> incomingObservable,
                                     io.vertx.ext.web.RoutingContext ctx)

Default implementation of a JSON listener allows multiple packages delivered

Parameters:

incomingObservable - The observable that comes with JsonObject

ctx - Request context

listenForResponse

protected abstract void listenForResponse(EventBusRequestObservable<T> incomingObservable,
                                          io.vertx.ext.web.RoutingContext ctx)

Parameters:

incomingObservable - The Observable running

prepareRequestBody

protected abstract io.vertx.core.Future<io.vertx.core.json.JsonObject> prepareRequestBody(io.vertx.ext.web.RoutingContext ctx,
                                                                                          io.vertx.core.MultiMap header)

Parameters:

ctx -

• Request/Respnse context

header - The header for the EventBus

Returns:

a future with the JSON Object we sent over the EventBus

requestBodyFromAllParams

protected io.vertx.core.Future<io.vertx.core.json.JsonObject> requestBodyFromAllParams(io.vertx.ext.web.RoutingContext ctx,
                                                                                       io.vertx.core.MultiMap headers)

Copies all parameters into the JsonObject for processing

Parameters:

ctx - Request context

headers -

• if we need to add something

Returns:

a Json Object usable as EventBus request body