com.hcl.domino.keep.tools

Class KeepUtils

java.lang.Object

com.hcl.domino.keep.tools.KeepUtils

public class KeepUtils
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static io.vertx.core.json.JsonObject	addEtag(io.vertx.core.json.JsonObject source, java.util.Calendar dateSource) Adds a standardized ETAG to a JsonObject based on a provided Calendar value
static io.vertx.core.json.JsonObject	addEtag(io.vertx.core.json.JsonObject source, java.time.OffsetDateTime dateSource) Adds a standardized ETAG to a JsonObject based on a provided Calendar value
static double	calcRunTimeSecondsDbl(long startTime)
static java.lang.String	cleanupApiName(java.lang.String curApiName) removes special characters from API names
static io.vertx.core.json.JsonArray	cleanupJSResults(io.vertx.core.json.JsonArray raw)
static io.vertx.core.json.JsonObject	fromDateRange(com.hcl.domino.data.DominoDateRange range) Converts a date range into a JSON object
static java.time.OffsetDateTime	fromIsoDate(java.lang.String isoString)
static java.lang.String	generateAppIdOrSecret() Generates key for Application ID or Secret
static java.lang.Object	getAsJson(java.lang.String jsonString) Removes all blank lines from a String and converts it to JSON, if possible
static io.vertx.core.buffer.Buffer	getBufferFromResource(java.lang.String resourceName) Loads a Classpath resource into a buffer
static java.util.Map<java.lang.String,io.vertx.core.json.JsonObject>	getEnabledJsonFromConfig(java.lang.String key, io.vertx.core.json.JsonObject config) Returns all JsonObjects where the JsonObject has a property active with the vaue “true” - used to switch on/off elements
static java.util.Set<java.lang.String>	getEnabledValuesFromConfig(java.lang.String key, io.vertx.core.json.JsonObject config) Returns all keys where the value is “true” - used to switch on/off features
static io.vertx.core.json.JsonArray	getEnvironmentParamsToRead() Names all parameters that can be overwritten / defined by environment variables
static java.lang.String	getIcon(java.lang.String iconName) Provides one of our lovely database icons
static io.vertx.core.json.JsonObject	getJsonFromResource(java.lang.String resourceName)
static io.vertx.core.json.JsonObject	getJsonObjectFromMap(java.util.Map<java.lang.String,java.lang.String> source)
static java.lang.Throwable	getKeepException(java.lang.Throwable incomingThrowable) Helper function to turn any Throwable into a KeepException for proper processing on return to client
static java.util.Map<java.lang.String,java.lang.String>	getMapFromResource(java.lang.String resourceName)
static java.util.Map<java.lang.String,java.lang.String>	getMapFromResource(java.lang.String resourceName, java.lang.String separator)
static io.vertx.core.http.HttpServerOptions	getServerOptions(java.lang.String portType, int portDefault, io.vertx.core.json.JsonObject config) Constructing options for HTTP server
static java.lang.String	getStringFromFile(java.lang.String fileName)
static java.lang.String	getStringFromResource(java.lang.String resourceName)
static java.lang.String	hashString(java.lang.String source) Produces a light hash of an incoming string
static java.lang.String	isoDate(com.hcl.domino.data.DominoDateTime dDT) Returns a date as ISO formatted string
static java.lang.String	isoDate(java.time.OffsetDateTime value) Returns a OffsetDateTime as ISO formatted string
static io.vertx.core.Future<io.vertx.core.json.JsonObject>	loadConfiguration(io.vertx.core.Vertx vertx, java.lang.String configDirName) Retrieves config based on value is increating priority: - Default config from Jar - config from command line - environment parameters
static boolean	looksLikeAnUnid(java.lang.String candidate) Checks if a given String looks like an UNID: - 32 characters long - contains ony HEX characters 0-9 A-F
static java.lang.String	replaceNamedVars(java.lang.String source, io.vertx.core.json.JsonObject dqlVars) Poor man’s query parameter replacement Special handling: replace ‘ with ’’ to avoid injections
static boolean	seemsValidXmlFile(java.io.File xmlFile) Check if a file is valid xml
static java.lang.String	timediff(java.util.Date theEnd, java.util.Date startDate)
static java.lang.String	timediff(long diff)
static void	writeTextItemEmptyIfNull(com.hcl.domino.data.Document note, java.lang.String itemName, java.lang.Object itemValue) Writes an Item to a Note, replaces null with an empty string

Methods inherited from class java.lang.Object

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

Method Detail

addEtag

public static io.vertx.core.json.JsonObject addEtag(io.vertx.core.json.JsonObject source,
                                                    java.util.Calendar dateSource)

Adds a standardized ETAG to a JsonObject based on a provided Calendar value

Parameters:

source - JsonObject that needs the ETAG added

dateSource - Calendar with the Date/Time for the eTag

Returns:

JsonObject with DateTime ETAG added

addEtag

public static io.vertx.core.json.JsonObject addEtag(io.vertx.core.json.JsonObject source,
                                                    java.time.OffsetDateTime dateSource)

Adds a standardized ETAG to a JsonObject based on a provided Calendar value

Parameters:

source - JsonObject that needs the ETAG added

dateSource - Calendar with the Date/Time for the eTag

Returns:

JsonObject with DateTime ETAG added

calcRunTimeSecondsDbl

public static double calcRunTimeSecondsDbl(long startTime)

Parameters:

startTime -

Returns:

duration in milliseconds

cleanupApiName

public static java.lang.String cleanupApiName(java.lang.String curApiName)

removes special characters from API names

Parameters:

curApiName -

Returns:

cleaned String

cleanupJSResults

public static io.vertx.core.json.JsonArray cleanupJSResults(io.vertx.core.json.JsonArray raw)

Parameters:

raw - JsonArray with results, might contain “Json ready strings”

Returns:

cleaned up array where JSON is JSON

fromDateRange

public static io.vertx.core.json.JsonObject fromDateRange(com.hcl.domino.data.DominoDateRange range)

Converts a date range into a JSON object

Parameters:

range - DominoDateRange

Returns:

JsonObject with start/end

fromIsoDate

public static java.time.OffsetDateTime fromIsoDate(java.lang.String isoString)

Parameters:

isoString -

Returns:

Datetime

generateAppIdOrSecret

public static java.lang.String generateAppIdOrSecret()

Generates key for Application ID or Secret

Returns:

hex lower-case string 18 characters long of format abcdef-1234-567890

getAsJson

public static java.lang.Object getAsJson(java.lang.String jsonString)

Removes all blank lines from a String and converts it to JSON, if possible

Parameters:

jsonString - to convert

Returns:

JsonObject, JsonArray or String

getBufferFromResource

public static io.vertx.core.buffer.Buffer getBufferFromResource(@Nonnull
                                                                java.lang.String resourceName)

Loads a Classpath resource into a buffer

Parameters:

resourceName - name of the resource

Returns:

Buffer, empty if resource not found

getEnabledJsonFromConfig

public static java.util.Map<java.lang.String,io.vertx.core.json.JsonObject> getEnabledJsonFromConfig(@Nonnull
                                                                                                     java.lang.String key,
                                                                                                     @Nonnull
                                                                                                     io.vertx.core.json.JsonObject config)

Returns all JsonObjects where the JsonObject has a property active with the vaue “true” - used to switch on/off elements

Parameters:

key -

• value to look for

config -

Returns:

Map of values that are enabled

getEnabledValuesFromConfig

public static java.util.Set<java.lang.String> getEnabledValuesFromConfig(java.lang.String key,
                                                                         io.vertx.core.json.JsonObject config)

Returns all keys where the value is “true” - used to switch on/off features

Parameters:

key -

• value to look for

config -

Returns:

Set of values that are enables

getEnvironmentParamsToRead

public static io.vertx.core.json.JsonArray getEnvironmentParamsToRead()

Names all parameters that can be overwritten / defined by environment variables

Returns:

JsonArray

getIcon

public static java.lang.String getIcon(java.lang.String iconName)

Provides one of our lovely database icons

Parameters:

iconName -

Returns:

SVG with an actual icon

getJsonFromResource

public static io.vertx.core.json.JsonObject getJsonFromResource(@Nonnull
                                                                java.lang.String resourceName)

Parameters:

resourceName -

Returns:

a JsonObject or an empty JsonObject if no resource found

getJsonObjectFromMap

public static io.vertx.core.json.JsonObject getJsonObjectFromMap(java.util.Map<java.lang.String,java.lang.String> source)

Parameters:

source - a Map with key/value pairs

Returns:

a flat JsonObject

getKeepException

public static java.lang.Throwable getKeepException(java.lang.Throwable incomingThrowable)

Helper function to turn any Throwable into a KeepException for proper processing on return to client

Parameters:

incomingThrowable -

Returns:

a KeepException

getMapFromResource

public static java.util.Map<java.lang.String,java.lang.String> getMapFromResource(@Nonnull
                                                                                  java.lang.String resourceName)

Parameters:

resourceName - Name of resource to be read, separated by “=”

Returns:

a Map with found values, values can’t contain =

getMapFromResource

public static java.util.Map<java.lang.String,java.lang.String> getMapFromResource(@Nonnull
                                                                                  java.lang.String resourceName,
                                                                                  java.lang.String separator)

Parameters:

resourceName - Name of resource to be read

separator - separator for key/value, “=” if null, values must not contain separator

Returns:

a Map with found values

getServerOptions

public static io.vertx.core.http.HttpServerOptions getServerOptions(java.lang.String portType,
                                                                    int portDefault,
                                                                    io.vertx.core.json.JsonObject config)

Constructing options for HTTP server

Parameters:

portType - which port constant to use to retrieve from config

portDefault - default port, if nothing in config

config - config from which to retrieve the port

Returns:

HttpServerOptions to apply to server

getStringFromFile

public static java.lang.String getStringFromFile(@Nonnull
                                                 java.lang.String fileName)

Parameters:

fileName -

Returns:

content as String or null

getStringFromResource

public static java.lang.String getStringFromResource(@Nonnull
                                                     java.lang.String resourceName)

Parameters:

resourceName -

Returns:

a String

hashString

public static java.lang.String hashString(java.lang.String source)

Produces a light hash of an incoming string

Parameters:

source -

• String to hash

Returns:

non-cryptographic hash

isoDate

public static java.lang.String isoDate(com.hcl.domino.data.DominoDateTime dDT)

Returns a date as ISO formatted string

Parameters:

dDT -

• a date

Returns:

ISO String

isoDate

public static java.lang.String isoDate(java.time.OffsetDateTime value)

Returns a OffsetDateTime as ISO formatted string

Parameters:

value -

• a date

Returns:

ISO String

loadConfiguration

public static io.vertx.core.Future<io.vertx.core.json.JsonObject> loadConfiguration(@Nonnull
                                                                                    io.vertx.core.Vertx vertx,
                                                                                    @Nonnull
                                                                                    java.lang.String configDirName)

Retrieves config based on value is increating priority: - Default config from Jar - config from command line - environment parameters

Parameters:

vertx -

configDirName -

• the directory with additional configuration files

Returns:

a future with th JsonObject containing the configuration

looksLikeAnUnid

public static boolean looksLikeAnUnid(java.lang.String candidate)

Checks if a given String looks like an UNID: - 32 characters long - contains ony HEX characters 0-9 A-F

Parameters:

candidate - the String to check

Returns:

true if it might be a UNID

replaceNamedVars

public static java.lang.String replaceNamedVars(java.lang.String source,
                                                io.vertx.core.json.JsonObject dqlVars)

Poor man’s query parameter replacement Special handling: replace ‘ with ’’ to avoid injections

Parameters:

source -

• DQL with parameters

dqlVars -

Returns:

a resolved query string

seemsValidXmlFile

public static boolean seemsValidXmlFile(java.io.File xmlFile)

Check if a file is valid xml

Parameters:

xmlFile -

Returns:

true if file is valid XML

timediff

public static java.lang.String timediff(java.util.Date theEnd,
                                        java.util.Date startDate)

Parameters:

theEnd -

startDate -

Returns:

Time passed as String

timediff

public static java.lang.String timediff(long diff)

Parameters:

diff -

Returns:

Time difference

writeTextItemEmptyIfNull

public static void writeTextItemEmptyIfNull(com.hcl.domino.data.Document note,
                                            java.lang.String itemName,
                                            java.lang.Object itemValue)

Writes an Item to a Note, replaces null with an empty string

Parameters:

note - Document to write to

itemName - Item name to write to

itemValue - Item value, might be null