com.hcl.domino.keep.info

Class KeepApiInfo

java.lang.Object

com.hcl.domino.keep.info.KeepApiInfo

public class KeepApiInfo
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeepApiInfo.BodyType List of body types we expect / process Currently we only need to distinguish between JSON (object/array) and other like buffer or mime

Method Summary

Modifier and Type	Method and Description
static KeepApiInfo	create(java.lang.String path, java.lang.String method, io.vertx.core.json.JsonObject methodContent, io.vertx.core.json.JsonArray paramsOnPathLevel, java.lang.String version)
static KeepApiInfo	create(java.lang.String path, java.lang.String method, io.vertx.core.json.JsonObject methodContent, java.lang.String version)
boolean	expectBody() Does this API call expect a Body submission (any type) yes for POST, PUT, PATCH
boolean	expectJsonBody() Body check: must be there and must be JSON
java.lang.String	getEventBusId() The eventbusId is composed out of the associated Tag and the operationId This allows different OpenAPI implementations to reuse existing methods
java.util.Set<java.lang.String>	getKnownParameterNames()
java.lang.String	getName()
io.vertx.core.json.JsonObject	getRawMethod()
java.util.Set<java.lang.String>	getRequestType() MimeTypes only are relevant for POST, PUT, PATCH for GET, DELETE etc.
java.util.Set<java.lang.String>	getRequiredParameterNames()
java.util.Set<java.lang.String>	getReturnType()
java.util.Collection<java.lang.String>	getTags()
java.lang.String	getVersion()
boolean	hasNoTags() Checks if the method hasn’t any tags which would prevent it from getting loaded
boolean	hasTag(java.lang.String tag) Checks if a method holds a specific tag
boolean	isJsonInOut() Check if the method is the default case of Nothing or JSON in body and JSON as return type
boolean	isRequestsAnArray()
boolean	isRequireBodyNotJson() Returns true if the body is NOT in JSON format but a buffer of content
boolean	isReturnsAnArray()
boolean	isUsesConfigAsDbParameter()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static KeepApiInfo create(@Nonnull
                                 java.lang.String path,
                                 @Nonnull
                                 java.lang.String method,
                                 @Nonnull
                                 io.vertx.core.json.JsonObject methodContent,
                                 @Nonnull
                                 io.vertx.core.json.JsonArray paramsOnPathLevel,
                                 @Nonnull
                                 java.lang.String version)

Parameters:

path -

method - get, put, post, patch etc.

methodContent -

• The JSON fragment from an OpenAPI method

paramsOnPathLevel -

• parameters that come from a group of methods

version -

• the short- name of the loaded API

Returns:

a new ApiInfo instance - used to load handlers and requesters

create

public static KeepApiInfo create(@Nonnull
                                 java.lang.String path,
                                 @Nonnull
                                 java.lang.String method,
                                 @Nonnull
                                 io.vertx.core.json.JsonObject methodContent,
                                 @Nonnull
                                 java.lang.String version)

Parameters:

method - get, put, post, patch etc.

methodContent -

• The JSON fragment from an OpenAPI method

version -

• the short- name of the loaded API

Returns:

a new ApiInfo instance - used to load handlers and requesters

expectBody

public boolean expectBody()

Does this API call expect a Body submission (any type) yes for POST, PUT, PATCH

Returns:

true/false

expectJsonBody

public boolean expectJsonBody()

Body check: must be there and must be JSON

Returns:

true when we expect a Body in JSON format

getEventBusId

public java.lang.String getEventBusId()

The eventbusId is composed out of the associated Tag and the operationId This allows different OpenAPI implementations to reuse existing methods

Returns:

the eventBusId

getKnownParameterNames

public java.util.Set<java.lang.String> getKnownParameterNames()

Returns:

Returns all known parameters, path, query, headerd

getName

public java.lang.String getName()

Returns:

the name

getRequestType

public java.util.Set<java.lang.String> getRequestType()

MimeTypes only are relevant for POST, PUT, PATCH for GET, DELETE etc. they are Void

Returns:

MimeType that gets requested, might be Void

getRequiredParameterNames

public java.util.Set<java.lang.String> getRequiredParameterNames()

Returns:

all parameters that are mandatory

getReturnType

public java.util.Set<java.lang.String> getReturnType()

Returns:

MimeType that will come back

getTags

public java.util.Collection<java.lang.String> getTags()

Returns:

all tags for this API endpoint

getVersion

public java.lang.String getVersion()

Returns:

the API version

hasNoTags

public boolean hasNoTags()

Checks if the method hasn’t any tags which would prevent it from getting loaded

Returns:

no tags provided

hasTag

public boolean hasTag(@Nonnull
                      java.lang.String tag)

Checks if a method holds a specific tag

Parameters:

tag - name of the tag

Returns:

true if contained as tag

isJsonInOut

public boolean isJsonInOut()

Check if the method is the default case of Nothing or JSON in body and JSON as return type

Returns:

true if we have the default case

isRequestsAnArray

public boolean isRequestsAnArray()

Returns:

true if the body submitted is supposed to be an array even when there is only one element posted

isRequireBodyNotJson

public boolean isRequireBodyNotJson()

Returns true if the body is NOT in JSON format but a buffer of content

Returns:

true/false

isReturnsAnArray

public boolean isReturnsAnArray()

Returns:

true if the response is supposed to be an array even when there is only one element coming back

isUsesConfigAsDbParameter

public boolean isUsesConfigAsDbParameter()

Returns:

the usesConfigAsDbParameter

getRawMethod

public io.vertx.core.json.JsonObject getRawMethod()